Skip to main content

Example Order Events

Order for Item Family without Items​

{
  "type": "order.created",
  "object": {
    "location_id": "poslocationid",
    "fulfillment_type": "delivery",
    "source": "uber",
    "customer_name": "Jane Doe",
    "customer_phone": "+11111111",
    "subtotal": 600,
    "tax": 50,
    "tax_withheld_by_dsp": 0,
    "line_items": [
      {
        "provider_id": "itemfamilyid",
        "name": "Item Family Name",
        "quantity": 1,
        "price_amount": 500,
        "price_currency": "usd",
        "modifiers": []
      }
    ],
    "is_future_order": false
  }
}

Order for Item Family with Items​

{
  "type": "order.created",
  "object": {
    "location_id": "poslocationid",
    "fulfillment_type": "delivery",
    "source": "uber",
    "customer_name": "Jane Doe",
    "customer_phone": "+11111111",
    "subtotal": 600,
    "tax": 50,
    "tax_withheld_by_dsp": 0,
    "line_items": [
      {
        "provider_id": "itemid",
        "name": "Item Name",
        "quantity": 1,
        "price_amount": 500,
        "price_currency": "usd",
        "modifiers": []
      }
    ],
    "is_future_order": false
  }
}

Order with Modifiers​

{
  "type": "order.created",
  "object": {
    "location_id": "poslocationid",
    "fulfillment_type": "delivery",
    "source": "uber",
    "customer_name": "Jane Doe",
    "customer_phone": "+11111111",
    "subtotal": 700,
    "tax": 50,
    "tax_withheld_by_dsp": 0,
    "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"
          }
        ]
      }
    ],
    "is_future_order": false
  }
}

Order with Special Instructions​

{
  "type": "order.created",
  "object": {
    "location_id": "poslocationid",
    "fulfillment_type": "delivery",
    "source": "uber",
    "customer_name": "Jane Doe",
    "customer_phone": "+11111111",
    "subtotal": 600,
    "tax": 50,
    "tax_withheld_by_dsp": 0,
    "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"
          }
        ],
        "special_instructions": "Modify half of the item"
      }
    ],
    "special_instructions": "Throw over the gate",
    "is_future_order": false
  }
}

Order for Future​

{
  "type": "order.created",
  "object": {
    "location_id": "poslocationid",
    "fulfillment_type": "delivery",
    "source": "uber",
    "customer_name": "Jane Doe",
    "customer_phone": "+11111111",
    "subtotal": 600,
    "tax": 50,
    "tax_withheld_by_dsp": 0,
    "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"
          }
        ]
      }
    ],
    "requested_for": 1799639066202,
    "is_future_order": true
  }
}

Order for Merchant Delivery with Tip​

{
  "type": "order.created",
  "object": {
    "location_id": "poslocationid",
    "fulfillment_type": "merchant_managed_delivery",
    "source": "uber",
    "customer_name": "Jane Doe",
    "customer_phone": "+11111111",
    "subtotal": 500,
    "tax": 50,
    "tax_withheld_by_dsp": 0,
    "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
  }
}

Order for Pickup or Dine-In with Tip​

{
  "type": "order.created",
  "object": {
    "location_id": "poslocationid",
    "fulfillment_type": "dine_in",
    "source": "flipdish",
    "customer_name": "Jane Doe",
    "customer_phone": "+11111111",
    "subtotal": 500,
    "tax": 50,
    "tax_withheld_by_dsp": 0,
    "line_items": [
      {
        "provider_id": "itemid",
        "name": "Item Name",
        "quantity": 1,
        "price_amount": 500,
        "price_currency": "usd",
        "modifiers": []
      }
    ],
    "is_future_order": false,
    "restaurant_tip": 200
  }
}

Order with Customer Phone Masking​

{
  "type": "order.created",
  "object": {
    "location_id": "poslocationid",
    "fulfillment_type": "dine_in",
    "source": "flipdish",
    "customer_name": "Jane Doe",
    "customer_phone": "+11111111",
    "customer_phone_code": "123",
    "subtotal": 500,
    "tax": 50,
    "tax_withheld_by_dsp": 0,
    "line_items": [
      {
        "provider_id": "itemid",
        "name": "Item Name",
        "quantity": 1,
        "price_amount": 500,
        "price_currency": "usd",
        "modifiers": []
      }
    ],
    "is_future_order": false
  }
}

Order with Tax Withheld by DSP​

{
  "type": "order.created",
  "object": {
    "location_id": "poslocationid",
    "fulfillment_type": "dine_in",
    "source": "flipdish",
    "customer_name": "Jane Doe",
    "customer_phone": "+11111111",
    "customer_phone_code": "123",
    "subtotal": 500,
    "tax": 0,
    "tax_withheld_by_dsp": 50,
    "line_items": [
      {
        "provider_id": "itemid",
        "name": "Item Name",
        "quantity": 1,
        "price_amount": 500,
        "price_currency": "usd",
        "modifiers": []
      }
    ],
    "is_future_order": false
  }
}

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": {
    "location_id": "poslocationid",
    "fulfillment_type": "delivery",
    "source": "uber",
    "customer_name": "Jane Doe",
    "customer_phone": "+11111111",
    "customer_phone_code": "123",
    "subtotal": 750,
    "tax": 0,
    "tax_withheld_by_dsp": 50,
    "line_items": [
      {
        "provider_id": "itemid",
        "name": "Item Name",
        "quantity": 1,
        "price_amount": 500,
        "price_currency": "usd",
        "modifiers": []
      },
      {
        "name": "Uber Markup",
        "quantity": 1,
        "price_amount": 250,
        "price_currency": "usd",
        "modifiers": []
      }
    ],
    "is_future_order": false
  }
}