Skip to main content

POS 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​

Added​

  • menu.publish_failure events can carry three more failure_code values: PUBLISH_VALIDATION_BELOW_THRESHOLD (too few items have the attributes the DSP requires), INSUFFICIENT_UPC_COVERAGE (retail: too few items have a valid UPC) and DSP_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) and ModifierGroupRules.default_modifiers_free (the group's default options are not charged). API Spec
  • UnitValue.unit also accepts ft, m, mm, yd and kg.
  • allergens accepts none, and dietary_tags accepts nut_free and none. Use none when the merchant confirmed the item has none; Stream does not publish it to DSPs. API Spec

Changed​

  • menu_id on menu.publish_failure events is now optional. Stream already omits it on some failures, so do not require it. API Spec
  • Item.additional_nutritional_details is now fully typed as PartnerNutritionalDetails: nutrients as { value, unit }, labels such as serving_size as strings, packaging flags such as deposit_required as booleans. Stream already accepted these values. Read more
  • API spec corrections, with no change in behaviour: classifications on item families is shown as an array of enum values, and several fields now say which field replaces them (for example customer_name → customers[].name).

2026-11-13​

Changed​

  • Documented how to use the order brand field alongside source: brand is the channel within the ordering platform (seamless on a Grubhub order, postmates on an Uber order, or catering or kiosk from a DSP that sends them). Map it to a revenue center, order channel or payment type so merchants can see each channel separately. brand can be any string, not only the values in the spec, and can be missing; treat a missing brand as source. 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: percentage scaling takes a decimal multiplier (0.1 = 10%, not 10), flat sets 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 quantity is how many times it was selected on one unit of its parent line, not the total across the line, and a line's total is quantity × (price_amount + each modifier's quantity × 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 500 with a posValidation body is a rejection (not retried), a bare 400 without posValidation is retried before the order fails, and posValidation is read only on 400 and 500. 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_key to avoid duplicate orders. The retry schedule has been live since September 2024. Since 2026-11-04, a pos_offline rejection 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_overrides and dsp_is_active_overrides are 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 400 and code: "dsp_country_not_served". The body names the refused location_id, the country_code read from the location's address, and, when another DSP serves that country, the suggested_source to 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_code and customers[].name on order.created are 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.requested to remove a line item, reduce its quantity, or substitute an item on a pending or in-progress order. Stream validates synchronously (4xx with a code on rejection), then reports the DSP's answer with order.adjusted or the new order.adjustment.failed event. This is opt-in per merchant: contact Stream to enable it. Read more
  • line_items[]._id on order.created and order.adjusted: the Stream id of each line item, used to reference it in adjustment requests. applied_adjustments[] on order.adjusted now also carries _id and, for substitutions, substitution.

2026-09-14​

Added​

  • order.created now includes delivery_fee_taxes on merchant_managed_delivery orders — the tax charged on the delivery fee, in cents. It is additive and separate from tax; sum the two for the order's total tax. The field is omitted when there is no delivery-fee tax. Read more

Changed​

  • tax on order.created now consistently excludes the delivery-fee tax. Where the delivery-fee tax was previously bundled into tax, it is now itemized in the new delivery_fee_taxes field. Reconcile total tax as tax + delivery_fee_taxes. Read more

2026-09-12​

Removed​

  • Removed dsp_provider_location_id from the menu.publish_success and menu.publish_failure notification events. The field was only populated on some publish paths and never carried a reliable value. Use location_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 items array may include an optional amount (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-level amount; when amount is 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_fees carries 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), and amount_paid_by_other_methods carries 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_due is 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 in dsp_fees). Read more

2026-08-06​

Added​

  • Categories now accept an optional schedule of availability hours — the same weekly, multi-slot shape as the menu-level schedule, including split windows and ranges crossing midnight. A category without a schedule follows 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, and tax_category; items accept number_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.canceled event (Stream -> POS) now includes an optional cancel_reason field — 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-level bundles array 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_due on 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 driver latitude / longitude) on DeliveryDriverDetails for order status update events.
  • Added optional description on MerchantLocation.
  • Added kosher and spicy values to item family dietary_tags.
  • Added DSP_CONFIGURATION_ERROR and ASSEMBLY_FAILED menu publish failure codes.

2026-05-13​

Added​

  • Added optional provider_loyalty_id on the order Customer object. Forwarded from DSPs that provide a loyalty program identifier (e.g. Deliveroo). Read more

2026-04-30​

Added​

  • Added manufacturer_name and manufacturer_brand fields on item families for pre-packaged goods. These map to JET manufacturer.name / manufacturer.brand used by Lieferando and other JET partners for DE compliance. Read more
  • Added optional dsp_source on location.status.updated webhooks 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_language on the Get Catalog response and name_translations / description_translations arrays on categories, item families, items, modifier groups, modifiers, and menus. Read more

2026-04-16​

Changed​

  • Removed images from POS Item. Provide catalog imagery on item_family; modifier groups and modifiers continue to support images. Read more

2026-03-31​

Added​

  • Added dietary_tags field 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 description and images fields 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 classifications on item families, providing support for Deliveroo Item Classifications

2025-11-18​

Added​

  • Added support for holidays on catalog objects. Read more
  • Added support for provider_org_name on sso_details. Read more

2025-09-22​

Added​

  • Added support for longitude and latitude on delivery_address.

2025-07-09​

Added​

2025-06-09​

Added​

  • Added support for connection_status on POS location connections. Read more

2025-04-18​

Added​

  • Added customers field to orders in preparation for group order support. Read more

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

2025-02-24​

Added​

  • Added item_family_provider_id and modifier_group_provider_id to the order.created line item object. Link

2025-02-11​

Added​

  • Added is_tax_exempt item families. Read more

  • Added prep_time_minutes to locations. Read more

2025-01-16​

Added​

  • Added support for menu_overrides on Global Catalog objects. Read more

2024-11-11​

Added​

  • Added an idempotency_key to the new order submission webhook. Read more

2024-10-31​

Added​

  • Added support for customer_email on 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 upc and sku propert 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 brand property to distinguish ordering brand for multi-brand connections Link

2024-07-01​

Added​

  • Deprecated order validations unknownValidation in favor of orderValidation - order.created response Link

2024-06-24​

Added​

  • Support for POS sourced location status notifications - location.status.updated Link

2024-06-05​

Added​

  • Support for miscellaneous services charges with the service_charge property 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_at property

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