Promotions¶

How Promotions Affect Departures¶

Promotions are tightly coupled with Departures. In the majority of cases, a Promotion will be displayed in-line within the Departure object, within its price_bands. To highlight the primary scenarios and ones you should consider, we’ve provided the following table:

Of course, in all cases, webhooks are delivered for changes to the representation of the departure and promotion resources.

Applying Promotions To Departure Services¶

If the promotion has the flag APPLY_AUTOMATICALLY, this promotion will – as the name suggests – apply to the booked service(s) automatically. Otherwise, you may apply the promotion when creating a service, like so:

{
    "booking": { "id": BOOKING_ID },
    "product": { "id": PRODUCT_ID },
    "customers": [
        { "id" : CUSTOMER_ID }
    ],
    "applied_promotion": {
        "id": PROMOTION_ID
    }
}

Reference our Creating Your First Booking tutorial on how to create a Departure Services resource

Promotion Flags¶

As Promotions can be complex, we have provided this table to further elaborate what is displayed in the flags attribute on each Promotion.

Understanding sale and product dates¶

You will notice the Promotion resource has a couple of pairs of attributes around start and finish dates. They are: sale_start_date, sale_finish_date, and product_start_date, product_finish_date.

It’s important to understand how these affect the products listed within the resource. The sale_start_date and sale_finish_date pair identify when the promotion can be applied. The promotion cannot be applied unless the current date is between those two days.

Along side this, there are product_start_date and product_finish_date, which narrow down what products are applicable for the promotion. For a promotion to be applicable to a product, the product’s start_date must fall between these two dates. (This is an inclusive date range)

To clarify this, an example might look like this:

{
    "sale_start_date": "2015-06-30",
    "sale_finish_date": "2015-07-31",
    "product_start_date": "2015-07-01",
    "product_finish_date": "2016-03-31"
}

First, this means that if the product’s start or finish date is outside of the product_[start|finish]_date, then the Promotion cannot be applied for that product. Additionally, the promotion must be applied between the sale_[start|finish]_date range, otherwise it will be handled as invalid.

XML Schema:

• promotions.xsd

Fields

Get a Promotion

GET /promotions/(string: promotion_id)¶

List Public Promotions

GET /promotions/¶