Operator API v2 Booking System 2.2.0

The Operator API v2 Booking System (OBS) is an API specification with endpoints for listing suppliers, products, availabilities, and managing holds and bookings.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 RFC 2119 RFC 8174 when, and only when, they appear in all capitals, as shown here.

Server

https://{operatorDomain}/{basePath}

Server Variables

Authentication

http basicAuth

Suppliers

GET

/suppliers

Returns a list of suppliers and associated contact details.

This list MAY be limited based on the suppliers that the authenticated user has been granted access to.

Auth

GET /suppliers

 
curl --get \ --url 'https://api.example.com/required-base-path/suppliers' \ --header 'Authorization: Basic {token}'
Copy

Responses

200

List of suppliers with details.

array	array[object]
id	string	This MUST be unique within the scope of the Booking Platform (1024 character limit). maxLength: 1024
name	string	Common name for the supplier that may be displayed to the customer.
endpoint	string	This is the base URL that will be prepended to ALL other paths. The value SHOULD NOT contain a trailing `/`.
contact	object	Contact details for the supplier.
website	string	This SHOULD be the website of the Supplier that is separate from the Booking Platform but MAY be a unique destination within the Booking Platform about the Supplier.
email	string	This SHOULD be the email support contact for the Supplier. This information MAY be provided to the customer.
telephone	string	This SHOULD be the phone support contact for the Supplier. This information MAY be provided to the customer.
address	string	This SHOULD be the mail address support contact for the Supplier. This information MAY be provided to the customer.
firstName	string	First name of the supplier contact.
lastName	string	Last name of the supplier contact.

400

An error has occurred. See the definition of the ErrorObject for more details.

401

Missing Authorization header or key could not be validated.

403

The Authorization header was validated but the requestor does not have the correct permissions to access the requested resource or perform the requested operation.

500

An unknown error occurred and the server cannot respond in a sensible way. The response may not include a valid error object if one could not be generated.

503

The server is temporarily unavailable, either because the server is under maintenance, or overloaded (accepted too many requests in too short a time).

Response

 
[ {  "id": "2c912279-c44a-4f32-9d59-70e5e3a0cbc8",  "name": "Acme Tour Co.",  "endpoint": "https://api.my-booking-platform.com/v1",  "contact": {   "website": "https://acme-tours.co.fake",   "email": "info@acme-tours.co.fake",   "telephone": "+1 888-555-1212",   "address": "123 Main St, Anytown USA",   "firstName": "{string}",   "lastName": "{string}"  } }]
Copy

Products

GET

/suppliers/{supplierId}/products

Returns a list of products for a specific supplier.

WARNING: this endpoint may live under a different domain, path or both depending on the supplier endpoint URL returned by the GET /suppliers.

Contains all product details necessary to ingest, map, and sell.

Auth

Headers

X-Capabilities

string

Comman-delimited list of capabilities the client wishes from the server.

Path Params

supplierId

string

A valid supplier ID that matches the id returned from GET /suppliers.

GET /suppliers/{supplierId}/products

 
curl --get \ --url 'https://api.example.com/required-base-path/suppliers/Wisconsin%20Widget%20World/products' \ --header 'X-Capabilities: redeam/cart,redeam/policy' \ --header 'Authorization: Basic {token}'
Copy

Responses

200

List of products with details.

array	array[object]
id	string	This MUST be unique within the scope of the Supplier (1024 character limit). maxLength: 1024
internalName	string	This SHOULD be a friendly name for the Product to facilitate easier identification. It MUST NOT be shown to the customer.
reference	string	This is an internal reference identifier that the Supplier wishes to use. It MAY be non-unique.
locale	string	This MUST be a valid BCP 47 RFC 5646 RFC 4647 language tag.
timeZone	string	This MUST be a valid database name from the ICANN tz database. Any calculation of UTC offset or UTC DTC offset MUST use the correct offset from this database.
instantConfirmation	boolean	This indicates whether the Reseller can expect an immediate confirmation of whether the Supplier has accepted the booking. If `false` then the Reseller MUST be able to delay confirmation to the customer while waiting for the Supplier to accept or reject the Booking. When `instantConfirmation` is set to `false` one should expect created bookings to first get into a `PENDING` state.
instantDelivery	boolean	This indicates whether the Reseller can expect immediate delivery of the customer's tickets. If `false` then the Reseller MUST be able to delay delivery of the tickets to the customer.
availabilityType	string	This indicates whether the Product's availabilites have limited capacity (`START_TIME`), or may be sold freesale at the specified times (`OPENING_HOURS`). Products with an availabilityType of `START_TIME` MUST NOT have availabilities with a status of `FREESALE`. Products with an availabilityType of `OPENING_HOURS` MUST have status `FREESALE` on all availabilities. Enum: `START_TIME`,`OPENING_HOURS`
deliveryFormats	array[string]	This MAY contain more than one value if some Options or Units under this Product will use different delivery formats. The Reseller MUST be able to support all of the specified formats in order to sell this Product. Valid values are `["QR_CODE", "EAN13", "CODE128", "UPCA", "TEXT", "CODE39"]` Enum: `QR_CODE`,`EAN13`,`CODE128`,`UPCA`,`TEXT`,`CODE39`
deliveryMethods	array[string]	A product MAY support both types of delivery methods. Valid values are `["TICKET", "VOUCHER"]` Enum: `TICKET`,`VOUCHER`
redemptionMethod	string	This indicates the redemption requirements for the customer. A value of `MANIFEST` indicates that the customer MUST provide a form of identification to redeem and as such a printed or digital copy of the ticket is OPTIONAL. A value of `DIGITAL` indicates that the customer MUST provide a copy of the ticket but MAY be digital or printed. A value of `PRINT` indicates that the customer MUST provide a printed copy of the ticket (this is typically only used when the Supplier must retain the printed copy for their records). Enum: `MANIFEST`,`DIGITAL`,`PRINT`
capabilities	array[object]
id	string	This MUST be a unique identifier within the scope of the OBS specification. Officially adopted capabilities will be identified only by the name of the capability but any capabilities that are specific to a particular partner MUST be prefixed with that partner's identifier and separated from the capability name with a `/`.
revision	integer	This represents which revision of the capability is supported. This is not a version numbers and therefore there is no implied version compatibility like you would have with a semantic version, therefore if multiple revisions are supported, then one Capability object should be returned for each revision that is supported.
required	boolean	This indicates whether the capability is merely supported or strictly required. Resellers that don't support the capability or specific revision will use this flag to filter out products they are unable to support.
options	array[object]
id	string	This MUST be a unique identifier within the scope of the Product (1024 character limit). maxLength: 1024
internalName	string	This SHOULD be a friendly name for the Option to facilitate easier identification. It MUST NOT be shown to the customer.
reference	string	This is an internal reference identifier that the Supplier wishes to use. It MAY be non-unique.
units	array[object]
id	string	This MUST be a unique identifier within the scope of the Option (1024 character limit). maxLength: 1024
internalName	string	This SHOULD be a friendly name for the Unit to facilitate easier identification. It MUST NOT be shown to the customer.
reference	string	This is an internal reference identifier that the Supplier wishes to use. It MAY be non-unique.
type	string	This is the base unit type for this unit definition. Enum: `ADULT`,`CHILD`,`INFANT`,`YOUTH`,`STUDENT`,`SENIOR`,`TRAVELLER`

400

An error has occurred. See the definition of the ErrorObject for more details.

401

Missing Authorization header or key could not be validated.

403

The Authorization header was validated but the requestor does not have the correct permissions to access the requested resource or perform the requested operation.

404

Invalid URI path requested.

500

An unknown error occurred and the server cannot respond in a sensible way. The response may not include a valid error object if one could not be generated.

503

The server is temporarily unavailable, either because the server is under maintenance, or overloaded (accepted too many requests in too short a time).

Response

 
[ {  "id": "b3c053bd-cc04-4689-8d6b-27b81d93e1fb",  "internalName": "Morning tour",  "reference": "LR1-01",  "locale": "en-GB",  "timeZone": "Europe/London",  "instantConfirmation": true,  "instantDelivery": true,  "availabilityType": "START_TIME",  "deliveryFormats": [   "QR_CODE",   "CODE39"  ],  "deliveryMethods": [   "TICKET",   "VOUCHER"  ],  "redemptionMethod": "DIGITAL",  "capabilities": [   {    "id": "dynamic-pricing",    "revision": 1,    "required": true   },   {    "id": "api.my-booking-platform.com/dynamic-pricing",    "revision": 2,    "required": false   }  ],  "options": [   {    "id": "0001",    "internalName": "Morning",    "reference": "LR1-01",    "units": [     {      "id": "adult",      "internalName": "Adult",      "reference": "LR1-01-01",      "type": "ADULT"     },     {      "id": "0001-0001-child",      "internalName": "Child",      "reference": "LR1-01-02",      "type": "CHILD"     }    ]   },   {    "id": "0002",    "internalName": "Afternoon",    "reference": "LR1-02",    "units": [     {      "id": "adult",      "internalName": "Adult",      "reference": "LR1-01-01",      "type": "ADULT"     },     {      "id": "0001-0001-child",      "internalName": "Child",      "reference": "LR1-01-02",      "type": "CHILD"     }    ]   }  ] }]
Copy

Availability

GET

/suppliers/{supplierId}/availability

POST

/suppliers/{supplierId}/availability

Returns a list of dates and their availability status.

WARNING: this endpoint may live under a different domain, path or both depending on the supplier endpoint URL returned by the GET /suppliers.

For any dates which are never available for booking, the response MUST exclude those dates entirely.

