API v2.4 / Orders / List orders

Server

GET

/orders

eSIM Go API

Get details on all previous orders, including total cost and contents. Response data is paginated.

Authorizations

apikeyAuth

Parameters

Query Parameters

includeIccids

boolean

Set to true to include eSIM data (ICCID, Matching ID and SMDP Address) in the response, and an ICCIDs array.

Example

true

page

integer

Page number to return.

Example

limit

integer

Number of results to return per page.

Example

createdAt

string

Specifies the date range for filtering orders. This parameter has a 'lte:' prefix to specify the end date. For example, to query orders from March 1, 2024, to March 31, 2024, use the following format: `createdAt=gte:2024-03-01T00:00:00.000Z&createdAt=lte:2024-03-31T23:59:59.999Z`.

Example

<dateTime>

Responses

200

object

groups

Array<object>

object

name

required

string

priceListUrl

string format: uri

desc

string

icon

string format: uri

Example

{
  "orders": [
    {
      "order": [
        {
          "type": "bundleRefund",
          "item": "esim_data_plan_1",
          "quantity": 1,
          "subTotal": 5.99,
          "pricePerUnit": 5.99,
          "AllowReassign": false
        }
      ],
      "total": 0,
      "currency": "USD",
      "status": "completed",
      "statusMessage": "Refund completed",
      "orderReference": "order-ref-001",
      "createdDate": "2023-06-15T10:30:00Z",
      "runningBalance": 50
    },
    {
      "order": [
        {
          "type": "bundle",
          "item": "esim_data_plan_2",
          "quantity": 1,
          "subTotal": 9.99,
          "pricePerUnit": 9.99,
          "AllowReassign": false,
          "esims": [
            {
              "iccid": "8900000000000000001",
              "matchingId": "MATCH-001",
              "smdpAddress": "smdp.example.com"
            }
          ],
          "iccids": [
            "8900000000000000001"
          ]
        }
      ],
      "total": 9.99,
      "currency": "USD",
      "status": "completed",
      "statusMessage": "Order completed: 1 eSIM assigned",
      "orderReference": "order-ref-002",
      "createdDate": "2023-06-14T15:45:00Z",
      "assigned": true,
      "runningBalance": 40.01
    },
    {
      "order": [
        {
          "type": "bundle",
          "item": "esim_data_plan_3",
          "quantity": 1,
          "subTotal": 14.99,
          "pricePerUnit": 14.99,
          "AllowReassign": false
        }
      ],
      "total": 14.99,
      "currency": "USD",
      "status": "failed",
      "statusMessage": "Order processing failed",
      "orderReference": "order-ref-003",
      "createdDate": "2023-06-13T09:15:00Z",
      "assigned": false,
      "runningBalance": 25.02
    }
  ],
  "pageCount": 5,
  "pageSize": 10,
  "rows": 50
}