Medusa
Store APIAdmin API
Store APIAdmin API
Discord
Twitter
Linkedin
Github
  1. Products
  • 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
    • Get a Product
      GET
  • 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 a Product Category
  • 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. Products

Get a Product

GET
/store/products/{id}
Products
Retrieve a product by its ID. You can expand the product's relations or select the fields that should be returned.
Request Request Example
JavaScript
Shell
Java
Swift
curl --location -g --request GET '{{BASE_URL}}/store/products/' \
--header 'x-publishable-api-key;'
Response Response Example
200 - Example 1
{
    "product": {
        "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
id
string 
required
The product'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.
region_id
string 
region_id
optional
The ID of the region the product is being viewed from. This is required if you're retrieving product variant prices with taxes.
country_code
string 
country_code
optional
The country code the product is being viewed from. This is required if you're retrieving product variant prices with taxes.
province
string 
province
optional
The lower-case ISO 3166-2 province code the product is being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes.
Example:
us-ca
cart_id
string 
cart_id
optional
The ID of the customer's cart. If set, the cart's region and shipping address's country code and province are used instead of the region_id, country_code, and province properties.
limit
number 
limit
optional
Limit the number of items returned in the list.
offset
number 
offset
optional
The number of items to skip when retrieving a list.
order
string 
order
optional
The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.
Header Params
x-publishable-api-key
string 
required
Publishable API Key created in the Medusa Admin.

Responses

🟢200OK
application/json
OK
Body
The product's details.
product
object (StoreProduct) 
required
The product's details.
length
number 
length
required
The product's length.
title
string 
title
required
The product's title.
description
string 
description
required
The product's description.
id
string 
id
required
The product's ID.
metadata
object 
optional
The product's metadata, can hold custom key-value pairs.
created_at
string <date-time>
created_at
required
The date the product was created.
updated_at
string <date-time>
updated_at
required
The date the product was updated.
handle
string 
handle
required
The product's handle.
subtitle
string 
subtitle
required
The product's subtitle.
is_giftcard
boolean 
is_giftcard
required
Whether the product is a gift card.
thumbnail
string 
thumbnail
required
The product's thumbnail URL.
width
number 
width
required
The product's width.
weight
number 
weight
required
The product's weight.
height
number 
height
required
The product's height.
origin_country
string 
origin_country
required
The product's origin country.
hs_code
string 
hs_code
required
The product's HS code.
mid_code
string 
mid_code
required
The product's MID code.
material
string 
material
required
The product's material.
collection_id
string 
collection_id
required
The ID of the collection that the product belongs to.
type_id
string 
type_id
required
The ID of the product's type.
discountable
boolean 
discountable
required
Whether the product can be discounted.
external_id
string 
external_id
required
The ID of the product in an external service or system.
deleted_at
string <date-time>
deleted_at
required
The date the product was deleted.
categories
array [object] 
optional
The product's categories.
status
enum<string> 
required
The product's status.
Allowed values:
draftproposedpublishedrejected
images
array[object (StoreProductImage) {7}] 
required
The product's images.
tags
array[object (StoreProductTag) {6}] 
optional
The product's tags.
collection
object (StoreCollection) 
optional
The collection's details.
type
object (StoreProductType) 
optional
The product type's details.
options
array[object (StoreProductOption) {9}] 
required
The product's options.
variants
array[object (StoreProductVariant) {26}] 
required
The product's variants.
🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🟠409409
🟠422Parameter Error
🔴500Server Error
Modified at 2025-06-17 04:21:30
Previous
List Products
Next
Get Logged-in Customer
Built with