Introduction

The API Reference is generated from the Management API contract. Each section below corresponds to one domain of the API, and each page inside it to one operation.

How to read a reference page

• The page title is the operation name — fetchOrders, not a sentence. That name is also the operationId in the OpenAPI document, so a generated client's method has the same name.
• Under the title is the path. Every operation is a POST with one JSON body and one JSON reply. There are no path parameters and no query strings.
• Request lists the body's fields: the field name, its type, its description, and — for an enumerated field — the complete set of accepted values under Possible values.
• The right-hand column carries the authorization headers the operation requires and a ready-to-paste code sample in Go, raw HTTP, Java and JavaScript, each using only that language's standard library.

Sections

• Orders — the normalized order feed across every connected delivery platform.
• Stores — the store directory and identity map: locations, brands, and the storefronts that sit at their intersection.
• Management — service-level operations for the API itself.

Implementation status

An operation whose description says it is not yet implemented has a real, final contract and a server that answers 501 until the read behind it lands. That is deliberate: an empty result page is a factual claim ("nothing matched") that an integration is entitled to act on, and returning one for an unimplemented operation would be a lie with real consequences downstream.