Order Confirmed

This event will be sent after Stream successfully injects a DSP order into the POS.

API Reference

Delivery Order

{
  "type": "order.confirmed",
  "location_id": "STREAM_LOCATION_1",
  "reference_id": "PROVIDER_LOCATION_1",
  "order": {
    "id": "STREAM_ORDER_1234",
    "source": "uber",
    "dsp_order_id": "123456789",
    "dsp_order_number": "1234",
    "customer": {
      "name": "test c.",
      "phone": "+1111111111",
      "masked_phone_code": "111"
    },
    "currency": "usd",
    "delivery_fee": 350,
    "driver_tip": 100,
    "estimated_fulfillment_time": 1706124214619,
    "fulfillment_type": "delivery",
    "items": [
      {
        "name": "Cheeseburger",
        "quantity": 1,
        "price": 1000,
        "modifiers": [
          {
            "name": "Extra Patty",
            "quantity": 1,
            "price": 500
          }
        ],
        "special_instructions": "No bun please"
      }
    ],
    "special_instructions": "Extra napkins please",
    "subtotal": 1500,
    "tax": 150,
    "total": 2100
  }
}

Self-Delivery Order (without additional consent for delivery_address)

{
  "type": "order.confirmed",
  "location_id": "STREAM_LOCATION_1",
  "reference_id": "PROVIDER_LOCATION_1",
  "order": {
    "id": "STREAM_ORDER_1234",
    "source": "uber",
    "dsp_order_id": "123456789",
    "dsp_order_number": "1234",
    "customer": {
      "name": "test c.",
      "phone": "+1111111111",
      "masked_phone_code": "111"
    },
    "currency": "usd",
    "delivery_fee": 350,
    "driver_tip": 100,
    "estimated_fulfillment_time": 1706124214619,
    "fulfillment_type": "merchant_managed_delivery",
    "items": [
      {
        "name": "Cheeseburger",
        "quantity": 1,
        "price": 1000,
        "modifiers": [
          {
            "name": "Extra Patty",
            "quantity": 1,
            "price": 500
          }
        ],
        "special_instructions": "No bun please"
      }
    ],
    "special_instructions": "Extra napkins please",
    "subtotal": 1500,
    "tax": 150,
    "total": 2100
  }
}

Self-Delivery Order (with additional consent for delivery_address)

{
  "type": "order.confirmed",
  "location_id": "STREAM_LOCATION_1",
  "reference_id": "PROVIDER_LOCATION_1",
  "order": {
    "id": "STREAM_ORDER_1234",
    "source": "uber",
    "dsp_order_id": "123456789",
    "dsp_order_number": "1234",
    "customer": {
      "name": "test c.",
      "phone": "+1111111111",
      "masked_phone_code": "111"
    },
    "currency": "usd",
    "delivery_address": {
      "address_line_1": "123 test lane",
      "address_line_2": "apt 11",
      "city": "Los Angeles",
      "state": "CA",
      "postal_code": "90010",
      "country": "USA",
      "lat": 1000,
      "long": 1000
    },
    "delivery_fee": 350,
    "driver_tip": 100,
    "estimated_fulfillment_time": 1706124214619,
    "fulfillment_type": "merchant_managed_delivery",
    "fulfillment_instructions": "Gate code 1234",
    "items": [
      {
        "name": "Cheeseburger",
        "quantity": 1,
        "price": 1000,
        "modifiers": [
          {
            "name": "Extra Patty",
            "quantity": 1,
            "price": 500
          }
        ],
        "special_instructions": "No bun please"
      }
    ],
    "special_instructions": "Extra napkins please",
    "subtotal": 1500,
    "tax": 150,
    "total": 2100
  }
}

Drive thru Order

{
  "type": "order.confirmed",
  "location_id": "STREAM_LOCATION_1",
  "reference_id": "PROVIDER_LOCATION_1",
  "order": {
    "id": "STREAM_ORDER_1234",
    "source": "flipdish",
    "dsp_order_id": "123456789",
    "dsp_order_number": "1234",
    "customer": {
      "name": "test c.",
      "phone": "+1111111111",
      "masked_phone_code": "111"
    },
    "currency": "usd",
    "estimated_fulfillment_time": 1706124214619,
    "fulfillment_type": "drive_thru",
    "items": [
      {
        "name": "Cheeseburger",
        "quantity": 1,
        "price": 1000,
        "modifiers": [
          {
            "name": "Extra Patty",
            "quantity": 1,
            "price": 500
          }
        ],
        "special_instructions": "No bun please"
      }
    ],
    "special_instructions": "Extra napkins please",
    "subtotal": 1500,
    "tax": 150,
    "total": 1650,
    "unpaid": true
  }
}