Medusa
Store APIAdmin API
Store APIAdmin API
Discord
Twitter
Linkedin
Github
  1. Product Categories
  • Introduction
  • Authentication
  • HTTP Compression
  • Publishable API Key
  • Expanding Fields
  • Selecting Fields
  • Query Parameter Types
  • Pagination
  • Currencies
    • List Currencies
      GET
    • Get a Currency
      GET
  • Payment Providers
    • List Payment Providers
      GET
  • Return Reasons
    • List Return Reasons
      GET
    • Get a Return Reason
      GET
  • Auth
    • Retrieve Registration JWT Token
      POST
    • Authenticate Customer
      POST
    • Generate Reset Password Token for Customer
      POST
    • Refresh Authentication Token
      POST
    • Validate Authentication Callback
      POST
    • Delete Authentication Session
      DELETE
    • Set Authentication Session
      POST
    • Reset a Customer's Password
      POST
  • Collections
    • List Collections
      GET
    • Get a Collection
      GET
  • Regions
    • List Regions
    • Get a Region
  • Products
    • List Products
    • Get a Product
  • Customers
    • Get Logged-in Customer
    • Update Customer
    • Create Address for Logged-In Customer
    • List Customer's Addresses
    • Get Customer's Address
    • Update Customer's Address
    • Remove Customer's Address
    • Register Customer
  • Product Tags
    • List Product Tags
    • Get a Product Tag
  • Returns
    • Create Return
  • Product Types
    • Get a Product Type
    • List Product Types
  • Product Categories
    • List Product Categories
      GET
    • Get a Product Category
      GET
  • Carts
    • Create Cart
    • Set Cart's Customer
    • Add Shipping Method to Cart
    • Add Line Item to Cart
    • Calculate Cart Taxes
    • Get a Cart
    • Update a Cart
    • Update a Line Item in a Cart
    • Remove Line Item from Cart
    • Complete Cart
    • Add Promotions to Cart
    • Remove Promotions from Cart
  • Orders
    • List Logged-in Customer's Orders
    • Request Order Transfer
    • Get an Order
    • Cancel Order Transfer
    • Decline Order Transfer
    • Accept Order Transfer
  • Payment Collections
    • Initialize Payment Session of a Payment Collection
    • Create Payment Collection
  • Shipping Options
    • Calculate Shipping Option Price
    • List Shipping Options for Cart
  1. Product Categories

List Product Categories

GET
/store/product-categories
Retrieve a list of product categories. The product categories can be filtered by fields such as id. The product categories can also be sorted or paginated.

Request

Query Params

Header Params

Responses

🟢200OK
application/json
OK
Body

🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🟠409409
🟠422Parameter Error
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl '{backend_url}/store/product-categories' \
-H 'x-publishable-api-key: {your_publishable_api_key}'
Response Response Example
200 - Example 1
{
    "limit": 0,
    "offset": 0,
    "count": 0,
    "estimate_count": 0,
    "product_categories": [
        {
            "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
                            }
                        }
                    ]
                }
            ]
        }
    ]
}
Modified at 2025-06-17 04:21:30
Previous
List Product Types
Next
Get a Product Category
Built with