Skip to main content
POST
Adopt the starter merchandising pack for your brand

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string
required

Required on every mutation. Replaying the same request with the same key returns the original result; reusing the key with a materially different request is rejected 409 with machine code IDEMPOTENCY_CONFLICT.

Minimum string length: 1
X-Client-Id
string
required

Identifies your account. The platform sets this header from your API key when the request is authenticated — you do not send it yourself, and a value you supply is never trusted. Requests without a resolved account identity answer 401 before any processing, and every write is attributed to this identity in the audit trail.

Minimum string length: 1

Path Parameters

brand_id
string
required

The brand to adopt for. Must be one of your account's own brands.

Body

application/json

The starter-pack adoption body: the pack version you are adopting, as stated in your welcome pack. Nothing else rides the body — the template copy is held by the platform, and the brand you are adopting for comes from the path, so you can only ever adopt for a brand that belongs to your account.

pack_version
integer
required

the starter pack version to adopt (the current version is 2)

Response

the adoption result — the offerings adopted and the offerings skipped (already merchandised, or no template available), with the pack version and content hash; or an idempotent replay of the original result

data
object

The starter-pack adoption result: which offerings this call merchandised, and which it skipped — either because they were already merchandised or because the pack has no template for them — together with the pack version and the pack's content hash. The hash is stable for a given pack version: the templates are a fixed, published set, so the hash moves only when those templates themselves change.