If the product's availabilityType is OPENING_HOURS then the localDateTimeStart and localDateTimeEnd are the hours of operation. If a product has more than one hours of operation on the same day (e.g. the supplier is open 8-5 but closed for lunch from 12-1) then one availability object MUST be returned for each contiguous range of time for that day.

The availability id value MUST be sent when making a Booking request.

The status field SHOULD be used to infer how frequently your cache should be updated from the Booking Platform. The RECOMMENDED frequency is as follows:

FREESALE: Always available. Refresh no more than once/week.
AVAILABLE: Currently available for sale, but has a fixed capacity. Refresh every 12 hours.
LIMITED: Currently available for sale, but has a fixed capacity and may be sold out soon. Refresh at least once/hour.
SOLD_OUT: Currently sold out, but additional availability may free up. Refresh no more than once/hour.
CLOSED: Currently not available for sale, but not sold out (e.g. temporarily on stop-sell) and may be available for sale soon. Refresh no more than once/12 hours.

Auth

Path Params

supplierId

string

A valid supplier ID that matches the id returned from GET /suppliers.

Query String

productId	string	A valid product ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
optionId	string	A valid option ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
localDateStart	string	This MUST be an RFC 3339 compliant date-time. The start of the date-time range MUST be treated as inclusive of this date-time when generating the response.
localDateEnd	string	This MUST be an RFC 3339 compliant date-time. The end of the date-time range MUST be treated as exclusive of this date-time when generating the response.

GET /suppliers/{supplierId}/availability

 
curl --get \ --url 'https://api.example.com/required-base-path/suppliers/Wisconsin%20Widget%20World/availability' \ --header 'Authorization: Basic {token}' \ --data productId=Wisconsin%20Widget%20World%20Admission \ --data optionId=All-Day%20Widget%20Pass \ --data localDateStart=2021-08-01T14:28:30-06:00 \ --data localDateEnd=2021-08-23T14:28:30-06:00
Copy

Responses

200

List of availability objects with status.

array	array
id	string	This MUST be a unique identifier within the scope of the Option.
optionId	string	This MUST be a valid option ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
localDateTimeStart	date-time	This MUST be an RFC 3339 compliant date and time. Fractions of a second will be removed when retrieved by Redeam. For example, Redeam will interpret the date-time `2023-01-05T14:35:45.754Z` as `2023-01-05T14:35:45Z`.
localDateTimeEnd	date-time	This MUST be an RFC 3339 compliant date and time. Fractions of a second will be removed when retrieved by Redeam. For example, Redeam will interpret the date-time `2023-01-05T14:35:45.754Z` as `2023-01-05T14:35:45Z`.
status	string	This represents whether the availability in this configuration is currently bookable. The values have the following meanings: `FREESALE`: Always available. `AVAILABLE`: Currently available for sale, but has a fixed capacity. `LIMITED`: Currently available for sale, but has a fixed capacity and may be sold out soon. `SOLD_OUT`: Currently sold out, but additional availability may free up. `CLOSED`: Currently not available for sale, but not sold out (e.g. temporarily on stop-sell) and may be available for sale soon. Enum: `FREESALE`,`AVAILABLE`,`LIMITED`,`SOLD_OUT`,`CLOSED`
vacancies	integer	This SHOULD NOT be returned when `status` is `FREESALE`. This SHOULD be a shared pool for all Unit types in the Option. If availability is tracked per-Unit then this value MUST be equal to the available quantity for the Unit that has the most remaining. minimum: 0

400

An error has occurred. See the definition of the ErrorObject for more details.

401

Missing Authorization header or key could not be validated.

403

The Authorization header was validated but the requestor does not have the correct permissions to access the requested resource or perform the requested operation.

404

Invalid URI path requested.

500

An unknown error occurred and the server cannot respond in a sensible way. The response may not include a valid error object if one could not be generated.

503

The server is temporarily unavailable, either because the server is under maintenance, or overloaded (accepted too many requests in too short a time).

Response

 
[ {  "id": "28271273-a317-40fc-8f42-79725a7072a3",  "optionId": "LR1-01",  "localDateTimeStart": "2019-10-31T08:30:00Z",  "localDateTimeEnd": "2019-10-31T10:00:00Z",  "status": "AVAILABLE",  "vacancies": 100 }, {  "id": "6143d137-fdf6-4da1-a558-20aa93eb55f0",  "optionId": "LR1-01",  "localDateTimeStart": "2019-10-31T12:00:00Z",  "localDateTimeEnd": "2019-10-31T13:00:00Z",  "status": "FREESALE",  "vacancies": null }]
Copy

Returns a list of dates after evaluating the specific Unit and Availability IDs that the customer would like to book.

WARNING: this endpoint may live under a different domain, path or both depending on the supplier endpoint URL returned by the GET /suppliers.

This request is intended to provide the Booking Platform a complete view of the Unit IDs, Unit quantity, and Availability IDs so that additional restrictions and policies can be validated within the Booking Platform prior to making a Booking. The purpose is to provide a clear and accurate answer to the Reseller about whether the requested booking configuration could be accepted by the Supplier. This is to support complex booking requirements without the Reseller needing to know the details of the restriction (e.g. "must purchase at least 1 adult ticket if a child ticket is purchased").

Auth

Path Params

supplierId

string

A valid supplier ID that matches the id returned from GET /suppliers.

Request Body

This MUST include all units that the customer is attempting to reserve and SHOULD include all possible availability IDs that the customer may be interested in reserving.

