API reference
Categories
Up to 100 categories per store. Deleting one leaves its products uncategorised.
Endpoints
GET/categoriescategories:read
List categories.
curl https://api.sellhidden.com/v1/categories \
-H "Authorization: Bearer hsk_live_…"200 OKjson
{ "ok": true, "categories": [ { "id": "clx…", "name": "Software", "slug": "software", "position": 0, "productCount": 12, "activeProductCount": 11, "createdAt": "…" } ] }POST/categoriescategories:writeIdempotency-Key201
Create a category.
| Body | Type | Description |
|---|---|---|
| namerequired | Type: string | Unique in the store, up to 60 characters. |
| slug | Type: string | Derived from the name when omitted. |
curl -X POST https://api.sellhidden.com/v1/categories \
-H "Authorization: Bearer hsk_live_…" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"name":"Software"}'GET/categories/{id}categories:read
Get a category.
curl https://api.sellhidden.com/v1/categories/ID \
-H "Authorization: Bearer hsk_live_…"PATCH/categories/{id}categories:write
Update a category.
| Body | Type | Description |
|---|---|---|
| name | Type: string | |
| slug | Type: string | |
| position | Type: integer | Display position, 0 first. |
curl -X PATCH https://api.sellhidden.com/v1/categories/ID \
-H "Authorization: Bearer hsk_live_…" \
-H "Content-Type: application/json" \
-d '{"name":"Licenses"}'DELETE/categories/{id}categories:write
Delete a category.
curl -X DELETE https://api.sellhidden.com/v1/categories/ID \
-H "Authorization: Bearer hsk_live_…"200 OKjson
{ "ok": true, "id": "clx…", "uncategorisedProducts": 3 }POST/categories/reordercategories:writeIdempotency-Key
Reorder categories.
| Body | Type | Description |
|---|---|---|
| orderrequired | Type: string[] | Category ids in display order. |
curl -X POST \
https://api.sellhidden.com/v1/categories/reorder \
-H "Authorization: Bearer hsk_live_…" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"order":["clx1","clx2"]}'Get help
Send us the endpoint, the request or delivery id and the response you got. Security findings go through responsible disclosure. Live platform status is on the support page.
See also