Booking

Gets the current state of a Booking.

Requests to this endpoint that fail may be retried depending on the Response Code. See more in the Responses section.

get/v1/bookings/{bookingReference}

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/get.ts
A function with typed inputs. Its response is checked against the schema.

bookingReferencestring required

200 OK: Booking found.

bookingReferencestring required

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

status'Created' | 'PartiallyModified' | 'Modified' | 'PartiallyCancelled' | 'Cancelled' required

The current status of the Booking.

createdAtUtcstring date-time required

An ISO 8601 date-time string in UTC.

lastModifiedAtUtcstring date-time required

An ISO 8601 date-time string in UTC.

Nov 7, 2025v17448f4760619 Revision changes
- info
  added the required property // to the response with the status
Oct 24, 2025v155d59ca4a825 Revision changes
- breaking
  removed the required property // from the response with the status