Introduction
The API Reference is generated from the Onboarding API contract. There is one section, because this API is one domain: provisioning.
How to read a reference page
- The page title is the operation name —
createLocation, not a sentence. That name is also theoperationIdin the OpenAPI document, so a generated client's method has the same name. - Under the title is the path. Every operation is a
POSTwith 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
- Onboarding — the three provisioning operations: list the brands you own, create a location, and add brands to one.