Skip to main content
POST
Create retailer

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

UUID of the organization to create the retailer for.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Body

application/json
name
string
required
metadata
Metadata · object | null

Developer-attached key/value data. Send {} or null to clear. Empty-string values delete that key. Omitted keys are preserved.

website
string
default:""
gln
string | null
category
string | null
marketplace_regions
string[]

Response

OK

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
name
string
required

Retailer display name.

created
string<date-time>
required

When the retailer was created.

metadata
Metadata · object

Developer-attached key/value data attached to this object. Up to 50 keys; key max 40 chars, value max 500 chars.

is_online
boolean
default:false

Derived — true iff the retailer has at least one active OnlineStore.

is_physical
boolean
default:false

Derived — true iff the retailer has at least one active PhysicalStore.

website
string
default:""

Retailer's canonical homepage URL (separate from individual storefronts).

gln
string | null

GS1 Global Location Number.

is_canonical
boolean
default:false

True for Closient-curated retailers (read-only).

organization_id
string<shortuuid> | null

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
marketplace_regions
string[]

ISO 3166-1 alpha-2 region codes.

category
string | null

Retailer type/category classification.

is_active
boolean
default:true

Whether the retailer is active.