object	object
productId	string	A valid product ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
optionId	string	A valid option ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
availabilityIds	array[string]
units	array[object]
unitId	string	A valid unit ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`. example: 'adult'
quantity	integer	The total number of this unit that the customer wants to purchase.

POST /suppliers/{supplierId}/availability

 
curl --request POST \ --url 'https://api.example.com/required-base-path/suppliers/Wisconsin%20Widget%20World/availability' \ --header 'Authorization: Basic {token}' \ --data '{  "productId": "adult",  "optionId": "LR1-01",  "availabilityIds": [    "28271273-a317-40fc-8f42-79725a7072a3",    "6143d137-fdf6-4da1-a558-20aa93eb55f0"  ],  "units": [    {      "unitId": "adult",      "quantity": 2    },    {      "unitId": "child",      "quantity": 1    }  ]}'
Copy

Responses

200

List of availability objects with status.

array	array
id	string	This MUST be a unique identifier within the scope of the Option.
optionId	string	This MUST be a valid option ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
localDateTimeStart	date-time	This MUST be an RFC 3339 compliant date and time. Fractions of a second will be removed when retrieved by Redeam. For example, Redeam will interpret the date-time `2023-01-05T14:35:45.754Z` as `2023-01-05T14:35:45Z`.
localDateTimeEnd	date-time	This MUST be an RFC 3339 compliant date and time. Fractions of a second will be removed when retrieved by Redeam. For example, Redeam will interpret the date-time `2023-01-05T14:35:45.754Z` as `2023-01-05T14:35:45Z`.
status	string	This represents whether the availability in this configuration is currently bookable. The values have the following meanings: `FREESALE`: Always available. `AVAILABLE`: Currently available for sale, but has a fixed capacity. `LIMITED`: Currently available for sale, but has a fixed capacity and may be sold out soon. `SOLD_OUT`: Currently sold out, but additional availability may free up. `CLOSED`: Currently not available for sale, but not sold out (e.g. temporarily on stop-sell) and may be available for sale soon. Enum: `FREESALE`,`AVAILABLE`,`LIMITED`,`SOLD_OUT`,`CLOSED`
vacancies	integer	This SHOULD NOT be returned when `status` is `FREESALE`. This SHOULD be a shared pool for all Unit types in the Option. If availability is tracked per-Unit then this value MUST be equal to the available quantity for the Unit that has the most remaining. minimum: 0

400

An error has occurred. See the definition of the ErrorObject for more details.

401

Missing Authorization header or key could not be validated.

403

The Authorization header was validated but the requestor does not have the correct permissions to access the requested resource or perform the requested operation.

404

Invalid URI path requested.

500

An unknown error occurred and the server cannot respond in a sensible way. The response may not include a valid error object if one could not be generated.

503

The server is temporarily unavailable, either because the server is under maintenance, or overloaded (accepted too many requests in too short a time).

Response

 
[ {  "id": "28271273-a317-40fc-8f42-79725a7072a3",  "optionId": "LR1-01",  "localDateTimeStart": "2019-10-31T08:30:00Z",  "localDateTimeEnd": "2019-10-31T10:00:00Z",  "status": "AVAILABLE",  "vacancies": 100 }, {  "id": "6143d137-fdf6-4da1-a558-20aa93eb55f0",  "optionId": "LR1-01",  "localDateTimeStart": "2019-10-31T12:00:00Z",  "localDateTimeEnd": "2019-10-31T13:00:00Z",  "status": "FREESALE",  "vacancies": null }]
Copy

Bookings

POST

/suppliers/{supplierId}/bookings

GET

/suppliers/{supplierId}/bookings/{uuid}

POST

/suppliers/{supplierId}/bookings/{uuid}/extend

POST

/suppliers/{supplierId}/bookings/{uuid}/confirm

POST

/suppliers/{supplierId}/bookings/{uuid}/cancel

Create a new pending booking.

WARNING: this endpoint may live under a different domain, path or both depending on the supplier endpoint URL returned by the GET /suppliers.

This creates a new pending booking.

This call has to be idempotent. To be able to safely retry a call on any network error or timeout, therefore it MUST not fail on retry or create a duplicate booking. The idempotency key is the UUID. A supplier SHOULD verify that a retried request with the same UUID is matching the original booking data, to avoid erroneous clients generating repeating UUIDs, and respond with an HTTP 400 status in such a case.

Auth

Path Params

supplierId

string

A valid supplier ID that matches the id returned from GET /suppliers.

Request Body

This MUST include all unitItems that the customer wants to book.

object	object
uuid	uuid	This UUID is generated for the initial `createBooking` request and MUST never change. This value MUST be tracked by both the Reseller and Booking Platform for locating this record.
resellerReference	string	An OPTIONAL tracking reference for the Reseller that SHOULD be tracked by the Booking Platform. This MUST be returned if the value was provided in the request body.
channelName	string	The originating channel's human-readable name. A list of operator-visible channels can be retrieved via Redeam's Channel Management API (GET `/channels` endpoint). This is provided in the Pending Booking request, and should be mirrored back in every Booking response.
channelId	uuid	The unique identifier of the originating channel. A list of operator-visible channels can be retrieved via Redeam's Channel Management API (GET `/channels` endpoint). This is provided in the Pending Booking request, and should be mirrored back in every Booking response.
productId	string	A valid product ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
optionId	string	A valid option ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
availabilityId	string	A valid availability ID that matches the `id` returned from `GET /suppliers/{supplierId}/availability`.
unitItems	array[object]
uuid	string	This is a randomly-generated UUID that MUST be tracked by both the Reseller and Booking Platform for locating this record.
unitId	string	A valid unit ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
resellerReference	string	An OPTIONAL tracking reference for the Reseller that SHOULD be tracked by the Booking Platform. This MUST be returned if the value was provided in the request body.
quantity	integer	The total number of this unit that the customer wants to purchase.
holdExpirationMinutes	integer	This is the duration that the Reseller would like the product inventory to be temporarily held while the booking is completed. The Booking Platform SHOULD reserve the inventory for at least this duration but MAY reserve for a shorter period of time. The exact hold expiration time will be returned in the response.

POST /suppliers/{supplierId}/bookings

 
curl --request POST \ --url 'https://api.example.com/required-base-path/suppliers/Wisconsin%20Widget%20World/bookings' \ --header 'Authorization: Basic {token}' \ --data '{  "uuid": "7df49d62-57ad-44be-8373-e4c2fe7e63fe",  "resellerReference": "001-002",  "channelName": "Online Tours & Attractions",  "channelId": "06981987-abf6-498b-9afd-4c994791bc31",  "productId": "adult",  "optionId": "LR1-01",  "availabilityId": "28271273-a317-40fc-8f42-79725a7072a3",  "unitItems": [    {      "uuid": "6be0409f-181e-4520-acc1-cc6791896859",      "unitId": "adult",      "resellerReference": "001-002",      "quantity": 2    }  ],  "holdExpirationMinutes": 30}'
Copy

Responses

200

A complete representation of the current booking booking status.

object	object
uuid	uuid	This is a randomly-generated UUID that MUST be tracked by both the Reseller and Booking Platform for locating this record.
resellerReference	string	An OPTIONAL tracking reference for the Reseller that SHOULD be tracked by the Booking Platform. This MUST be returned if the value was provided in the request body.
channelName	string	The originating channel's human-readable name. A list of operator-visible channels can be retrieved via Redeam's Channel Management API (GET `/channels` endpoint). This is provided in the Pending Booking request, and should be mirrored back in every Booking response.
channelId	uuid	The unique identifier of the originating channel. A list of operator-visible channels can be retrieved via Redeam's Channel Management API (GET `/channels` endpoint). This is provided in the Pending Booking request, and should be mirrored back in every Booking response.
supplierReference	string	An OPTIONAL tracking reference for the Supplier that SHOULD be tracked by the Reseller.
status	string	After a successful `createBooking` request, the `status` MUST be `ON_HOLD`. After a successful `confirmBooking` request, the `status` MUST be `CONFIRMED`. After a successful `confirmCancellation` request, the `status` MUST be `CANCELLED`. Following are the only valid Booking flow status transitions: New Booking -> `REJECTED` New Booking -> `ON_HOLD` -> `EXPIRED` New Booking -> `ON_HOLD` -> `CONFIRMED` New Booking -> `ON_HOLD` -> `PENDING` -> `REJECTED` New Booking -> `ON_HOLD` -> `PENDING` -> `CONFIRMED` The `PENDING` status MAY appear only for products with the `instantConfirmation` property set to `false`. Poll the /bookings endpoint for status changes. Following are the only valid Cancellation flow status transitions: `CONFIRMED` -> `CANCELLED` `ON_HOLD` -> `EXPIRED` Enum: `ON_HOLD`,`EXPIRED`,`PENDING`,`REJECTED`,`CONFIRMED`,`CANCELLED`
cancellable	boolean	Indicates whether the booking is cancellable right now
utcHoldExpiration	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the availability hold will be released. This SHOULD be equivalent to the time calculated by adding `holdExpirationMinutes` to the current UTC time but MAY be either earlier or later than the requested duration.
refreshFrequency	string	This is the RECOMMENDED refresh interval for the Reseller and SHOULD be used by the Reseller to control the frequency at which they make a `getBooking` request for the following scenarios: To see if a booking has changed out of a `PENDING` status into `CONFIRMED` or `REJECTED`. To see if a booking has had any new Vouchers or Tickets delivered for the booking. To see if a booking has changed from `CONFIRMED` to `CANCELLED` in the event of a supplier-initiated cancellation. To see if a booking has an updated `utcRedeemedAt`/`utcResolvedAt` value for the Voucher or any of the Tickets. Enum: `HOURLY`,`DAILY`
productId	string	A valid product ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
optionId	string	A valid option ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
availability	object
id	string	This MUST be a unique identifier within the scope of the Option.
optionId	string	This MUST be a valid option ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
localDateTimeStart	date-time	This MUST be an RFC 3339 compliant date and time. Fractions of a second will be removed when retrieved by Redeam. For example, Redeam will interpret the date-time `2023-01-05T14:35:45.754Z` as `2023-01-05T14:35:45Z`.
localDateTimeEnd	date-time	This MUST be an RFC 3339 compliant date and time. Fractions of a second will be removed when retrieved by Redeam. For example, Redeam will interpret the date-time `2023-01-05T14:35:45.754Z` as `2023-01-05T14:35:45Z`.
deliveryMethod	string	A value of `TICKET` indicates that there will be one `deliveryValue` for each ticket in the Booking while a value of `VOUCHER` indicates that there will be one `deliveryValue` that is shared among all tickets in the Booking. Enum: `TICKET`,`VOUCHER`
unitItems	array[object]
uuid	string	This is a randomly-generated UUID that MUST be tracked by both the Reseller and Booking Platform for locating this record.
unitId	string	A valid unit ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
resellerReference	string	An OPTIONAL tracking reference for the Reseller that SHOULD be tracked by the Booking Platform. This MUST be returned if the value was provided in the request body.
quantity	integer	The total number of this unit that the customer wants to purchase.
cancellationRequest	object
reason	string	This value indicates the reason that the cancellation request was sent. `CUSTOMER` is the most common and indicates that the customer requested the cancellation. `SUPPLIER` indicates that the supplier requested the cancellation (possibly due to bad weather or other unexpected circumstances). `FRAUD` indicates that the booking cancellation is being requested by the Reseller because it has been determined the booking was fraudulent. `OTHER` indicates that the cancellation reason does not fall into one of these categories. This SHOULD be used only in rare circumstances. Enum: `CUSTOMER`,`SUPPLIER`,`FRAUD`,`OTHER`
reasonDetails	string	This field provides additional details about the reason for the cancellation request. It may include information from the customer, supplier, or support agent about the reason for the cancellation (especially in the case of requesting a cancellation outside of the normal policy which may require manual approval from the supplier).
status	string	After a successful `createBooking` request, the `status` MUST be `ON_HOLD`. After a successful `confirmBooking` request, the `status` MUST be `CONFIRMED`. After a successful `confirmCancellation` request, the `status` MUST be `CANCELLED`. Following are the only valid Booking flow status transitions: New Booking -> `REJECTED` New Booking -> `ON_HOLD` -> `EXPIRED` New Booking -> `ON_HOLD` -> `CONFIRMED` New Booking -> `ON_HOLD` -> `PENDING` -> `REJECTED` New Booking -> `ON_HOLD` -> `PENDING` -> `CONFIRMED` The `PENDING` status MAY appear only for products with the `instantConfirmation` property set to `false`. Poll the /bookings endpoint for status changes. Following are the only valid Cancellation flow status transitions: `CONFIRMED` -> `CANCELLED` `ON_HOLD` -> `EXPIRED` Enum: `ON_HOLD`,`EXPIRED`,`PENDING`,`REJECTED`,`CONFIRMED`,`CANCELLED`
refund	string	This value indicates the expected refund from the Supplier. `FULL` indicates that the Supplier has fully refunded the booking and will not be paid by the Reseller for this booking. This is the expected state when a valid cancellation request is made before any cancellation cutoff policy or when a Supplier approves a cancellation request that was made after the cutoff. `PARTIAL` indicates that the Supplier has agreed to partially refund the customer. This may be due to a cancellation policy that grants a partial refund or because the Supplier has agreed to partially refund the customer when the cancellation policy would otherwise have not allowed any refund. `NONE` indicates that no refund will be given by the Supplier. The customer may still be refunded by the Reseller but the Supplier MUST still be paid for this booking. Enum: `FULL`,`PARTIAL`,`NONE`
utcRequestedAt	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the cancellation request was originally started. This timestamp MUST be used for any validation against a cancellation policy. This is important because there may be some delay in confirming this cancellation request during the 2-phase workflow which could finish just after the cancellation policy cutoff has elapsed.
utcConfirmedAt	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the cancellation request was confirmed by the Reseller.
utcResolvedAt	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the cancellation was confirmed. This will typically be the same as `utcConfirmedAt` however if the cancellation request required manual approval from the Supplier, it may be different.

400

An error has occurred. See the definition of the ErrorObject for more details.

401

Missing Authorization header or key could not be validated.

403

The Authorization header was validated but the requestor does not have the correct permissions to access the requested resource or perform the requested operation.

404

Invalid URI path requested.

500

An unknown error occurred and the server cannot respond in a sensible way. The response may not include a valid error object if one could not be generated.

503

The server is temporarily unavailable, either because the server is under maintenance, or overloaded (accepted too many requests in too short a time).

Response

 
{ "uuid": "f149068e-300e-452a-a856-3f091239f1d7", "resellerReference": "001-002", "supplierReference": "ABC-123", "channelName": "Online Tours & Attractions", "channelId": "06981987-abf6-498b-9afd-4c994791bc31", "status": "ON_HOLD", "cancellable": true, "utcHoldExpiration": "2019-10-31T08:30:00Z", "refreshFrequency": "HOURLY", "productId": "adult", "optionId": "LR1-01", "availability": {  "id": "28271273-a317-40fc-8f42-79725a7072a3",  "optionId": "LR1-01",  "localDateTimeStart": "2019-10-31T08:30:00.000Z",  "localDateTimeEnd": "2019-10-31T10:00:00.000Z" }, "deliveryMethod": "VOUCHER", "unitItems": [  {   "uuid": "6be0409f-181e-4520-acc1-cc6791896859",   "unitId": "adult",   "resellerReference": "001-002",   "quantity": 2  } ]}
Copy

Gets the current details of an in-progress booking or completed booking.

WARNING: this endpoint may live under a different domain, path or both depending on the supplier endpoint URL returned by the GET /suppliers.

This returns the current state of any valid booking. This request MAY be made at any point after the initial createBooking request is processed successfully and it MUST return the booking object.

Auth

Path Params

supplierId	string	A valid supplier ID that matches the `id` returned from `GET /suppliers`.
uuid	string	A valid booking UUID that matches the `uuid` sent during the initial `POST /suppliers/{supplierId}/bookings`

GET /suppliers/{supplierId}/bookings/{uuid}

 
curl --get \ --url 'https://api.example.com/required-base-path/suppliers/Wisconsin%20Widget%20World/bookings/a8f8c73e-ce0e-4acf-98e5-cc67de634f82' \ --header 'Authorization: Basic {token}'
Copy

Responses

200

A complete representation of the current booking booking status.

object	object
uuid	uuid	This is a randomly-generated UUID that MUST be tracked by both the Reseller and Booking Platform for locating this record.
resellerReference	string	An OPTIONAL tracking reference for the Reseller that SHOULD be tracked by the Booking Platform. This MUST be returned if the value was provided in the request body.
channelName	string	The originating channel's human-readable name. A list of operator-visible channels can be retrieved via Redeam's Channel Management API (GET `/channels` endpoint). This is provided in the Pending Booking request, and should be mirrored back in every Booking response.
channelId	uuid	The unique identifier of the originating channel. A list of operator-visible channels can be retrieved via Redeam's Channel Management API (GET `/channels` endpoint). This is provided in the Pending Booking request, and should be mirrored back in every Booking response.
supplierReference	string	An OPTIONAL tracking reference for the Supplier that SHOULD be tracked by the Reseller.
status	string	After a successful `createBooking` request, the `status` MUST be `ON_HOLD`. After a successful `confirmBooking` request, the `status` MUST be `CONFIRMED`. After a successful `confirmCancellation` request, the `status` MUST be `CANCELLED`. Following are the only valid Booking flow status transitions: New Booking -> `REJECTED` New Booking -> `ON_HOLD` -> `EXPIRED` New Booking -> `ON_HOLD` -> `CONFIRMED` New Booking -> `ON_HOLD` -> `PENDING` -> `REJECTED` New Booking -> `ON_HOLD` -> `PENDING` -> `CONFIRMED` The `PENDING` status MAY appear only for products with the `instantConfirmation` property set to `false`. Poll the /bookings endpoint for status changes. Following are the only valid Cancellation flow status transitions: `CONFIRMED` -> `CANCELLED` `ON_HOLD` -> `EXPIRED` Enum: `ON_HOLD`,`EXPIRED`,`PENDING`,`REJECTED`,`CONFIRMED`,`CANCELLED`
cancellable	boolean	Indicates whether the booking is cancellable right now
utcHoldExpiration	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the availability hold will be released. This SHOULD be equivalent to the time calculated by adding `holdExpirationMinutes` to the current UTC time but MAY be either earlier or later than the requested duration.
refreshFrequency	string	This is the RECOMMENDED refresh interval for the Reseller and SHOULD be used by the Reseller to control the frequency at which they make a `getBooking` request for the following scenarios: To see if a booking has changed out of a `PENDING` status into `CONFIRMED` or `REJECTED`. To see if a booking has had any new Vouchers or Tickets delivered for the booking. To see if a booking has changed from `CONFIRMED` to `CANCELLED` in the event of a supplier-initiated cancellation. To see if a booking has an updated `utcRedeemedAt`/`utcResolvedAt` value for the Voucher or any of the Tickets. Enum: `HOURLY`,`DAILY`
productId	string	A valid product ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
optionId	string	A valid option ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
availability	object
id	string	This MUST be a unique identifier within the scope of the Option.
optionId	string	This MUST be a valid option ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
localDateTimeStart	date-time	This MUST be an RFC 3339 compliant date and time. Fractions of a second will be removed when retrieved by Redeam. For example, Redeam will interpret the date-time `2023-01-05T14:35:45.754Z` as `2023-01-05T14:35:45Z`.
localDateTimeEnd	date-time	This MUST be an RFC 3339 compliant date and time. Fractions of a second will be removed when retrieved by Redeam. For example, Redeam will interpret the date-time `2023-01-05T14:35:45.754Z` as `2023-01-05T14:35:45Z`.
deliveryMethod	string	A value of `TICKET` indicates that there will be one `deliveryValue` for each ticket in the Booking while a value of `VOUCHER` indicates that there will be one `deliveryValue` that is shared among all tickets in the Booking. Enum: `TICKET`,`VOUCHER`
unitItems	array[object]
uuid	string	This is a randomly-generated UUID that MUST be tracked by both the Reseller and Booking Platform for locating this record.
unitId	string	A valid unit ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
resellerReference	string	An OPTIONAL tracking reference for the Reseller that SHOULD be tracked by the Booking Platform. This MUST be returned if the value was provided in the request body.
quantity	integer	The total number of this unit that the customer wants to purchase.
cancellationRequest	object
reason	string	This value indicates the reason that the cancellation request was sent. `CUSTOMER` is the most common and indicates that the customer requested the cancellation. `SUPPLIER` indicates that the supplier requested the cancellation (possibly due to bad weather or other unexpected circumstances). `FRAUD` indicates that the booking cancellation is being requested by the Reseller because it has been determined the booking was fraudulent. `OTHER` indicates that the cancellation reason does not fall into one of these categories. This SHOULD be used only in rare circumstances. Enum: `CUSTOMER`,`SUPPLIER`,`FRAUD`,`OTHER`
reasonDetails	string	This field provides additional details about the reason for the cancellation request. It may include information from the customer, supplier, or support agent about the reason for the cancellation (especially in the case of requesting a cancellation outside of the normal policy which may require manual approval from the supplier).
status	string	After a successful `createBooking` request, the `status` MUST be `ON_HOLD`. After a successful `confirmBooking` request, the `status` MUST be `CONFIRMED`. After a successful `confirmCancellation` request, the `status` MUST be `CANCELLED`. Following are the only valid Booking flow status transitions: New Booking -> `REJECTED` New Booking -> `ON_HOLD` -> `EXPIRED` New Booking -> `ON_HOLD` -> `CONFIRMED` New Booking -> `ON_HOLD` -> `PENDING` -> `REJECTED` New Booking -> `ON_HOLD` -> `PENDING` -> `CONFIRMED` The `PENDING` status MAY appear only for products with the `instantConfirmation` property set to `false`. Poll the /bookings endpoint for status changes. Following are the only valid Cancellation flow status transitions: `CONFIRMED` -> `CANCELLED` `ON_HOLD` -> `EXPIRED` Enum: `ON_HOLD`,`EXPIRED`,`PENDING`,`REJECTED`,`CONFIRMED`,`CANCELLED`
refund	string	This value indicates the expected refund from the Supplier. `FULL` indicates that the Supplier has fully refunded the booking and will not be paid by the Reseller for this booking. This is the expected state when a valid cancellation request is made before any cancellation cutoff policy or when a Supplier approves a cancellation request that was made after the cutoff. `PARTIAL` indicates that the Supplier has agreed to partially refund the customer. This may be due to a cancellation policy that grants a partial refund or because the Supplier has agreed to partially refund the customer when the cancellation policy would otherwise have not allowed any refund. `NONE` indicates that no refund will be given by the Supplier. The customer may still be refunded by the Reseller but the Supplier MUST still be paid for this booking. Enum: `FULL`,`PARTIAL`,`NONE`
utcRequestedAt	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the cancellation request was originally started. This timestamp MUST be used for any validation against a cancellation policy. This is important because there may be some delay in confirming this cancellation request during the 2-phase workflow which could finish just after the cancellation policy cutoff has elapsed.
utcConfirmedAt	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the cancellation request was confirmed by the Reseller.
utcResolvedAt	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the cancellation was confirmed. This will typically be the same as `utcConfirmedAt` however if the cancellation request required manual approval from the Supplier, it may be different.

400

An error has occurred. See the definition of the ErrorObject for more details.

401

Missing Authorization header or key could not be validated.

403

The Authorization header was validated but the requestor does not have the correct permissions to access the requested resource or perform the requested operation.

404

Invalid URI path requested.

500

An unknown error occurred and the server cannot respond in a sensible way. The response may not include a valid error object if one could not be generated.

503

The server is temporarily unavailable, either because the server is under maintenance, or overloaded (accepted too many requests in too short a time).

Response

 
{ "uuid": "f149068e-300e-452a-a856-3f091239f1d7", "resellerReference": "001-002", "supplierReference": "ABC-123", "channelName": "Online Tours & Attractions", "channelId": "06981987-abf6-498b-9afd-4c994791bc31", "status": "ON_HOLD", "cancellable": true, "utcHoldExpiration": "2019-10-31T08:30:00Z", "refreshFrequency": "HOURLY", "productId": "adult", "optionId": "LR1-01", "availability": {  "id": "28271273-a317-40fc-8f42-79725a7072a3",  "optionId": "LR1-01",  "localDateTimeStart": "2019-10-31T08:30:00.000Z",  "localDateTimeEnd": "2019-10-31T10:00:00.000Z" }, "deliveryMethod": "VOUCHER", "unitItems": [  {   "uuid": "6be0409f-181e-4520-acc1-cc6791896859",   "unitId": "adult",   "resellerReference": "001-002",   "quantity": 2  } ]}
Copy

Extend the hold of an in-progress booking.

WARNING: this endpoint may live under a different domain, path or both depending on the supplier endpoint URL returned by the GET /suppliers.

This extends the hold of an in-progress booking. The utcHoldExpiration MUST NOT be elapsed when this request is sent, otherwise the response MAY show a status of EXPIRED.

Auth

Path Params

supplierId	string	A valid supplier ID that matches the `id` returned from `GET /suppliers`.
uuid	string	A valid booking UUID that matches the `uuid` sent during the initial `POST /suppliers/{supplierId}/bookings`

Request Body

This MUST include the proper reason for requesting the extension and MUST NOT be abused to keep availability reserved due to processing delays by the Reseller.

object	object
reason	string	This indicates the reason for extending the booking hold. `FRAUD_CHECK` is the most common scenario where additional time is required to ensure that the booking is not being made using fraudulent payment information. `CUSTOMER_REQUESTED` is intended for scenarios where the customer is actively completing the checkout process but requires some additional time to complete. The Reseller SHOULD try to ensure that customers may only extend their booking once. `OTHER` can be used in other unusual circumstances but SHOULD not be abused to maintain a hold without good reason. If this value is specified the Reseller SHOULD provide `reasonDetails` to explain the justification. Enum: `FRAUD_CHECK`,`CUSTOMER_REQUESTED`,`OTHER`
reasonDetails	string	This provides additional details behind the reason for requesting the extension and SHOULD be provided in all cases, but especially if the `reason` given is `OTHER`.
holdExpirationMinutes	integer	This is the duration that the Reseller would like the product inventory hold to be extended while the booking is completed. The Booking Platform SHOULD extend the hold on the inventory for at least this duration from the time of the request but MAY reserve for a shorter period of time. The exact hold expiration time will be returned in the response.

POST /suppliers/{supplierId}/bookings/{uuid}/extend

 
curl --request POST \ --url 'https://api.example.com/required-base-path/suppliers/Wisconsin%20Widget%20World/bookings/a8f8c73e-ce0e-4acf-98e5-cc67de634f82/extend' \ --header 'Authorization: Basic {token}' \ --data '{  "reason": "FRAUD_CHECK",  "reasonDetails": "Manual fraud review with 2-hour SLA.",  "holdExpirationMinutes": 120}'
Copy

Responses

200

A complete representation of the current booking booking status.

object	object
uuid	uuid	This is a randomly-generated UUID that MUST be tracked by both the Reseller and Booking Platform for locating this record.
resellerReference	string	An OPTIONAL tracking reference for the Reseller that SHOULD be tracked by the Booking Platform. This MUST be returned if the value was provided in the request body.
channelName	string	The originating channel's human-readable name. A list of operator-visible channels can be retrieved via Redeam's Channel Management API (GET `/channels` endpoint). This is provided in the Pending Booking request, and should be mirrored back in every Booking response.
channelId	uuid	The unique identifier of the originating channel. A list of operator-visible channels can be retrieved via Redeam's Channel Management API (GET `/channels` endpoint). This is provided in the Pending Booking request, and should be mirrored back in every Booking response.
supplierReference	string	An OPTIONAL tracking reference for the Supplier that SHOULD be tracked by the Reseller.
status	string	After a successful `createBooking` request, the `status` MUST be `ON_HOLD`. After a successful `confirmBooking` request, the `status` MUST be `CONFIRMED`. After a successful `confirmCancellation` request, the `status` MUST be `CANCELLED`. Following are the only valid Booking flow status transitions: New Booking -> `REJECTED` New Booking -> `ON_HOLD` -> `EXPIRED` New Booking -> `ON_HOLD` -> `CONFIRMED` New Booking -> `ON_HOLD` -> `PENDING` -> `REJECTED` New Booking -> `ON_HOLD` -> `PENDING` -> `CONFIRMED` The `PENDING` status MAY appear only for products with the `instantConfirmation` property set to `false`. Poll the /bookings endpoint for status changes. Following are the only valid Cancellation flow status transitions: `CONFIRMED` -> `CANCELLED` `ON_HOLD` -> `EXPIRED` Enum: `ON_HOLD`,`EXPIRED`,`PENDING`,`REJECTED`,`CONFIRMED`,`CANCELLED`
cancellable	boolean	Indicates whether the booking is cancellable right now
utcHoldExpiration	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the availability hold will be released. This SHOULD be equivalent to the time calculated by adding `holdExpirationMinutes` to the current UTC time but MAY be either earlier or later than the requested duration.
refreshFrequency	string	This is the RECOMMENDED refresh interval for the Reseller and SHOULD be used by the Reseller to control the frequency at which they make a `getBooking` request for the following scenarios: To see if a booking has changed out of a `PENDING` status into `CONFIRMED` or `REJECTED`. To see if a booking has had any new Vouchers or Tickets delivered for the booking. To see if a booking has changed from `CONFIRMED` to `CANCELLED` in the event of a supplier-initiated cancellation. To see if a booking has an updated `utcRedeemedAt`/`utcResolvedAt` value for the Voucher or any of the Tickets. Enum: `HOURLY`,`DAILY`
productId	string	A valid product ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
optionId	string	A valid option ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
availability	object
id	string	This MUST be a unique identifier within the scope of the Option.
optionId	string	This MUST be a valid option ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
localDateTimeStart	date-time	This MUST be an RFC 3339 compliant date and time. Fractions of a second will be removed when retrieved by Redeam. For example, Redeam will interpret the date-time `2023-01-05T14:35:45.754Z` as `2023-01-05T14:35:45Z`.
localDateTimeEnd	date-time	This MUST be an RFC 3339 compliant date and time. Fractions of a second will be removed when retrieved by Redeam. For example, Redeam will interpret the date-time `2023-01-05T14:35:45.754Z` as `2023-01-05T14:35:45Z`.
deliveryMethod	string	A value of `TICKET` indicates that there will be one `deliveryValue` for each ticket in the Booking while a value of `VOUCHER` indicates that there will be one `deliveryValue` that is shared among all tickets in the Booking. Enum: `TICKET`,`VOUCHER`
unitItems	array[object]
uuid	string	This is a randomly-generated UUID that MUST be tracked by both the Reseller and Booking Platform for locating this record.
unitId	string	A valid unit ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
resellerReference	string	An OPTIONAL tracking reference for the Reseller that SHOULD be tracked by the Booking Platform. This MUST be returned if the value was provided in the request body.
quantity	integer	The total number of this unit that the customer wants to purchase.
cancellationRequest	object
reason	string	This value indicates the reason that the cancellation request was sent. `CUSTOMER` is the most common and indicates that the customer requested the cancellation. `SUPPLIER` indicates that the supplier requested the cancellation (possibly due to bad weather or other unexpected circumstances). `FRAUD` indicates that the booking cancellation is being requested by the Reseller because it has been determined the booking was fraudulent. `OTHER` indicates that the cancellation reason does not fall into one of these categories. This SHOULD be used only in rare circumstances. Enum: `CUSTOMER`,`SUPPLIER`,`FRAUD`,`OTHER`
reasonDetails	string	This field provides additional details about the reason for the cancellation request. It may include information from the customer, supplier, or support agent about the reason for the cancellation (especially in the case of requesting a cancellation outside of the normal policy which may require manual approval from the supplier).
status	string	After a successful `createBooking` request, the `status` MUST be `ON_HOLD`. After a successful `confirmBooking` request, the `status` MUST be `CONFIRMED`. After a successful `confirmCancellation` request, the `status` MUST be `CANCELLED`. Following are the only valid Booking flow status transitions: New Booking -> `REJECTED` New Booking -> `ON_HOLD` -> `EXPIRED` New Booking -> `ON_HOLD` -> `CONFIRMED` New Booking -> `ON_HOLD` -> `PENDING` -> `REJECTED` New Booking -> `ON_HOLD` -> `PENDING` -> `CONFIRMED` The `PENDING` status MAY appear only for products with the `instantConfirmation` property set to `false`. Poll the /bookings endpoint for status changes. Following are the only valid Cancellation flow status transitions: `CONFIRMED` -> `CANCELLED` `ON_HOLD` -> `EXPIRED` Enum: `ON_HOLD`,`EXPIRED`,`PENDING`,`REJECTED`,`CONFIRMED`,`CANCELLED`
refund	string	This value indicates the expected refund from the Supplier. `FULL` indicates that the Supplier has fully refunded the booking and will not be paid by the Reseller for this booking. This is the expected state when a valid cancellation request is made before any cancellation cutoff policy or when a Supplier approves a cancellation request that was made after the cutoff. `PARTIAL` indicates that the Supplier has agreed to partially refund the customer. This may be due to a cancellation policy that grants a partial refund or because the Supplier has agreed to partially refund the customer when the cancellation policy would otherwise have not allowed any refund. `NONE` indicates that no refund will be given by the Supplier. The customer may still be refunded by the Reseller but the Supplier MUST still be paid for this booking. Enum: `FULL`,`PARTIAL`,`NONE`
utcRequestedAt	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the cancellation request was originally started. This timestamp MUST be used for any validation against a cancellation policy. This is important because there may be some delay in confirming this cancellation request during the 2-phase workflow which could finish just after the cancellation policy cutoff has elapsed.
utcConfirmedAt	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the cancellation request was confirmed by the Reseller.
utcResolvedAt	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the cancellation was confirmed. This will typically be the same as `utcConfirmedAt` however if the cancellation request required manual approval from the Supplier, it may be different.

400

An error has occurred. See the definition of the ErrorObject for more details.

401

Missing Authorization header or key could not be validated.

403

The Authorization header was validated but the requestor does not have the correct permissions to access the requested resource or perform the requested operation.

404

Invalid URI path requested.

500

An unknown error occurred and the server cannot respond in a sensible way. The response may not include a valid error object if one could not be generated.

503

The server is temporarily unavailable, either because the server is under maintenance, or overloaded (accepted too many requests in too short a time).

Response

 
{ "uuid": "f149068e-300e-452a-a856-3f091239f1d7", "resellerReference": "001-002", "supplierReference": "ABC-123", "channelName": "Online Tours & Attractions", "channelId": "06981987-abf6-498b-9afd-4c994791bc31", "status": "ON_HOLD", "cancellable": true, "utcHoldExpiration": "2019-10-31T08:30:00Z", "refreshFrequency": "HOURLY", "productId": "adult", "optionId": "LR1-01", "availability": {  "id": "28271273-a317-40fc-8f42-79725a7072a3",  "optionId": "LR1-01",  "localDateTimeStart": "2019-10-31T08:30:00.000Z",  "localDateTimeEnd": "2019-10-31T10:00:00.000Z" }, "deliveryMethod": "VOUCHER", "unitItems": [  {   "uuid": "6be0409f-181e-4520-acc1-cc6791896859",   "unitId": "adult",   "resellerReference": "001-002",   "quantity": 2  } ]}
Copy

Confirm an in-progress booking.

WARNING: this endpoint may live under a different domain, path or both depending on the supplier endpoint URL returned by the GET /suppliers.

This confirms an in-progress booking. The utcHoldExpiration MUST NOT be elapsed when this request is sent, otherwise the response MAY show a status of EXPIRED.

This call MUST be idempotent so that a Reseller may retry the request for any network error or timeout. The Booking uuid MUST be used to ensure idempotency of the request.

Auth

Path Params

supplierId	string	A valid supplier ID that matches the `id` returned from `GET /suppliers`.
uuid	string	A valid booking UUID that matches the `uuid` sent during the initial `POST /suppliers/{supplierId}/bookings`

Request Body

This confirms an in-progress booking and MUST be sent before the utcHoldExpiration has elapsed.

object	object
resellerReference	string	An OPTIONAL tracking reference for the Reseller that SHOULD be tracked by the Booking Platform. This MUST be returned if the value was provided in the request body.
contact	object
fullName	string	The full name of the lead traveller.
emailAddress	string	The contact email of the lead traveller.
phoneNumber	string	The contact phone number of the lead traveller.
locales	array[string]
country	string	This MUST be a valid ISO 3166-1 alpha-2 country code.
guestDetails	array[object]
firstName	string	Given name of the guest.
lastName	string	Family or surname of the guest.
email	string	A valid contact email address for the guest.
phone	string	A valid contact phone number for the guest.
type	string	This is the base unit type for this unit definition. Enum: `ADULT`,`CHILD`,`INFANT`,`YOUTH`,`STUDENT`,`SENIOR`,`TRAVELLER`
age	integer	Age of the guest, in years. minimum: 0
gender	string	Gender of the guest.
height	string	Guest height with unit measure.
weight	string	Guest weight with unit measure.
countryOfOrigin	string	The guest's home country.
primaryLanguage	string	Spoken language of the guest.
identifications	array[object]	A list of official travel documents issued by a government that identifies the guest.
type	string	Indicates the type of identifying document.
value	string	Unique identifier assigned by authorities to this document.

POST /suppliers/{supplierId}/bookings/{uuid}/confirm

 
curl --request POST \ --url 'https://api.example.com/required-base-path/suppliers/Wisconsin%20Widget%20World/bookings/a8f8c73e-ce0e-4acf-98e5-cc67de634f82/confirm' \ --header 'Authorization: Basic {token}' \ --data '{  "resellerReference": "001-002",  "contact": {    "fullName": "Mr. Traveller",    "emailAddress": "traveller@fake.com",    "phoneNumber": "+1 555-555-1212",    "locales": [      "en-GB",      "en-US",      "en"    ],    "country": "GB"  },  "guestDetails": [    {      "firstName": "John",      "lastName": "Doe",      "email": "john.doe@example.com",      "phone": "1-555-555-5555",      "type": "YOUTH",      "age": 18,      "gender": "{string}",      "height": "5'7ft, 1.75m",      "weight": "144lbs, 65kg",      "countryOfOrigin": "Japan",      "primaryLanguage": "English",      "identifications": [        {          "type": "Passport, Military ID, Drivers License, National ID, Vaccination Certificate",          "value": "E000077303USA6502056F3010149500101920<091824"        }      ],      "extensions": "{}"    }  ]}'
Copy

Responses

200

A complete representation of the current booking booking status.

object	object
uuid	uuid	This is a randomly-generated UUID that MUST be tracked by both the Reseller and Booking Platform for locating this record.
resellerReference	string	An OPTIONAL tracking reference for the Reseller that SHOULD be tracked by the Booking Platform. This MUST be returned if the value was provided in the request body.
channelName	string	The originating channel's human-readable name. A list of operator-visible channels can be retrieved via Redeam's Channel Management API (GET `/channels` endpoint). This is provided in the Pending Booking request, and should be mirrored back in every Booking response.
channelId	uuid	The unique identifier of the originating channel. A list of operator-visible channels can be retrieved via Redeam's Channel Management API (GET `/channels` endpoint). This is provided in the Pending Booking request, and should be mirrored back in every Booking response.
supplierReference	string	An OPTIONAL tracking reference for the Supplier that SHOULD be tracked by the Reseller.
status	string	After a successful `createBooking` request, the `status` MUST be `ON_HOLD`. After a successful `confirmBooking` request, the `status` MUST be `CONFIRMED`. After a successful `confirmCancellation` request, the `status` MUST be `CANCELLED`. Following are the only valid Booking flow status transitions: New Booking -> `REJECTED` New Booking -> `ON_HOLD` -> `EXPIRED` New Booking -> `ON_HOLD` -> `CONFIRMED` New Booking -> `ON_HOLD` -> `PENDING` -> `REJECTED` New Booking -> `ON_HOLD` -> `PENDING` -> `CONFIRMED` The `PENDING` status MAY appear only for products with the `instantConfirmation` property set to `false`. Poll the /bookings endpoint for status changes. Following are the only valid Cancellation flow status transitions: `CONFIRMED` -> `CANCELLED` `ON_HOLD` -> `EXPIRED` Enum: `ON_HOLD`,`EXPIRED`,`PENDING`,`REJECTED`,`CONFIRMED`,`CANCELLED`
cancellable	boolean	Indicates whether the booking is cancellable right now
utcHoldExpiration	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the availability hold will be released. This SHOULD be equivalent to the time calculated by adding `holdExpirationMinutes` to the current UTC time but MAY be either earlier or later than the requested duration.
refreshFrequency	string	This is the RECOMMENDED refresh interval for the Reseller and SHOULD be used by the Reseller to control the frequency at which they make a `getBooking` request for the following scenarios: To see if a booking has changed out of a `PENDING` status into `CONFIRMED` or `REJECTED`. To see if a booking has had any new Vouchers or Tickets delivered for the booking. To see if a booking has changed from `CONFIRMED` to `CANCELLED` in the event of a supplier-initiated cancellation. To see if a booking has an updated `utcRedeemedAt`/`utcResolvedAt` value for the Voucher or any of the Tickets. Enum: `HOURLY`,`DAILY`
productId	string	A valid product ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
optionId	string	A valid option ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
availability	object
id	string	This MUST be a unique identifier within the scope of the Option.
optionId	string	This MUST be a valid option ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
localDateTimeStart	date-time	This MUST be an RFC 3339 compliant date and time. Fractions of a second will be removed when retrieved by Redeam. For example, Redeam will interpret the date-time `2023-01-05T14:35:45.754Z` as `2023-01-05T14:35:45Z`.
localDateTimeEnd	date-time	This MUST be an RFC 3339 compliant date and time. Fractions of a second will be removed when retrieved by Redeam. For example, Redeam will interpret the date-time `2023-01-05T14:35:45.754Z` as `2023-01-05T14:35:45Z`.
deliveryMethod	string	A value of `TICKET` indicates that there will be one `deliveryValue` for each ticket in the Booking Enum: `TICKET`,`VOUCHER`,`TICKET`
unitItems	array[object]
uuid	string	This is a randomly-generated UUID that MUST be tracked by both the Reseller and Booking Platform for locating this record.
unitId	string	A valid unit ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
resellerReference	string	An OPTIONAL tracking reference for the Reseller that SHOULD be tracked by the Booking Platform. This MUST be returned if the value was provided in the request body.
quantity	integer	The total number of this unit that the customer wants to purchase.
supplierReference	string	An OPTIONAL tracking reference for the Supplier that SHOULD be tracked by the Reseller.
ticket	object
deliveryOptions	array[object]	This MUST contain a list of one or more deliveryOptions. Any one of the listed deliveryOptions MAY be used to redeem this Ticket.
deliveryFormat	string	This indicates the format for the `deliveryValue` so that it can be parsed or encoded correctly. Enum: `QR_CODE`,`EAN13`,`CODE128`,`UPCA`,`TEXT`,`CODE39`
deliveryValue	string	Represents the value for the voucher or ticket that should be used. This value MUST be encoded according to the `deliveryFormat` value.
redemptionMethod	string	This indicates the redemption requirements for the customer. A value of `MANIFEST` indicates that the customer MUST provide a form of identification to redeem and as such a printed or digital copy of the ticket is OPTIONAL. A value of `DIGITAL` indicates that the customer MUST provide a copy of the ticket but MAY be digital or printed. A value of `PRINT` indicates that the customer MUST provide a printed copy of the ticket (this is typically only used when the Supplier must retain the printed copy for their records). Enum: `MANIFEST`,`DIGITAL`,`PRINT`
utcDeliveredAt	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the voucher was made available to the customer by the Supplier. This will typically be the same as `utcConfirmedAt`.
utcRedeemedAt	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the customer redeemed this voucher.
cancellationRequest	object
reason	string	This value indicates the reason that the cancellation request was sent. `CUSTOMER` is the most common and indicates that the customer requested the cancellation. `SUPPLIER` indicates that the supplier requested the cancellation (possibly due to bad weather or other unexpected circumstances). `FRAUD` indicates that the booking cancellation is being requested by the Reseller because it has been determined the booking was fraudulent. `OTHER` indicates that the cancellation reason does not fall into one of these categories. This SHOULD be used only in rare circumstances. Enum: `CUSTOMER`,`SUPPLIER`,`FRAUD`,`OTHER`
reasonDetails	string	This field provides additional details about the reason for the cancellation request. It may include information from the customer, supplier, or support agent about the reason for the cancellation (especially in the case of requesting a cancellation outside of the normal policy which may require manual approval from the supplier).
status	string	After a successful `createBooking` request, the `status` MUST be `ON_HOLD`. After a successful `confirmBooking` request, the `status` MUST be `CONFIRMED`. After a successful `confirmCancellation` request, the `status` MUST be `CANCELLED`. Following are the only valid Booking flow status transitions: New Booking -> `REJECTED` New Booking -> `ON_HOLD` -> `EXPIRED` New Booking -> `ON_HOLD` -> `CONFIRMED` New Booking -> `ON_HOLD` -> `PENDING` -> `REJECTED` New Booking -> `ON_HOLD` -> `PENDING` -> `CONFIRMED` The `PENDING` status MAY appear only for products with the `instantConfirmation` property set to `false`. Poll the /bookings endpoint for status changes. Following are the only valid Cancellation flow status transitions: `CONFIRMED` -> `CANCELLED` `ON_HOLD` -> `EXPIRED` Enum: `ON_HOLD`,`EXPIRED`,`PENDING`,`REJECTED`,`CONFIRMED`,`CANCELLED`
refund	string	This value indicates the expected refund from the Supplier. `FULL` indicates that the Supplier has fully refunded the booking and will not be paid by the Reseller for this booking. This is the expected state when a valid cancellation request is made before any cancellation cutoff policy or when a Supplier approves a cancellation request that was made after the cutoff. `PARTIAL` indicates that the Supplier has agreed to partially refund the customer. This may be due to a cancellation policy that grants a partial refund or because the Supplier has agreed to partially refund the customer when the cancellation policy would otherwise have not allowed any refund. `NONE` indicates that no refund will be given by the Supplier. The customer may still be refunded by the Reseller but the Supplier MUST still be paid for this booking. Enum: `FULL`,`PARTIAL`,`NONE`
utcRequestedAt	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the cancellation request was originally started. This timestamp MUST be used for any validation against a cancellation policy. This is important because there may be some delay in confirming this cancellation request during the 2-phase workflow which could finish just after the cancellation policy cutoff has elapsed.
utcConfirmedAt	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the cancellation request was confirmed by the Reseller.
utcResolvedAt	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the cancellation was confirmed. This will typically be the same as `utcConfirmedAt` however if the cancellation request required manual approval from the Supplier, it may be different.
utcConfirmedAt	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the booking was confirmed (either automatically by the Booking Platform or manually by the Supplier).
utcDeliveredAt	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at whcih the VOUCHER was delivered.
contact	object
fullName	string	The full name of the lead traveller.
emailAddress	string	The contact email of the lead traveller.
phoneNumber	string	The contact phone number of the lead traveller.
locales	array[string]
country	string	This MUST be a valid ISO 3166-1 alpha-2 country code.

400

An error has occurred. See the definition of the ErrorObject for more details.

401

Missing Authorization header or key could not be validated.

403

The Authorization header was validated but the requestor does not have the correct permissions to access the requested resource or perform the requested operation.

404

Invalid URI path requested.

500

An unknown error occurred and the server cannot respond in a sensible way. The response may not include a valid error object if one could not be generated.

503

The server is temporarily unavailable, either because the server is under maintenance, or overloaded (accepted too many requests in too short a time).

Response

 
{ "uuid": "f149068e-300e-452a-a856-3f091239f1d7", "resellerReference": "001-002", "supplierReference": "ABC-123", "channelName": "Online Tours & Attractions", "channelId": "06981987-abf6-498b-9afd-4c994791bc31", "status": "ON_HOLD", "cancellable": true, "utcHoldExpiration": "2019-10-31T08:30:00Z", "refreshFrequency": "HOURLY", "productId": "adult", "optionId": "LR1-01", "availability": {  "id": "28271273-a317-40fc-8f42-79725a7072a3",  "optionId": "LR1-01",  "localDateTimeStart": "2019-10-31T08:30:00.000Z",  "localDateTimeEnd": "2019-10-31T10:00:00.000Z" }, "deliveryMethod": "TICKET", "unitItems": [  {   "uuid": "6be0409f-181e-4520-acc1-cc6791896859",   "unitId": "adult",   "resellerReference": "001-002",   "quantity": 2,   "ticket": {    "deliveryOptions": [     {      "deliveryFormat": "QR_CODE",      "deliveryValue": "0123456789"     },     {      "deliveryFormat": "QR_CODE",      "deliveryValue": "0123456790"     }    ],    "redemptionMethod": "DIGITAL",    "utcDeliveredAt": "2019-10-31T08:30:00.000Z"   }  } ], "contact": {  "fullName": "John Doe",  "emailAddress": "johndoe@example.com",  "locales": [   "en-US"  ] }}
Copy

Either cancel the booking, or expire the hold of an in-progress booking.

WARNING: this endpoint may live under a different domain, path or both depending on the supplier endpoint URL returned by the GET /suppliers.

This expires the hold of an in-progress booking, releasing its availability for other bookings to use. Resellers SHOULD send this in order to ensure proper cleanup of any outstanding holds.

This call MUST be idempotent, using the UUID of the booking as the idempotency key. Meaning, repeated attempts to cancel the same booking MUST return a successful response (with the cancelled booking in the response body).

Auth

Path Params

supplierId	string	A valid supplier ID that matches the `id` returned from `GET /suppliers`.
uuid	string	A valid booking UUID that matches the `uuid` sent during the initial `POST /suppliers/{supplierId}/bookings`

Request Body

This request will release the inventory hold on an in-progress booking or cancel a completed booking. It is RECOMMENDED that this request be sent if the customer fails to complete their booking, in order to release the inventory for other customers. It is also RECOMMENDED that this request be sent for a completed booking even if no refund is expected so that the Supplier can attempt to sell the unused inventory to another customer.

object object

reason

string

This value indicates the reason that the cancellation request was sent.

CUSTOMER is the most common and indicates that the customer requested the cancellation.
SUPPLIER indicates that the supplier requested the cancellation (possibly due to bad weather or other unexpected circumstances).
FRAUD indicates that the booking cancellation is being requested by the Reseller because it has been determined the booking was fraudulent.
OTHER indicates that the cancellation reason does not fall into one of these categories. This SHOULD be used only in rare circumstances.

Enum: CUSTOMER,SUPPLIER,FRAUD,OTHER

reasonDetails

string

This field provides additional details about the reason for the cancellation request. It may include information from the customer, supplier, or support agent about the reason for the cancellation (especially in the case of requesting a cancellation outside of the normal policy which may require manual approval from the supplier).

POST /suppliers/{supplierId}/bookings/{uuid}/cancel

 
curl --request POST \ --url 'https://api.example.com/required-base-path/suppliers/Wisconsin%20Widget%20World/bookings/a8f8c73e-ce0e-4acf-98e5-cc67de634f82/cancel' \ --header 'Authorization: Basic {token}' \ --data '{  "reason": "CUSTOMER",  "reasonDetails": "Child came down with the flu the day before the activity."}'
Copy

Responses

200

A complete representation of the current booking booking status.

object	object
uuid	uuid	This is a randomly-generated UUID that MUST be tracked by both the Reseller and Booking Platform for locating this record.
resellerReference	string	An OPTIONAL tracking reference for the Reseller that SHOULD be tracked by the Booking Platform. This MUST be returned if the value was provided in the request body.
channelName	string	The originating channel's human-readable name. A list of operator-visible channels can be retrieved via Redeam's Channel Management API (GET `/channels` endpoint). This is provided in the Pending Booking request, and should be mirrored back in every Booking response.
channelId	uuid	The unique identifier of the originating channel. A list of operator-visible channels can be retrieved via Redeam's Channel Management API (GET `/channels` endpoint). This is provided in the Pending Booking request, and should be mirrored back in every Booking response.
supplierReference	string	An OPTIONAL tracking reference for the Supplier that SHOULD be tracked by the Reseller.
status	string	After a successful `createBooking` request, the `status` MUST be `ON_HOLD`. After a successful `confirmBooking` request, the `status` MUST be `CONFIRMED`. After a successful `confirmCancellation` request, the `status` MUST be `CANCELLED`. Following are the only valid Booking flow status transitions: New Booking -> `REJECTED` New Booking -> `ON_HOLD` -> `EXPIRED` New Booking -> `ON_HOLD` -> `CONFIRMED` New Booking -> `ON_HOLD` -> `PENDING` -> `REJECTED` New Booking -> `ON_HOLD` -> `PENDING` -> `CONFIRMED` The `PENDING` status MAY appear only for products with the `instantConfirmation` property set to `false`. Poll the /bookings endpoint for status changes. Following are the only valid Cancellation flow status transitions: `CONFIRMED` -> `CANCELLED` `ON_HOLD` -> `EXPIRED` Enum: `ON_HOLD`,`EXPIRED`,`PENDING`,`REJECTED`,`CONFIRMED`,`CANCELLED`
cancellable	boolean	Indicates whether the booking is cancellable right now
utcHoldExpiration	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the availability hold will be released. This SHOULD be equivalent to the time calculated by adding `holdExpirationMinutes` to the current UTC time but MAY be either earlier or later than the requested duration.
refreshFrequency	string	This is the RECOMMENDED refresh interval for the Reseller and SHOULD be used by the Reseller to control the frequency at which they make a `getBooking` request for the following scenarios: To see if a booking has changed out of a `PENDING` status into `CONFIRMED` or `REJECTED`. To see if a booking has had any new Vouchers or Tickets delivered for the booking. To see if a booking has changed from `CONFIRMED` to `CANCELLED` in the event of a supplier-initiated cancellation. To see if a booking has an updated `utcRedeemedAt`/`utcResolvedAt` value for the Voucher or any of the Tickets. Enum: `HOURLY`,`DAILY`
productId	string	A valid product ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
optionId	string	A valid option ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
availability	object
id	string	This MUST be a unique identifier within the scope of the Option.
optionId	string	This MUST be a valid option ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
localDateTimeStart	date-time	This MUST be an RFC 3339 compliant date and time. Fractions of a second will be removed when retrieved by Redeam. For example, Redeam will interpret the date-time `2023-01-05T14:35:45.754Z` as `2023-01-05T14:35:45Z`.
localDateTimeEnd	date-time	This MUST be an RFC 3339 compliant date and time. Fractions of a second will be removed when retrieved by Redeam. For example, Redeam will interpret the date-time `2023-01-05T14:35:45.754Z` as `2023-01-05T14:35:45Z`.
deliveryMethod	string	A value of `TICKET` indicates that there will be one `deliveryValue` for each ticket in the Booking while a value of `VOUCHER` indicates that there will be one `deliveryValue` that is shared among all tickets in the Booking. Enum: `TICKET`,`VOUCHER`
unitItems	array[object]
uuid	string	This is a randomly-generated UUID that MUST be tracked by both the Reseller and Booking Platform for locating this record.
unitId	string	A valid unit ID that matches the `id` returned from `GET /suppliers/{supplierId}/products`.
resellerReference	string	An OPTIONAL tracking reference for the Reseller that SHOULD be tracked by the Booking Platform. This MUST be returned if the value was provided in the request body.
quantity	integer	The total number of this unit that the customer wants to purchase.
cancellationRequest	object
reason	string	This value indicates the reason that the cancellation request was sent. `CUSTOMER` is the most common and indicates that the customer requested the cancellation. `SUPPLIER` indicates that the supplier requested the cancellation (possibly due to bad weather or other unexpected circumstances). `FRAUD` indicates that the booking cancellation is being requested by the Reseller because it has been determined the booking was fraudulent. `OTHER` indicates that the cancellation reason does not fall into one of these categories. This SHOULD be used only in rare circumstances. Enum: `CUSTOMER`,`SUPPLIER`,`FRAUD`,`OTHER`
reasonDetails	string	This field provides additional details about the reason for the cancellation request. It may include information from the customer, supplier, or support agent about the reason for the cancellation (especially in the case of requesting a cancellation outside of the normal policy which may require manual approval from the supplier).
status	string	After a successful `createBooking` request, the `status` MUST be `ON_HOLD`. After a successful `confirmBooking` request, the `status` MUST be `CONFIRMED`. After a successful `confirmCancellation` request, the `status` MUST be `CANCELLED`. Following are the only valid Booking flow status transitions: New Booking -> `REJECTED` New Booking -> `ON_HOLD` -> `EXPIRED` New Booking -> `ON_HOLD` -> `CONFIRMED` New Booking -> `ON_HOLD` -> `PENDING` -> `REJECTED` New Booking -> `ON_HOLD` -> `PENDING` -> `CONFIRMED` The `PENDING` status MAY appear only for products with the `instantConfirmation` property set to `false`. Poll the /bookings endpoint for status changes. Following are the only valid Cancellation flow status transitions: `CONFIRMED` -> `CANCELLED` `ON_HOLD` -> `EXPIRED` Enum: `ON_HOLD`,`EXPIRED`,`PENDING`,`REJECTED`,`CONFIRMED`,`CANCELLED`
refund	string	This value indicates the expected refund from the Supplier. `FULL` indicates that the Supplier has fully refunded the booking and will not be paid by the Reseller for this booking. This is the expected state when a valid cancellation request is made before any cancellation cutoff policy or when a Supplier approves a cancellation request that was made after the cutoff. `PARTIAL` indicates that the Supplier has agreed to partially refund the customer. This may be due to a cancellation policy that grants a partial refund or because the Supplier has agreed to partially refund the customer when the cancellation policy would otherwise have not allowed any refund. `NONE` indicates that no refund will be given by the Supplier. The customer may still be refunded by the Reseller but the Supplier MUST still be paid for this booking. Enum: `FULL`,`PARTIAL`,`NONE`
utcRequestedAt	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the cancellation request was originally started. This timestamp MUST be used for any validation against a cancellation policy. This is important because there may be some delay in confirming this cancellation request during the 2-phase workflow which could finish just after the cancellation policy cutoff has elapsed.
utcConfirmedAt	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the cancellation request was confirmed by the Reseller.
utcResolvedAt	date-time	This MUST be an RFC 3339 compliant date and time. The value represents the time at which the cancellation was confirmed. This will typically be the same as `utcConfirmedAt` however if the cancellation request required manual approval from the Supplier, it may be different.

400

An error has occurred. See the definition of the ErrorObject for more details.

401

Missing Authorization header or key could not be validated.

403

The Authorization header was validated but the requestor does not have the correct permissions to access the requested resource or perform the requested operation.

404

Invalid URI path requested.

500

An unknown error occurred and the server cannot respond in a sensible way. The response may not include a valid error object if one could not be generated.

503

The server is temporarily unavailable, either because the server is under maintenance, or overloaded (accepted too many requests in too short a time).

Response

 
{ "uuid": "f149068e-300e-452a-a856-3f091239f1d7", "resellerReference": "001-002", "supplierReference": "ABC-123", "channelName": "Online Tours & Attractions", "channelId": "06981987-abf6-498b-9afd-4c994791bc31", "status": "ON_HOLD", "cancellable": true, "utcHoldExpiration": "2019-10-31T08:30:00Z", "refreshFrequency": "HOURLY", "productId": "adult", "optionId": "LR1-01", "availability": {  "id": "28271273-a317-40fc-8f42-79725a7072a3",  "optionId": "LR1-01",  "localDateTimeStart": "2019-10-31T08:30:00.000Z",  "localDateTimeEnd": "2019-10-31T10:00:00.000Z" }, "deliveryMethod": "VOUCHER", "unitItems": [  {   "uuid": "6be0409f-181e-4520-acc1-cc6791896859",   "unitId": "adult",   "resellerReference": "001-002",   "quantity": 2  } ], "cancellationRequest": {  "reason": "CUSTOMER",  "reasonDetails": "Child came down with the flu the day before the activity.",  "status": "ON_HOLD",  "refund": "FULL",  "utcRequestedAt": "2019-10-31T08:30:00.000Z",  "utcConfirmedAt": "2019-10-31T08:30:00.000Z",  "utcResolvedAt": "2019-10-31T08:30:00.000Z" }}
Copy