Example Order Events

Overview

This page provides example order payloads for common scenarios. All examples show orders sent from Stream to your POS via the Handle Order (Stream -> POS) endpoint. These examples can be used as references when implementing your POS integration. Note, they are using the most up to date schema and omit deprecated fields.

Basic Order Examples

Order for Item Family without Items

{
  "type": "order.created",
  "object": {
    "idempotency_key": "uber_order_123_1699564800000",
    "fulfillment_type": "delivery",
    "source": "uber",
    "brand": "uber",
    "dsp_order_id": "uber-internal-guid-123",
    "dsp_order_number": "ORDER-456",
    "location_id": "poslocationid",
    "customers": [
      {
        "id": "customer_1",
        "name": "Jane Doe",
        "phone": "+11111111"
      }
    ],
    "line_items": [
      {
        "provider_id": "itemfamilyid",
        "name": "Item Family Name",
        "quantity": 1,
        "price_amount": 500,
        "price_currency": "USD",
        "modifiers": []
      }
    ],
    "is_future_order": false,
    "subtotal": 500,
    "tax": 50,
    "tax_withheld_by_dsp": 0
  }
}

Order for Item Family with Items

{
  "type": "order.created",
  "object": {
    "idempotency_key": "uber_order_124_1699564800000",
    "fulfillment_type": "delivery",
    "source": "uber",
    "brand": "uber",
    "dsp_order_id": "uber-internal-guid-124",
    "dsp_order_number": "ORDER-457",
    "location_id": "poslocationid",
    "customers": [
      {
        "id": "customer_1",
        "name": "Jane Doe",
        "phone": "+11111111"
      }
    ],
    "line_items": [
      {
        "provider_id": "itemid",
        "name": "Item Name",
        "quantity": 1,
        "price_amount": 500,
        "price_currency": "USD",
        "modifiers": []
      }
    ],
    "is_future_order": false,
    "subtotal": 500,
    "tax": 50,
    "tax_withheld_by_dsp": 0
  }
}

Order with Modifiers

{
  "type": "order.created",
  "object": {
    "idempotency_key": "uber_order_125_1699564800000",
    "fulfillment_type": "delivery",
    "source": "uber",
    "brand": "uber",
    "dsp_order_id": "uber-internal-guid-125",
    "dsp_order_number": "ORDER-458",
    "location_id": "poslocationid",
    "customers": [
      {
        "id": "customer_1",
        "name": "Jane Doe",
        "phone": "+11111111"
      }
    ],
    "line_items": [
      {
        "provider_id": "itemid",
        "name": "Item Name",
        "quantity": 1,
        "price_amount": 500,
        "price_currency": "USD",
        "modifiers": [
          {
            "provider_id": "modifierid",
            "name": "Modifier",
            "quantity": 2,
            "price_amount": 100,
            "price_currency": "USD",
            "modifiers": []
          }
        ]
      }
    ],
    "is_future_order": false,
    "subtotal": 700,
    "tax": 50,
    "tax_withheld_by_dsp": 0
  }
}

Order with Special Instructions

{
  "type": "order.created",
  "object": {
    "idempotency_key": "uber_order_126_1699564800000",
    "fulfillment_type": "delivery",
    "source": "uber",
    "brand": "uber",
    "dsp_order_id": "uber-internal-guid-126",
    "dsp_order_number": "ORDER-459",
    "location_id": "poslocationid",
    "customers": [
      {
        "id": "customer_1",
        "name": "Jane Doe",
        "phone": "+11111111"
      }
    ],
    "line_items": [
      {
        "provider_id": "itemid",
        "name": "Item Name",
        "quantity": 1,
        "price_amount": 500,
        "price_currency": "USD",
        "special_instructions": "Modify half of the item",
        "modifiers": [
          {
            "provider_id": "modifierid",
            "name": "Modifier",
            "quantity": 1,
            "price_amount": 100,
            "price_currency": "USD",
            "modifiers": []
          }
        ]
      }
    ],
    "special_instructions": "Throw over the gate",
    "is_future_order": false,
    "subtotal": 600,
    "tax": 50,
    "tax_withheld_by_dsp": 0
  }
}

Order for Future

{
  "type": "order.created",
  "object": {
    "idempotency_key": "uber_order_127_1699564800000",
    "fulfillment_type": "delivery",
    "source": "uber",
    "brand": "uber",
    "dsp_order_id": "uber-internal-guid-127",
    "dsp_order_number": "ORDER-460",
    "location_id": "poslocationid",
    "customers": [
      {
        "id": "customer_1",
        "name": "Jane Doe",
        "phone": "+11111111"
      }
    ],
    "line_items": [
      {
        "provider_id": "itemid",
        "name": "Item Name",
        "quantity": 1,
        "price_amount": 500,
        "price_currency": "USD",
        "modifiers": [
          {
            "provider_id": "modifierid",
            "name": "Modifier",
            "quantity": 1,
            "price_amount": 100,
            "price_currency": "USD",
            "modifiers": []
          }
        ]
      }
    ],
    "requested_for": 1799639066202,
    "is_future_order": true,
    "subtotal": 600,
    "tax": 50,
    "tax_withheld_by_dsp": 0
  }
}

