LIliteapi
eSIMply orders

List eSIMply orders

Overview

Retrieve eSIM order history for the authenticated partner account, with optional filters for destination, date range, and client reference.

When to Use

  • Partner dashboard - Show past eSIM purchases and top-ups
  • Support lookup - Find orders by destination or your clientReference
  • Reporting - Pull order history for a travel date window

What You Get

  • Order records - Packages, ICCIDs, pricing, destinations, install metadata, and plan status (active or expired)
  • Filterable history - Narrow results by destination, dates, or client reference

Key Features

  • Flexible filters: destination, startDate, endDate, clientReference
  • Currency conversion: Optional Currency header for priced fields
  • Environment-aware: Sandbox and production histories are separate by API key
get/esimply/orders

Request

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

Query parameters

destinationstring
Example:MA
startDatestring date
Example:2026-01-01
endDatestring date
Example:2026-12-31
clientReferencestring
Example:demo-001

Headers

Currencystring
Example:EUR

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

Response

Orders retrieved successfully

Example response

{
  "data": [
    {
      "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,
      "status": "active"
    }
  ]
}

Changes

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