Get a Product Category

Retrieve a product category by its ID. You can expand the product category's relations or select the fields that should be returned.

{ "product_category": { "parent_category": {}, "name": "string", "description": "string", "id": "string", "metadata": {}, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "handle": "string", "deleted_at": "2019-08-24T14:15:22Z", "is_active": true, "is_internal": true, "rank": 0, "parent_category_id": "string", "category_children": [ {} ], "products": [ {} ] } }

Request

Authorization

Path Params

string

required

The product category's ID.

Query Params

fields

string

fields

optional

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the Retrieve Custom Links documentation.

include_ancestors_tree

boolean

include_ancestors_tree

optional

Whether to retrieve the category's parent. If you enable this, add to the fields query parameter parent_category to set the parent of a category in this field. You can either pass *parent_category to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, fields=parent_category.id,parent_category.name.

include_descendants_tree

boolean

include_descendants_tree

optional

Whether to retrieve a list of child categories. If you enable this, add to the fields query parameter category_children to set the children of a category in this field. You can either pass *category_children to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, fields=category_children.id,category_children.name.

Responses

🟢200OK

application/json

Body

The product category's details.

product_category

object (AdminProductCategory)

required

The product category's details.

parent_category

object

required

name

string

name

required

The category's name.

description

string

description

required

The category's description.

string

required

The category's ID.

metadata

object

optional

The category's metadata, can hold custom key-value pairs.

created_at

string <date-time>

created_at

required

The date the category was created.

updated_at

string <date-time>

updated_at

required

The date the category was updated.

handle

string

handle

required

The category's unique handle.

deleted_at

string <date-time>

deleted_at

required

The date the category was deleted.

is_active

boolean

is_active

required

Whether the category is active. If disabled, the category isn't shown in the storefront.

is_internal

boolean

is_internal

required

Whether the category is internal. If enabled, the category is only seen by admin users.

rank

number

rank

required

The category's rank among sibling categories.

parent_category_id

string

parent_category_id

required

The ID of the category's parent.

category_children

array [object]

required

The category's children.

products

array [object]

optional

The category's products.

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error