List shipments

get

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

Retrieve a list of shipments associated with an account.

Path Params

accountId

string

required

The account ID associated with the shipments.

Query Params

name

string

Filter shipments by name.

referenceId

string

Filter shipments by reference ID.

setId

string

Filter shipments by set ID.

healthStatus

string

enum

Filter shipments by health status.

Allowed:

status

string

enum

Filter shipments by status.

cursor

string

Pagination cursor for fetching the next set of results.

includeTotal

boolean

Include the total count of shipments in the response.

limit

int32

Limit the number of shipments returned in the response.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Loading…

Response

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

text/plain

application/json

text/json

200Success