List products

Retrieve your organization's products, with filters, text search and pagination.

Endpoint

GET
/products

Query parameters

NameTypeRequiredDescription
searchTermstringNoCase- and accent-insensitive search on name, description and sku. Exact and prefix name matches come first.
product_category_idintegerNoOnly products of this category.
statusstringNoactive or inactive.
typestringNoproduct or service.
skustringNoExact SKU.
parent_idintegerNoOnly variants of this product.
is_variantbooleanNotrue for variants only, false for base products only.
pricenumberNoExact price, or a range with price[$gte]=100&price[$lte]=1000.
fastJoinForProductListbooleanNoSend true to add category (id, name, organization_id) and main_media_path (the file_path of the first media item by position) to each product. Omit it otherwise.
$limitintegerNoPage size (default 10, max 50).
$skipintegerNoNumber of records to skip.
$sort[field]1 | -1NoSort, for example $sort[name]=1. With searchTerm, only name, created_at, updated_at, price, sku and id are used, after the relevance order.
$select[]stringNoReturn only these fields.

Any other product field can be used as a filter with Feathers syntax (field=value, field[$in][]=a, field[$gt]=x). Results are filtered to the API key's organization automatically.

Request

Search by text:

Response

json

category and main_media_path are only present when fastJoinForProductList=true.

Report an issue with this documentation

Please log in to report issues with our documentation.