Introduction

Merchandise¶

This resource represents a merchandise product. Usually these merchandise will occur during a departure. An example of an merchandise is a parka. Merchandise are booked as add-ons to a departure.

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.
id read-only	String
href read-only	Field
name read-only	String	Company name
start_date required	Date	The date this product begins, in the standard Dates & Times.
finish_date required	Date	The date this product ends, in the standard Dates & Times.
type required	String	The type of this resource.
sub_type required	String	A brief description of the type of product.
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 & Prices.
amount required	Decimal	The amount for this Pricing option, in the standard Currencies & Prices.
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 & Prices.
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 & Prices.

Get a Merchandise¶

GET /merchandise/(string: merchandise_id)¶