List orders

GET

/orders

• eSIMGo 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. Note: From v2.3.0 onwards, this data will be included by default.

Example

true

page

integer

Page number to return.

Example

1

limit

integer

Number of results to return per page.

Example

10

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

OK

object

Example

[
  {
    "order": [
      {
        "type": "<string>",
        "item": "<string>",
        "quantity": "<integer>",
        "subTotal": "<integer>",
        "pricePerUnit": "<integer>",
        "invoiceLink": "<string>"
      },
      {
        "type": "<string>",
        "item": "<string>",
        "quantity": "<integer>",
        "subTotal": "<integer>",
        "pricePerUnit": "<integer>",
        "invoiceLink": "<string>"
      }
    ],
    "total": "<integer>",
    "currency": "<string>",
    "status": "<string>",
    "statusMessage": "<string>",
    "orderReference": "<string>",
    "createDate": "<string>"
  },
  {
    "order": [
      {
        "type": "<string>",
        "item": "<string>",
        "quantity": "<integer>",
        "subTotal": "<integer>",
        "pricePerUnit": "<integer>",
        "invoiceLink": "<string>"
      },
      {
        "type": "<string>",
        "item": "<string>",
        "quantity": "<integer>",
        "subTotal": "<integer>",
        "pricePerUnit": "<integer>",
        "invoiceLink": "<string>"
      }
    ],
    "total": "<integer>",
    "currency": "<string>",
    "status": "<string>",
    "statusMessage": "<string>",
    "orderReference": "<string>",
    "createDate": "<string>"
  }
]

400

Bad Request

object

Example

{
  "message": "<string>"
}

403

Forbidden

object

Example

{
  "message": "<string>"
}

500

Internal Server Error

object

Example

{
  "message": "<string>"
}