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 Defintion

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-time.
date_last_modified Datetime The time when the resource was last modified, in the standard dates-time.
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 companies that own this product, and are in charge of its inventory and sale.
  • id read-only
 String  
  • href read-only
 Field  
  • name read-only
 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.
  • street required
 String Street of this location.
  • city required
 String City of this location.
  • country required
 Nested Object Country resource associated with this location.
    • id read-only
 String  
    • href read-only
 Field  
    • name
 String  
  • postal_zip required
 String The postal/zip code of this location.
  • latitude
 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)
  • longitude
 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.
  • code required
 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.
  • name required
 String The name of this room.
  • min_nights required
 Integer The minimum number of nights that can be booked for this room option on this accommodation to receive this price option.
  • max_nights required
 Integer The minimum number of nights that can be booked for this room option on this accommodation to receive this price option.
  • availability required
 Nested Object Availability information for this room option of this product. See our availability reference here: Availability.
    • status required
 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
    • total required
 Integer The total number of available spaces for this room option on this product. This includes male/female-only spaces.
  • price_bands required
 Field Pricing information for this room option on this product.
    • code required
 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.
    • name required
 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).
    • min_travellers required
 Integer The minimum number of travellers that must book this room option on this product to receive this Pricing option.
    • max_travellers required
 Integer The maximum number of travellers that can book this room option on this product to receive this Pricing option.
    • min_age required
 Integer The minimum age of a traveller (on the start date of this product) that can receive this Pricing option.
    • max_age required
 Integer The maximum age of a traveller (on the start date of this product) that can receive this Pricing option.
    • prices required
 Field The prices for this price_band.
      • currency required
 String The currency ISO code, in the standard currencies.
      • amount required
 Decimal The amount for this Pricing option, in the standard currencies.
      • deposit required
 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.
      • promotions required
 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.
        • id read-only
 String  
        • href read-only
 Field  
        • amount required
 Decimal The promotion amount for this Pricing option, in the standard currencies.
    • season_dates required
 Field The date range for which this room/Pricing option on this product can be booked.
      • start_date required
 Date The inclusive start date of the range for which this room/Pricing option on this product can be booked.
      • finish_date required
 Date The inclusive finish date of the range for which this room/Pricing option on this product can be booked.
    • blackout_dates required
 Field The blackout date range for which this room/Pricing option on this product can NOT be booked.
      • start_date required
 Date The inclusive blackout start date of the range for which this room/Pricing option on this product can NOT be booked.
      • finish_date required
 Date The inclusive blackout finish date of the range for which this room/Pricing option on this product can NOT be booked.
  • class required
 String A brief description of the class or comfort level of the accommodation.
phone_numbers required Field Telephone number information.
  • number required
 String A telephone number. No specific format.
  • type required
 String A brief description of the type of telephone number. Must be one of: [Home, Business, Cell, Fax]
accommodation_dossier read-only Reference Object The related accommodation_dossier resource.

Get an Accommodation

GET /accommodations/(string: accommodation_id)

List Accommodations

GET /accommodations/