Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Cheese

Hierarchy

Implements

Index

Properties

Properties

Optional alwaysCharge

alwaysCharge: undefined | false | true

modifier always charge

Optional countAs

countAs: undefined | number

modifier count as

id

id: string

Represents the identifier of the ordered product.

Optional lineItemDiscountWeighting

lineItemDiscountWeighting: undefined | number

Represents the weighting at which discount should be applied within a deal, against the original line item price less modifiers.

This field is only applicable when one of the following is true:

  • A market needs to calculate line item level discounting within the context of a deal
  • There is a basket discount (order.discount) and the discounted(lineItemPrice) & original(lineItemOriginalPrice) prices sent to the POS

Optional lineItemDiscountable

lineItemDiscountable: undefined | false | true

Represents whether or not the line item is subject to discount

This field is only applicable when one of the following is true:

  • A market needs to calculate line item level discounting within the context of a deal
  • There is a basket discount (order.discount) and the discounted(lineItemPrice) & original(lineItemOriginalPrice) prices sent to the POS

Optional lineItemDiscountablePrice

lineItemDiscountablePrice: undefined | number

Represents the price which is subject to discount within a deal, less any modifiers (i.e. crust upgrades).

This field is only applicable when one of the following is true:

  • A market needs to calculate line item level discounting within the context of a deal
  • There is a basket discount (order.discount) and the discounted(lineItemPrice) & original(lineItemOriginalPrice) prices sent to the POS

Optional lineItemDiscountedAmount

lineItemDiscountedAmount: undefined | number

Represents the amount a line item has been discounted by in relation to its original value less any modifiers.

This field is only applicable when one of the following is true:

  • A market needs to calculate line item level discounting within the context of a deal
  • There is a basket discount (order.discount) and the discounted(lineItemPrice) & original(lineItemOriginalPrice) prices sent to the POS

Optional lineItemOriginalPrice

lineItemOriginalPrice: number | undefined

Represents the full price of the ordered product within a deal without any discounts.

This field is only applicable when one of the following is true:

  • A market needs to calculate line item level discounting within the context of a deal
  • There is a basket discount (order.discount) and the discounted(lineItemPrice) & original(lineItemOriginalPrice) prices sent to the POS

As the Product.price property can vary depending on the pricing strategy used for Deals. This property is used to indicate the full price of the product within the parent deal excluding discounts.

This property came into existence due to some of the Point of Sales systems required it to generate detailed receipts.

Example:

{
 id: "classic-corn-pan-medium",
 price: 199,
 lineItemPrice: 199,
 lineItemOriginalPrice: 199,
}

Optional lineItemPrice

lineItemPrice: number | undefined

Represents the full (a la carte) price of the ordered product within a deal including discounts.

This field is only applicable when one of the following is true:

  • A market needs to calculate line item level discounting within the context of a deal
  • There is a basket discount (order.discount) and the discounted(lineItemPrice) & original(lineItemOriginalPrice) prices sent to the POS

As the Product.price property can vary depending on the pricing strategy used for Deals. This property is used to indicate the full price of the product within the parent deal including discounts.

This property came into existence due to some of the Point of Sales systems required it to generate detailed receipts.

Example:

{
 id: "classic-corn-pan-medium",
 price: 199,
 lineItemPrice: 199,
 lineItemOriginalPrice: 199,
}

Optional modifiers

modifiers: Modifier[]

Represents the modifiers for product

Optional optionIndex

optionIndex: undefined | string

Represents the index of a deal option in the products data. Only products that are part of a deal (dealId !== 'ND') will have this property Used internally to provide a reference to a particular deal option in our order pipeline

Optional originalPrice

originalPrice: number | undefined

Represents the list price of the ordered product without any discounts.

price

price: number

Represents the price of the ordered product.

As explained in Deal, this property must be used to indicate the price of the product when the parent deal does not include a price. On the contrary, when the ordered deal includes a price it represents the up-sell price of the ordered product.

Example:

{
 id: "classic-corn-pan-medium",
 price: 199
}

Optional servingCalories

servingCalories: string | null

Represents the serving calories for product

Optional subtype

subtype: undefined | string

Represents the subtype of the ordered product. Only markets that use microservice-menu will have this property.* This property allows us to handle all different products a market may have, without changing what we consider to be a primary type (e.g. pizzas, sides, desserts, drinks)

Example:

{
 type: 'side',
 subtype: 'pasta'
}

Optional taxCode

taxCode: undefined | string

Represents the tax band assigned on a product by product basis.

Optional type

type: undefined | string

Represents the type of the ordered product.

Generated using TypeDoc