Skip to main content

Order Confirmed

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

API Reference

Customer Fields​

Each order carries a customers array holding the customer details for the order. For a single-customer order — the canonical case — the array contains exactly one element.

The singular customer field is deprecated. It is still populated with the first customer for backwards compatibility, but new integrations should read customers instead.

FieldTypeDescription
namestringCustomer display name
phonestringCustomer phone number
masked_phone_codestring (optional)Phone masking access code, only provided when the platform uses phone masking
provider_loyalty_idstring (optional)Customer loyalty program identifier, when provided by the ordering platform
emailstring (optional)Customer email address, when provided by the ordering platform

provider_loyalty_id lets loyalty platforms reconcile points and rewards against the ordering platform's own customer identity. It is only present when the ordering platform supplies a loyalty identifier on the order — orders without one simply omit the field.

email is likewise only present when the ordering platform shares the customer's email on the order — orders without one omit the field.

note

email is opt-in per integration and off by default. It is not sent until Stream enables it for your integration, and ships with Stream's next release. Masked DoorDash addresses (support@doordash.com, support+<id>@doordash.com) are never sent.

{
"customers": [
{
"name": "test c.",
"phone": "+1111111111",
"masked_phone_code": "111",
"provider_loyalty_id": "user@example.com",
"email": "customer@example.com"
}
]
}

Item and Modifier IDs​

Each item and modifier carries a stream_id — the Stream catalog ID for that object. It matches the stream_id exposed on the DSP menu, so integrators using both the DSP and Events products can reconcile order contents against their stored menu data instead of matching by name. Items or modifiers that share a name are always distinguishable by their stream_id.

One exception: on the DSP V2 menu schema, a portion or multiplier modifier ("1st Half", "Extra") is published under one ID per parent path, such as mod_half_1__mod_pepperoni. The event carries the modifier's catalog ID (mod_half_1), so for these modifiers it does not match the IDs on the V2 menu.

The field is omitted in the rare case where an order line could not be matched to a Stream catalog object, so treat it as optional.

Modifiers​

Each item carries a modifiers array. A modifier may itself contain a nested modifiers array when the selected option has its own selected modifiers (for example, a "Half & Half" topping that further splits into per-half choices). Nesting can be several levels deep.

The nested modifiers field is only present when a modifier has its own selected modifiers — leaf modifiers omit it entirely. Consumers that do not need nested modifiers can safely ignore the field, so existing integrations are unaffected.

{
"stream_id": "STREAM_ITEM_1",
"name": "Build Your Own Pizza",
"quantity": 1,
"price": 1500,
"modifiers": [
{
"stream_id": "STREAM_MODIFIER_1",
"name": "Large",
"quantity": 1,
"price": 300
},
{
"stream_id": "STREAM_MODIFIER_2",
"name": "Half & Half",
"quantity": 1,
"price": 0,
"modifiers": [
{
"stream_id": "STREAM_MODIFIER_3",
"name": "Left: Pepperoni",
"quantity": 1,
"price": 200,
"modifiers": [
{
"stream_id": "STREAM_MODIFIER_4",
"name": "Extra Pepperoni",
"quantity": 2,
"price": 100
}
]
},
{
"stream_id": "STREAM_MODIFIER_5",
"name": "Right: Mushroom",
"quantity": 1,
"price": 150
}
]
}
]
}

Unpaid Orders​

Most orders arrive already paid through the ordering platform. When unpaid is true, payment has not been collected and is due at fulfillment — drive_thru is the common case.

For unpaid orders, cash_amount_due carries the amount to collect at fulfillment, in the lowest denomination (e.g. cents). It may be less than total when the ordering platform funds a promotion that reduces the cash owed without appearing as a separate discount line, so collect cash_amount_due rather than deriving the amount from total.

Both fields are optional and omitted on ordinary prepaid orders.

caution

Don't assume every unpaid order carries cash_amount_due. Stream only sends it when the ordering platform (DSP) provides a cash amount on the order; Stream does not calculate it. An order with unpaid: true can arrive without cash_amount_due, and a missing value does not mean nothing is owed.

Platform Fees​

Some ordering platforms charge the customer fees that are collected with the order but belong to the platform, not the merchant — for example a small order fee or a marketplace fee. When present, dsp_fees carries their sum in the lowest denomination (e.g. cents), and total includes it.

caution

Don't book total as merchant revenue when dsp_fees is present. The dsp_fees portion is remitted to the ordering platform. Subtract it to get the amount the merchant keeps.

dsp_fees is optional and omitted when the order has no platform fees.

{
"subtotal": 399,
"tax": 24,
"delivery_fee": 699,
"delivery_fee_tax": 88,
"driver_tip": 150,
"dsp_fees": 200,
"total": 1560,
"unpaid": true
}

Platform-Remitted Tax​

On some orders the ordering platform (DSP) collects the tax and remits it to the tax authority itself, instead of passing it to the merchant. This happens, for example, under marketplace facilitator rules. When it does, tax_withheld_by_dsp carries that amount in the lowest denomination (e.g. cents), and total includes it, because the customer paid it.

tax_withheld_by_dsp is reported separately from tax. tax holds only the tax the merchant collects and owes.

caution

