Medusa
Store APIAdmin API
Store APIAdmin API
Discord
Twitter
Linkedin
Github
  1. Product Categories
  • Getting Started
    • Introduction
    • Authentication
    • HTTP Compression
    • Publishable API Key
    • Expanding Fields
    • Selecting Fields
    • Query Parameter Types
    • Pagination
  • Auth
    • Check if Email Exists
      GET
    • Customer Login (JWT)
      POST
    • Customer Login (JWT)
      POST
    • Customer Log out
      DELETE
    • Get Current Customer
      GET
    • Customer Login
      POST
  • Carts
    • Create Payment Sessions
      POST
    • Update a Payment Session
      POST
    • Delete a Payment Session
      DELETE
    • Create a Cart
      POST
    • Get a Cart
      GET
    • Update a Cart
      POST
    • Remove Discount
      DELETE
    • Add a Line Item
      POST
    • Update a Line Item
      POST
    • Delete a Line Item
      DELETE
    • Select a Payment Session
      POST
    • Refresh a Payment Session
      POST
    • Add Shipping Method
      POST
    • Calculate Cart Taxes
      POST
    • Complete a Cart
      POST
  • Customers
    • Get Saved Payment Methods
    • Request Password Reset
    • Update a Shipping Address
    • Delete an Address
    • Create a Customer
    • Get a Customer
    • Update Customer
    • Add a Shipping Address
    • Reset Password
    • List Orders
  • Gift Cards
    • Get Gift Card by Code
  • Orders
    • Claim Order
    • Verify Order Claim
    • Look Up an Order
    • Get by Cart ID
    • Get an Order
  • Order Edits
    • Retrieve an Order Edit
    • Decline an Order Edit
    • Complete an Order Edit
  • Payment Collections
    • Refresh a Payment Session
    • Authorize Payment Session
    • Get a PaymentCollection
    • Create a Payment Session
    • Manage Payment Sessions
    • Authorize Payment Sessions
  • Products
    • Search Products
    • Get a Product
    • List Products
  • Product Variants
    • Get Product Variants
    • Get a Product Variant
  • Product Categories
    • Get a Product Category
      GET
    • List Product Categories
      GET
  • Product Collections
    • List Collections
    • Get a Collection
  • Product Tags
    • List Product Tags
  • Product Types
    • List Product Types
  • Regions
    • Get a Region
    • List Regions
  • Returns
    • Create Return
  • Return Reasons
    • List Return Reasons
    • Get a Return Reason
  • Shipping Options
    • List for Cart
    • Get Shipping Options
  • Swaps
    • Create a Swap
    • Get by Cart ID
  1. Product Categories

Get a Product Category

GET
/store/product-categories/{id}
Retrieve a Product Category's details.

Request

Path Params
id
string 
required
The ID of the Product Category
Query Params
fields
string 
optional
Comma-separated fields that should be expanded in the returned product category.
expand
string 
optional
Comma-separated relations that should be expanded in the returned product category.

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.medusa-commerce.com/store/product-categories/'

Responses

🟢200OK
application/json
Body
The product category's details.
product_category
object (Product Category) 
required
A product category can be used to categorize products into a hierarchy of categories.
id
string 
required
The product category's ID
Example:
pcat_01G2SG30J8C85S4A5CHM2S1NS2
name
string 
required
The product category's name
Example:
Regular Fit
description
string 
optional
The product category's description.
Default:
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:
0
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.
metadata
object  | null 
required
An optional key-value map with additional details
Example:
{"car":"white"}
Example
{
    "product_category": {
        "id": "pcat_01G2SG30J8C85S4A5CHM2S1NS2",
        "name": "Regular Fit",
        "description": "",
        "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": [
            {}
        ],
        "metadata": {
            "car": "white"
        }
    }
}
🟠400Client Error or Multiple Errors
🟠401User is not authorized. Must log in first
🟠404Not Found Error
🟠409Invalid State Error
🟠422Invalid Request Error
🔴500Server Error
Modified at 2024-01-06 03:57:20
Previous
Get a Product Variant
Next
List Product Categories
Built with