Overview

ProductID / ProductModifierID

For more information about sourcing values for productId and productModifierId please see the MenuSync documentation on Modifiers.

Tax

For jurisdictions with inclusive taxes (taxes that are already included in the price of an item like UK/EU VAT or Australian GST) there is no requirement to populate tax fields as the POS will be able to calculate the tax internally. Providers would only need to send the tax amounts if they were planning on either withholding tax/displaying tax receipts.

For jurisdictions with exclusive tax (sometimes called addon taxes - i.e. taxes that are in addition to the list price) the tax fields are mandatory.

Adjustments

Adjustments (discounts/surcharges) can be added to a parent RemoteOrder in two different ways, either applying to the entire order or to individual products within that order. The primary difference between the two methods will be how the onsite sales reporting will account for the adjustment effects.

Order level adjustments are set at RemoteOrder.orderAdjustments. Adjustments here will apply their adjustment amounts across all products in the order prorata. When sending order adjustments leave all RemoteOrderProduct price/amount unchanged. Only adjust the RemoteOrder.totalAmount (and RemoteOrderPayment.amountPaid)

Product level adjustments are set at RemoteOrderProduct.productAdjustment and will affect the RemoteOrderProduct.totalAmount but leave RemoteOrderProduct.price alone. The changed RemoteOrderProduct.totalAmount should also be reflected in the balance at the parent RemoteOrder.totalAmount

If taxes are being sent with the adjustments - leave the tax amounts unadjusted. The POS will calculate the adjustment effects (if any) on tax.

Constant

System.Int32 MaxAllergens = 16

The maximum number of allergens allowed in ExcludedRemoteOrderAllergenTypes

Any additional entries will be ignored

Example

{
  "remoteOrderProductID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "quantity": 321,
  "price": 1.23,
  "totalAmount": 1.23,
  "productID": "string value",
  "productModifierID": "string value",
  "name": "string value",
  "specialInstructions": "string value",
  "allergenFreeFormText": "string value",
  "excludedRemoteOrderAllergenTypes": [1],
  "taxCollected": [],
  "productAdjustment": {},
  "attributes": []
}