API v2.4 / Orders / Get order detail

Server

GET

/orders/{orderReference}

eSIM Go API

Get details on an order, including total cost and contents

Authorizations

apikeyAuth

Parameters

Path Parameters

orderReference

required

string

(Required) Reference for your order

Example

<string>

Responses

200

object

order

Array<object>

object

esims

Array<object>

object

iccid

string

matchingId

string

smdpAddress

string

type

string

item

string

iccids

Array<string>

quantity

integer

subTotal

number format: float

pricePerUnit

number format: float

AllowReassign

boolean

total

number format: float

currency

string

status

string

statusMessage

string

orderReference

string

createdDate

string format: date-time

assigned

boolean

Example

{
  "order": [
    {
      "esims": [
        {
          "iccid": "8912345678901234567",
          "matchingId": "AB-12C3DE-4FGHIJ5",
          "smdpAddress": "http://rsp.mockprovider.com"
        }
      ],
      "type": "bundle",
      "item": "esim_5GB_30D_EU_V3",
      "iccids": [
        "8912345678901234567"
      ],
      "quantity": 1,
      "subTotal": 9.99,
      "pricePerUnit": 9.99,
      "AllowReassign": true
    }
  ],
  "total": 9.99,
  "currency": "USD",
  "status": "completed",
  "statusMessage": "Order completed: 1 eSIMs assigned",
  "orderReference": "1a2b3c4d-5e6f-7g8h-9i10-11j12k13l14m",
  "createdDate": "2023-06-15T10:30:45.123456789Z",
  "assigned": true
}