List shipments, newest first (cursor pagination)

get

https://apis.kentro.live/channel/v1/shipments

Scope: channel:read, channel:write, shipments:write or admin.

Idempotency: not keyed; the request itself is safe to repeat.

Rate limit: read class, 6,000 requests per minute per tenant by default (write class 1,200). Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset; a refusal is 429 rate_limited with Retry-After.

Query Params

orderId

string

^(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|[0-9a-fA-F]{24})$

A uuid, or a legacy 24-hex id.

fulfillmentOrderId

string

^(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|[0-9a-fA-F]{24})$

A uuid, or a legacy 24-hex id.

orderNumber

string

length between 1 and 100

The order's stored number (its hid: the displayId the order was created with), matched exactly: the shipments of the oldest order of the tenant carrying it, within the caller's channels. An order with no stored number is not found by its public id.

channelId

string

^(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|[0-9a-fA-F]{24})$

Sales channel id: a uuid, or a legacy 24-hex id.

carrier

string

length between 1 and 255

The carrier name (case-insensitive).

trackingNumber

string

length between 1 and 100

status

enum

shipped, or canceled (its recorded movements reversed).

shippedSince

date-time

ISO-8601, UTC.

updatedSince

date-time

ISO-8601, UTC.

cursor

string

length between 1 and 512

The nextCursor of the previous page.

limit

integer

1 to 200

Default 50.

Responses

200Default Response

400Default Response