Bookings

List Bookings

get/brands/{brand}/bookings

Request

  • Base URL: https://app.amber.ai/api/public/v1
  • URL: https://app.amber.ai/api/public/v1/brands/{brand}/bookings
  • Auth: HTTP bearer

Path parameters

brandstring required
Example:acme

Brand slug authorized by this API key.

Query parameters

cursorstring

Opaque nextCursor from the same collection and filters. Omit on the first request.

limitinteger
externalBookingIdstring

Exact, case-sensitive match. Spaces and punctuation are literal.

externalBookingReferencestring

Exact, case-sensitive match. Spaces and punctuation are literal.

sourcestring

Exact, case-sensitive match. Spaces and punctuation are literal.

pushStatusstring

Exact, case-sensitive match. Spaces and punctuation are literal.

originIdstring

Exact related entity ID.

destinationIdstring

Exact related entity ID.

originstring

Exact, case-sensitive match. Spaces and punctuation are literal.

orderIdstring
sourceLegIdstring

Response

A page of matching records. totalItems counts all matches across pages. When nextCursor is null, you have reached the last page.

nextCursorstring nullable required
totalItemsinteger required

Total number of matching records across all pages.

Changes

No recorded changes to this operation across all 1 revision of this API.