ShipmentFilter

Input.

No description

Fields

between

•

DateTimeRange

Return Shipment resources created within a given date range

carrier

•

String

Filter by carrier code

createdAt

•

DateTimeRange

Enhanced date filter for created_at with various comparison options

currencyCode

•

CurrencyCode

Filter by currency code

destinationAdmin1

•

String

Filter by destination admin1 (state/province code, e.g. CA, ON, NSW). Best used with destinationCountryCode.

destinationCountryCode

•

CountryCode

Filter by destination country code

direction

•

ShipmentDirection

Omitting this returns both directions. Pass OUTBOUND when reasoning about fulfillment.

orderId

•

The ID of the Order this Shipment belongs to

•

String

Fuzzy search query - searches across tracking numbers, order IDs, customer names, addresses, service levels, and countries

serviceLevelId

•

String

A ServiceLevel ID that is used for a Shipment

serviceLevels

•

[String!]

A list of ServiceLevel codes or names that are used for a ShipmentA list of ServiceLevel codes or names that are used for a Shipment

shipDate

•

DateTimeRange

A date range to filter Shipment objects by their ship date

shipmentType

•

ShipmentType

The type of Shipment

status

•

String

Filter by shipment status

totalAmount

•

ShipmentAmountFilter

Enhanced amount filter for total amount with various comparison options

trackingNumber

•

String

The tracking number associated with the Shipment

Fields

Was this page helpful?