LIliteapi
eSIMply orders

Submit an eSIMply order

Overview

Finalize a cart and provision the eSIM. On success you receive the order ID, ICCID, QR / LPA install payload, and purchase details. Successful orders are persisted for the partner account.

When to Use

  • Complete purchase - After collecting traveler contact details
  • Provision eSIM - Generate installable QR / activation data for the traveler
  • Partner reconciliation - Attach your clientReference for support and reporting
  • Safe retries - Resubmit the same cartKey after timeouts; liteAPI returns the stored order without buying again

What You Get

  • Order ID - Provider order identifier
  • Purchases - ICCID, QR code, SM-DP address, activation code, package and pricing
  • Traveler-ready install data - Everything needed to install the eSIM on a device

Key Features

  • Idempotent by cartKey: Retrying submit with an already-completed cartKey returns the persisted order
  • Currency conversion: Optional Currency header converts priced fields via liteAPI FX
  • End-user details required: Email, phone, first and last name
  • Persistent records: Successful submits are stored in liteAPI (esimply_orders / esimply_purchases)
post/esimply/orders/submit

Request

  • Base URL
    https://api.liteapi.travel/v3.0
  • URL
    https://api.liteapi.travel/v3.0/esimply/orders/submit
  • Auth
    API key in header X-API-Key

Headers

Currencystring
Example:EUR

Optional ISO-4217 currency code. When set, priced fields are converted using liteAPI exchange rates only (not forwarded to eSIMply).

Request body

cartKeystring required
endUserEmailstring email required
endUserPhonestring required
endUserFirstNamestring required
endUserLastNamestring required
clientReferencestring

Your internal reference for reconciliation

Example request

{
  "cartKey": "EXAMPLECARTKEY00000000000000001",
  "endUserEmail": "traveler@example.com",
  "endUserPhone": "+14155552671",
  "endUserFirstName": "Jane",
  "endUserLastName": "Doe",
  "clientReference": "demo-001"
}

Response

Order submitted and eSIM provisioned

Example response

{
  "data": {
    "orderId": "ord_8a9b2c3d4e5f6789",
    "purchases": [
      {
        "esimId": 10001,
        "packageName": "1 GB",
        "dataSizeMb": 1024,
        "remainingData": 1024,
        "destinationCode": "MA",
        "destinationName": "Morocco",
        "price": 3.46,
        "b2bPrice": 3.46,
        "currency": "EUR",
        "iccid": "89000000000000000001",
        "qrCode": "LPA:1$smdp.example.com$EXAMPLEACTIVATIONCODE0001",
        "smdpAddress": "smdp.example.com",
        "activationCode": "EXAMPLEACTIVATIONCODE0001",
        "esimProviderId": 4,
        "externalPackageId": "MA|1024",
        "validityDays": 7,
        "flag": "https://esimply-destinations-flags.s3.us-west-1.amazonaws.com/ma.svg",
        "createdAt": "2026-08-12T16:12:49Z",
        "startDate": "2026-08-20T00:00:00Z",
        "endDate": "2026-08-27T00:00:00Z",
        "packageId": 1
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.