🔒 List shipments V3

get

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

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

Paginated list of shipments - what was packed for a delivery note and handed to a carrier, with the carrier, the day it went out, and one entry per parcel carrying its tracking number, tracking link and weight. Filter by deliveryNote.id or salesOrder.id to get the shipments of one document.

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

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

salesOrder.id: equals, notEquals, in, notIn

filter

sort

array

Sort via id, -id, sentAt, -sentAt, createdAt, -createdAt, updatedAt and -updatedAt. 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. 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

200Paginated list of shipments - what was packed for a delivery note and handed to a carrier, with the carrier, the day it went out, and one entry per parcel carrying its tracking number, tracking link and weight. Filter by deliveryNote.id or salesOrder.id to get the shipments of one document.

429Too Many Requests