Don't add tax_withheld_by_dsp to the merchant's tax liability. The platform has already paid that tax. Subtract it from total to get the amount that excludes platform-remitted tax.

tax_withheld_by_dsp is optional and omitted when the platform remits no tax for the order.

{
"subtotal": 3798,
"tax": 0,
"tax_withheld_by_dsp": 139,
"total": 3937
}

Scheduled / Future Orders​

Scheduled (future) orders — placed now to be fulfilled at a later time — carry two additional fields:

FieldTypeDescription
is_future_orderboolean (optional)true when the order is a future / scheduled order
future_order_fulfillment_timenumber (optional)Epoch milliseconds the order is requested to be completed

For a scheduled order, estimated_fulfillment_time carries the requested fulfillment time (equal to future_order_fulfillment_time) until the order is confirmed and refined with prep time — so estimated_fulfillment_time is always populated and safe to use for delivery-time calculations.

Both fields are optional and omitted on immediate orders.

{
"is_future_order": true,
"future_order_fulfillment_time": 1706124214619,
"estimated_fulfillment_time": 1706124214619
}

Uber Eats orders delivered by the merchant's own courier (fulfillment_type: merchant_managed_delivery) carry an optional courier_tracking_url. It opens the Uber Driver app so the courier shares their live location with Uber.

FieldTypeDescription
courier_tracking_urlstring (optional)Courier-facing link for merchant-managed delivery. Currently sent only on Uber Eats orders delivered by the merchant's courier

This link is for the courier only. Do not show it to customers or use it as a customer tracking link.

The field is sent to every Events API integration and omitted on all other orders, so existing integrations are unaffected.

{
"fulfillment_type": "merchant_managed_delivery",
"courier_tracking_url": "https://earn.sng.link/A3ir4p/eh3s?_dl=uberdriver://byoc-mode?code=00000000-0000-0000-0000-000000000000"
}

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",
"pos_order_id": "POS_ORDER_5678",
"customers": [
{
"name": "test c.",
"phone": "+1111111111",
"masked_phone_code": "111"
}
],
"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": [
{
"stream_id": "STREAM_ITEM_1",
"name": "Cheeseburger",
"quantity": 1,
"price": 1000,
"modifiers": [
{
"stream_id": "STREAM_MODIFIER_1",
"name": "Extra Patty",
"quantity": 1,
"price": 500
}
],
"special_instructions": "No bun please"
}
],
"special_instructions": "Extra napkins please",
"subtotal": 1500,
"tax": 150,
"total": 2100
}
}

On self-delivery orders (fulfillment_type: merchant_managed_delivery), the customer's delivery_address and fulfillment_instructions are personal data that ordering platforms only release with the customer's explicit consent.

Without that consent, the order omits delivery_address and fulfillment_instructions entirely — the fields are simply absent, not empty or null. Every other field is unaffected, and the order is still a valid merchant_managed_delivery order.

Because of this, your integration must not assume a self-delivery order carries an address. Treat both fields as optional and handle the missing case explicitly — for example, by falling back to contacting the customer via phone (with the masked_phone_code when phone masking is in use) to arrange delivery.

The two examples below show the same self-delivery order without and with the customer's consent for the 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",
"pos_order_id": "POS_ORDER_5678",
"customers": [
{
"name": "test c.",
"phone": "+1111111111",
"masked_phone_code": "111"
}
],
"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",
"courier_tracking_url": "https://earn.sng.link/A3ir4p/eh3s?_dl=uberdriver://byoc-mode?code=00000000-0000-0000-0000-000000000000",
"items": [
{
"stream_id": "STREAM_ITEM_1",
"name": "Cheeseburger",
"quantity": 1,
"price": 1000,
"modifiers": [
{
"stream_id": "STREAM_MODIFIER_1",
"name": "Extra Patty",
"quantity": 1,
"price": 500
}
],
"special_instructions": "No bun please"
}
],
"special_instructions": "Extra napkins please",
"subtotal": 1500,
"tax": 150,
"total": 2100
}
}
{
"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",
"pos_order_id": "POS_ORDER_5678",
"customers": [
{
"name": "test c.",
"phone": "+1111111111",
"masked_phone_code": "111"
}
],
"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",
"courier_tracking_url": "https://earn.sng.link/A3ir4p/eh3s?_dl=uberdriver://byoc-mode?code=00000000-0000-0000-0000-000000000000",
"fulfillment_instructions": "Gate code 1234",
"items": [
{
"stream_id": "STREAM_ITEM_1",
"name": "Cheeseburger",
"quantity": 1,
"price": 1000,
"modifiers": [
{
"stream_id": "STREAM_MODIFIER_1",
"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",
"pos_order_id": "POS_ORDER_5678",
"customers": [
{
"name": "test c.",
"phone": "+1111111111",
"masked_phone_code": "111"
}
],
"customer": {
"name": "test c.",
"phone": "+1111111111",
"masked_phone_code": "111"
},
"currency": "usd",
"estimated_fulfillment_time": 1706124214619,
"fulfillment_type": "drive_thru",
"items": [
{
"stream_id": "STREAM_ITEM_1",
"name": "Cheeseburger",
"quantity": 1,
"price": 1000,
"modifiers": [
{
"stream_id": "STREAM_MODIFIER_1",
"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,
"cash_amount_due": 1650
}
}