Order for Merchant Delivery with Tip

{
  "type": "order.created",
  "object": {
    "idempotency_key": "uber_order_128_1699564800000",
    "fulfillment_type": "merchant_managed_delivery",
    "source": "uber",
    "brand": "uber",
    "dsp_order_id": "uber-internal-guid-128",
    "dsp_order_number": "ORDER-461",
    "location_id": "poslocationid",
    "customers": [
      {
        "id": "customer_1",
        "name": "Jane Doe",
        "phone": "+11111111"
      }
    ],
    "line_items": [
      {
        "provider_id": "itemid",
        "name": "Item Name",
        "quantity": 1,
        "price_amount": 500,
        "price_currency": "USD",
        "modifiers": []
      }
    ],
    "is_future_order": false,
    "delivery_address": {
      "address_line_1": "123 Sesame Street",
      "address_line_2": "Apt 1",
      "city": "NYC",
      "state": "NY",
      "postal_code": "10101",
      "country": "USA"
    },
    "driver_tip": 200,
    "delivery_fee": 399,
    "fulfillment_instructions": "Leave at the door",
    "subtotal": 500,
    "tax": 50,
    "tax_withheld_by_dsp": 0
  }
}

Order for Pickup or Dine-In with Tip

{
  "type": "order.created",
  "object": {
    "idempotency_key": "example_dsp_order_129_1699564800000",
    "fulfillment_type": "dine_in",
    "source": "example-dsp",
    "brand": "example-brand",
    "dsp_order_id": "example-dsp-internal-guid-129",
    "dsp_order_number": "ORDER-462",
    "location_id": "poslocationid",
    "customers": [
      {
        "id": "customer_1",
        "name": "Jane Doe",
        "phone": "+11111111"
      }
    ],
    "line_items": [
      {
        "provider_id": "itemid",
        "name": "Item Name",
        "quantity": 1,
        "price_amount": 500,
        "price_currency": "USD",
        "modifiers": []
      }
    ],
    "is_future_order": false,
    "restaurant_tip": 200,
    "subtotal": 500,
    "tax": 50,
    "tax_withheld_by_dsp": 0
  }
}

Order for Pickup requiring a Payment

caution

Unpaid orders are not enabled by default on the POS integration. If you would like to allow unpaid orders, please reach out to Partner API support to enable this for your integration.

{
  "type": "order.created",
  "object": {
    "idempotency_key": "example_dsp_order_130_1699564800000",
    "fulfillment_type": "pickup",
    "source": "example-dsp",
    "brand": "example-brand",
    "dsp_order_id": "example-dsp-internal-guid-130",
    "dsp_order_number": "ORDER-463",
    "location_id": "poslocationid",
    "customers": [
      {
        "id": "customer_1",
        "name": "Jane Doe",
        "phone": "+11111111"
      }
    ],
    "line_items": [
      {
        "provider_id": "itemid",
        "name": "Item Name",
        "quantity": 1,
        "price_amount": 500,
        "price_currency": "USD",
        "modifiers": []
      }
    ],
    "is_future_order": false,
    "unpaid": true,
    "subtotal": 500,
    "tax": 50,
    "tax_withheld_by_dsp": 0
  }
}

Order with Customer Phone Masking

{
  "type": "order.created",
  "object": {
    "idempotency_key": "example_dsp_order_131_1699564800000",
    "fulfillment_type": "dine_in",
    "source": "example-dsp",
    "brand": "example-brand",
    "dsp_order_id": "example-dsp-internal-guid-131",
    "dsp_order_number": "ORDER-464",
    "location_id": "poslocationid",
    "customers": [
      {
        "id": "customer_1",
        "name": "Jane Doe",
        "phone": "+11111111",
        "phone_code": "123"
      }
    ],
    "line_items": [
      {
        "provider_id": "itemid",
        "name": "Item Name",
        "quantity": 1,
        "price_amount": 500,
        "price_currency": "USD",
        "modifiers": []
      }
    ],
    "is_future_order": false,
    "subtotal": 500,
    "tax": 50,
    "tax_withheld_by_dsp": 0
  }
}

Order with Tax Withheld by DSP

