Delivery Syria
العربية

API reference

Connect your own system to Delivery Syria. Both APIs are plain JSON over HTTPS, authenticated with a Bearer API key. This reference is rendered from OpenAPI 3.1 documents that automated tests check against the real routes, validation rules and responses.

Before you start

  • Send your API key in the Authorization: Bearer header. No other way of sending it is read.
  • Every answer is JSON in one envelope: success with data (and meta on paginated lists), or an error with a code.
  • Requests are limited per IP address and by your plan; a 429 answer tells you to wait.
  • The version is the path (/api/v1, /api/company/v1). There is no version header and no Idempotency-Key: use the parcel reference to retry safely.

Import into Postman or Insomnia

Download the OpenAPI 3.1 document of an API and import it, or give the tool the address of the document. The file describes paths relative to /api/v1 or /api/company/v1, so set the base URL to your platform address after importing. Examples use placeholders only (YOUR_DOMAIN, YOUR_API_KEY): never paste a real key into a shared collection.

No “Try it out” console

This reference has no “Try it out” console and sends no request from your browser. That would mean typing a live API key into a web page and calling the production API with production data. Test with the code samples and your own key from your own server or terminal instead.

There are no generated client libraries (SDKs) either: the OpenAPI documents describe the API, and you can use any generator you trust with them.