Skip to main content

Quick Start Guide

Get up and running with the Courimax API in 5 minutes.

Prerequisites​

  • An active Courimax account
  • API key (obtain from your organization admin)
  • HTTP client (curl, Postman, or any programming language)

Step 1: Get Your API Key​

Contact your organization administrator to obtain an API key. The key will be in the format:

cmx_your_unique_api_key

Step 2: Make Your First Request​

Test your API key by listing delivery windows:

curl -X GET "https://api.courimax.com/api/integrations/yango/delivery-windows?zone=TLV-CENTER&date=2026-08-20" \
  -H "X-API-Key: cmx_your_api_key"

Expected response:

{
  "zone": "TLV-CENTER",
  "date": "2026-08-20",
  "timezone": "Asia/Jerusalem",
  "windows": [
    {
      "start": "2026-08-20T08:00:00+03:00",
      "end": "2026-08-20T12:00:00+03:00",
      "available": true,
      "scheduledCount": 5,
      "capacityLimit": 20
    }
  ]
}

Step 3: Create an Order​

Create a delivery order:

curl -X POST "https://api.courimax.com/api/integrations/yango/orders" \
  -H "X-API-Key: cmx_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "pickupAddress": "Rothschild Blvd 1, Tel Aviv",
    "pickupLat": 32.0639,
    "pickupLng": 34.7742,
    "dropoffAddress": "Dizengoff Center, Tel Aviv",
    "dropoffLat": 32.0753,
    "dropoffLng": 34.7749,
    "recipientName": "Jane Doe",
    "recipientPhone": "+972501234567",
    "packageSize": "small",
    "externalRef": "ORDER-123"
  }'

Step 4: Check Order Status​

Retrieve the order you just created:

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

Step 5: Release for Dispatch​

When ready, release the order for courier dispatch:

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

Next Steps​

Common Issues​

401 Unauthorized​

Make sure your API key is valid and included in the X-API-Key header.

400 Bad Request​

Check that all required fields are present and in the correct format. See the endpoint documentation for details.

404 Not Found​

Verify the resource exists and you're using the correct external reference.