Create a booking

POST

/v1/bookings

• Reserved future sandbox boundary — unavailable in Phase 1
• Reserved future production boundary — unavailable in Phase 1

Preview of a future idempotent booking create operation.

Authorizations

• bearerAuth

Parameters

Header Parameters

Idempotency-Key

required

string

>= 16 characters <= 128 characters

A caller-generated key used to make a future write safe to retry.

Request Body^required

Media typeapplication/json

object

external_reference

string

<= 120 characters

service_date

required

string format: date

party

required

object

adults

required

integer

>= 1

children

required

integer

infants

integer

0

customer

required

object

name

required

string

>= 2 characters <= 160 characters

email

required

string format: email

<= 254 characters

notes

string

<= 2000 characters

Responses

201

The booking record was created.

Media typeapplication/json

object

id

required

string

external_reference

string | null

<= 120 characters

status

required

string

Allowed values: enquiry confirmed supplier_pending ready_to_operate operating completed cancelled

service_date

required

string format: date

party

required

object

adults

required

integer

>= 1

children

required

integer

infants

integer

0

customer

object

id

required

string

name

required

string

<= 160 characters

supplier_status

string

Allowed values: not_required pending confirmed exception

next_action

string | null

<= 160 characters

created_at

required

string format: date-time

updated_at

required

string format: date-time

400

The request does not match the contract.

Media typeapplication/json

object

type

required

string

message

required

string

request_id

required

string

401

The API credential is missing or invalid.

Media typeapplication/json

object

type

required

string

message

required

string

request_id

required

string