Accommodations¶
This resource represents an accommodation product at a particular location. The accommodation product is a pre-tour or post-tour hotel accommodation, before the start of a departure or at the end of a departure. Accommodations are booked as add-ons to a departure. An accommodation has a one-to-one relationship with an accommodation dossier.
XML Schema:
Resource Definition¶
Note
This resource can be searched, allowing to you to access a filtered set of data. See our Searching The G API documentation for details on how to query specific fields and the operators available.
Fields
Name |
Type |
Description |
---|---|---|
id read-only |
String |
|
href read-only |
Field |
|
date_created |
Datetime |
The time when the resource was created, in the standard Dates & Times. |
date_last_modified |
Datetime |
The time when the resource was last modified, in the standard Dates & Times. |
name required |
String |
The name of this resource. |
product_line required |
String |
A 1 to 10 character sequence for the tour associated wih this product. |
sku required |
String |
A unique code for this product. The first 3 letters represent the brochure code. The next 1 to 10 characters represent the dossier code. The following 6 digits represent the start date of the product, in the format %YY%mm%dd. The final 3 characters represent the product instance code, for cases where there are multiple products of the same tour on the same day. |
booking_companies read-only |
Field |
The booking_company that own this product, and are in charge of its inventory and sale. |
|
String |
|
|
Field |
|
|
String |
Company name |
type required |
String |
The type of this resource. |
sub_type required |
String |
A brief description of the type of product. |
address required |
Nested Object |
Location information for the product. |
|
String |
Street of this location. |
|
String |
City of this location. |
|
Nested Object |
Country resource associated with this location. |
|
String |
|
|
Field |
|
|
String |
|
|
String |
The postal/zip code of this location. |
|
Decimal |
A geographic coordinate that specifies the north-south position of a point on the Earth’s surface (valid values range from -90.0 to 90.0) |
|
Decimal |
A geographic coordinate that specifies the east-west position of a point on the Earth’s surface (valid values range from -180.0 to 180.0) |
rooms required |
Field |
A list of available rooming options. |
|
String |
A unique code for this room that is used when creating a booking. This code will never change and can be used as an identifier. |
|
String |
The name of this room. |
|
Integer |
The minimum number of nights that can be booked for this room option on this accommodation to receive this price option. |
|
Integer |
The minimum number of nights that can be booked for this room option on this accommodation to receive this price option. |
|
Nested Object |
Availability information for this room option of this product. See our availability reference here: Availability. |
|
String |
The availability status indicates whether or not this room option on this product can be booked, as well as the resulting status of a booked service on this product. A list of availability statuses can be found here: Availability |
|
Integer |
The total number of available spaces for this room option on this product. This includes male/female-only spaces. |
|
Field |
|
|
String |
A unique code for this Pricing option. Possible values are: ‘ANY’, ‘ADULT’, ‘CHILD’, ‘INFANT’.This code will never change and can be used as an identifier. |
|
String |
The name of this Pricing option. This is usually a string representation of the minimum/maximum ages for this Pricing option (e.g. Adult, Child, Infant, etc). |
|
Integer |
The minimum number of travellers that must book this room option on this product to receive this Pricing option. |
|
Integer |
The maximum number of travellers that can book this room option on this product to receive this Pricing option. |
|
Integer |
The minimum age of a traveller (on the start date of this product) that can receive this Pricing option. |
|
Integer |
The maximum age of a traveller (on the start date of this product) that can receive this Pricing option. |
|
Field |
The prices for this price_band. |
|
String |
The currency ISO code, in the standard Currencies & Prices. |
|
Decimal |
The amount for this Pricing option, in the standard Currencies & Prices. |
|
Decimal |
The deposit amount needed as a payment before a booked service on this product and Pricing option can be confirmed, in the standard Currencies & Prices. |
|
Field |
A list of promotions associated with this product. As expected, a promotions Webhooks will fire when it is modified. Clients should then iterate through the list of promotion ‘products’ in order to pull new promotional pricing data. The best promotions (largest discount) are displayed first. |
|
String |
|
|
Field |
|
|
Decimal |
The promotion amount for this Pricing option, in the standard Currencies & Prices. |
|
Field |
The date range for which this room/Pricing option on this product can be booked. |
|
Date |
The inclusive start date of the range for which this room/Pricing option on this product can be booked. |
|
Date |
The inclusive finish date of the range for which this room/Pricing option on this product can be booked. |
|
Field |
The blackout date range for which this room/Pricing option on this product can NOT be booked. |
|
Date |
The inclusive blackout start date of the range for which this room/Pricing option on this product can NOT be booked. |
|
Date |
The inclusive blackout finish date of the range for which this room/Pricing option on this product can NOT be booked. |
|
String |
A brief description of the class or comfort level of the accommodation. |
phone_numbers required |
Field |
Telephone number information. |
|
String |
A telephone number. No specific format. |
|
String |
A brief description of the type of telephone number. Must be one of:
[ |
accommodation_dossier read-only |
Reference Object |
The related accommodation dossier resource. |
Get an Accommodation
- GET /accommodations/(string: accommodation_id)¶
List Accommodations
- GET /accommodations/¶