Deals allow for special pricing and free items to be offered to patrons during their order flow. Deals may be automatically applied to an in-progress order, depending on its contents and other conditions.
The table below displays the supported and unsupported deals, as per the current capabilities of OCAPI.
| Deals type | Feature description/examples | Supported |
|---|---|---|
| Volume discount | Buy 1 item for $2.00, 2 for $3.50, 3 for $5.00, etc | ✓ |
| Minimum spend deal | Spend $10.00 or more to unlock a deal | ✓ |
| Price reduction to a different item | Buy one item, get a different item for a discounted price | ✓ |
| Price reduction to an additional item | Buy one, get one (BOGO) free or at discounted price | ✓ |
| Offering discounted item as a deal | If an item has a discount, choose to offer it as a deal or not | ✓ |
| Item price-off deal | Get a free small popcorn with an optional upgrade for discounted price | ✓ |
| Deals exclusive to vouchers | Deals only available with an appropriate voucher | ✓ |
| Deals exclusive to loyalty rewards | Deals only available with a loyalty member reward | ✓ |
| Credit card deals | Deals only available with a certain credit card brand | ✗ |
| Deal triggers | Configurable triggers for suggesting deals | ✗ |
| Manually selected deals | Selecting a deal other than the deal automatically selected by OCAPI | ✗ |
| Double dealing | Applying more than one deal to a single item | ✗ |
| Season pass deals | Special pricing when tickets are purchased for multiple showtimes | ✗ |
OCAPI will automatically apply any available deals as an in-progress order is populated (e.g. by adding tickets and/or items).
If multiple deals are available, OCAPI will apply the single deal, or combination of deals, that provides the highest savings to the patron. The amountSaved property of each order line reflects the price reduction that was applied by the deal, and the dealId property indicates the unique identifier of the deal that was applied.
The totalPrice of the order will reflect the total price to be paid, taking into account the saving from any applied deals.
Deals are recalculated whenever an order's contents are modified. Deals apply to individual order lines, not the entire order. Consequently, if a ticket or item is removed from the order, the associated deal may also be removed.
OCAPI does not currently return suggested deals.
Deals restricted to Loyalty member rewards are supported by OCAPI. However, the following criteria need to be met before OCAPI can apply these deals:
- A loyalty member must be authenticated.
- The loyalty member must have the reward available to them and must meet the criteria for them to redeem the reward.
- The deal can only be applied as many times as the member can afford the points cost or within the per-order limits configured for reward.
Deals exclusive to a voucher are supported by OCAPI. The voucher must be configured as a miscellaneous voucher, and the deal should be configured to be exclusive to this voucher.
The type must be set to "Deal" when the deal voucher is added by the AddVoucher endpoint.
To apply the deal, specify the voucher's barcode (and PIN if necessary) when calling the AddVoucher endpoint. Remember, although applying the voucher activates the deal, the items/tickets eligible for the deal must still be added to the order separately.
{
"type": "Deal",
"credentials": {
"barcode": "MISCD00000361196",
"pin": "1234"
}
}The details of the added voucher and the available redemptions will be returned in the response.
{
"voucher": {
"id": "92acebfb60e64330aa204720279f2477",
"type": "Deal",
"maskedBarcode": "............1196",
"voucherTypeCode": "string",
"voucherTypeDescription": {
"text": "string",
"translations": []
}
},
"availableRedemptions": 1
}The GetOrder endpoint will reflect the added voucher and applied deal in the response.