API v2.4 / Orders / List orders

Authorizations

apikeyAuth

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>

200

OK

object

order

Order type [ transaction ]

Array<object>

object

esims

Array<object>

object

iccid

ICCID of eSIM new bundle was assigned to

string

matchingId

SMDP+ ID (used in eSIM activation)

string

smdpAddress

SMDP+ Address (used in eSIM activation)

string

type

Item type [ bundle ]

string

item

Name of the bundle

string

iccids

ICCID of eSIM new bundle was assigned to

Array<string>

quantity

Quantity of items

integer

subTotal

Cost of a bundle multiplied by its quantity

number format: float

pricePerUnit

Price per each item

number format: float

AllowReassign

Allow a new eSIM to be provided if the bundle is not compatible with the eSIM profile

boolean

total

Total price

number format: float

currency

Currency of the transaction

string

status

Status of the order

string

statusMessage

Status message

string

orderReference

Order reference

string

createdDate

Data and time of order creation

string format: date-time

assigned

Indicates if bundle was assigned to eSIM

boolean

sourceIP

Source IP of the order

string

{
  "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": "http://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,
  "sourceIP": "244.178.44.111"
}