Skip to main content

Order Management

Overview​

After a merchant connects one of your locations to Stream, they will be able to receive orders from Stream into your POS system via the Handle Order (Stream -> POS) endpoint.

As we process an order, there are multiple actions that may take place before the final fulfillment of the order.

Order Fulfillment Types​

There are multiple types of fulfillment that can be submitted through Stream:

  • delivery: An order that is being delivered to a customer
  • merchant_managed_delivery: An order that is being delivered to a customer by a merchant's employee/dispatch system
  • pickup: An order that is being picked up by a customer
  • curbside: An order that is being picked up by a customer at a curbside location
  • drive_thru: An order that is being picked up at a drive thru window
  • dine_in: An order that is being taken at a dine in location

Order Source and Brand​

Every order carries two fields that say where it came from:

  • source: the ordering platform, such as grubhub, uber or a partner's slug.
  • brand: the channel within that platform, such as seamless on a Grubhub order, postmates on an Uber order, or catering or kiosk from a platform that sends separate channels. brand can be missing; treat a missing brand as equal to source.

Use brand to give merchants separate visibility of each channel in your POS. For example, map it to a revenue center, order channel, payment type or reporting tag, so that catering or kiosk orders don't mix with the platform's other orders. Match on source when you want one mapping for everything from a platform.

caution

Treating brand as a fixed list rejects or misroutes orders. The values listed in the API spec are examples, and a DSP can send any string. Fall back to source when brand is missing or you don't recognise it.

API Spec

Order Flow Overview​

The typical order flow includes:

  1. Order Reception: Stream receives order from DSP
  2. Validation: Order is validated against catalog and business rules
  3. Acceptance: POS accepts or rejects the order (see Order Acceptance)
  4. Status Updates: Order status is updated throughout fulfillment (see Stream Order Status Updates)
  5. Completion: Order is marked as completed or canceled