Skip to content

eSIMTrade Docs

Public API

api.esimtrade.com

cURL
JavaScript
HTTP
JSON

Simpler, clearer reseller API docs.

Start with authentication, check wallet balance, read plans, and then move into orders and inventory. These docs are designed to help teams integrate faster with less scrolling and less guessing.

Fast scan
Live route coverage
Copyable examples
Orders
API key or session
GET

Query Order Status

Sync a provider order by order number or ICCID and update the persisted reseller order status.

Endpoint

GET /portal/orders

Endpoint behavior

This route syncs live provider status for an existing order by provider order number or ICCID. When an order number is supplied, the server also updates the local persisted PortalOrder status and records a provider_sync event.

If the synced status crosses into one of the notifiable lifecycle states, the server can also trigger reseller email updates once per status transition.

Query parameterTypeRequiredDescription
ordernostringEitherProvider order number to sync
iccidstringEitherICCID to sync if order number is unavailable

Sync by provider order number

cURL
curl --location --request GET 'https://api.esimtrade.com/api/v1/portal/orders?orderno=B26022703140001' \
--header 'x-access-code: YOUR_ACCESS_CODE' \
--header 'x-secret-key: YOUR_SECRET_KEY'

Sync by ICCID

cURL
curl --location --request GET 'https://api.esimtrade.com/api/v1/portal/orders?iccid=8948010000095399804' \
--header 'x-access-code: YOUR_ACCESS_CODE' \
--header 'x-secret-key: YOUR_SECRET_KEY'

Live response shape

JSON
{
  "data": {
    "esimTranNo": "26022703140001",
    "orderNo": "B26022703140001",
    "transactionId": "gs_1772162041486",
    "imsi": "260010181623870",
    "iccid": "8948010000095399804",
    "qrCodeUrl": "https://p.qrsim.net/example.png",
    "shortUrl": "https://p.qrsim.net/example",
    "smdpStatus": "RELEASED",
    "totalVolume": 524288000,
    "totalDuration": 1,
    "durationUnit": "DAY",
    "orderUsage": 0,
    "esimStatus": "CANCEL",
    "packageList": [
      {
        "packageName": "Pakistan 500MB/Day",
        "packageCode": "PUX79Y0PK",
        "slug": "PK_0.5_Daily"
      }
    ]
  }
}

Base URL

https://api.esimtrade.com/api/v1

Open on API host

On this page