API docs
Sous Chef Management API
Request access

Platform coverage

This page shows what each delivery platform supports through Sous Chef, and the behaviours worth designing for, so that you can plan for the differences. Where a limit belongs to a platform, it says so.

Platform-dependent coverage

Delivery platforms expose different capabilities to integrations. Sous Chef normalizes what can be normalized and documents the rest.

CapabilityDoorDashUber EatsGrubhub
Orders (read + webhooks)YesYesYes
Order-level promotion attributionYes (merchant-funded and co-funded only)YesPartial
Store status read + discrepancyYesYesYes
Pause / unpauseYesYesYes (no pause-reason support platform-side)
Item availabilityYesYesYes
ReportsNot available through this APIYesYes
Menu publishYes (confirms)Yes (acknowledges)Yes (acknowledges)
Promotions read / writeNo (order-level attribution only)Read + writeNo (no platform API surface)

Per-platform report types, window constraints and pointers to official documentation are in the Platform report catalogue. Report coverage is also readable programmatically through fetchReportCoverage.

Notes worth designing around

  • Reporting on DoorDash. DoorDash reports are not available through this API. fetchReportCoverage returns those rows as unavailable, with the reason attached. Use the export in the DoorDash Merchant Portal.
  • Menu publish confirmation differs by platform. Some platforms confirm a menu went live (confirmed); others only acknowledge the submission (acknowledged). The publication status tells you which one you got. An acknowledgement is never reported as a confirmation.
  • Promotion attribution is incomplete on some platforms. Promotions funded entirely by the platform are not transmitted to integrations, so they cannot be attributed. Attribution covers merchant-funded and co-funded activity.
  • Promotions follow each platform's limits. Uber Eats offers integrations a full create / read / revoke lifecycle, and promotions are immutable once created: there is no update or pause platform-side. DoorDash restaurant storefronts expose no promotion write API to integrations; campaigns are created in DoorDash's own tools and integrations receive order-level attribution. Grubhub exposes no promotions API surface at all; promotion amounts arrive on order payloads and are carried through the order's financial breakdown. Platform APIs change on their own schedule; the platforms' own documentation is authoritative.

Not available

CapabilityStatus
Menu edits (changing items, prices or modifiers)Not available. Read with fetchMenu, publish with publishMenu, edit in the portal.
Promotions on DoorDash and GrubhubNot available. The promotion operations cover Uber Eats storefronts only.
Kitchen order lifecycle writes (accept, mark ready, cancel)Not available. Those actions happen in the kitchen, on the Sous Chef tablet.

Behaviours to design for

Read these once. Each one saves an integration bug.

  • Saving a menu is not publishing it. Menu edits change Sous Chef state only. Guests see a change after an explicit publish, which is asynchronous and per-platform.
  • Item availability applies at the kitchen (location) level and reaches every storefront selling the item. There is no per-storefront availability: a store-scoped availability call resolves to the parent location and affects sibling storefronts too. For this reason fetchStoreItems is store-_addressed_, not store-_scoped_, and echoes the locationId it answered from. It does narrow the brand (a kitchen hosts several), so you see the storefront's own catalogue, not its neighbours'.
  • Item availability is what Sous Chef intends, not what the platform shows. A platform can mark an item unavailable on its own side, and no read here reports that. It is the item-level counterpart of the desired / observed split fetchStoreStatus makes explicit for the storefront.
  • A modifier's availability can cascade to parent items. The write response reports the item you set. Read fetchLocationItems again to see the full effect rather than assuming the scope of the change.
  • Webhooks are retried and unordered. A delivery can arrive more than once. Deduplicate, order by the transported state, and reconcile from the reads. See Webhooks.
  • Order history is queried by creation time, with an inclusive lower bound and an exclusive upper one. There is no maximum window width and no rolling retention ceiling, so history stays queryable well beyond any platform's export window and a full backfill can be one request's window paged with the cursor. There is no pickup-time filter: an order's pickup time is a different timestamp, and windowing on creation time is what makes a backfill exact. Every order is created exactly once, so contiguous windows partition your history with no gap and no overlap. Filtering by locationCode, storeId and statuses works alongside the window, and the page is sorted by creation time in whichever direction you ask for. orderIds replaces every other filter, the window included.
  • locationCode and storeId cannot be combined on fetchOrders. Sending both is a 400. A storefront is already inside exactly one kitchen, so the pair is either redundant or contradictory; send whichever one you mean.
  • Observed platform state has a freshness window. Check lastPolledAt before acting. See Data freshness.
  • lastPolledAt is the timestamp on a store status. It is when the observation was taken. A discrepancy is a standing condition rather than an event, so it is true as of lastPolledAt and you re-read to see whether it still holds.