Added an optional tax_withheld_by_dsp field to the order.confirmed payload. It carries the tax that the ordering platform (DSP) collected from the customer and remits itself on the merchant's behalf, in the lowest denomination. It is omitted when the platform remits no tax. It is not part of tax. Read More
total on the order.confirmed payload now includes tax_withheld_by_dsp, in the same way it includes dsp_fees. Before this change, total left out platform-remitted tax, so it was lower than the amount the customer paid on those orders. Orders without platform-remitted tax are unchanged. Read More
Clarified that cash_amount_due on the order.confirmed payload is only sent when the ordering platform (DSP) provides it. Stream does not calculate the value, so an order with unpaid: true can arrive without cash_amount_due. No behaviour changed; this has been the case since the field was first sent on 2026-05-04. Read More
Added an optional email field to each customer in customers (and the deprecated customer) on the order.confirmed payload. It carries the customer's email address when the ordering platform provides one, and is omitted otherwise. The field 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 are never sent. Read More
Added an optional estimated_courier_arrival_time (Unix ms) to the order on delivery.status_updated. It is present only while the courier is heading to the store (pending, pending_driver_confirmation, enroute_to_pickup). The event is now also sent when only the ETA changes, so you may receive several delivery.status_updated events per order with an unchanged delivery_status; treat the latest as current. Integrations that don't read the field are unaffected beyond the extra events. delivery.status_updated stays off by default: turn it on under Subscribed Events to receive the ETA and the ETA-only refreshes. Read More
You can send the same optional field on order.update.delivery.status. A value that is not a number is rejected with a 400; null is treated as absent. Read More
Added an optional dsp_fees field to the order.confirmed payload. It carries customer-paid fees that are collected with the order but remitted to the ordering platform rather than kept by the merchant, such as a small order fee, in the lowest denomination. It is omitted when the order has no such fees. Read More
total on the order.confirmed payload now includes dsp_fees, so it matches the amount the customer was charged at checkout. Previously these fees were left out of total. If you use total as merchant revenue, subtract dsp_fees. Read More
Added an optional courier_tracking_url field to the order.confirmed payload. On Uber Eats orders delivered by the merchant's own courier (merchant_managed_delivery), it carries a courier-facing link that opens the Uber Driver app so the courier shares live location with Uber. Do not show it to customers. It is omitted on all other orders, so existing integrations are unaffected. Read More
Added self-service event subscriptions to the partner portal. On the Events API integration page, Subscribed Events lets you turn each event type on or off yourself, and your choice applies to every location connected to your integration. You no longer need to ask Stream to turn event types on per location. If you haven't made a choice, you receive the default events only: order.confirmed, order.updated and order.canceled. order.tip_updated, delivery.status_updated and any new event types are off until you turn them on. Read More
Added the order.tip_updated event, sent when an order's tip is raised in the POS after it was paid (currently Toast). The payload carries the order's new total driver_tip. It can arrive before or without order.confirmed, so handle it idempotently by order id. This event is opt-in — it is not enabled automatically; contact Stream to start receiving order.tip_updated events. Read More
Added optional is_future_order and future_order_fulfillment_time fields to the order.confirmed payload, identifying scheduled/future orders and the epoch-millisecond time they are requested to be completed. Both are omitted on immediate orders, so existing integrations are unaffected. Read More
estimated_fulfillment_time is now always populated on scheduled/future orders. Previously it could be sent as null for a future order, since the requested time was only carried on an internal future-order field; it now falls back to future_order_fulfillment_time so the required field is never null. Read More
Added a customers array to the order payload of the order.confirmed event. For single-customer orders it contains exactly one element. Read More
Added an optional provider_loyalty_id to customer objects, carrying the customer's loyalty program identifier when the ordering platform supplies one. Orders without a loyalty identifier omit the field, so existing integrations are unaffected. Read More
Documented cash_amount_due on the order.confirmed payload. When an order is unpaid (for example drive_thru), this is the cash amount to collect at fulfillment in the lowest denomination; it may be less than total when the ordering platform funds benefits that are not sent as discount lines. The field has been sent since 2026-05-04 and was already documented on the DSP and POS APIs — this adds the missing Events API documentation. Read More
Deprecated the singular customer field on the order.confirmed payload in favor of customers. It is still populated with the first customer for backwards compatibility, so no action is required to keep existing integrations working.
Corrected the documented merchant cancellation status value. The API spec previously listed the order.canceled merchant status as canceled; the value Stream actually sends is merchant_canceled, which is what the Order Canceled page has always shown. No behavior changed — only the spec was wrong. If your integration matches on canceled for merchant cancellations, switch to merchant_canceled.
Items and modifiers in the order.confirmed event now include a stream_id — the Stream catalog ID matching the stream_id exposed on the DSP menu — so order contents can be reconciled against stored menu data instead of by name. Read More
Modifiers in the order.confirmed event can now contain their own nested modifiers array, allowing multi-level modifier selections to be represented. The field is only present when a modifier has nested selections, so existing integrations are unaffected. Read More