Skip to main content

DSP API Changelog

2026-11-17​

Added​

  • GET /onboarding/org/{id}/locations returns two optional fields on each dsps[] entry: dsp_provider_id (the store's ID at the DSP) and integration_id (the DSP integration the connection is bound through). Read more

Changed​

  • DELETE /onboarding/integrations/{id} now disconnects the integration for headless white-label partners. It removes every connection on it: for a DSP onboarding every DSP connection bound through the integration, for a POS onboarding every POS location on it and the DSP connections under them. The response is the onboarding record with status deprovisioned, or the new waiting_for_deprovision when Stream must remove a connection manually; call it again after Stream finishes to move it to deprovisioned. Repeat calls are safe. An onboarding of another partner, or a missing one, now returns 404, and a disconnected onboarding cannot be reconnected or bound (400). Read more

2026-11-16​

Changed​

  • ItemV2.additional_nutritional_details is now fully typed as PartnerNutritionalDetails. Nutrients are { value, unit } pairs, labels such as serving_size are strings, and packaging flags such as deposit_required are booleans. Stream already sent these string and boolean values; the schema used to describe every value as { value, unit }. Ignore keys you do not support. Read more
  • API spec corrections, with no change to what Stream sends: dietary_tags on ItemFamilyV2 and ModifierV2, and allergens on ModifierV2, are now shown as arrays of enum values instead of a single string, and the UnitValue schema is now published.
  • UnitValue.unit can now also be kJ, ml or L. Accept these units, or ignore values whose unit you do not support.

2026-11-13​

Changed​

  • Documented the optional order brand field: use it to mark the channel an order came from within your platform (for example catering or kiosk), the same way a Grubhub order through Seamless carries brand: "seamless". Stream passes it to the merchant's POS, where Toast uses it to pick the revenue center, payment type, dining option, service charge and discount, Simphony the order channel, tender, service charge and discount, and Aloha the channel label. On Toast, an order fails when no payment type matches. If you omit brand, your partner slug is used. Documentation only; no behaviour changed. The field has been accepted on DSP orders since 2025-08-28. Read more | API Spec

2026-11-12​

Added​

  • Payment links: for an order sent with unpaid: true, request a link with POST /payment-links and give it to the guest, who pays on a Stream-hosted page through the merchant's POS processor. When the guest pays, you receive a new location.order.paid event with the amount paid and a payment_status of paid or authorized. Payment links are not enabled by default — contact Stream before you start using them. The event is not retried. Read more | API Spec

2026-11-10​

Changed​

  • V2 menu schema: portion and multiplier modifiers are now priced. Modifiers that a POS prices as a multiple of their parent (a half topping, "Extra", "Light") were published once with price: 0. They are now published once per parent path, each with its own stream_id (for example mod_half_1__mod_pepperoni) and a price that is the change to the parent's price, which can be negative (a half of a 1000 topping is -500). The modifier groups that hold them get a per-path stream_id too. No field was added or removed, but an integration that rejects a negative price, limits the length of a stream_id, or keeps IDs from an earlier publish needs a change. V1 menus and menus without multiplier modifiers are unchanged. Read more
  • ItemV2.modifier_overrides now also carries rows for multiplier modifiers nested under a size-priced topping. Apply the rows at every nesting level, not only to top-level modifiers. Read more
  • On orders, return the published modifier and modifier group IDs unchanged, and send the published delta (negative values included) as each line's price. Stream resolves the IDs to the POS modifiers. Read more | API Spec
  • On the V2 schema, a stock change to a portion or multiplier modifier, or to a modifier that has portion options under it, is followed by a full menu publish, because an object update cannot address every published ID. Read more

2026-11-09​

Changed​

  • Documented that a modifier's quantity is per one unit of its parent line, not the total across the line. For two of an item each with one "Not Spicy", send the line with quantity: 2 and the modifier with quantity: 1. Stream forwards modifier quantities to the POS unchanged. If you multiply the modifier quantity by the line quantity, the POS can reject the order with order_validation_error and an empty invalid_item_ids. No behavior changed — Stream has always forwarded modifier quantities this way. Read more | API Spec

2026-10-27​

Added​

  • Added an optional estimated_courier_arrival_time (Unix ms) to the delivery_status_update event you send to Stream: the courier's estimated arrival at the store while en route to pickup. Stream stores it on the order and passes it to connected event partners. A value that is not a number is rejected with a 400; null is treated as absent. Omitting the field leaves existing behavior unchanged. Read more | API Spec

2026-10-19​

Changed​

  • Expanded the documentation for order discounts, with examples of order-level, item-level, and multi-item discounts. Send item prices and subtotal before discounts and express the promotion only in discounts; a discount's item_id must match the discounted line's id (the variation ID), not the line's item_id, or the discount reaches the POS as order-level. A promotion covering several lines is sent as one entry per line. No behavior changed — discounts have been accepted in this shape since 2023-03-05. Read more | API Spec

2026-09-29​

Changed​

  • Documented the required format for the delivery_address on merchant_managed_delivery orders. state must be the ISO 3166-2 subdivision code without the country prefix (e.g. FL, not Florida or US-FL) and country must be the ISO 3166-1 alpha-2 code (e.g. US). Stream forwards the address to the POS unchanged, and a full state name can cause the POS to reject the order with order_validation_error. No behavior changed — this has been the expected format since delivery_address was introduced; the API spec now describes each Address field. Read more | API Spec

2026-09-08​

Changed​

  • Documented how to submit an unpaid order. unpaid and cash_amount_due were only described in the API spec and previous changelog entries, and the fulfillment page implied that a drive_thru order was unpaid by nature. Payment state is carried solely by unpaid — an order sent with fulfillment_type: "drive_thru" but without unpaid: true is submitted to the merchant's POS as already paid. No behavior changed; both fields have been accepted since they were added. Read more | API Spec

2026-08-24​

Added​

  • Headless white-label partners can now restart OAuth for an existing DSP integration and refresh its credentials in place, without creating a new integration. Reconnection is available only for supported OAuth providers. Read more

2026-08-12​

Added​

  • Added nut_free to the dietary_tags enum on item families (ItemFamilyV2) and modifiers (ModifierV2). The value is only present on objects the merchant has tagged as nut free, so existing consumers are unaffected. Read more
  • Added default_modifiers_free to ModifierRulesV2. When true, the modifier group's default options are not charged; absent or false means they are charged as normal. Read more

Changed​

  • The API spec now carries the optional schedule field on the V2 Category schema. Category-level availability hours were announced on 2026-06-30 and documented on the menu schemas page, but the field was missing from the published spec. No behavior changed — the field has been sent since then. Read more

2026-08-04​

Added​

  • Merchant-initiated cancellations sent via the location.order.cancel event now carry the merchant-selected reason: cancel_reason (a normalized value such as item_out_of_stock, store_closed, kitchen_too_busy, customer_requested, driver_unavailable, or other) plus an optional cancel_reason_details free-text field, used primarily when cancel_reason is other. Both fields are optional and omitted when no reason is provided, so existing consumers are unaffected. Read more | API Spec

2026-07-08​

Added​

  • Added a location.busy webhook event (Stream -> DSP) for merchant-triggered Busy Mode. When a merchant marks a location as busy, the event is sent with enabled: true, an absolute prep_time_minutes to surface while busy, and a busy_until epoch-millisecond timestamp; the platform should self-expire the elevated prep at that time. An early manual clear sends enabled: false with no prep. This event is opt-in — it is not enabled automatically; contact Stream to start receiving location.busy events. Read more | API Spec

2026-06-30​

Added​

  • Added category-level availability hours to the V2 menu schema. A Category may now include an optional schedule field — the same weekly, multi-slot shape as the menu-level schedule — letting partners that support category-level scheduling (e.g. a "Lunch" category available only midday) honor per-category hours. Categories without defined hours omit the field and behave exactly as before, so current consumers are unaffected. Read more

2026-06-29​

Added​

  • Added name_translations and description_translations to the V1 and V2 menu schemas. Menus, categories, item families, items (variations), modifier groups, and modifiers can now carry translated names and descriptions (each a { locale, value } LocalizedName entry) so you can publish bilingual or multilingual menus. The base name/description remain the default-language values. Read more | API Spec

2026-06-12​

Added​

  • Added an order_adjustment webhook event (DSP -> Stream) for updating an order after submission. The event carries the full adjusted order in the same shape as new_order and replaces the previously sent order details. Scheduled orders still held by Stream are updated before POS submission and retain their scheduled preparation time unless the adjustment changes it; orders already sent to the POS are not adjusted automatically and the merchant is notified instead. Read more | API Spec

2026-06-10​

Added​

  • Added nutrition, allergen, and dietary fields to the V2 menu schema. Item families and modifiers now support dietary_tags; modifiers also support allergens. Item variations now support calories, ingredients, alcohol_percentage, caffeine_content_mg, and additional_nutritional_details (nutrient → { value, unit }), and modifiers support calories. Read more | API Spec

2026-06-03​

Added​

  • Added table_number to the new order payload. For dine_in orders, the value is placed on the POS ticket so staff can deliver the order to the correct table. Read more

2026-05-26​

Added​

  • Added is_active to the V2 ItemFamily to indicate whether an item family is active. API Spec
  • Added cash_amount_due to the new order webhook order payload. When an order is unpaid (for example drive_thru), this is the cash amount to collect at fulfillment in minor units (cents); it may be less than the order total when the marketplace funds benefits that are not sent as discount lines.
  • Added empty_cart to the order failure reason values reported on failed-order events.

2026-04-29​

Added​

  • Added a menu_refresh event so a DSP can request a menu re-publish for a location via API instead of relying on a manual re-publish from the Stream Website. Read more

2026-02-19​

Added​

  • Added default_item_id field to V1 Item and V2 ItemFamily for specifying the default variation of an item when configured. Read more

2026-02-06​

Added​

  • Added cancel_source and cancel_reason to the cancel order webhook event (Stream -> DSP) for normalized cancelation reporting.

2026-02-05​

  • Added stock_count to item variations on the V1 and V2 api. This field reflects the current stock count of the item within the POS. Read more

2025-09-02​

Added​

  • Added delivery_status_update field to DSP API to allow for updating the delivery status of an order within Stream and the POS when supported. Read more

2025-04-18​

Added​

  • Added allergens field to menu items for structured food allergen information. Read more

2025-02-24​

Added​

  • Added a new webhook endpoint for pausing and resuming an integration from the DSP side. Read more

2024-10-31​

Added​

  • Released a new optimized menu schema (v2) that significantly reduces payload size through improved data associations. The v2 schema provides equivalent menu functionality while requiring smaller request bodies compared to v1. Read more

2024-09-05​

Added​

  • Added support for object-level stock updates via the Stream -> DSP webhook. Read more

2024-07-22​

Added​

  • Added support for refresh token expiration for oAuth platforms like Cognito. Read more

2024-06-07​

Added​

  • Added support for item level tax information. This information is assigned at an item level using tax_ids field and reference objects on the root level taxes field. Read more

2024-06-05​

Added​

2024-05-28​

Added​

2024-05-14​

Added​

  • Added Schedule Exception (Holiday) information to the menu payload. See guide here

2023-04-23​

Added​

  • Enforced 'Stream-Webhook-Signature' on DSP -> Stream requests

Changed​

  • Changed location.order.fail payload failure_details.reason_details -> failure_details.error_message

2023-03-05​

Added​

  • DSP order discounts

2023-01-30​

Added​

  • Driver tips & Fulfillment instructions
  • Delivery fees