Create a Product Category

Create a Product Category.

curl --location -g --request POST '{{BASE_URL}}/admin/product-categories' \ --header 'Content-Type: application/json' \ --data-raw '{ "name": "string", "description": "string", "handle": "string", "is_internal": true, "is_active": true, "parent_category_id": "string" }'

{ "product_category": { "id": "pcat_01G2SG30J8C85S4A5CHM2S1NS2", "name": "Regular Fit", "handle": "regular-fit", "mpath": "pcat_id1.pcat_id2.pcat_id3", "is_internal": false, "is_active": false, "rank": 0, "parent_category_id": null, "parent_category": {}, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "category_children": [ {} ], "products": [ {} ] } }

Request

Query Params

expand

string

optional

Comma-separated relations that should be expanded in the returned product category.

fields

string

optional

Comma-separated fields that should be included in the returned product category.

Body Params application/json

name

string

required

The name of the product category

description

string

optional

The description of the product category.

handle

string

optional

The handle of the product category. If none is provided, the kebab-case version of the name will be used. This field can be used as a slug in URLs.

is_internal

boolean

optional

If set to true, the product category will only be available to admins.

is_active

boolean

optional

If set to false, the product category will not be available in the storefront.

parent_category_id

string

optional

The ID of the parent product category

Examples

Responses

🟢200OK

application/json

Body

product_category

object (Product Category)

required

A product category can be used to categorize products into a hierarchy of categories.

string

required

The product category's ID

Example:

pcat_01G2SG30J8C85S4A5CHM2S1NS2

name

string

required

The product category's name

Example:

Regular Fit

handle

string

required

A unique string that identifies the Product Category - can for example be used in slug structures.

Example:

regular-fit

mpath

string | null

required

A string for Materialized Paths - used for finding ancestors and descendents

Example:

pcat_id1.pcat_id2.pcat_id3

is_internal

boolean

required

A flag to make product category an internal category for admins

Default:

false

is_active

boolean

required

A flag to make product category visible/hidden in the store front

Default:

false

rank

integer

optional

An integer that depicts the rank of category in a tree node

Default:

parent_category_id

string | null

required

The ID of the parent category.

Default:

null

parent_category

object | null

optional

The details of the parent of this category.

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

category_children

array [object]

required

The details of the category's children.

products

array [object]

optional

The details of the products that belong to this category.

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error