Overview

The majority of properties for RemoteOrder are optional and can be omitted entirely (see the example at the bottom of the page for a relatively minimal RemoteOrder)

Service Mode

For more information about sourcing values for serviceModeId and serviceModeEntityId please see the MenuSync documentation on ServiceModes

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 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.TimeSpan DefaultExpiryLength = 03:00:00

If DateTimeExpiresAtUTC is null / empty. This length will be added to the current time to make a default value

Example

{
  "OutletID": "36637eaa-6aed-4868-93f9-cc1ed3145db1",
  "ProviderID": 9999,
  "ProviderName":  "",
  "ProviderOrderID": "abc123",
  "CurrencyCode": "AUD",
  "RemoteOrderType": 1,
  "TotalAmount": 15,
  "Payments": [
    {
      "AmountPaid": 15,
      "AmountOutletTip": 2.5
    }
  ],
  "Products": [
    {
      "Name": "Hamburger",
      "ProductID": "plu123",
      "Quantity": 2,
      "Price": 5,
      "TotalAmount": 10,
      "Attributes": [
        {
            "Name": "Fries",
            "ProductAttributeID": "plu456",
            "ProductAttributeModifierID": "396123a7-df39-45b7-991c-1506c582cbbc",
            "Quantity": 2,
            "Price": 2.5,
            "TotalAmount": 5,
            "TaxCollected": [
                {
                  "RemoteOrderTaxID": 1,
                  "TotalTaxableSales": 5,
                  "TotalInclusiveAmount":  0.9876543
                }
            ]
        }
      ],
      "TaxCollected": [
        {
          "RemoteOrderTaxID": 1,
          "TotalTaxableSales": 10,
          "TotalInclusiveAmount":  1.4562411
        }
      ]
    }
  ],
  "TotalTaxCollected": [
    {
      "RemoteOrderTaxID": 1,
      "TotalTaxableSales": 15,
      "TotalInclusiveAmount": 2.4438954
    }
  ]
}