List products for pickers
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/products/list?store_id=1&ids=1&ids=2&ids=3&limit=20&offset=0&search=cotton%20shirt&keyword=cotton%20shirt&status=draft&inventory_status=in_stock&collection_id=12&sort_by=id&sort_order=asc&include_counts=true&include_variants=false&include_combinations=false&include_promotion=false&min_price=10&max_price=100&external_id_pattern=tiktok_%25&filters=%5B%7B%22field%22%3A%22status%22%2C%22operator%22%3A%22is_not%22%2C%22values%22%3A%5B%22draft%22%5D%7D%5D';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://apibase.ecomweb.app/api/v1/stores/example/products/list?store_id=1&ids=1&ids=2&ids=3&limit=20&offset=0&search=cotton%20shirt&keyword=cotton%20shirt&status=draft&inventory_status=in_stock&collection_id=12&sort_by=id&sort_order=asc&include_counts=true&include_variants=false&include_combinations=false&include_promotion=false&min_price=10&max_price=100&external_id_pattern=tiktok_%25&filters=%5B%7B%22field%22%3A%22status%22%2C%22operator%22%3A%22is_not%22%2C%22values%22%3A%5B%22draft%22%5D%7D%5D' \ --header 'x-api-key: <x-api-key>'Returns a compact array of products (ID, name, price and first image URL) for selection controls. The price field is currently always 0; read prices from the full product list or a single product instead. It takes the same filters as the full list and returns the first 100 products when no limit is given. The filters parameter is a JSON array of clauses, each {"field", "operator", "values"}, with at most 10 clauses and 50 values per clause. Fields: status (is, is_not; draft, active or unlisted), category and product_type (is, is_not), tag and collection (is, is_not; numeric IDs), sales_channel (is; numeric IDs), inventory_status (is; in_stock, low_stock or out_of_stock) and price (gte, lte; an amount). sort_by accepts id, name, status, created_at, updated_at, min_price and max_price.
Required scopes: read:products
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Query Parameters
Section titled “Query Parameters”Example
1Filter by store ID (required for store-specific queries)
Example
[ 1, 2, 3]Filter by multiple product IDs
Example
20Number of items per page
Example
0Number of items to skip
Example
cotton shirtFree-text search over product name or description
Example
cotton shirtDeprecated alias for search, kept so existing callers keep working. search wins when both are sent. New callers should send search.
Example
activeFilter by product status
Example
low_stockFilter by inventory status (in_stock, low_stock, out_of_stock)
Example
12Only products in this manual collection. A smart collection is refused (400): its products are chosen by its rules.
Example
created_atSort field. Any other value is rejected with a 400 error.
Example
descSort order
Example
trueInclude related counts (variants, inventory)
Example
falseInclude product variants in the response
Example
falseInclude variant combinations (options and values) in the response
Example
falseInclude promotion information in the response
Example
10Filter by minimum price
Example
100Filter by maximum price
Example
tiktok_%Filter by external ID pattern (for bulk imports)
Example
[{"field":"status","operator":"is_not","values":["draft"]}]A JSON array of filter clauses, each {field, operator, values}. At most 10 clauses, at most 50 values each. Fields: status (is, is_not; draft, active, unlisted), category and product_type (is, is_not), tag and collection (is, is_not; numeric IDs), sales_channel (is; numeric IDs), inventory_status (is; in_stock, low_stock, out_of_stock) and price (gte, lte; an amount).
Responses
Section titled “Responses”object
Product ID.
Product name.
Currently always 0; use the product’s variant prices or min_price instead.
URL of the first product image, or null when there is none.
Example generated
[ { "id": 1, "name": "example", "price": 1, "image_url": "example" }]The request is malformed or failed validation.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}