Process orders
POST /orders
Orders can be validated and processed using this endpoint.
Total will be deducted from your Organisation’s balance.
Auto-assign
By specifying ICCID(s) of eSIM(s) belonging to your Organisation and setting ‘assign’ to true, a bundle can be automatically assigned to eSIM(s)
Usage:
- eSIM ICCIDs can only be specifed if assign is set to true
- If assign is set to true, but no ICCIDs are provided, bundles are assigned to new eSIMs
- If ICCIDs are provided, quantity is required to match the number of ICCIDs for each bundle
- If quantity is specified and assign is set to false, the quantity of that bundle is purchased into inventory
Note: In some cases, it may take up to 5 minutes for your eSIM bundles to be delivered
Authorizations
Parameters
Path Parameters
Set to true to include eSIM data (ICCID, Matching ID and SMDP Address) in the response, and an ICCIDs array. eSIM data will only be available on small (<= 5 eSIMs) orders. For larger orders, see the GET request for this endpoint.
Note: From v2.3.0 onwards, this data will be included by default.
Request Body required
Details of new Order
object
Order type
Whether to assign the Bundles to eSIMs straight after a successful order
object
Item Type
The number of the specific item to buy
Item name
ICCIDs of eSIMs to apply bundle to
Responses
200
Order validation or transaction data
400
Bad Request
401
Unauthorised
503
Processing - Please come back later or use the Retry-After (seconds) header