Organization / Shipments

shipments

List shipments

Arguments

afterString

A cursor after which elements are returned.

beforeString

A cursor before which elements are returned.

firstInt

Limits number of fetched items. Maximum allowed value: 250.

lastInt

Limits number of fetched items. Maximum allowed value: 250.

queryString

Search and filter expression for shipments. A filter made up of field terms, connectives, modifiers, and comparators. You can apply one or more filters to a query.

Supported filters
customer.iduuidAny value
brand.iduuidAny value
recipient_address.country_codestringAny value
statusenum
CANCELED
CREATED
Registered without requesting a carrier label.
ERROR
The carrier rejected the label request; see the shipment events.
GENERATING
The carrier label is being created.
GENERATED
The carrier label is created; ready to dispatch.
PRINTED
REQUESTED
Label requested and waiting to be generated.
SHIPPED
shipping_service_method.iduuidAny value
created_atdatetimeAny value
shipped_atdatetimeAny value
searchstringAny value
reverseBoolean!Default: false

Reverse the order of the underlying list.

sortKeyShipmentsSortKeyDefault: ID

Sort the underlying list using a key.

CREATED_ATIDSHIPPED_AT

Returns

cursorString!

A unique cursor that can be used for pagination.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.