Get Order

Retrieve details of a specific order by its external reference.

GET /integrations/yango/orders/:externalRef

Request

Path Parameters

Parameter	Type	Required	Description
externalRef	string	Yes	Your unique order reference

Headers

Header	Required	Description
X-API-Key	Yes	Your API key

Examples

cURL

curl -X GET "https://api.courimax.com/api/integrations/yango/orders/YANGO-ORDER-123" \
  -H "X-API-Key: cmx_your_api_key"

JavaScript (Fetch)

const response = await fetch(
  'https://api.courimax.com/api/integrations/yango/orders/YANGO-ORDER-123',
  {
    headers: {
      'X-API-Key': 'cmx_your_api_key'
    }
  }
);

const order = await response.json();
console.log(order);

Python (Requests)

import requests

response = requests.get(
    'https://api.courimax.com/api/integrations/yango/orders/YANGO-ORDER-123',
    headers={
        'X-API-Key': 'cmx_your_api_key'
    }
)

order = response.json()
print(order)

Response

Success (200 OK)

{
  "externalRef": "YANGO-ORDER-123",
  "courimaxOrderId": "order-uuid",
  "status": "in_transit",
  "driver": {
    "id": "driver-uuid",
    "name": "David Cohen",
    "phone": "+972501234567"
  },
  "deliveryWindowStart": "2026-08-20T10:00:00.000Z",
  "deliveryWindowEnd": "2026-08-20T14:00:00.000Z",
  "trackingToken": "tracking-token-abc",
  "currentMappingStatus": "assigned"
}

Response Fields

Field	Type	Description
externalRef	string	Your order reference
courimaxOrderId	string	Courimax internal order ID
status	string	Current order status
driver	object	Assigned driver information (null if unassigned)
driver.id	string	Driver ID
driver.name	string	Driver name
driver.phone	string	Driver phone
deliveryWindowStart	string	ISO 8601 delivery window start
deliveryWindowEnd	string	ISO 8601 delivery window end
trackingToken	string	Public tracking token
currentMappingStatus	string	Integration mapping status

Order Statuses

• pending - Order created, awaiting dispatch
• dispatching - Order being dispatched to drivers
• assigned - Driver assigned
• picked_up - Package picked up by driver
• in_transit - Package in transit to destination
• delivered - Package delivered
• failed - Delivery failed
• cancelled - Order cancelled

Error Responses

401 Unauthorized - Missing or invalid API key

{
  "statusCode": 401,
  "message": "Missing X-API-Key header",
  "error": "Unauthorized"
}

404 Not Found - Order not found

{
  "statusCode": 404,
  "message": "Order not found",
  "error": "Not Found"
}

Tracking

Use the trackingToken to provide public tracking to your customers:

https://admin.courimax.com/track/{trackingToken}

Or via API:

curl "https://api.courimax.com/api/track/{trackingToken}"

Next Steps

• Create Order - Create a new order
• Release Order - Release for dispatch
• Webhooks - Get status updates