{
  "type": "order.created",
  "object": {
    "idempotency_key": "example_dsp_order_132_1699564800000",
    "fulfillment_type": "dine_in",
    "source": "example-dsp",
    "brand": "example-brand",
    "dsp_order_id": "example-dsp-internal-guid-132",
    "dsp_order_number": "ORDER-465",
    "location_id": "poslocationid",
    "customers": [
      {
        "id": "customer_1",
        "name": "Jane Doe",
        "phone": "+11111111",
        "phone_code": "123"
      }
    ],
    "line_items": [
      {
        "provider_id": "itemid",
        "name": "Item Name",
        "quantity": 1,
        "price_amount": 500,
        "price_currency": "USD",
        "modifiers": []
      }
    ],
    "is_future_order": false,
    "subtotal": 500,
    "tax": 0,
    "tax_withheld_by_dsp": 50
  }
}

Order with Cart Level Discount

{
  "type": "order.created",
  "object": {
    "idempotency_key": "example_dsp_order_134_1699564800000",
    "fulfillment_type": "dine_in",
    "source": "example-dsp",
    "brand": "example-brand",
    "dsp_order_id": "example-dsp-internal-guid-134",
    "dsp_order_number": "ORDER-467",
    "location_id": "poslocationid",
    "customers": [
      {
        "id": "customer_1",
        "name": "Jane Doe",
        "phone": "+11111111",
        "phone_code": "123"
      }
    ],
    "line_items": [
      {
        "provider_id": "itemid",
        "name": "Item Name",
        "quantity": 2,
        "price_amount": 500,
        "price_currency": "USD",
        "modifiers": []
      }
    ],
    "discounts": [
      {
        "provider_id": "five_off_promo",
        "amount": 500
      }
    ],
    "is_future_order": false,
    "subtotal": 1000,
    "tax": 100,
    "tax_withheld_by_dsp": 0
  }
}

Note that discount amount is NOT applied to the order subtotal. The subtotal reflects the total cost of items before discounts.

Order with Item Level Discount

{
  "type": "order.created",
  "object": {
    "idempotency_key": "example_dsp_order_135_1699564800000",
    "fulfillment_type": "dine_in",
    "source": "example-dsp",
    "brand": "example-brand",
    "dsp_order_id": "example-dsp-internal-guid-135",
    "dsp_order_number": "ORDER-468",
    "location_id": "poslocationid",
    "customers": [
      {
        "id": "customer_1",
        "name": "Jane Doe",
        "phone": "+11111111",
        "phone_code": "123"
      }
    ],
    "line_items": [
      {
        "provider_id": "itemid",
        "name": "Item Name",
        "quantity": 2,
        "price_amount": 500,
        "price_currency": "USD",
        "modifiers": []
      }
    ],
    "discounts": [
      {
        "provider_id": "itemid_bogo",
        "amount": 500,
        "items": [
          {
            "provider_id": "itemid"
          }
        ]
      }
    ],
    "is_future_order": false,
    "subtotal": 1000,
    "tax": 100,
    "tax_withheld_by_dsp": 0
  }
}

Note that discount amount is NOT applied to the order subtotal. The subtotal reflects the total cost of items before discounts.

Order with DSP Markup Line Item (By Request Only)

Submit a request to Partner API support to enable this behavior

In the scenario below, itemid was sold for $7.50 on Uber while having a POS price of $5.

{
  "type": "order.created",
  "object": {
    "idempotency_key": "uber_order_136_1699564800000",
    "fulfillment_type": "delivery",
    "source": "uber",
    "brand": "uber",
    "dsp_order_id": "uber-internal-guid-136",
    "dsp_order_number": "ORDER-469",
    "location_id": "poslocationid",
    "customers": [
      {
        "id": "customer_1",
        "name": "Jane Doe",
        "phone": "+11111111",
        "phone_code": "123"
      }
    ],
    "line_items": [
      {
        "provider_id": "itemid",
        "name": "Item Name",
        "quantity": 1,
        "price_amount": 500,
        "price_currency": "USD",
        "modifiers": []
      },
      {
        "provider_id": null,
        "name": "Uber Markup",
        "quantity": 1,
        "price_amount": 250,
        "price_currency": "USD",
        "modifiers": []
      }
    ],
    "is_future_order": false,
    "subtotal": 750,
    "tax": 0,
    "tax_withheld_by_dsp": 50
  }
}

Overview​

Basic Order Examples​

Order for Item Family without Items​

Order for Item Family with Items​

Order with Modifiers​

Order with Special Instructions​

Order for Future​

Order for Merchant Delivery with Tip​

Order for Pickup or Dine-In with Tip​

Order for Pickup requiring a Payment​

Order with Customer Phone Masking​

Order with Tax Withheld by DSP​

Order with Cart Level Discount​

Order with Item Level Discount​

Order with DSP Markup Line Item (By Request Only)​