Order Data Model

Order Structure

Basket Items

Each item in the order contains:

Field	Type	Description
productId	string	The product ID in your system (the integrator's product ID).
unitPrice	number	Unit price of the product (excluding modifiers).
discount	number	Discount applied by Cheers to this product.
externalPayment	number	Amount to be collected outside the Cheers system.
vat	number	VAT rate (e.g. 27).
isTakeaway	boolean	Whether the item is marked as takeaway.
modifiers	array	Add-ons/extras (e.g. "extra lemon", "no ice").

Product ID Mapping

The productId in the order matches the product ID in your external system -- no mapping is required. This is the same ID you provided during product synchronization.

Modifiers

Modifiers follow the same price structure as basket items:

Field	Type	Description
productId	string	The modifier product ID in your system.
unitPrice	number	Unit price of the modifier.
discount	number	Discount applied to this modifier.
externalPayment	number	External payment amount for this modifier.
vat	number	VAT rate.

Tip

Field	Description
tip	Total tip amount.
externalPayment	Portion of the tip to be collected externally.

Delivery Option

Present when the order includes delivery.

Field	Description
deliveryOptionFee	The delivery fee amount.
externalPayment	Portion of the fee to be collected externally.
vat	VAT rate for the delivery fee.
type	CUSTOM, TAKEAWAY, or HOME_DELIVERY.

Invoicing Types

Type	Description
PLACE_RECEIPT	The venue issues a receipt.
PLACE_INVOICE	The venue issues an invoice.
CHEERS_INVOICE	Cheers issues the invoice.

Supported combinations:

• PLACE_RECEIPT alone
• PLACE_INVOICE alone
• CHEERS_INVOICE alone
• PLACE_RECEIPT + PLACE_INVOICE
• PLACE_RECEIPT + CHEERS_INVOICE

Buyer & Delivery Address Data

When invoicing requires buyer data or the order includes delivery, additional fields are present:

Buyer Data -- name, country, zip code, city, address, company info (if applicable).

Delivery Address -- name, country, zip code, city, address, lat/lon coordinates, optional comment.