🔒 List stock movements V3

get

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

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: stockMovement:read.

Paginated list of stock movements - the warehouse ledger. Every posting that changed the stock of a product on a storage location is recorded here, which makes this the source for movement analyses. Filter by product.id, storageLocation.id or warehouse.id to narrow it down to what you want to analyse, and by postedAt to restrict the period.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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, isNull, isNotNull

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

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

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

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

direction: equals, notEquals, in, notIn

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

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

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

causedBy.type: equals, notEquals, in, notIn

causedBy.id: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

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

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

filter

sort

array

Sort via id, -id, postedAt, -postedAt, quantity, -quantity, createdAt and -createdAt. Default sort is -id

sort

perPage

integer

≥ 0

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

page

integer

≥ 0

Page number. Omitting it or sending 0 selects the first page.

Responses

401

Unauthorized

403

Forbidden

429Too Many Requests