Create eSIM Order

Production

https://api.getroamify.com

POST

/api/esim/order

Last modified:2025-09-03 22:22:04

Maintainer:Not configured

To create an eSIM order, you need to send a POST request to the /api/esim/order endpoint.

You are required to provide the following parameters in the request body:

items: An array of eSIM items you want to order. Each item should contain the following details:

packageId: The ID of the eSIM package you want to order. This is a required field of type string.

quantity: The quantity of the eSIM package you want to order. This is a required field of type number.

referenceId: The reference ID for the order. This is an optional field of type string. (Your custom reference ID for the order, if needed.)

Request

Header Params

Body Params application/json

Example

{
	"items": [
		{
			"packageId": "esim-cambodia-7days-1gb-all",
			"quantity": 1
		}
	],
	"referenceId": "partner reference id(optional)"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.getroamify.com/api/esim/order' \
--header 'Authorization: token' \
--header 'Content-Type: application/json' \
--data-raw '{
	"items": [
		{
			"packageId": "esim-cambodia-7days-1gb-all",
			"quantity": 1
		}
	],
	"referenceId": "partner reference id(optional)"
}'

Responses

🟢200successfully / 200

text/plain

Body

Example

application/json; charset=utf-8 content type is not supported in the response body

Modified at 2025-09-03 22:22:04

Get eSIM Packages

Create eSIM Top-Up Order