Booking Events

Gets Booking Events for a Booking leg.

Requests to this endpoint that fail may be retried after a few minutes. See more in the Responses section.

get/v1/bookings/{bookingReference}/events

Request

Base URL
https://your.domain.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/suntransfers/apis/st-spec-suntransfers-supplier-api-specification/docs/v1/bookings/:bookingReference/events/get.ts
A function with typed inputs. Its response is checked against the schema.

bookingReferencestring required

The Suntransfers Booking reference identifier.

leginteger required

The leg number of the Transfer within the Booking. Leg numbers start at 1.

sort'Asc' | 'Desc' required

The direction to sort results, either ascending or descending.

The sort direction of Booking Events (by occurredAt).

startingAtstring date-time

An ISO 8601 date-time string in local time.

The starting local date and time to filter Booking Events by.

endingAtstring date-time

An ISO 8601 date-time string in local time.

The ending local date and time to filter Booking Events by.

200 OK: Booking found. This Booking's events - if any - are listed in the response.

bookingReferencestring required

The Suntransfers Booking reference identifier. This is currently a string starting with 'SUNTR_' followed by alphanumeric characters.

leginteger required

The leg number of the Transfer within the Booking. Leg numbers start at 1.

No recorded changes to this operation across all 7 revisions of this API.