List Products

GET/store/products

Retrieves a list of products. The products can be filtered by fields such as id or q. The products can also be sorted or paginated.
This API Route can also be used to retrieve a product by its handle.

For accurate and correct pricing of the products based on the customer's context, it's highly recommended to pass fields such as
region_id, currency_code, and cart_id when available.

Passing sales_channel_id ensures retrieving only products available in the specified sales channel.
You can alternatively use a publishable API key in the request header instead of passing a sales_channel_id.

Request

Query Params

string

optional

term used to search products' title, description, variant's title, variant's sku, and collection's title.

string

optional

Filter by IDs.

sales_channel_id

array[string]

optional

Filter by sales channel IDs. When provided, only products available in the selected sales channels are retrieved. Alternatively, you can pass a publishable API key in the request header and this will have the same effect.

collection_id

array[string]

optional

Filter by product collection IDs. When provided, only products that belong to the specified product collections are retrieved.

type_id

array[string]

optional

Filter by product type IDs. When provided, only products that belong to the specified product types are retrieved.

tags

array[string]

optional

Filter by product tag IDs. When provided, only products that belong to the specified product tags are retrieved.

title

string

optional

Filter by title.

description

string

optional

Filter by description

handle

string

optional

Filter by handle.

is_giftcard

string

optional

Whether to retrieve regular products or gift-card products.

array[string]

optional

filter by dates less than this date

Example:

["",""]

array[string]

optional

filter by dates greater than this date

Example:

["",""]

lte

array[string]

optional

filter by dates less than or equal to this date

Example:

["",""]

gte

array[string]

optional

filter by dates greater than or equal to this date

Example:

["",""]

category_id

array[string]

optional

Filter by product category IDs. When provided, only products that belong to the specified product categories are retrieved.

include_category_children

string

optional

Whether to include child product categories when filtering using the category_id field.

offset

integer

optional

The number of products to skip when retrieving the products.

limit

integer

optional

Limit the number of products returned.

expand

string

optional

Comma-separated relations that should be expanded in the returned products.

fields

string

optional

Comma-separated fields that should be included in the returned products.

order

string

optional

A product field to sort-order the retrieved products by.

cart_id

string

optional

The ID of the cart. This is useful for accurate pricing based on the cart's context.

region_id

string

optional

The ID of the region. This is useful for accurate pricing based on the selected region.

currency_code

string

optional

A 3 character ISO currency code. This is useful for accurate pricing based on the selected currency.

Request samples

Responses

OK(200)

Client Error or Multiple Errors(400)

Not Found Error(404)

Invalid State Error(409)

Invalid Request Error(422)

Server Error(500)

HTTP Code: 200

Content Type : JSONapplication/json

No schema defined

Not configured

Modified at 10 months ago