GET
/
store
/
products
import Medusa from "@medusajs/js-sdk"

let MEDUSA_BACKEND_URL = "http://localhost:9000"

if (process.env.NEXT_PUBLIC_MEDUSA_BACKEND_URL) {
  MEDUSA_BACKEND_URL = process.env.NEXT_PUBLIC_MEDUSA_BACKEND_URL
}

export const sdk = new Medusa({
  baseUrl: MEDUSA_BACKEND_URL,
  debug: process.env.NODE_ENV === "development",
  publishableKey: process.env.NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY,
})

sdk.store.product.list()
.then(({ products, count, offset, limit }) => {
  console.log(products)
})
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "products": [
    {}
  ]
}

Headers

​
x-publishable-api-key
string
required

Publishable API Key created in the Medusa Admin.

Query Parameters

​
fields
string

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

The number of items to skip when retrieving a list.

​
limit
number

Limit the number of items returned in the list.

​
order
string

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
$and · object[]

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

​
$or
$or · object[]

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

​
q
string

Search term to filter the product's searchable properties.

​
id

Filter by a product ID.

​
title

Filter by product titles. Filter by a title.

​
handle

Filter by product handles. Filter by a product handle.

​
is_giftcard
boolean

Whether the product is a gift card.

​
collection_id
string[]

Filter by a collection's ID to retrieve the products in it.

A collection's ID.

​
tag_id

Filter by a tag's ID to retrieve the products in it. Filter by a product tag's ID.

​
type_id

Filter by a type's ID to retrieve the products in it. Filter by a product type's ID.

​
created_at
object

Filter by the product's creation date.

​
updated_at
object

Filter by the product's update date.

​
region_id
string

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

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

The ID of a sales channel to retrieve products in it.

​
category_id

The ID of a product category to retrieve products in it.

​
variants
object

Filter the products' variants.

​
country_code
string

The product's country code.

​
cart_id
string

The product's cart id.

Response

200
application/json

OK

The paginated list of products.