Organization / Shipments
shipments
List shipments
Arguments
afterStringA cursor after which elements are returned.
beforeStringA cursor before which elements are returned.
firstIntLimits number of fetched items. Maximum allowed value: 250.
lastIntLimits number of fetched items. Maximum allowed value: 250.
queryStringSearch 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 valuebrand. iduuidAny valuerecipient_address. country_codestringAny valuestatusenumCANCELEDCREATED- 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.
PRINTEDREQUESTED- Label requested and waiting to be generated.
SHIPPED
shipping_service_method. iduuidAny valuecreated_atdatetimeAny valueshipped_atdatetimeAny valuesearchstringAny valuereverseBoolean!Default: falseReverse the order of the underlying list.
Returns
cursorString!A unique cursor that can be used for pagination.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.