List shipments

get

https://api.sensos.io/v1/accounts/{accountId}/shipments

Retrieve a list of shipments associated with an account, most recently modified first.

Path Params

accountId

string

required

The account ID.

Query Params

name

string

Filter shipments by name (case-insensitive). Supports * as a wildcard, for example *text*, text* or *text.

referenceId

string

Filter shipments by reference ID.

setId

uuid

Filter shipments by set ID.

healthStatus

string

enum

Filter shipments by health status.

Allowed:

status

string

enum

Filter shipments by status.

cursor

string

Opaque cursor from metadata.nextCursor of the previous page. Cursors expire after 2 days; an invalid or expired cursor returns 400.

limit

int32

≤ 100

Defaults to 50

Maximum number of records per page (default 50, maximum 100). Values outside 1-100 are clamped.

includeTotal

boolean

Defaults to false

When true, metadata.total contains the total number of matching records.

Responses

401

Missing, invalid or expired access token. Returned by the gateway with an empty body.

403

The token lacks the required permission, the account is not accessible to it, or the tenant is inactive. Returned by the gateway with an empty body.

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

200Success

400Invalid request. Field and query validation failures return ValidationProblemDetails; business-rule failures return ErrorResponse.