Skip to main content

Order Pricing

Overview​

This document explains how to interpret the pricing and calculation fields provided in order data.

Order Amount Fields​

FieldDescription
SubtotalAmount of all items in the order prior to tax and/or discounts
TaxesAmount of taxes charged to the customer and paid to the merchant
Taxes Withheld by DSPAmount of taxes charged to the customer and paid to the DSP
Restaurant TipAmount of tip provided to the store
Driver TipAmount of tip provided to the driver
Delivery FeeAmount of fees provided to the delivery courier

Currency Format​

All pricing values are provided in the lowest denomination of the currency specified for the store.

For example:

  • USD: Values are in cents (e.g., 2500 = $25.00)
  • EUR: Values are in cents (e.g., 2500 = €25.00)

Order Markup Values​

The default behavior for item markups is to submit the order into the POS at the price it was ordered on the DSP, inclusive of markup.

To receive order markup total as a distinct line item, please reach out to Partner API support to enable this for your integration.

Markup Line Item Example​

If enabled, markup will be provided as a separate line item where the markup total across all items on the order is shown:

{
  "line_items": [
    {
      "name": "Burger",
      "quantity": 1,
      "price_amount": 1200,
      "price_currency": "usd",
      "modifiers": []
    },
    {
      "name": "Uber Markup",
      "quantity": 1,
      "price_amount": 250,
      "price_currency": "usd",
      "modifiers": []
    }
  ]
}

In this example, the markup total is $2.50.

Order Discounts​

When a promotion is configured on the ordering channel, we will attach this information to the order to allow for accurate reporting within the POS. The discounts array will contain details about the discounts applied to the order, but discount amounts are NOT subtracted from item level prices or order subtotal.

Discount information can be provided in two forms: order-level and item-level.

Order-Level Discounts​

When you have an order-level discount, the items field will be omitted from the discount record:

{
  "discounts": [
    {
      "provider_id": "discount_id",
      "amount": 250
    }
  ]
}

Item-Level Discounts​

When you have an item-level discount, the items array will reference the applicable items for the discount:

{
  "discounts": [
    {
      "provider_id": "discount_id",
      "amount": 250,
      "items": [
        {
          "provider_id": "variation_id"
        }
      ]
    }
  ]
}