Developers

REST API

Read and update your store's orders, bookings, products and customers.

The Zaher API lets your own systems work with your store: sync orders into an ERP, mark them shipped from your warehouse software, keep stock in step with another sales channel, or pull customers into a CRM.

Base URL

https://api.zaher-dev.com/v1
  • JSON over HTTPS
  • Bearer API keys with scopes
  • Cursor pagination

Endpoints

API and webhooks together

Webhooks tell you the moment something changes; the API lets you read the full picture and make changes back. An order from GET /v1/orders/{id} has exactly the same shape as the data of an order.* webhook, plus "object": "order" — one parser handles both.

A common pattern: react to order.created in real time, and run a periodic sync with updated_after to catch anything a webhook outage missed.

Conventions

  • JSON in and out, fields in snake_case.
  • Ids are UUIDs. Every object has an object field ("order", "product", …).
  • Money is a decimal string with the currency alongside — "149.00", never a float.
  • Timestamps are ISO 8601 in UTC.
  • Every response has an X-Request-Id header. Quote it when you contact support.
  • /v1 only ever changes additively: new endpoints, fields and enum values. Ignore fields you don't know. Anything breaking would be /v2.

Keys are secrets

Call the API from your server, never from a browser or mobile app — anyone who can read a key can use it.

On this page