Skip to main content
POST
Create a group

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: 255
image_url
string | null

http(s) URL.

unlisted
boolean
default:false
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

group
object
products
object[]