This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.
This endpoint requires the following scopes: product:read.
Paginated list of products. Embed sub-resources with ?include=. The categories.id filter matches products assigned to the given category or to any of its descendant categories. On the relation filters categories.id, salesChannel.id and tags.id, a value list under equals requires every value to match, in matches any of them, and notEquals/notIn match products not assigned to any of the given values at all. The salesChannel.id filter matches by the numeric sales channel id. The externalReferences.salesChannel.id filter matches by the sales channel id of an external reference. A matrix product holds its options under include=options, while each of its variants carries one value per option under include=optionValues, reachable for every variant at once via include=variants.optionValues. The properties.id, properties.name, properties.value and properties.unit filters match per property entry: all of them have to be satisfied by the same entry, so properties.name = Material together with properties.value = Aluminium does not match a product that has Material: Stahl and Farbe: Aluminium. Repeat the keys to require a further entry - the n-th condition of each properties.* key describes the n-th entry. A value list matches any of its values under both equals and in. notEquals, notIn and notContains exclude: they match products that have no entry satisfying the rest of their conditions together with the given value, so on its own such a filter excludes every product carrying that property. On properties.value and properties.unit, isNull matches entries whose value or unit is not set. properties.id is the property definition id that include=properties reports, and deleted property definitions are returned by neither the include nor the filters.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
401Unauthorized
403Forbidden
