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
| Parameter | Type | Default | Description |
|---|---|---|---|
search | string | — | Search term |
type | string | — | Filter by order type |
status | string | — | Filter by order status |
date | datetime | — | Filter by date |
page | integer | 1 | Page number |
pageSize | integer | 10 | Results 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"
}
| Field | Type | Description |
|---|---|---|
type | integer | Order type — see /api/orders/metadata |
quantity | integer | Number of SIMs |
shippingCompany | string? | Company name |
shippingLine1 | string? | Address line 1 |
shippingLine2 | string? | Address line 2 |
shippingCity | string? | City |
shippingCountry | string? | Country |
shippingPostcode | string? | Postcode / ZIP |
shippingExtraInfo | string? | Delivery instructions |
Response
{
"id": 987,
"status": "Pending",
"cost": 125.00
}
Get Order
GET /api/orders/{orderId}
Path Parameters
| Parameter | Type | Description |
|---|---|---|
orderId | integer | Order ID |
Order Object
| Field | Type | Description |
|---|---|---|
id | integer | Order ID |
type | integer | Order type code |
quantity | integer | Number of SIMs ordered |
unitPrice | double | Price per unit |
total | double | Total order cost |
status | string | Order status |
date | datetime | Order date |
stripeInvoiceId | string? | Stripe invoice reference |
stripeReceiptUrl | string? | Link to Stripe receipt |
shippingCompany | string? | Delivery company name |
shippingLine1 | string? | Address line 1 |
shippingLine2 | string? | Address line 2 |
shippingCity | string? | City |
shippingCountry | string? | Country |
shippingPostcode | string? | Postcode / ZIP |
shippingExtraInfo | string? | Delivery instructions |
trackingNumber | string? | Carrier tracking number |
shippingCarrier | string? | Carrier name |
Cancel Order
DELETE /api/orders/{orderId}
Cancels a pending order. Returns the order's final status.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
orderId | integer | Order 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" }
]
}