Introduction
The API Reference has one section, because this API covers one domain: provisioning. Each page in it covers one operation.
How to read a reference page
- The page title is a short description of the operation, for example Create a location.
- Under the title is the path. It ends with the operation name, for example
createLocation. That name is also theoperationIdin the OpenAPI document, so a generated client's method has the same name. Every operation is aPOSTwith 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 cURL, Go, raw HTTP, Java, JavaScript and Python.
OpenAPI document
The whole API is also published as one OpenAPI 3.1 document, for generating a client or importing into your own tools: openapi.json.
Sections
- Onboarding: the three provisioning operations (list the brands you own, create a location, and add brands to one).