POS API Changelog
2026-11-17
Added
GET /onboarding/org/{id}/locationsreturns two optional fields on eachdsps[]entry:dsp_provider_id(the store's ID at the DSP) andintegration_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 statusdeprovisioned, or the newwaiting_for_deprovisionwhen Stream must remove a connection manually; call it again after Stream finishes to move it todeprovisioned. Repeat calls are safe. An onboarding of another partner, or a missing one, now returns404, and a disconnected onboarding cannot be reconnected or bound (400). Read more
2026-11-16
Added
menu.publish_failureevents can carry three morefailure_codevalues:PUBLISH_VALIDATION_BELOW_THRESHOLD(too few items have the attributes the DSP requires),INSUFFICIENT_UPC_COVERAGE(retail: too few items have a valid UPC) andDSP_LOCATION_NOT_READY(the DSP store is not far enough into onboarding to accept a catalog). Stream already sends these codes. Handle unknown codes as a generic failure. API Spec- The API spec now lists
Modifier.modifier_overrides(a modifier can override the price of its child modifiers) andModifierGroupRules.default_modifiers_free(the group's default options are not charged). API Spec UnitValue.unitalso acceptsft,m,mm,ydandkg.allergensacceptsnone, anddietary_tagsacceptsnut_freeandnone. Usenonewhen the merchant confirmed the item has none; Stream does not publish it to DSPs. API Spec
Changed
menu_idonmenu.publish_failureevents is now optional. Stream already omits it on some failures, so do not require it. API SpecItem.additional_nutritional_detailsis now fully typed asPartnerNutritionalDetails: nutrients as{ value, unit }, labels such asserving_sizeas strings, packaging flags such asdeposit_requiredas booleans. Stream already accepted these values. Read more- API spec corrections, with no change in behaviour:
classificationson item families is shown as an array of enum values, and several fields now say which field replaces them (for examplecustomer_name→customers[].name).
2026-11-13
Changed
- Documented how to use the order
brandfield alongsidesource:brandis the channel within the ordering platform (seamlesson a Grubhub order,postmateson an Uber order, orcateringorkioskfrom a DSP that sends them). Map it to a revenue center, order channel or payment type so merchants can see each channel separately.brandcan be any string, not only the values in the spec, and can be missing; treat a missingbrandassource. Documentation only; no behaviour changed. The field has been on orders since 2024-07-09. Read more | API Spec
2026-11-11
Changed
- Corrected the Prep Time Overrides docs:
percentagescaling takes a decimal multiplier (0.1= 10%, not10),flatsets the minutes each additional unit takes, and the item prep time is added on top of the location prep time rather than replacing it. Documentation only; no behaviour changed, and the calculation has worked this way since these fields were added. Read more
2026-11-09
Changed
- Documented that line item and modifier quantities and prices are per unit. A modifier's
quantityis how many times it was selected on one unit of its parent line, not the total across the line, and a line's total isquantity× (price_amount+ each modifier'squantity×price_amount). Documentation only; no behaviour changed — Stream has always sent orders this way, and DSPs are now told to send modifier quantities per unit too. Read more | API Spec
2026-11-09
Added
- Documented the rejection traps on the Order Rejection page: a
500with aposValidationbody is a rejection (not retried), a bare400withoutposValidationis retried before the order fails, andposValidationis read only on400and500. Documentation only; no behaviour changed. Read more | API Spec
2026-11-05
Added
- Timeouts and retries for new orders: the 60-second response timeout, which responses Stream retries and which it treats as a final rejection, the retry schedule, and how to use
idempotency_keyto avoid duplicate orders. The retry schedule has been live since September 2024. Since 2026-11-04, apos_offlinerejection is retried before the order fails; before that it failed the order on the first attempt. Read more | API Spec
Changed
- Documented that
dsp_price_amount_overridesanddsp_is_active_overridesare authoritative when your POS sends them. A sync that includes either property replaces the per-DSP prices or availability that a merchant set in Stream, and an empty array ([]) clears them all. Omit the property to leave values set in Stream unchanged. Documentation only; no behaviour changed, as this rule has applied to these fields since 2024. Read more | API Spec - Binding a location to a DSP that Stream does not offer in the location's country now fails with
400andcode: "dsp_country_not_served". The body names the refusedlocation_id, thecountry_coderead from the location's address, and, when another DSP serves that country, thesuggested_sourceto bind instead. For example, German and Austrian locations bind to Lieferando, not Just Eat Takeaway. Existing connections are not affected. Read more
2026-10-22
Changed
delivery_address.city,delivery_address.state,delivery_address.postal_codeandcustomers[].nameonorder.createdare now documented as optional. Ordering platforms do not always provide them (for example a map-pin address or a redacted customer name), and Stream forwards what it receives, so these fields can be empty or absent. Accept these orders rather than rejecting them during request validation. No behaviour changed. Read more | API Spec
2026-10-14
Added
- New catalog example: a combo meal built with nested modifiers (choose an entrée, side, and drink, each with its own follow-up choices such as toppings or drink size), plus an optional "make it a combo" upgrade nested three levels deep. Documentation only; no behaviour changed, as nested modifier groups and these rules are already supported. Read more | API Spec
2026-09-28
Added
- POS-initiated order adjustments. Send
order.adjustment.requestedto remove a line item, reduce its quantity, or substitute an item on a pending or in-progress order. Stream validates synchronously (4xxwith acodeon rejection), then reports the DSP's answer withorder.adjustedor the neworder.adjustment.failedevent. This is opt-in per merchant: contact Stream to enable it. Read more line_items[]._idonorder.createdandorder.adjusted: the Stream id of each line item, used to reference it in adjustment requests.applied_adjustments[]onorder.adjustednow also carries_idand, for substitutions,substitution.
2026-09-14
Added
order.creatednow includesdelivery_fee_taxesonmerchant_managed_deliveryorders — the tax charged on the delivery fee, in cents. It is additive and separate fromtax; sum the two for the order's total tax. The field is omitted when there is no delivery-fee tax. Read more
Changed
taxonorder.creatednow consistently excludes the delivery-fee tax. Where the delivery-fee tax was previously bundled intotax, it is now itemized in the newdelivery_fee_taxesfield. Reconcile total tax astax + delivery_fee_taxes. Read more
2026-09-12
Removed
- Removed
dsp_provider_location_idfrom themenu.publish_successandmenu.publish_failurenotification events. The field was only populated on some publish paths and never carried a reliable value. Uselocation_id(your own POS provider location id) to identify the location a publish notification refers to.
2026-09-09
Added
- Item-level discounts that span multiple line items can now carry a per-item split. Each entry in a discount's
itemsarray may include an optionalamount(in cents) giving that line's share of the discount, so a promotion such as a multi-item "buy one, get one" applies the correct amount to each item instead of the whole discount landing on one line. The per-item amounts sum to the discount's top-levelamount; whenamountis omitted on an item, existing behavior is unchanged. Read more
2026-08-24
Added
- Cash orders now surface the fee components that make up
cash_amount_due, so the amount to collect in cash can be reconciled against the order.dsp_feescarries diner-paid fees that are remitted to the platform and are not merchant revenue (e.g. an Uber marketplace fee or a Wolt small-order surcharge), andamount_paid_by_other_methodscarries any portion already settled electronically. Both are optional and additive. Read more - Headless white-label partners can now restart OAuth for an existing POS integration and refresh its credentials in place, without creating a new integration. Reconnection is available only for supported OAuth providers. Read more
Changed
- Clarified that
cash_amount_dueis a verbatim value from the ordering platform and may be greater or less than the order total. It can exceed subtotal + delivery when the customer pays platform fees in cash (now itemized indsp_fees). Read more
2026-08-06
Added
- Categories now accept an optional
scheduleof availability hours — the same weekly, multi-slot shape as the menu-levelschedule, including split windows and ranges crossing midnight. A category without aschedulefollows the availability of the menus it belongs to exactly as before, so existing integrations are unaffected. Read more | API Spec - Category hours can be scoped per menu via
menu_overrides[].override.schedule, letting a category shared across menus keep different hours in each. This works in any catalog — unlike other override fields, it does not require a global catalog. Read more - Global catalogs can scope category hours per location via
location_overrides[].override.schedule. Read more - Added optional catering (ezCater) fields to the catalog schema. Item families accept
unit_of_measure,individual_wrap_status,item_type_tags, andtax_category; items acceptnumber_of_people(serves). Values are validated against their enums on ingest and flow through to ezCater on menu sync. These are optional and additive — partners not sending them see no change in behavior. Read more
2026-08-04
Added
- The
order.canceledevent (Stream -> POS) now includes an optionalcancel_reasonfield — the normalized reason the DSP gave for the cancellation (e.g.customer_requested,item_out_of_stock,driver_unavailable,other). It is omitted when the DSP provided no reason, so existing consumers are unaffected. Read more | API Spec
2026-06-15
Added
- Added bundle information on the new order event payload. Line items that belong to a bundle now carry a
bundle_id, and a new order-levelbundlesarray describes each bundle (id,name,quantity,price_amount). This lets you identify which items in an order belong to a bundle for reporting purposes; it is optional to consume and non-bundle orders are unchanged. Read more
2026-05-26
Added
- Added
cash_amount_dueon the new order event payload. When an order is unpaid/cash, this is the amount to collect at fulfillment in minor units (cents); some marketplaces (e.g. Uber Eats) omit discount lines for platform-funded promos while still reporting partial cash due here. - Added
driver_location(last known driverlatitude/longitude) onDeliveryDriverDetailsfor order status update events. - Added optional
descriptiononMerchantLocation. - Added
kosherandspicyvalues to item familydietary_tags. - Added
DSP_CONFIGURATION_ERRORandASSEMBLY_FAILEDmenu publish failure codes.
2026-05-13
Added
- Added optional
provider_loyalty_idon the orderCustomerobject. Forwarded from DSPs that provide a loyalty program identifier (e.g. Deliveroo). Read more
2026-04-30
Added
- Added
manufacturer_nameandmanufacturer_brandfields on item families for pre-packaged goods. These map to JETmanufacturer.name/manufacturer.brandused by Lieferando and other JET partners for DE compliance. Read more - Added optional
dsp_sourceonlocation.status.updatedwebhooks to pause or resume a single DSP platform for a location. If omitted, the status update continues to apply to all DSP connections for the location. Link
2026-04-21
Added
- Added multilingual catalog support via top-level
default_languageon the Get Catalog response andname_translations/description_translationsarrays on categories, item families, items, modifier groups, modifiers, and menus. Read more
2026-04-16
Changed
- Removed
imagesfrom POSItem. Provide catalog imagery onitem_family; modifier groups and modifiers continue to supportimages. Read more
2026-03-31
Added
- Added
dietary_tagsfield on item families for dietary attributes (vegan, vegetarian, gluten-free, etc.). Read more - Added prep time override fields on item families:
prep_time_exception_minutes,prep_time_scaling_type,prep_time_scaling_value. Read more - Added EU regulatory fields on item families:
additives,country_of_origin,storage_type. Read more - Added
descriptionandimagesfields on items, modifier groups, and modifiers. Read more - Added item-level regulatory and nutritional fields:
ingredients,additional_nutritional_details,alcohol_percentage,caffeine_content_mg. Read more - Added physical dimension and packaging fields on items:
dimensions,weight,volume,count_per_pack,size_per_pack_item. Read more
2025-12-19
Added
- Added support for
classificationson item families, providing support for Deliveroo Item Classifications
2025-11-18
Added
- Added support for
holidayson catalog objects. Read more - Added support for
provider_org_nameonsso_details. Read more
2025-09-22
Added
- Added support for
longitudeandlatitudeondelivery_address.
2025-07-09
Added
- Added support for In-Store Orders. Read more
2025-06-09
Added
- Added support for
connection_statuson POS location connections. Read more
2025-04-18
Added
Added
customersfield to orders in preparation for group order support. Read moreAdded
allergensfield to catalog items for structured food allergen information. Read more
2025-02-24
Added
- Added
item_family_provider_idandmodifier_group_provider_idto theorder.createdline item object. Link
2025-02-11
Added
2025-01-16
Added
- Added support for
menu_overrideson Global Catalog objects. Read more
2024-11-11
Added
- Added an
idempotency_keyto the new order submission webhook. Read more
2024-10-31
Added
- Added support for
customer_emailon incoming orders. Link
2024-10-14
Added
- Added support for catalog object price markups on specific DSPs. Read more
2024-09-20
Added
- Added support for UPC and SKU on catalog items via a new
upcandskupropert on items and item families Link
2024-08-29
Added
- Added support for nested categories. Read More
2024-07-25
Added
- Added support for individual object stock notifications. Read more
2024-07-22
Added
- Added support for refresh token expiration for oAuth platforms like Cognito. Read more
2024-07-09
Added
- New order
brandproperty to distinguish ordering brand for multi-brand connections Link
2024-07-01
Added
- Deprecated order validations
unknownValidationin favor oforderValidation-order.createdresponse Link
2024-06-24
Added
- Support for POS sourced location status notifications -
location.status.updatedLink
2024-06-05
Added
- Support for miscellaneous services charges with the
service_chargeproperty on orders
2024-05-24
Added
- Support for modifier-specific modifier group overrides - Link
2024-05-08
Added
- Item specific
tax_ids- Link
2024-04-13
Added
- Order
placed_atproperty
Change
- /v1/token authorization_code grant includes
redirect_uri
2024-03-23
Added
- oAuth
sso_details- Link
2024-03-06
Added
- Add alcohol indicator - Link
2024-02-07
Added
- Markup support (opt-in) - Link
2024-01-25
Added
- Dynamic prep time support - Link