Skip to main content
POST
Create a category

Authorizations

x-api-key
string
header
required

Your Store API key (pk_live_...). Create it in Developers › API keys.

x-store-hash
string
header
required

The ID of the store the request is for. Shown in Developers › API keys.

Headers

Idempotency-Key
string

Unique key (for example a UUID) that makes retries safe. The first response is stored for 24 hours and replayed for retries with the same key and body.

Maximum string length: 255

Body

application/json
name
string
required
Maximum string length: 191
slug
string

Lowercase letters, digits and dashes. Generated from the name when omitted.

Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$
icon
string | null
active
boolean
default:true
parent_id
integer | null

Category of this store. null = top level.

position
integer
product_ids
(integer | string)[]

Product IDs or hash IDs of this store (max 1000). Replaces the current list; [] or null clears it.

Response

Created

success
boolean
required
Example:

true

category
object
products
object[]