POST
Move a category and set its position

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Headers

Idempotency-Key
string
required

A unique key per logical write. Replaying a request with the same key returns the first response byte for byte instead of applying the write twice.

Path Parameters

categoryId
string
required

Body

application/json

Both keys are required and neither is defaulted: omitting parent_id would silently re-root a nested branch. Send null for parent_id to move a category to the top level.

parent_id
string | null
required

The destination parent. An ACTIVE category cannot be moved under a HIDDEN one: the storefront will not render that branch, so the move is refused rather than silently producing an unreachable node.

rank
integer
required

Position among the destination's children, clamped to the ends. The siblings are renumbered around it.

Response

Success

data
object