Create category

Creates a new product category. Requires the CATEGORIES_WRITE scope.

Authorization

AuthorizationBearer <token>

Bearer token authentication. Pass the secret directly in the Authorization header. Token secrets start with sk_.

In: header

Path Parameters

storeId*string

Length12 <= length <= 48

Header Parameters

idempotency-key?string

Length8 <= length <= 32

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Match^[a-zA-Z0-9][a-zA-Z0-9 &'\-\.]{0,126}[a-zA-Z0-9]$

Length1 <= length <= 128

slug?string

Match^[a-z0-9][a-z0-9\-]{0,126}[a-z0-9]$

Length2 <= length <= 128

description?string

Lengthlength <= 500

parentId?string

Length12 <= length <= 48

displayOrder?integer

Range0 <= value <= 9999

Default0

icon?string

Match^[a-z0-9\-]+$

Length1 <= length <= 64

metaTitle?string

Lengthlength <= 128

metaDescription?string

Lengthlength <= 320

showInNavigation?boolean

Defaulttrue

featured?boolean

Defaultfalse

isFavourite?boolean

Defaultfalse

isArchived?boolean

Defaultfalse

productIds?array<>

Itemsitems <= 100

Response Body

`application/json`

curl -X POST "https://example.com/stores/stringstring/categories/" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "ok": true,  "data": {    "id": "ctg_4tzcbfp2v8q1mzwxj5h0r1n",    "name": "Plans",    "slug": "plans",    "description": "Subscription plans for the platform.",    "parentId": null,    "displayOrder": 0,    "icon": null,    "metaTitle": null,    "metaDescription": null,    "showInNavigation": true,    "featured": false,    "isFavourite": false,    "isArchived": false,    "createdAt": "2026-05-01T10:00:00.000Z",    "updatedAt": "2026-05-01T10:00:00.000Z"  }}

Create category

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

201application/json

400application/json

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

`application/json`

`application/json`