List products
Retrieve your organization's products, with filters, text search and pagination.
Endpoint
GET/products
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
searchTerm | string | No | Case- and accent-insensitive search on name, description and sku. Exact and prefix name matches come first. |
product_category_id | integer | No | Only products of this category. |
status | string | No | active or inactive. |
type | string | No | product or service. |
sku | string | No | Exact SKU. |
parent_id | integer | No | Only variants of this product. |
is_variant | boolean | No | true for variants only, false for base products only. |
price | number | No | Exact price, or a range with price[$gte]=100&price[$lte]=1000. |
fastJoinForProductList | boolean | No | Send 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. |
$limit | integer | No | Page size (default 10, max 50). |
$skip | integer | No | Number of records to skip. |
$sort[field] | 1 | -1 | No | Sort, for example $sort[name]=1. With searchTerm, only name, created_at, updated_at, price, sku and id are used, after the relevance order. |
$select[] | string | No | Return 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.