Documentatie

Explorează documentația noastră cuprinzătoare pentru a obține informații detaliate despre utilizarea și dezvoltarea serviciilor.

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.


API endpoint:

post
/v1/order

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:

delete
/v1/order/{order_id}

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:

post
/v1/order/reject/{order_id}

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:

get
/v1/order/{order_id}

Description:

Use this endpoint to get an order for eSIM/Plans.

Request example:

curl --location --request POST '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:

get
/v1/orders

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