🔒 List products V3

get

https://{xentralId}.xentral.biz/api/v3/products

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. The customFields.customField1 to customFields.customField40 filters match the value a product carries in that custom field, the value include=customFields reports under that key - not its per-language translations. On these keys isNull matches a custom field that is not set. v2 exposes the same 40 fields under the names freeField1 to freeField40. A custom field that is configured rather than one of these 40 carries an instance-specific key and is not filterable. A filter group condition may itself be a group, nesting to at most 5 levels, so mixed expressions like (A and B) or (C and D) are expressible. isDisabled and isDeleted switch the query as a whole rather than describing one product, and the properties filters pair their conditions across keys, so none of them can be used inside an or filter group or a nested group: they stay valid as direct conditions of a top-level and group only. The search parameter stays conjunctive as well - it narrows whatever the filter returns.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

filter

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

Supported filter operators by key:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

properties.id: equals, notEquals, in, notIn

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

properties.value: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

properties.unit: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField1: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField2: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField3: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField4: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField5: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField6: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField7: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField8: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField9: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField10: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField11: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField12: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField13: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField14: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField15: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField16: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField17: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField18: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField19: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField20: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField21: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField22: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField23: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField24: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField25: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField26: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField27: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField28: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField29: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField30: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField31: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField32: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField33: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField34: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField35: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField36: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField37: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField38: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField39: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

customFields.customField40: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

Alternatively the filter accepts a single group object {op, conditions}: or matches records satisfying at least one condition, and all of them. A condition may itself be such a group, nesting to at most 5 levels.

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

perPage

integer

≥ 0

Number of items per page. Default: 15, Max: 5000. A larger value is reduced to the maximum; omitting it or sending 0 selects the default.

page

integer

≥ 0

Page number. Only used with simple and table pagination. Omitting it or sending 0 selects the first page.

cursor

string

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

Headers

x-pagination

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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

429Too Many Requests