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

List Products

GET
/store/products
Products
Retrieve a list of products. The products can be filtered by fields such as id. The products can also be sorted or paginated.
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
{
    "limit": 0,
    "offset": 0,
    "count": 0,
    "products": [
        {}
    ]
}

Request

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.
offset
number 
offset
optional
The number of items to skip when retrieving a list.
limit
number 
limit
optional
Limit the number of items returned in the 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 -.
$and
array [object] 
$and
optional
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Example:
["",""]
$or
array [object] 
$or
optional
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Example:
["",""]
q
string 
q
optional
Search term to filter the product's searchable properties.
id
optional
One of
Filter by a product ID.
title
optional
Filter by product titles.
One of
Filter by a title.
handle
optional
Filter by product handles.
One of
Filter by a product handle.
is_giftcard
boolean 
is_giftcard
optional
Whether the product is a gift card.
collection_id
array[string]
optional
Filter by a collection's ID to retrieve the products in it.
tag_id
optional
Filter by a tag's ID to retrieve the products in it.
One of
Filter by a product tag's ID.
type_id
optional
Filter by a type's ID to retrieve the products in it.
One of
Filter by a product type's ID.
$ne
array[string]
optional
Filter by values not equal to this parameter.
Example:
["",""]
$gt
array[string]
optional
Filter by values greater than this parameter. Useful for numbers and dates only.
Example:
["",""]
$gte
array[string]
optional
Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
Example:
["",""]
$lt
array[string]
optional
Filter by values less than this parameter. Useful for numbers and dates only.
Example:
["",""]
$lte
array[string]
optional
Filter by values less than or equal to this parameter. Useful for numbers and dates only.
Example:
["",""]
$like
array[string]
optional
Apply a like filter. Useful for strings only.
Example:
["",""]
$re
array[string]
optional
Apply a regex filter. Useful for strings only.
Example:
["",""]
$ilike
array[string]
optional
Apply a case-insensitive like filter. Useful for strings only.
Example:
["",""]
$fulltext
array[string]
optional
Filter to apply on full-text properties.
Example:
["",""]
$exists
array[string]
optional
Filter by whether a value for this parameter exists (not null).
Example:
["",""]
$in
array[string]
optional
Filter by values in this array.
Example:
["",""]
$nin
array[string]
optional
Filter by values not in this array.
Example:
["",""]
$overlap
array[string]
optional
Filter arrays that have overlapping values with this parameter.
Example:
["",""]
$contains
array[string]
optional
Filter arrays that contain some of the values of this parameter.
Example:
["",""]
$contained
array[string]
optional
Filter arrays that contain all values of this parameter.
Example:
["",""]
$eq
array[string]
optional
Example:
["",""]
$not
array[string]
optional
Example:
["",""]
region_id
string 
region_id
optional
The ID of the region the products are 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 products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes.
Example:
us-ca
sales_channel_id
optional
One of
The ID of a sales channel to retrieve products in it.
category_id
optional
One of
The ID of a product category to retrieve products in it.
options
object 
optional
Filter by the variants' options.
option_id
string 
option_id
required
The ID of the option to filter by.
value
string 
value
required
Filter by a value of the option.
country_code
string 
country_code
optional
The product's country code.
cart_id
string 
cart_id
optional
The product's cart id.
Header Params
x-publishable-api-key
string 
required
Publishable API Key created in the Medusa Admin.

Responses

🟢200OK
application/json
OK
Body
The paginated list of products.
limit
number 
limit
required
The maximum number of items returned.
offset
number 
offset
required
The number of items skipped before retrieving the returned items.
count
number 
count
required
The total number of items.
products
array [object] 
required
The list of products.
🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🟠409409
🟠422Parameter Error
🔴500Server Error
Modified at 2025-06-17 04:21:30
Previous
Get a Region
Next
Get a Product
Built with