Get a Product Category

GET

/store/product-categories/{id}

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

Query Params

Header Params

Responses

🟢200OK

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

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

List Product Categories

Create Cart