List Products

GET

store

products

curl 'http://localhost:9000/store/products?limit=20&region_id=reg_01JB2K4S1T&fields=*variants.calculated_price' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

const { products, count } = await client.store.products.query({
  limit: 20,
  region_id: "reg_01JB2K4S1T",
  fields: "*variants.calculated_price",
})

{
  "products": [
    {
      "id": "prod_01JB2K5M8N",
      "title": "Linen Shirt",
      "subtitle": null,
      "status": "published",
      "description": "A breathable linen shirt.",
      "handle": "linen-shirt",
      "is_giftcard": false,
      "discountable": true,
      "thumbnail": "https://cdn.example.com/linen-shirt.png",
      "collection": null,
      "type": null,
      "tags": [],
      "images": [],
      "categories": [{ "id": "pcat_01JB2K6A2B", "name": "Shirts" }],
      "options": [{ "id": "opt_01JB2K6C3D", "title": "Size", "values": [{ "value": "M" }] }],
      "variants": [
        {
          "id": "variant_01JB2K6E4F",
          "title": "M",
          "offer_id": "offer_01JB2K6G5H",
          "calculated_price": {
            "calculated_amount": 4500,
            "original_amount": 5000,
            "currency_code": "eur"
          }
        }
      ],
      "product_attribute_values": [],
      "scoped_attributes": [],
      "metadata": null,
      "created_at": "2026-05-01T10:00:00.000Z",
      "updated_at": "2026-05-01T10:00:00.000Z"
    }
  ],
  "count": 42,
  "offset": 0,
  "limit": 20
}

Returns a paginated list of published products belonging to open, visible sellers.

Customer authentication is optional. When a customer token is provided, the customer’s group memberships are included in the pricing context, which can change variants.calculated_price results. Variant prices are only computed when you request variants.calculated_price in fields (or pass region_id); the calculated price reflects the cheapest offer for each variant.

Query parameters

number

default:"50"

Maximum number of products to return.

number

default:"0"

Number of products to skip before collecting results.

string

Field to sort by, prefixed with - for descending order (for example -created_at).

string

Comma-separated fields and relations to include; prefix with +/- to add to or remove from the defaults.

string

Free-text search term applied to product fields.

string | string[]

Filter by one or more product IDs.

string

Filter by exact product title.

string

Filter by product handle.

string | string[]

Filter by one or more collection IDs.

string | string[]

Filter by one or more product type IDs.

string | string[]

Filter by one or more category IDs; only active, non-internal categories match.

string | string[]

Filter by one or more tag IDs.

boolean

Filter by gift-card products.

string

Region used to build the pricing context for variants.calculated_price.

string

Currency used in the pricing context.

object

Filter by creation date using operators like $gt, $gte, $lt, $lte.

object

Filter by update date using operators like $gt, $gte, $lt, $lte.

object[]

Join multiple filter objects with a logical AND.

object[]

Join multiple filter objects with a logical OR.

Response

object[]

Show properties

string

The product’s ID.

string

The product’s title.

string | null

The product’s subtitle.

string

Always published on the store API.

string | null

The product’s description.

string

URL-safe handle.

boolean

Whether the product is a gift card.

boolean

Whether promotions can apply to the product.

string | null

Thumbnail URL.

object | null

The product’s collection.

object | null

The product’s type.

object[]

The product’s tags.

object[]

The product’s images.

object[]

The product’s categories.

object[]

Product options with their values.

object[]

Product variants with their options; calculated_price and offer_id are added when requested and reflect the cheapest offer.

object[]

Attribute values assigned to the product, each with its parent attribute.

object[]

Attributes scoped to this product, with their values.

object | null

Custom key-value data.

string

Creation timestamp.

string

Last update timestamp.

number

Total number of matching products.

number

Number of skipped products.

number

Maximum number of returned products.

curl 'http://localhost:9000/store/products?limit=20&region_id=reg_01JB2K4S1T&fields=*variants.calculated_price' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

const { products, count } = await client.store.products.query({
  limit: 20,
  region_id: "reg_01JB2K4S1T",
  fields: "*variants.calculated_price",
})

{
  "products": [
    {
      "id": "prod_01JB2K5M8N",
      "title": "Linen Shirt",
      "subtitle": null,
      "status": "published",
      "description": "A breathable linen shirt.",
      "handle": "linen-shirt",
      "is_giftcard": false,
      "discountable": true,
      "thumbnail": "https://cdn.example.com/linen-shirt.png",
      "collection": null,
      "type": null,
      "tags": [],
      "images": [],
      "categories": [{ "id": "pcat_01JB2K6A2B", "name": "Shirts" }],
      "options": [{ "id": "opt_01JB2K6C3D", "title": "Size", "values": [{ "value": "M" }] }],
      "variants": [
        {
          "id": "variant_01JB2K6E4F",
          "title": "M",
          "offer_id": "offer_01JB2K6G5H",
          "calculated_price": {
            "calculated_amount": 4500,
            "original_amount": 5000,
            "currency_code": "eur"
          }
        }
      ],
      "product_attribute_values": [],
      "scoped_attributes": [],
      "metadata": null,
      "created_at": "2026-05-01T10:00:00.000Z",
      "updated_at": "2026-05-01T10:00:00.000Z"
    }
  ],
  "count": 42,
  "offset": 0,
  "limit": 20
}

curl 'http://localhost:9000/store/products?limit=20&region_id=reg_01JB2K4S1T&fields=*variants.calculated_price' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

const { products, count } = await client.store.products.query({
  limit: 20,
  region_id: "reg_01JB2K4S1T",
  fields: "*variants.calculated_price",
})

{
  "products": [
    {
      "id": "prod_01JB2K5M8N",
      "title": "Linen Shirt",
      "subtitle": null,
      "status": "published",
      "description": "A breathable linen shirt.",
      "handle": "linen-shirt",
      "is_giftcard": false,
      "discountable": true,
      "thumbnail": "https://cdn.example.com/linen-shirt.png",
      "collection": null,
      "type": null,
      "tags": [],
      "images": [],
      "categories": [{ "id": "pcat_01JB2K6A2B", "name": "Shirts" }],
      "options": [{ "id": "opt_01JB2K6C3D", "title": "Size", "values": [{ "value": "M" }] }],
      "variants": [
        {
          "id": "variant_01JB2K6E4F",
          "title": "M",
          "offer_id": "offer_01JB2K6G5H",
          "calculated_price": {
            "calculated_amount": 4500,
            "original_amount": 5000,
            "currency_code": "eur"
          }
        }
      ],
      "product_attribute_values": [],
      "scoped_attributes": [],
      "metadata": null,
      "created_at": "2026-05-01T10:00:00.000Z",
      "updated_at": "2026-05-01T10:00:00.000Z"
    }
  ],
  "count": 42,
  "offset": 0,
  "limit": 20
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Query parameters

Response

​Query parameters

​Response

Query parameters

Response