Skip to main content
GET
Check whether your brand is ready to sell

Authorizations

Authorization
string
header
required

Per-client API key (M2M). Presented as Authorization: Bearer <key>.

Headers

X-Brand-Id
string
required

Your brand id (brd_...). It must be one of the brands your API key's account owns; with a publishable key it must be the one brand the key was issued for. A missing or malformed value is refused with 400, and an unknown or foreign brand with 404.

Pattern: ^brd_[A-Za-z0-9][A-Za-z0-9_-]*$

Path Parameters

brand_id
string
required

the brand to check. Must be one of your own brands; any other brand is not found (404, never 403 — existence is never revealed across accounts).

Response

the brand's readiness report

data
object
required

Whether one of your brands is ready to sell, and what is outstanding if it is not. checks covers the brand as a whole; offerings covers each offering you have enabled. Read source_readable first: false means the platform could not read your offering setup just now, so an empty rows list means "we could not look", never "nothing is outstanding".