Skip to main content
GET
Retrieve an order

Authorizations

x-api-key
string
header
default:kal_live_xxxxxxxxxxxxxxxxxxxxxxxx
required

Your Kalixo API key. Send it in the x-api-key header on every request.

Path Parameters

reference
string
required

The UUID orderId returned on placement, or your externalOrderCode.

Example:

"O-12345"

Response

The order and its current status.

orderId
string<uuid>
Example:

"b9f6f9a2-4d0a-4f5c-9a1e-7c2d8f3b6e10"

externalOrderCode
string
Example:

"O-12345"

status
enum<string>
Available options:
processing,
completed,
partially_completed,
failed
Example:

"completed"

estimatedReadyAt
string<date-time> | null
message
string | null
Example:

"Order is still processing"

reason
string | null
delivered
integer | null

Codes delivered so far (partial deliveries).

total
integer | null

Total codes in the order.

products
object[]

Present when status is completed or partially_completed. Each line includes codes for delivered units only.

wallet
object