Partner API.
Retrieve a list of availabilities
Returns a list of availabilities.
| X | string | Request ID for request tracking. |
| product | string | ||
| supplier | string |
| end | string | ||
| start | string | ||
| rate | string |
curl --get \ --url 'https://channel.redeam.io/v1.2/suppliers/{supplier_id}/products/{product_id}/availabilities' \ --header 'X-Request-ID: {X-Request-ID}' \ --header 'X-API-Key: {X-API-Key}' \ --header 'X-API-Secret: {X-API-Secret}' \ --data end={end} \ --data start={start} \ --data rate_id={rate_id}Retrieve a list of availabilities
| object | object | ||
| availabilities | object | The availabilities matching the request | |
| byProduct | object | List of availabilities | |
| availability | array[object] | ||
| capacity | int32 | Remaining capacity of the availability | |
| end | date-time | End of the availability | |
| id | uuid | ID of the availability | |
| maxCapacity | int32 | Maximum capacity of the availability. If the maximum capacity hasn't been set by the operator, then its value will be -1. | |
| start | date-time | Start of the availability | |
| byRate | object | Availabilities by rate ID | |
| expires | date-time | Expiration date | |
| productId | uuid | Product ID for availabilities | |
| retrieved | date-time | etrieval date | |
| meta | object | Request meta data | |
| reqId | uuid | Request ID |
Retrieve a list of availabilities
Retrieve a list of availabilities
{ "availabilities": { "byProduct": { "availability": [ { "capacity": 1, "end": "2018-10-19T17:37:31-06:00", "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "maxCapacity": 100, "start": "2018-10-19T17:37:31-06:00" } ] }, "byRate": { "string": { "availability": [ { "capacity": 1, "end": "2018-10-19T17:37:31-06:00", "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "maxCapacity": 100, "start": "2018-10-19T17:37:31-06:00" } ] } }, "expires": "2018-10-19T17:37:31-06:00", "productId": "5fd78809-4700-46d7-8386-3b8738117f4d", "retrieved": "2018-10-19T17:37:31-06:00" }, "meta": { "reqId": "5fd78809-4700-46d7-8386-3b8738117f4d" }}Retrieve a single availability
Checks the availability of a product.
| X | string | Request ID for request tracking. |
| product | string | ||
| supplier | string |
| at | string | ||
| qty | integer | ||
| rate | string |
curl --get \ --url 'https://channel.redeam.io/v1.2/suppliers/{supplier_id}/products/{product_id}/availability' \ --header 'X-Request-ID: {X-Request-ID}' \ --header 'X-API-Key: {X-API-Key}' \ --header 'X-API-Secret: {X-API-Secret}' \ --data at={at} \ --data qty={qty} \ --data rate_id={rate_id}Retrieve a single availability
| object | object | ||
| availability | object | The availability matching the request | |
| capacity | int32 | Remaining capacity of the availability | |
| end | date-time | End of the availability | |
| id | uuid | ID of the availability | |
| maxCapacity | int32 | Maximum capacity of the availability. If the maximum capacity hasn't been set by the operator, then its value will be -1. | |
| start | date-time | Start of the availability | |
| bookable | boolean | A true value means a bookable availability is found | |
| meta | object | Request meta data | |
| reqId | uuid | Request ID |
Retrieve a single availability
Retrieve a single availability
Retrieve a single availability
{ "availability": { "capacity": 1, "end": "2018-10-19T17:37:31-06:00", "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "maxCapacity": 100, "start": "2018-10-19T17:37:31-06:00" }, "bookable": true, "meta": { "reqId": "5fd78809-4700-46d7-8386-3b8738117f4d" }}Bookings
Create a booking
Creates a booking.
| X | string | Request ID for request tracking. |
| object | object | ||
| booking | object | The booking | |
| barcode | object | ||
| format | string | Format of the barcode Enum: | |
| value | string | Value of the barcode | |
| channelId | uuid | Channel ID requesting the booking | |
| customer | object | Customer for the booking | |
| string | Email address of the customer | ||
| firstName | string | First name of the customer | |
| lastName | string | Last name of the customer | |
| phone | string | Phone number of the customer | |
| ext | object | Extended data for the booking | |
| holdExt | object | Extended data for the hold associated with the booking | |
| holdId | uuid | Optional Hold ID | |
| id | uuid | ID of the booking. This field can optionally be provided on create. If a valid UUID is provided on create, it will be saved as the object's ID. Otherwise, the object will receive a generated ID. | |
| items | array[object] | Items for the booking | |
| availabilityId | uuid | ID of availability selection | |
| ext | object | Extended data for the booking item | |
| id | uuid | Booking Item ID. | |
| priceId | string | ID of price selection for the booking item. This must match one of the price IDs within the rate that is being used to create this booking | |
| productId | uuid | ID of product offering rate | |
| quantity | int32 | Quantity of the booking item | |
| rateId | uuid | Rate ID for the booking item Rate | |
| startTime | date-time | ||
| supplierId | uuid | ID of supplier offering product | |
| traveler | object | Traveler for the booking item | |
| age | int32 | Age of the traveler | |
| country | string | Origin country of the traveler, as an ISO 3316-1 alpha-3 code pattern: | |
| string | Email address of the traveler | ||
| firstName | string | First name of the traveler | |
| gender | string | Gender of the traveler Enum: | |
| isLead | boolean | Indicates this traveler is lead or primary. Each booking must have exactly one. | |
| lang | string | Spoken language of the traveler, as an ISO 639-3 code pattern: | |
| lastName | string | Last name of the traveler | |
| phone | string | Phone number of the traveler pattern: | |
| type | string | Matches the Rate Price's travelerType ageBand | |
| partnerId | string | A Partner ID can be used to store a unique key in a partner's system. | |
| resellerBookingRef | string | Reseller reference ID for the booking | |
| meta | object | Request meta data | |
| reqId | uuid | Request ID |
curl --request POST \ --url 'https://channel.redeam.io/v1.2/bookings' \ --header 'X-Request-ID: {X-Request-ID}' \ --header 'X-API-Key: {X-API-Key}' \ --header 'X-API-Secret: {X-API-Secret}' \ --data '{ "booking": { "barcode": { "format": "CODE128", "value": "string" }, "channelId": "5fd78809-4700-46d7-8386-3b8738117f4d", "customer": { "email": "customer@gmail.com", "firstName": "string", "lastName": "string", "phone": "(1) 212 555-1234" }, "ext": { "string": "string" }, "holdExt": { "string": "string" }, "holdId": "5fd78809-4700-46d7-8386-3b8738117f4d", "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "items": [ { "availabilityId": "5fd78809-4700-46d7-8386-3b8738117f4d", "ext": { "string": "string" }, "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "priceId": "string", "productId": "5fd78809-4700-46d7-8386-3b8738117f4d", "quantity": 1, "rateId": "5fd78809-4700-46d7-8386-3b8738117f4d", "startTime": "2018-10-19T17:37:31-06:00", "supplierId": "5fd78809-4700-46d7-8386-3b8738117f4d", "traveler": { "age": 35, "country": "USA", "email": "traveler@gmail.com", "firstName": "Jane", "gender": "MALE", "isLead": true, "lang": "DEU", "lastName": "Smith", "phone": "(1) 212 555-1234", "type": "ADULT" } } ], "partnerId": "string", "resellerBookingRef": "4AC773C0FF244aE" }, "meta": { "reqId": "5fd78809-4700-46d7-8386-3b8738117f4d" }}'Create a booking
| object | object | ||
| booking | object | The booking | |
| barcode | object | ||
| format | string | Format of the barcode Enum: | |
| value | string | Value of the barcode | |
| cancelable | boolean | True if the booking can be canceled. This value corresponds with the 'cancelable' status of the Rates in the Booking's Items. | |
| channelId | uuid | Channel ID requesting the booking | |
| customer | object | Customer for the booking | |
| string | Email address of the customer | ||
| firstName | string | First name of the customer | |
| lastName | string | Last name of the customer | |
| phone | string | Phone number of the customer | |
| ext | object | Extended data for the booking | |
| holdExt | object | Extended data for the hold associated with the booking | |
| holdId | uuid | Optional Hold ID | |
| id | uuid | ID of the booking. This field can optionally be provided on create. If a valid UUID is provided on create, it will be saved as the object's ID. Otherwise, the object will receive a generated ID. | |
| items | array[object] | Items for the booking | |
| availabilityId | uuid | ID of availability selection | |
| ext | object | Extended data for the booking item | |
| id | uuid | Booking Item ID. | |
| priceId | string | ID of price selection for the booking item. This must match one of the price IDs within the rate that is being used to create this booking | |
| productId | uuid | ID of product offering rate | |
| quantity | int32 | Quantity of the booking item | |
| rate | object | Rate selection for the booking item | |
| cancelable | boolean | Can a booking made with this rate be cancelled | |
| code | string | Short textual code representing the rate | |
| cutoff | int64 | The minimum interval (in minutes) between a booking's creation & start time | |
| ext | object | Extended data of the rate | |
| holdable | boolean | Can a hold be made against this rate | |
| holdablePeriod | int64 | The maximum interval (in seconds) between a hold's creation & expiration time | |
| hours | array[object] | Rules for specifying open hours for this rate | |
| dates | array[string] | Specific dates to which this rule applies | |
| daysOfWeek | array[integer] | Applicable days of week. 0 is undefined, 1 is Monday, etc | |
| times | array[object] | Open/Close times | |
| close | string | Close time in UTC, 24-hour time, with 'HH:mm' format pattern: | |
| open | string | Open time in UTC, 24-hour time, with 'HH:mm' format pattern: | |
| timezone | string | IANA timezone string. If empty, then the open and close times are interpreted as UTC. | |
| valid | object | Valid time range, if DaysOfWeek is specified | |
| from | date-time | Valid from time | |
| until | date-time | Valid until time | |
| id | uuid | ID of the rate. This field can optionally be provided on create. If a valid UUID is provided on create, it will be saved as the object's ID. Otherwise, the object will receive a generated ID. | |
| maxTravelers | int64 | Maximum number of travelers to qualify for this rate | |
| minTravelers | int64 | Minimum number of travelers to qualify for this rate. Must be at least 1. | |
| name | string | Human-friendly name for the rate | |
| optionId | uuid | An Option ID identifies a Rate as belonging to a given Product option. As an example, there could be five RESERVED Rates, one for each tour time, that are all grouped as part of a single Product option, and that are only represented by multiple Rates in order to separate their Availability capacities. | |
| partnerId | string | A Partner ID can be used to store a unique key in a partner's system. | |
| prices | array[object] | List of prices for this rate. | |
| id | uuid | ID of the rate price | |
| includedTaxes | array[object] | Portion of the Retail price dedicated to government taxes and fees. | |
| currency | string | ISO 4217 currency code, e.g.: USD, EUR, CHF pattern: | |
| id | string | ID of the included taxes entry (not required to be a UUID). | |
| name | string | Human-readable title of the included taxes entry | |
| net | int64 | Amount in cents (e.g. $1 USD == 100). | |
| retail | int64 | Amount in cents (e.g. $1 USD == 100). | |
| labels | array[string] | A list of filterable tags assigned to this price. Used in ChannelBindings (priceTags) to filter prices available by channel. | |
| name | string | Human-readable title of the RatePrice. | |
| net | object | The amount paid by a channel to the operator for a product. | |
| amount | int64 | Amount in cents | |
| currency | string | ISO 4217 currency code, e.g.: USD, EUR, CHF pattern: | |
| original | object | Operator's published price before discounts. | |
| amount | int64 | Amount in cents | |
| currency | string | ISO 4217 currency code, e.g.: USD, EUR, CHF pattern: | |
| retail | object | The amount paid by the traveler for a product. | |
| amount | int64 | Amount in cents | |
| currency | string | ISO 4217 currency code, e.g.: USD, EUR, CHF pattern: | |
| status | string | Determines if bound channels can list this price. Enum: | |
| travelerType | object | Structured description of the age, membership or role of the traveler this price is intended for. | |
| ageBand | string | Age band of the traveler type Enum: | |
| maxAge | int32 | Maximum age (inclusive) of the traveler type | |
| minAge | int32 | Minimum age (inclusive) of the traveler type | |
| modifier | string | Optional traveler modifier. For most use cases, this can be omitted or set to 'NONE'. Enum: | |
| name | string | Name of the traveler type, e.g. Diver, Observer, Adult, Military | |
| productId | uuid | ID of the owning product | |
| refundable | boolean | Can a booking made with this rate be refunded | |
| title | string | Display name for the rate | |
| type | string | Type of rate Enum: | |
| valid | object | Time range when this rate is valid | |
| from | date-time | Valid from time | |
| until | date-time | Valid until time | |
| version | int32 | Version of this object. Increments every update. | |
| rateId | uuid | Rate ID for the booking item Rate | |
| startTime | date-time | ||
| status | string | Status of the booking item Enum: | |
| supplierId | uuid | ID of supplier offering product | |
| traveler | object | Traveler for the booking item | |
| age | int32 | Age of the traveler | |
| country | string | Origin country of the traveler, as an ISO 3316-1 alpha-3 code pattern: | |
| string | Email address of the traveler | ||
| firstName | string | First name of the traveler | |
| gender | string | Gender of the traveler Enum: | |
| isLead | boolean | Indicates this traveler is lead or primary. Each booking must have exactly one. | |
| lang | string | Spoken language of the traveler, as an ISO 639-3 code pattern: | |
| lastName | string | Last name of the traveler | |
| phone | string | Phone number of the traveler pattern: | |
| type | string | Matches the Rate Price's travelerType ageBand | |
| partnerId | string | A Partner ID can be used to store a unique key in a partner's system. | |
| resellerBookingRef | string | Reseller reference ID for the booking | |
| status | string | Status of the booking Enum: | |
| tickets | array[object] | Tickets for the booking | |
| barcode | object | The barcode for this ticket. | |
| format | string | Format of the barcode Enum: | |
| value | string | Value of the barcode | |
| bookingItemIds | array[string] | One or more references to Booking Item IDs. | |
| extensions | object | ||
| guests | array[object] | The number of guests for this ticket. | |
| count | integer | Number of guests. | |
| typeCode | string | This should contain the Rate.Prices[].Traveler.AgeBand from the Price referenced by the Booking Item that corresponds to this ticket. | |
| typeModifier | string | This should contain the Rate.Prices[].Traveler.Modifier from the Price referenced by the Booking Item that corresponds to this ticket. Enum: | |
| typeName | string | This should contain the Rate.Prices[].Traveler.Name from the Price referenced by the Booking Item that corresponds to this ticket. | |
| leadTraveler | object | The lead traveler for this ticket. | |
| age | int32 | Age of the traveler | |
| country | string | Origin country of the traveler, as an ISO 3316-1 alpha-3 code pattern: | |
| string | Email address of the traveler | ||
| firstName | string | First name of the traveler | |
| gender | string | Gender of the traveler Enum: | |
| isLead | boolean | Indicates this traveler is lead or primary. Each booking must have exactly one. | |
| lang | string | Spoken language of the traveler, as an ISO 639-3 code pattern: | |
| lastName | string | Last name of the traveler | |
| phone | string | Phone number of the traveler pattern: | |
| type | string | Matches the Rate Price's travelerType ageBand | |
| status | string | Ticket status Enum: | |
| timeline | array[object] | Timeline of actions taken on the Booking. | |
| timestamp | date-time | ||
| typeOf | string | Enum: | |
| version | int32 | Internal version number | |
| meta | object | Request meta data | |
| reqId | uuid | Request ID |
Create a booking
Create a booking
Create a booking
Create a booking
{ "booking": { "barcode": { "format": "CODE128", "value": "string" }, "cancelable": true, "channelId": "5fd78809-4700-46d7-8386-3b8738117f4d", "customer": { "email": "customer@gmail.com", "firstName": "string", "lastName": "string", "phone": "(1) 212 555-1234" }, "ext": { "string": "string" }, "holdExt": { "string": "string" }, "holdId": "5fd78809-4700-46d7-8386-3b8738117f4d", "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "items": [ { "availabilityId": "5fd78809-4700-46d7-8386-3b8738117f4d", "ext": { "string": "string" }, "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "priceId": "string", "productId": "5fd78809-4700-46d7-8386-3b8738117f4d", "quantity": 1, "rate": { "cancelable": true, "code": "string", "cutoff": 1, "ext": { "string": "string" }, "holdable": true, "holdablePeriod": 1, "hours": [ { "dates": [ "2018-10-19T17:37:31-06:00" ], "daysOfWeek": [ 0 ], "times": [ { "close": 1020, "open": "08:00" } ], "timezone": "America/New_York", "valid": { "from": "2018-10-19T17:37:31-06:00", "until": "2018-10-19T17:37:31-06:00" } } ], "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "maxTravelers": 1, "minTravelers": 1, "name": "string", "optionId": "5fd78809-4700-46d7-8386-3b8738117f4d", "partnerId": "string", "prices": [ { "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "includedTaxes": [ { "currency": "USD", "id": "1", "name": "tourism tax", "net": 100, "retail": 100 } ], "labels": [ "string" ], "name": "Adult", "net": { "amount": 1, "currency": "USD" }, "original": { "amount": 1, "currency": "USD" }, "retail": { "amount": 1, "currency": "USD" }, "status": "ACTIVE", "travelerType": { "ageBand": "ADULT", "maxAge": 99, "minAge": 18, "modifier": "EU_CITIZEN", "name": "Adult" } } ], "productId": "5fd78809-4700-46d7-8386-3b8738117f4d", "refundable": true, "title": "string", "type": "FREESALE", "valid": { "from": "2018-10-19T17:37:31-06:00", "until": "2018-10-19T17:37:31-06:00" }, "version": 1 }, "rateId": "5fd78809-4700-46d7-8386-3b8738117f4d", "startTime": "2018-10-19T17:37:31-06:00", "status": "CANCELLED", "supplierId": "5fd78809-4700-46d7-8386-3b8738117f4d", "traveler": { "age": 35, "country": "USA", "email": "traveler@gmail.com", "firstName": "Jane", "gender": "MALE", "isLead": true, "lang": "DEU", "lastName": "Smith", "phone": "(1) 212 555-1234", "type": "ADULT" } } ], "partnerId": "string", "resellerBookingRef": "4AC773C0FF244aE", "status": "CANCELLED", "tickets": [ { "barcode": { "format": "CODE128", "value": "string" }, "bookingItemIds": [ "5fd78809-4700-46d7-8386-3b8738117f4d" ], "extensions": { "string": "string" }, "guests": [ { "count": 4, "typeCode": "ADULT", "typeModifier": "EU_CITIZEN", "typeName": "Adult" } ], "leadTraveler": { "age": 35, "country": "USA", "email": "traveler@gmail.com", "firstName": "Jane", "gender": "MALE", "isLead": true, "lang": "DEU", "lastName": "Smith", "phone": "(1) 212 555-1234", "type": "ADULT" }, "status": "CANCELLED" } ], "timeline": [ { "timestamp": "2018-10-19T17:37:31-06:00", "typeOf": "CANCELLED" } ], "version": 1 }, "meta": { "reqId": "5fd78809-4700-46d7-8386-3b8738117f4d" }}Cancel a booking
Cancels a booking.
| X | string | Request ID for request tracking. |
| booking | string |
curl --request PUT \ --url 'https://channel.redeam.io/v1.2/bookings/cancel/{booking_id}' \ --header 'X-Request-ID: {X-Request-ID}' \ --header 'X-API-Key: {X-API-Key}' \ --header 'X-API-Secret: {X-API-Secret}'Cancel a booking
| No response body |
Cancel a booking
Cancel a booking
Cancel a booking
Cancel a booking
No responseRetrieve a single booking
Returns a booking.
| X | string | Request ID for request tracking. |
| booking | string |
curl --get \ --url 'https://channel.redeam.io/v1.2/bookings/{booking_id}' \ --header 'X-Request-ID: {X-Request-ID}' \ --header 'X-API-Key: {X-API-Key}' \ --header 'X-API-Secret: {X-API-Secret}'Retrieve a single booking
| object | object | ||
| booking | object | The booking | |
| barcode | object | ||
| format | string | Format of the barcode Enum: | |
| value | string | Value of the barcode | |
| cancelable | boolean | True if the booking can be canceled. This value corresponds with the 'cancelable' status of the Rates in the Booking's Items. | |
| channelId | uuid | Channel ID requesting the booking | |
| customer | object | Customer for the booking | |
| string | Email address of the customer | ||
| firstName | string | First name of the customer | |
| lastName | string | Last name of the customer | |
| phone | string | Phone number of the customer | |
| ext | object | Extended data for the booking | |
| holdExt | object | Extended data for the hold associated with the booking | |
| holdId | uuid | Optional Hold ID | |
| id | uuid | ID of the booking. This field can optionally be provided on create. If a valid UUID is provided on create, it will be saved as the object's ID. Otherwise, the object will receive a generated ID. | |
| items | array[object] | Items for the booking | |
| availabilityId | uuid | ID of availability selection | |
| ext | object | Extended data for the booking item | |
| id | uuid | Booking Item ID. | |
| priceId | string | ID of price selection for the booking item. This must match one of the price IDs within the rate that is being used to create this booking | |
| productId | uuid | ID of product offering rate | |
| quantity | int32 | Quantity of the booking item | |
| rate | object | Rate selection for the booking item | |
| cancelable | boolean | Can a booking made with this rate be cancelled | |
| code | string | Short textual code representing the rate | |
| cutoff | int64 | The minimum interval (in minutes) between a booking's creation & start time | |
| ext | object | Extended data of the rate | |
| holdable | boolean | Can a hold be made against this rate | |
| holdablePeriod | int64 | The maximum interval (in seconds) between a hold's creation & expiration time | |
| hours | array[object] | Rules for specifying open hours for this rate | |
| dates | array[string] | Specific dates to which this rule applies | |
| daysOfWeek | array[integer] | Applicable days of week. 0 is undefined, 1 is Monday, etc | |
| times | array[object] | Open/Close times | |
| close | string | Close time in UTC, 24-hour time, with 'HH:mm' format pattern: | |
| open | string | Open time in UTC, 24-hour time, with 'HH:mm' format pattern: | |
| timezone | string | IANA timezone string. If empty, then the open and close times are interpreted as UTC. | |
| valid | object | Valid time range, if DaysOfWeek is specified | |
| from | date-time | Valid from time | |
| until | date-time | Valid until time | |
| id | uuid | ID of the rate. This field can optionally be provided on create. If a valid UUID is provided on create, it will be saved as the object's ID. Otherwise, the object will receive a generated ID. | |
| maxTravelers | int64 | Maximum number of travelers to qualify for this rate | |
| minTravelers | int64 | Minimum number of travelers to qualify for this rate. Must be at least 1. | |
| name | string | Human-friendly name for the rate | |
| optionId | uuid | An Option ID identifies a Rate as belonging to a given Product option. As an example, there could be five RESERVED Rates, one for each tour time, that are all grouped as part of a single Product option, and that are only represented by multiple Rates in order to separate their Availability capacities. | |
| partnerId | string | A Partner ID can be used to store a unique key in a partner's system. | |
| prices | array[object] | List of prices for this rate. | |
| id | uuid | ID of the rate price | |
| includedTaxes | array[object] | Portion of the Retail price dedicated to government taxes and fees. | |
| currency | string | ISO 4217 currency code, e.g.: USD, EUR, CHF pattern: | |
| id | string | ID of the included taxes entry (not required to be a UUID). | |
| name | string | Human-readable title of the included taxes entry | |
| net | int64 | Amount in cents (e.g. $1 USD == 100). | |
| retail | int64 | Amount in cents (e.g. $1 USD == 100). | |
| labels | array[string] | A list of filterable tags assigned to this price. Used in ChannelBindings (priceTags) to filter prices available by channel. | |
| name | string | Human-readable title of the RatePrice. | |
| net | object | The amount paid by a channel to the operator for a product. | |
| amount | int64 | Amount in cents | |
| currency | string | ISO 4217 currency code, e.g.: USD, EUR, CHF pattern: | |
| original | object | Operator's published price before discounts. | |
| amount | int64 | Amount in cents | |
| currency | string | ISO 4217 currency code, e.g.: USD, EUR, CHF pattern: | |
| retail | object | The amount paid by the traveler for a product. | |
| amount | int64 | Amount in cents | |
| currency | string | ISO 4217 currency code, e.g.: USD, EUR, CHF pattern: | |
| status | string | Determines if bound channels can list this price. Enum: | |
| travelerType | object | Structured description of the age, membership or role of the traveler this price is intended for. | |
| ageBand | string | Age band of the traveler type Enum: | |
| maxAge | int32 | Maximum age (inclusive) of the traveler type | |
| minAge | int32 | Minimum age (inclusive) of the traveler type | |
| modifier | string | Optional traveler modifier. For most use cases, this can be omitted or set to 'NONE'. Enum: | |
| name | string | Name of the traveler type, e.g. Diver, Observer, Adult, Military | |
| productId | uuid | ID of the owning product | |
| refundable | boolean | Can a booking made with this rate be refunded | |
| title | string | Display name for the rate | |
| type | string | Type of rate Enum: | |
| valid | object | Time range when this rate is valid | |
| from | date-time | Valid from time | |
| until | date-time | Valid until time | |
| version | int32 | Version of this object. Increments every update. | |
| rateId | uuid | Rate ID for the booking item Rate | |
| startTime | date-time | ||
| status | string | Status of the booking item Enum: | |
| supplierId | uuid | ID of supplier offering product | |
| traveler | object | Traveler for the booking item | |
| age | int32 | Age of the traveler | |
| country | string | Origin country of the traveler, as an ISO 3316-1 alpha-3 code pattern: | |
| string | Email address of the traveler | ||
| firstName | string | First name of the traveler | |
| gender | string | Gender of the traveler Enum: | |
| isLead | boolean | Indicates this traveler is lead or primary. Each booking must have exactly one. | |
| lang | string | Spoken language of the traveler, as an ISO 639-3 code pattern: | |
| lastName | string | Last name of the traveler | |
| phone | string | Phone number of the traveler pattern: | |
| type | string | Matches the Rate Price's travelerType ageBand | |
| partnerId | string | A Partner ID can be used to store a unique key in a partner's system. | |
| resellerBookingRef | string | Reseller reference ID for the booking | |
| status | string | Status of the booking Enum: | |
| tickets | array[object] | Tickets for the booking | |
| barcode | object | The barcode for this ticket. | |
| format | string | Format of the barcode Enum: | |
| value | string | Value of the barcode | |
| bookingItemIds | array[string] | One or more references to Booking Item IDs. | |
| extensions | object | ||
| guests | array[object] | The number of guests for this ticket. | |
| count | integer | Number of guests. | |
| typeCode | string | This should contain the Rate.Prices[].Traveler.AgeBand from the Price referenced by the Booking Item that corresponds to this ticket. | |
| typeModifier | string | This should contain the Rate.Prices[].Traveler.Modifier from the Price referenced by the Booking Item that corresponds to this ticket. Enum: | |
| typeName | string | This should contain the Rate.Prices[].Traveler.Name from the Price referenced by the Booking Item that corresponds to this ticket. | |
| leadTraveler | object | The lead traveler for this ticket. | |
| age | int32 | Age of the traveler | |
| country | string | Origin country of the traveler, as an ISO 3316-1 alpha-3 code pattern: | |
| string | Email address of the traveler | ||
| firstName | string | First name of the traveler | |
| gender | string | Gender of the traveler Enum: | |
| isLead | boolean | Indicates this traveler is lead or primary. Each booking must have exactly one. | |
| lang | string | Spoken language of the traveler, as an ISO 639-3 code pattern: | |
| lastName | string | Last name of the traveler | |
| phone | string | Phone number of the traveler pattern: | |
| type | string | Matches the Rate Price's travelerType ageBand | |
| status | string | Ticket status Enum: | |
| timeline | array[object] | Timeline of actions taken on the Booking. | |
| timestamp | date-time | ||
| typeOf | string | Enum: | |
| version | int32 | Internal version number | |
| meta | object | Request meta data | |
| reqId | uuid | Request ID |
Retrieve a single booking
Retrieve a single booking
{ "booking": { "barcode": { "format": "CODE128", "value": "string" }, "cancelable": true, "channelId": "5fd78809-4700-46d7-8386-3b8738117f4d", "customer": { "email": "customer@gmail.com", "firstName": "string", "lastName": "string", "phone": "(1) 212 555-1234" }, "ext": { "string": "string" }, "holdExt": { "string": "string" }, "holdId": "5fd78809-4700-46d7-8386-3b8738117f4d", "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "items": [ { "availabilityId": "5fd78809-4700-46d7-8386-3b8738117f4d", "ext": { "string": "string" }, "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "priceId": "string", "productId": "5fd78809-4700-46d7-8386-3b8738117f4d", "quantity": 1, "rate": { "cancelable": true, "code": "string", "cutoff": 1, "ext": { "string": "string" }, "holdable": true, "holdablePeriod": 1, "hours": [ { "dates": [ "2018-10-19T17:37:31-06:00" ], "daysOfWeek": [ 0 ], "times": [ { "close": 1020, "open": "08:00" } ], "timezone": "America/New_York", "valid": { "from": "2018-10-19T17:37:31-06:00", "until": "2018-10-19T17:37:31-06:00" } } ], "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "maxTravelers": 1, "minTravelers": 1, "name": "string", "optionId": "5fd78809-4700-46d7-8386-3b8738117f4d", "partnerId": "string", "prices": [ { "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "includedTaxes": [ { "currency": "USD", "id": "1", "name": "tourism tax", "net": 100, "retail": 100 } ], "labels": [ "string" ], "name": "Adult", "net": { "amount": 1, "currency": "USD" }, "original": { "amount": 1, "currency": "USD" }, "retail": { "amount": 1, "currency": "USD" }, "status": "ACTIVE", "travelerType": { "ageBand": "ADULT", "maxAge": 99, "minAge": 18, "modifier": "EU_CITIZEN", "name": "Adult" } } ], "productId": "5fd78809-4700-46d7-8386-3b8738117f4d", "refundable": true, "title": "string", "type": "FREESALE", "valid": { "from": "2018-10-19T17:37:31-06:00", "until": "2018-10-19T17:37:31-06:00" }, "version": 1 }, "rateId": "5fd78809-4700-46d7-8386-3b8738117f4d", "startTime": "2018-10-19T17:37:31-06:00", "status": "CANCELLED", "supplierId": "5fd78809-4700-46d7-8386-3b8738117f4d", "traveler": { "age": 35, "country": "USA", "email": "traveler@gmail.com", "firstName": "Jane", "gender": "MALE", "isLead": true, "lang": "DEU", "lastName": "Smith", "phone": "(1) 212 555-1234", "type": "ADULT" } } ], "partnerId": "string", "resellerBookingRef": "4AC773C0FF244aE", "status": "CANCELLED", "tickets": [ { "barcode": { "format": "CODE128", "value": "string" }, "bookingItemIds": [ "5fd78809-4700-46d7-8386-3b8738117f4d" ], "extensions": { "string": "string" }, "guests": [ { "count": 4, "typeCode": "ADULT", "typeModifier": "EU_CITIZEN", "typeName": "Adult" } ], "leadTraveler": { "age": 35, "country": "USA", "email": "traveler@gmail.com", "firstName": "Jane", "gender": "MALE", "isLead": true, "lang": "DEU", "lastName": "Smith", "phone": "(1) 212 555-1234", "type": "ADULT" }, "status": "CANCELLED" } ], "timeline": [ { "timestamp": "2018-10-19T17:37:31-06:00", "typeOf": "CANCELLED" } ], "version": 1 }, "meta": { "reqId": "5fd78809-4700-46d7-8386-3b8738117f4d" }}Holds
Acquire a hold
Acquires a hold.
| X | string | Request ID for request tracking. |
| object | object | ||
| hold | object | ||
| expires | date-time | Datetime of hold expiration | |
| ext | object | Extended data for the hold | |
| id | uuid | ID of the hold. This field can optionally be provided on create. If a valid UUID is provided on create, it will be saved as the object's ID. Otherwise, the object will receive a generated ID. | |
| items | array[object] | Items in the hold | |
| at | date-time | Availability time for the Hold item | |
| availabilityId | string | Availability selection for the Hold item | |
| ext | object | Extended data for the Hold item | |
| id | uuid | A unique identifier for this HoldItem | |
| priceId | string | ID of price selection for the booking item. This must match one of the price IDs within the rate that is being used to create this hold | |
| productId | uuid | Product selection for the Hold item | |
| quantity | int32 | Amount of item to hold | |
| rateId | uuid | Rate ID for the hold item Rate | |
| supplierId | uuid | Supplier offering the product | |
| travelerType | string | Traveler type for the Hold item Enum: | |
| partnerId | string | A Partner ID can be used to store a unique key in a partner's system. | |
| meta | object | Request meta data | |
| reqId | uuid | Request ID |
curl --request POST \ --url 'https://channel.redeam.io/v1.2/holds' \ --header 'X-Request-ID: {X-Request-ID}' \ --header 'X-API-Key: {X-API-Key}' \ --header 'X-API-Secret: {X-API-Secret}' \ --data '{ "hold": { "expires": "2018-10-19T17:37:31-06:00", "ext": { "string": "string" }, "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "items": [ { "at": "2018-10-19T17:37:31-06:00", "availabilityId": "string", "ext": { "string": "string" }, "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "priceId": "string", "productId": "5fd78809-4700-46d7-8386-3b8738117f4d", "quantity": 1, "rateId": "5fd78809-4700-46d7-8386-3b8738117f4d", "supplierId": "5fd78809-4700-46d7-8386-3b8738117f4d", "travelerType": "ANY" } ], "partnerId": "string" }, "meta": { "reqId": "5fd78809-4700-46d7-8386-3b8738117f4d" }}'Acquire a hold
| object | object | ||
| hold | object | ||
| expires | date-time | Datetime of hold expiration | |
| ext | object | Extended data for the hold | |
| id | uuid | ID of the hold. This field can optionally be provided on create. If a valid UUID is provided on create, it will be saved as the object's ID. Otherwise, the object will receive a generated ID. | |
| items | array[object] | Items in the hold | |
| at | date-time | Availability time for the Hold item | |
| availabilityId | string | Availability selection for the Hold item | |
| ext | object | Extended data for the Hold item | |
| id | uuid | A unique identifier for this HoldItem | |
| priceId | string | ID of price selection for the booking item. This must match one of the price IDs within the rate that is being used to create this hold | |
| productId | uuid | Product selection for the Hold item | |
| quantity | int32 | Amount of item to hold | |
| rate | object | Rate selection for the Hold item | |
| cancelable | boolean | Can a booking made with this rate be cancelled | |
| code | string | Short textual code representing the rate | |
| cutoff | int64 | The minimum interval (in minutes) between a booking's creation & start time | |
| ext | object | Extended data of the rate | |
| holdable | boolean | Can a hold be made against this rate | |
| holdablePeriod | int64 | The maximum interval (in seconds) between a hold's creation & expiration time | |
| hours | array[object] | Rules for specifying open hours for this rate | |
| dates | array[string] | Specific dates to which this rule applies | |
| daysOfWeek | array[integer] | Applicable days of week. 0 is undefined, 1 is Monday, etc | |
| times | array[object] | Open/Close times | |
| close | string | Close time in UTC, 24-hour time, with 'HH:mm' format pattern: | |
| open | string | Open time in UTC, 24-hour time, with 'HH:mm' format pattern: | |
| timezone | string | IANA timezone string. If empty, then the open and close times are interpreted as UTC. | |
| valid | object | Valid time range, if DaysOfWeek is specified | |
| from | date-time | Valid from time | |
| until | date-time | Valid until time | |
| id | uuid | ID of the rate. This field can optionally be provided on create. If a valid UUID is provided on create, it will be saved as the object's ID. Otherwise, the object will receive a generated ID. | |
| maxTravelers | int64 | Maximum number of travelers to qualify for this rate | |
| minTravelers | int64 | Minimum number of travelers to qualify for this rate. Must be at least 1. | |
| name | string | Human-friendly name for the rate | |
| optionId | uuid | An Option ID identifies a Rate as belonging to a given Product option. As an example, there could be five RESERVED Rates, one for each tour time, that are all grouped as part of a single Product option, and that are only represented by multiple Rates in order to separate their Availability capacities. | |
| partnerId | string | A Partner ID can be used to store a unique key in a partner's system. | |
| prices | array[object] | List of prices for this rate. | |
| id | uuid | ID of the rate price | |
| includedTaxes | array[object] | Portion of the Retail price dedicated to government taxes and fees. | |
| currency | string | ISO 4217 currency code, e.g.: USD, EUR, CHF pattern: | |
| id | string | ID of the included taxes entry (not required to be a UUID). | |
| name | string | Human-readable title of the included taxes entry | |
| net | int64 | Amount in cents (e.g. $1 USD == 100). | |
| retail | int64 | Amount in cents (e.g. $1 USD == 100). | |
| labels | array[string] | A list of filterable tags assigned to this price. Used in ChannelBindings (priceTags) to filter prices available by channel. | |
| name | string | Human-readable title of the RatePrice. | |
| net | object | The amount paid by a channel to the operator for a product. | |
| amount | int64 | Amount in cents | |
| currency | string | ISO 4217 currency code, e.g.: USD, EUR, CHF pattern: | |
| original | object | Operator's published price before discounts. | |
| amount | int64 | Amount in cents | |
| currency | string | ISO 4217 currency code, e.g.: USD, EUR, CHF pattern: | |
| retail | object | The amount paid by the traveler for a product. | |
| amount | int64 | Amount in cents | |
| currency | string | ISO 4217 currency code, e.g.: USD, EUR, CHF pattern: | |
| status | string | Determines if bound channels can list this price. Enum: | |
| travelerType | object | Structured description of the age, membership or role of the traveler this price is intended for. | |
| ageBand | string | Age band of the traveler type Enum: | |
| maxAge | int32 | Maximum age (inclusive) of the traveler type | |
| minAge | int32 | Minimum age (inclusive) of the traveler type | |
| modifier | string | Optional traveler modifier. For most use cases, this can be omitted or set to 'NONE'. Enum: | |
| name | string | Name of the traveler type, e.g. Diver, Observer, Adult, Military | |
| productId | uuid | ID of the owning product | |
| refundable | boolean | Can a booking made with this rate be refunded | |
| title | string | Display name for the rate | |
| type | string | Type of rate Enum: | |
| valid | object | Time range when this rate is valid | |
| from | date-time | Valid from time | |
| until | date-time | Valid until time | |
| version | int32 | Version of this object. Increments every update. | |
| rateId | uuid | Rate ID for the hold item Rate | |
| supplierId | uuid | Supplier offering the product | |
| travelerType | string | Traveler type for the Hold item Enum: | |
| partnerId | string | A Partner ID can be used to store a unique key in a partner's system. | |
| retrieved | date-time | Datetime of retrieval | |
| status | string | Status of the hold Enum: | |
| timeline | array[object] | Timeline of actions taken on the Hold. | |
| timestamp | date-time | ||
| typeOf | string | Enum: | |
| meta | object | Request meta data | |
| reqId | uuid | Request ID |
Acquire a hold
Acquire a hold
Acquire a hold
Acquire a hold
{ "hold": { "expires": "2018-10-19T17:37:31-06:00", "ext": { "string": "string" }, "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "items": [ { "at": "2018-10-19T17:37:31-06:00", "availabilityId": "string", "ext": { "string": "string" }, "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "priceId": "string", "productId": "5fd78809-4700-46d7-8386-3b8738117f4d", "quantity": 1, "rate": { "cancelable": true, "code": "string", "cutoff": 1, "ext": { "string": "string" }, "holdable": true, "holdablePeriod": 1, "hours": [ { "dates": [ "2018-10-19T17:37:31-06:00" ], "daysOfWeek": [ 0 ], "times": [ { "close": 1020, "open": "08:00" } ], "timezone": "America/New_York", "valid": { "from": "2018-10-19T17:37:31-06:00", "until": "2018-10-19T17:37:31-06:00" } } ], "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "maxTravelers": 1, "minTravelers": 1, "name": "string", "optionId": "5fd78809-4700-46d7-8386-3b8738117f4d", "partnerId": "string", "prices": [ { "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "includedTaxes": [ { "currency": "USD", "id": "1", "name": "tourism tax", "net": 100, "retail": 100 } ], "labels": [ "string" ], "name": "Adult", "net": { "amount": 1, "currency": "USD" }, "original": { "amount": 1, "currency": "USD" }, "retail": { "amount": 1, "currency": "USD" }, "status": "ACTIVE", "travelerType": { "ageBand": "ADULT", "maxAge": 99, "minAge": 18, "modifier": "EU_CITIZEN", "name": "Adult" } } ], "productId": "5fd78809-4700-46d7-8386-3b8738117f4d", "refundable": true, "title": "string", "type": "FREESALE", "valid": { "from": "2018-10-19T17:37:31-06:00", "until": "2018-10-19T17:37:31-06:00" }, "version": 1 }, "rateId": "5fd78809-4700-46d7-8386-3b8738117f4d", "supplierId": "5fd78809-4700-46d7-8386-3b8738117f4d", "travelerType": "ANY" } ], "partnerId": "string", "retrieved": "2018-10-19T17:37:31-06:00", "status": "ACTIVE", "timeline": [ { "timestamp": "2018-10-19T17:37:31-06:00", "typeOf": "CANCELLED" } ] }, "meta": { "reqId": "5fd78809-4700-46d7-8386-3b8738117f4d" }}Release a hold
Releases a hold.
| X | string | Request ID for request tracking. |
| hold | string |
curl --request DELETE \ --url 'https://channel.redeam.io/v1.2/holds/{hold_id}' \ --header 'X-Request-ID: {X-Request-ID}' \ --header 'X-API-Key: {X-API-Key}' \ --header 'X-API-Secret: {X-API-Secret}'Release a hold
| No response body |
Release a hold
Release a hold
No responseRetrieve a hold
Returns a hold.
| X | string | Request ID for request tracking. |
| hold | string |
curl --get \ --url 'https://channel.redeam.io/v1.2/holds/{hold_id}' \ --header 'X-Request-ID: {X-Request-ID}' \ --header 'X-API-Key: {X-API-Key}' \ --header 'X-API-Secret: {X-API-Secret}'Retrieve a hold
| object | object | ||
| hold | object | ||
| expires | date-time | Datetime of hold expiration | |
| ext | object | Extended data for the hold | |
| id | uuid | ID of the hold. This field can optionally be provided on create. If a valid UUID is provided on create, it will be saved as the object's ID. Otherwise, the object will receive a generated ID. | |
| items | array[object] | Items in the hold | |
| at | date-time | Availability time for the Hold item | |
| availabilityId | string | Availability selection for the Hold item | |
| ext | object | Extended data for the Hold item | |
| id | uuid | A unique identifier for this HoldItem | |
| priceId | string | ID of price selection for the booking item. This must match one of the price IDs within the rate that is being used to create this hold | |
| productId | uuid | Product selection for the Hold item | |
| quantity | int32 | Amount of item to hold | |
| rate | object | Rate selection for the Hold item | |
| cancelable | boolean | Can a booking made with this rate be cancelled | |
| code | string | Short textual code representing the rate | |
| cutoff | int64 | The minimum interval (in minutes) between a booking's creation & start time | |
| ext | object | Extended data of the rate | |
| holdable | boolean | Can a hold be made against this rate | |
| holdablePeriod | int64 | The maximum interval (in seconds) between a hold's creation & expiration time | |
| hours | array[object] | Rules for specifying open hours for this rate | |
| dates | array[string] | Specific dates to which this rule applies | |
| daysOfWeek | array[integer] | Applicable days of week. 0 is undefined, 1 is Monday, etc | |
| times | array[object] | Open/Close times | |
| close | string | Close time in UTC, 24-hour time, with 'HH:mm' format pattern: | |
| open | string | Open time in UTC, 24-hour time, with 'HH:mm' format pattern: | |
| timezone | string | IANA timezone string. If empty, then the open and close times are interpreted as UTC. | |
| valid | object | Valid time range, if DaysOfWeek is specified | |
| from | date-time | Valid from time | |
| until | date-time | Valid until time | |
| id | uuid | ID of the rate. This field can optionally be provided on create. If a valid UUID is provided on create, it will be saved as the object's ID. Otherwise, the object will receive a generated ID. | |
| maxTravelers | int64 | Maximum number of travelers to qualify for this rate | |
| minTravelers | int64 | Minimum number of travelers to qualify for this rate. Must be at least 1. | |
| name | string | Human-friendly name for the rate | |
| optionId | uuid | An Option ID identifies a Rate as belonging to a given Product option. As an example, there could be five RESERVED Rates, one for each tour time, that are all grouped as part of a single Product option, and that are only represented by multiple Rates in order to separate their Availability capacities. | |
| partnerId | string | A Partner ID can be used to store a unique key in a partner's system. | |
| prices | array[object] | List of prices for this rate. | |
| id | uuid | ID of the rate price | |
| includedTaxes | array[object] | Portion of the Retail price dedicated to government taxes and fees. | |
| currency | string | ISO 4217 currency code, e.g.: USD, EUR, CHF pattern: | |
| id | string | ID of the included taxes entry (not required to be a UUID). | |
| name | string | Human-readable title of the included taxes entry | |
| net | int64 | Amount in cents (e.g. $1 USD == 100). | |
| retail | int64 | Amount in cents (e.g. $1 USD == 100). | |
| labels | array[string] | A list of filterable tags assigned to this price. Used in ChannelBindings (priceTags) to filter prices available by channel. | |
| name | string | Human-readable title of the RatePrice. | |
| net | object | The amount paid by a channel to the operator for a product. | |
| amount | int64 | Amount in cents | |
| currency | string | ISO 4217 currency code, e.g.: USD, EUR, CHF pattern: | |
| original | object | Operator's published price before discounts. | |
| amount | int64 | Amount in cents | |
| currency | string | ISO 4217 currency code, e.g.: USD, EUR, CHF pattern: | |
| retail | object | The amount paid by the traveler for a product. | |
| amount | int64 | Amount in cents | |
| currency | string | ISO 4217 currency code, e.g.: USD, EUR, CHF pattern: | |
| status | string | Determines if bound channels can list this price. Enum: | |
| travelerType | object | Structured description of the age, membership or role of the traveler this price is intended for. | |
| ageBand | string | Age band of the traveler type Enum: | |
| maxAge | int32 | Maximum age (inclusive) of the traveler type | |
| minAge | int32 | Minimum age (inclusive) of the traveler type | |
| modifier | string | Optional traveler modifier. For most use cases, this can be omitted or set to 'NONE'. Enum: | |
| name | string | Name of the traveler type, e.g. Diver, Observer, Adult, Military | |
| productId | uuid | ID of the owning product | |
| refundable | boolean | Can a booking made with this rate be refunded | |
| title | string | Display name for the rate | |
| type | string | Type of rate Enum: | |
| valid | object | Time range when this rate is valid | |
| from | date-time | Valid from time | |
| until | date-time | Valid until time | |
| version | int32 | Version of this object. Increments every update. | |
| rateId | uuid | Rate ID for the hold item Rate | |
| supplierId | uuid | Supplier offering the product | |
| travelerType | string | Traveler type for the Hold item Enum: | |
| partnerId | string | A Partner ID can be used to store a unique key in a partner's system. | |
| retrieved | date-time | Datetime of retrieval | |
| status | string | Status of the hold Enum: | |
| timeline | array[object] | Timeline of actions taken on the Hold. | |
| timestamp | date-time | ||
| typeOf | string | Enum: | |
| meta | object | Request meta data | |
| reqId | uuid | Request ID |
Retrieve a hold
Retrieve a hold
{ "hold": { "expires": "2018-10-19T17:37:31-06:00", "ext": { "string": "string" }, "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "items": [ { "at": "2018-10-19T17:37:31-06:00", "availabilityId": "string", "ext": { "string": "string" }, "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "priceId": "string", "productId": "5fd78809-4700-46d7-8386-3b8738117f4d", "quantity": 1, "rate": { "cancelable": true, "code": "string", "cutoff": 1, "ext": { "string": "string" }, "holdable": true, "holdablePeriod": 1, "hours": [ { "dates": [ "2018-10-19T17:37:31-06:00" ], "daysOfWeek": [ 0 ], "times": [ { "close": 1020, "open": "08:00" } ], "timezone": "America/New_York", "valid": { "from": "2018-10-19T17:37:31-06:00", "until": "2018-10-19T17:37:31-06:00" } } ], "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "maxTravelers": 1, "minTravelers": 1, "name": "string", "optionId": "5fd78809-4700-46d7-8386-3b8738117f4d", "partnerId": "string", "prices": [ { "id": "5fd78809-4700-46d7-8386-3b8738117f4d", "includedTaxes": [ { "currency": "USD", "id": "1", "name": "tourism tax", "net": 100, "retail": 100 } ], "labels": [ "string" ], "name": "Adult", "net": { "amount": 1, "currency": "USD" }, "original": { "amount": 1, "currency": "USD" }, "retail": { "amount": 1, "currency": "USD" }, "status": "ACTIVE", "travelerType": { "ageBand": "ADULT", "maxAge": 99, "minAge": 18, "modifier": "EU_CITIZEN", "name": "Adult" } } ], "productId": "5fd78809-4700-46d7-8386-3b8738117f4d", "refundable": true, "title": "string", "type": "FREESALE", "valid": { "from": "2018-10-19T17:37:31-06:00", "until": "2018-10-19T17:37:31-06:00" }, "version": 1 }, "rateId": "5fd78809-4700-46d7-8386-3b8738117f4d", "supplierId": "5fd78809-4700-46d7-8386-3b8738117f4d", "travelerType": "ANY" } ], "partnerId": "string", "retrieved": "2018-10-19T17:37:31-06:00", "status": "ACTIVE", "timeline": [ { "timestamp": "2018-10-19T17:37:31-06:00", "typeOf": "CANCELLED" } ] }, "meta": { "reqId": "5fd78809-4700-46d7-8386-3b8738117f4d" }}