Single Supplements

This resource represents an optional surcharge product that can be added to the cost for a traveller to have their own room when prices are based on double occupancy. On a land-based departure, this allows a single traveller to have accommodation during the departure to themselves, instead of being partnered with another single traveller for the standard shared-basis accommodations. On certain departures there are exemption nights that are identified in the body details of the associated tour_dossier.

Similarly, on a non land-based departure this allows a single traveller to book an entire cabin to themselves. Single supplements are booked as add-ons to a departure.

If there is no single supplement available for the related departure, then that tour only offers shared accommodations, and that should be made apparent to the customer.

XML Schema:

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  
name required String The name of this resource.
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.
type required String The type of this resource.
sub_type required String A brief description of the type of product.
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.
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.
start_date required Date The date this product begins, in the standard dates-time.
finish_date required Date The date this product ends, in the standard dates-time.
departure read-only Nested Object The related departures resource.
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

Get a Single Supplement

GET /single_supplements/(string: single_supplement_id)