🔒 List products V3

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
filter
array of objects

The filter parameter is used to filter the results of the given endpoint.

Supported filter operators by key:

id: equals, notEquals, in, notIn

number: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

ean: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

name: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

description: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

manufacturer: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

manufacturerProductNumber: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

customsTariffNumber: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

uuid: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

minimumStockLevel: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

minimumOrderQuantity: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

project.id: equals, notEquals, in, notIn

defaultSupplier.id: equals, notEquals, in, notIn

variantOf.id: equals, notEquals, in, notIn, isNull, isNotNull

tags.id: equals, notEquals, in, notIn

externalReferences.number: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

externalReferences.name: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

externalReferences.salesChannel.id: equals, notEquals, in, notIn

isMatrixProduct: equals, notEquals

isStockItem: equals, notEquals

isDiscountProduct: equals, notEquals

isShippingCostsProduct: equals, notEquals

createdAt: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals, isNull, isNotNull

updatedAt: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals, isNull, isNotNull

hasBillOfMaterials: equals, notEquals

isAssembledJustInTime: equals, notEquals

merchandiseGroup.id: equals, notEquals, in, notIn

categories.id: equals, notEquals, in, notIn

salesChannel.id: equals, notEquals, in, notIn

isDisabled: equals, notEquals

isDeleted: equals, notEquals

filter
sort
array

Sort via id, -id, number, -number, name, -name, createdAt, -createdAt, updatedAt and -updatedAt. Default sort is -id

sort
string

Full-text-style search across number, name (German and English), short text (German and English), description (German and English), ean and customs tariff number.

include
array of strings
include
integer

Number of items per page. Default: 15, Max: 5000

integer

Page number. Only used with simple and table pagination.

string

The cursor to use for the paginated call. Only used with cursor pagination. Not compatible with page parameter

Headers
string
enum

Controls the pagination format. Available types: simple, table, cursor. Defaults to 'simple' if not specified.

Allowed:
Responses

401

Unauthorized

403

Forbidden

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json