Skip to main content

Base URL and Versioning

Base URL​

All API requests should be made to:

https://api.courimax.com/api

For local development:

http://localhost:3001/api

API Versioning​

The Courimax API uses URL-based versioning. The current version is embedded in the endpoint paths.

Current Endpoints​

All integration endpoints are under:

/api/integrations/{platform}/

Where {platform} is one of:

  • yango - Yango delivery integration
  • galaxis - Galaxis WMS integration
  • floating-deli - Floating Deli merchant integration

Provisioning Endpoints​

Provisioning endpoints are under:

/api/provisioning/

Response Format​

All responses are in JSON format with ISO 8601 timestamps:

{
  "id": "uuid",
  "status": "pending",
  "createdAt": "2026-08-19T10:00:00.000Z",
  "updatedAt": "2026-08-19T10:05:00.000Z"
}

Content Type​

All requests with a body must include:

Content-Type: application/json

Timezones​

All timestamps are in UTC (ISO 8601 format). Delivery windows are returned with timezone information:

{
  "timezone": "Asia/Jerusalem",
  "windows": [
    {
      "start": "2026-08-20T08:00:00+03:00",
      "end": "2026-08-20T12:00:00+03:00"
    }
  ]
}

Pagination​

Currently, most endpoints return all results. Pagination support is planned for future versions.

Error Responses​

All errors follow a standard format:

{
  "statusCode": 400,
  "message": "Error description",
  "error": "Bad Request"
}

See Error Codes for complete error reference.

Next Steps​