Get a Product Category

GET

/store/product-categories/{id}

Product Categories

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

Request Example

JavaScript

Shell

Java

Swift

curl --location -g --request GET '{{BASE_URL}}/store/product-categories/' \
--header 'x-publishable-api-key;'

Response Example

200 - Example 1

{
    "product_category": {
        "id": "string",
        "name": "string",
        "description": "string",
        "handle": "string",
        "rank": 0,
        "parent_category_id": "string",
        "parent_category": {},
        "metadata": {},
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "category_children": [
            {}
        ],
        "products": [
            {
                "length": 0,
                "title": "string",
                "description": "string",
                "id": "string",
                "metadata": {},
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "handle": "string",
                "subtitle": "string",
                "is_giftcard": true,
                "thumbnail": "string",
                "width": 0,
                "weight": 0,
                "height": 0,
                "origin_country": "string",
                "hs_code": "string",
                "mid_code": "string",
                "material": "string",
                "collection_id": "string",
                "type_id": "string",
                "discountable": true,
                "external_id": "string",
                "deleted_at": "2019-08-24T14:15:22Z",
                "categories": [
                    {}
                ],
                "status": "draft",
                "images": [
                    {
                        "id": "string",
                        "url": "string",
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "deleted_at": "2019-08-24T14:15:22Z",
                        "metadata": {},
                        "rank": 0
                    }
                ],
                "tags": [
                    {
                        "id": "string",
                        "value": "string",
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "deleted_at": "2019-08-24T14:15:22Z",
                        "metadata": {}
                    }
                ],
                "collection": {
                    "id": "string",
                    "title": "string",
                    "handle": "string",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "metadata": {},
                    "products": [
                        {}
                    ]
                },
                "type": {
                    "id": "string",
                    "metadata": {},
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "value": "string"
                },
                "options": [
                    {
                        "id": "string",
                        "title": "string",
                        "product": {},
                        "product_id": "string",
                        "metadata": {},
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "deleted_at": "2019-08-24T14:15:22Z",
                        "values": [
                            {
                                "id": "string",
                                "value": "string",
                                "option": {},
                                "option_id": "string",
                                "metadata": {},
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z",
                                "deleted_at": "2019-08-24T14:15:22Z"
                            }
                        ]
                    }
                ],
                "variants": [
                    {
                        "product": {},
                        "length": 0,
                        "title": "string",
                        "metadata": {},
                        "id": "string",
                        "width": 0,
                        "weight": 0,
                        "height": 0,
                        "origin_country": "string",
                        "hs_code": "string",
                        "mid_code": "string",
                        "material": "string",
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "deleted_at": "2019-08-24T14:15:22Z",
                        "product_id": "string",
                        "sku": "string",
                        "barcode": "string",
                        "ean": "string",
                        "upc": "string",
                        "allow_backorder": true,
                        "variant_rank": 0,
                        "manage_inventory": true,
                        "inventory_quantity": 0,
                        "options": [
                            {
                                "id": "string",
                                "value": "string",
                                "option": {},
                                "option_id": "string",
                                "metadata": {},
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z",
                                "deleted_at": "2019-08-24T14:15:22Z"
                            }
                        ],
                        "calculated_price": {
                            "id": "string",
                            "is_calculated_price_price_list": true,
                            "is_calculated_price_tax_inclusive": true,
                            "calculated_amount": 0,
                            "calculated_amount_with_tax": 0,
                            "calculated_amount_without_tax": 0,
                            "is_original_price_price_list": true,
                            "is_original_price_tax_inclusive": true,
                            "original_amount": 0,
                            "currency_code": "usd",
                            "calculated_price": {},
                            "original_price": {},
                            "original_amount_with_tax": 0,
                            "original_amount_without_tax": 0
                        }
                    }
                ]
            }
        ]
    }
}

Request

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.

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.

Header Params

x-publishable-api-key

string

required

Publishable API Key created in the Medusa Admin.

Responses

🟢200OK

application/json

Body

The product category's details.

product_category

object (StoreProductCategory)

required

The category's details.

string

required

The category's ID.

name

string

name

required

The category's name.

description

string

description

required

The category's description.

handle

string

handle

required

The category's handle.

rank

number

rank

required

The category's rank.

parent_category_id

string

parent_category_id

required

The ID of the category's parent.

parent_category

object

required

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.

deleted_at

string <date-time>

deleted_at

required

The date the category was deleted.

category_children

array [object]

required

The category's children.

products

array[object (StoreProduct) {31}]

optional

The category's products.

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

Modified at 2025-06-17 04:21:30

List Product Categories

Create Cart