SupplierReference

Reference of a booking. Store the whole object and send it back unchanged; new keys may be added.

booking_id object

Provider booking id.

anyOf

• string
• null

string

Example: healthy

confirmation_number object

Provider confirmation number.

anyOf

• string
• null

string

Example: healthy

provider object

Provider.

anyOf

• string
• null

string

Example: healthy

booking_status object

Book status at book time (completed, pending).

anyOf

• string
• null

string

Example: healthy

booking_tokenstringrequired

Opaque, encrypted state of the booking, tied to your API key. Required by booking-details and cancel; a modified token or booking_id is rejected with 422 invalid_booking_token.

Example: bt1.gAAAAAB...opaque-booking-token...(about 1-2 kB; trimmed in this example)

property name*any

Reference of a booking. Store the whole object and send it back unchanged; new keys may be added.

SupplierReference

{
  "booking_id": "01aa00bb11cc22dd33ee44ff55667781",
  "confirmation_number": "PRV0000001",
  "provider": "provider_a",
  "booking_status": "completed",
  "booking_token": "bt1.gAAAAAB...opaque-booking-token...(about 1-2 kB; trimmed in this example)"
}