curl --request GET \
--url https://api.kalixo.io/v2/orders/{reference} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.kalixo.io/v2/orders/{reference}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.kalixo.io/v2/orders/{reference}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kalixo.io/v2/orders/{reference}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"orderId": "b9f6f9a2-4d0a-4f5c-9a1e-7c2d8f3b6e10",
"externalOrderCode": "O-12345",
"status": "processing",
"estimatedReadyAt": "2026-06-02T11:05:00Z",
"message": "Order is still processing"
}Retrieve an order
Fetches an order by the UUID orderId returned on placement or by your externalOrderCode.
Redemption codes are returned when status is completed (all units) or partially_completed (delivered units only). While processing you receive estimatedReadyAt and a status message; failed returns a reason.
partially_completed includes delivered, total, and products[].codes for every code that was delivered (see the Partial delivery with codes response example).
curl --request GET \
--url https://api.kalixo.io/v2/orders/{reference} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.kalixo.io/v2/orders/{reference}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.kalixo.io/v2/orders/{reference}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kalixo.io/v2/orders/{reference}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"orderId": "b9f6f9a2-4d0a-4f5c-9a1e-7c2d8f3b6e10",
"externalOrderCode": "O-12345",
"status": "processing",
"estimatedReadyAt": "2026-06-02T11:05:00Z",
"message": "Order is still processing"
}Authorizations
Your Kalixo API key. Send it in the x-api-key header on every request.
Path Parameters
The UUID orderId returned on placement, or your externalOrderCode.
"O-12345"
Response
The order and its current status.
"b9f6f9a2-4d0a-4f5c-9a1e-7c2d8f3b6e10"
"O-12345"
processing, completed, partially_completed, failed "completed"
"Order is still processing"
Codes delivered so far (partial deliveries).
Total codes in the order.
Present when status is completed or partially_completed. Each line includes codes for delivered units only.
Show child attributes
Show child attributes
Show child attributes
Show child attributes