This documentation provides detailed information about the available API endpoints.
The eSIM and Data Plan Order Management API allows users to create, update, retrieve, and manage orders for eSIMs and data plans efficiently. This API supports operations such as placing orders, tracking order status, managing order details, and handling rejections.
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.
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.
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 create an order for eSIM/Plans.
Request example:
curl --location --request POST 'https://api.simvox.com/v1/order' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"type": "",
"package_id": "",
"description": "",
"auto_renewal": true
}'
| 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 |
| type | Required string | Type of Order,e.g.'esim' or 'plan' |
| iccid | Optional string | Unique ID of eSIM |
API endpoint:
Description:
Use this endpoint to cancel an order for eSIM/Plans.
Request example:
curl --location --request DELETE 'https://api.simvox.com/v1/order/{order_id}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
| Parameter | Type | Description |
| order_id | Required string | Unique ID of order. |
API endpoint:
Description:
Use this endpoint to reject an order for eSIM/Plans.
Request example:
curl --location --request POST 'https://api.simvox.com/v1/order/reject/{order_id}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
| Parameter | Type | Description |
| order_id | Required string | Unique ID of order. |
API endpoint:
Description:
Use this endpoint to get an order for eSIM/Plans.
Request example:
curl --location --request POST 'https://api.simvox.com/v1/order/reject/{order_id}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
| Parameter | Type | Description |
| order_id | Required string | Unique ID of order. |
API endpoint:
Description:
Use this endpoint to get all order list for eSIM/Plans.
Request example:
curl --location --request POST 'https://api.simvox.com/v1/orders' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
| Parameter | Type | Description |