API v2.4 / Orders / Get order detail

Authorizations

apikeyAuth

Path Parameters

orderReference

required

string

(Required) Reference for your order

Example

<string>

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

runningBalance

Current balance at a time when the order was placed

string

sourceIP

Source IP of the order

string

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
}