- Mon - Sat: 8:00am - 6:00pm
- noc@request.ro
Documentation
Explore our comprehensive documentation to get detailed insights on service usage and development.
Retrieve a filtered list of Products by using products apis
What is an Order?
An order represents a request for an eSIM and data plan. Orders contain details about the customer, the selected plan, and the eSIM activation process.
Why Can Orders Be Rejected?
Orders can be rejected due to invalid plan selections, fraudulent requests, or incompatible eSIM devices. The rejection feature ensures that only valid orders proceed to activation.
How to Manage Order Status?
Users can track order status from "pending" to "completed," with intermediate states like "inprogress" or "rejected." This allows for better order management and transparency.
For authentication,The Bearer token should be sent as a bearer tokens in the Authorization header of the request. Create account.
API endpoint:
Description:
Use this endpoint to retrieve a filtered list of Products in your account.
Request example:
curl --location --request GET 'https://api.simvox.com/v1/packages' \
--header 'Authorization: Bearer {token}'
| Parameter | Type | Description |
| country | Optional string | ISO2 code for a country, e.g. fr, us, ca |
| pageNum | Optional integer | Current page number for pagination |
| pageSize | Optional integer | Number of items per page |
| data | Optional integer | Filter by data amount in MB (e.g., 1000 for 1GB, 2000 for 2GB) |
| validity | Optional integer | Filter by validity period (e.g., 7, 30) |
| title | Optional string | Filter by package title or keyword |
| unlimited | Optional boolean | Filter by unlimited packages (e.g., 1 for unlimited, 0 for limited) |
API endpoint:
Description:
Use this endpoint to get the details of a single Product (Data Plan type)
Request example:
curl --location --request GET 'https://api.simvox.com/v1/packages/{package_id}' \
--header 'Authorization: Bearer {token}'
| Parameter | Type | Description |
| package_id | Required string | The Data Plan ID is linked to a specific mobile data plan, which could include voice, text, and data services |
API endpoint:
Description:
Retrieves available attributes of All eSIM packages based on the selected country.
Request example:
curl --location --request GET 'https://api.simvox.com/v1/package-attributes' \
--header 'Authorization: Bearer {token} \
| Parameter | Type | Description |
| country | Optional string | ISO2 code for a country, e.g. fr, us, ca |