Skip to main content

DSP API Changelog

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