Skip to main content
All Partner API responses use a consistent JSON envelope.

Success — Single Resource

Example — Booking Status


Success — Paginated List


Error Response

The same requestId is returned in the X-Request-Id response header.

HTTP Status Codes


Validation Errors

When error.code is VALIDATION_ERROR, error.details may contain field-level messages from class-validator:

Null & Omitted Fields

  • Optional fields may be omitted or null depending on the endpoint.
  • Empty arrays are returned as [], not null.
  • Monetary amounts are numbers in SAR with up to two decimal places in API output.