Skip to main content

Orders

The Orders API lets you purchase SIM hardware, view your order history, and cancel pending orders.

Base URL

https://app.zentarinetworks.com

List Orders

GET /api/orders

Returns a paginated order history.

Query Parameters

ParameterTypeDefaultDescription
searchstringSearch term
typestringFilter by order type
statusstringFilter by order status
datedatetimeFilter by date
pageinteger1Page number
pageSizeinteger10Results per page

Response

{
"data": [ /* array of order objects */ ],
"pagination": { ... }
}

Create Order

POST /api/orders

Places a new SIM order. Use GET /api/orders/pricing to retrieve available order types and their prices before submitting.

Request Body

{
"type": 1,
"quantity": 50,
"shippingCompany": "Acme Ltd",
"shippingLine1": "123 High Street",
"shippingLine2": "",
"shippingCity": "London",
"shippingCountry": "GB",
"shippingPostcode": "EC1A 1BB",
"shippingExtraInfo": "Leave with reception"
}
FieldTypeDescription
typeintegerOrder type — see /api/orders/metadata
quantityintegerNumber of SIMs
shippingCompanystring?Company name
shippingLine1string?Address line 1
shippingLine2string?Address line 2
shippingCitystring?City
shippingCountrystring?Country
shippingPostcodestring?Postcode / ZIP
shippingExtraInfostring?Delivery instructions

Response

{
"id": 987,
"status": "Pending",
"cost": 125.00
}

Get Order

GET /api/orders/{orderId}

Path Parameters

ParameterTypeDescription
orderIdintegerOrder ID

Order Object

FieldTypeDescription
idintegerOrder ID
typeintegerOrder type code
quantityintegerNumber of SIMs ordered
unitPricedoublePrice per unit
totaldoubleTotal order cost
statusstringOrder status
datedatetimeOrder date
stripeInvoiceIdstring?Stripe invoice reference
stripeReceiptUrlstring?Link to Stripe receipt
shippingCompanystring?Delivery company name
shippingLine1string?Address line 1
shippingLine2string?Address line 2
shippingCitystring?City
shippingCountrystring?Country
shippingPostcodestring?Postcode / ZIP
shippingExtraInfostring?Delivery instructions
trackingNumberstring?Carrier tracking number
shippingCarrierstring?Carrier name

Cancel Order

DELETE /api/orders/{orderId}

Cancels a pending order. Returns the order's final status.

Path Parameters

ParameterTypeDescription
orderIdintegerOrder ID

Response

{
"id": 987,
"status": "Cancelled"
}

Get Pricing

GET /api/orders/pricing

Returns the current price for each available order type.

Response

[
{ "type": 1, "price": 2.50 },
{ "type": 2, "price": 4.00 }
]

Order Metadata

GET /api/orders/metadata

Returns human-readable labels for order type integer codes.

Response

{
"types": [
{ "code": 1, "description": "Physical SIM" },
{ "code": 2, "description": "eSIM" }
]
}