Skip to content

Filtering

The OData feed supports server-side filtering only on specific fields. Each field only supports a certain type of filtering.

Single Value Filter

Allows filtering by exactly one value using equality comparison only. For example:

$filter=EmailAddress eq 'customer@example.com'

$filter=ShipmentUid eq '76c7bfff50824c1d9016e1050458725c'

Multiple Values Filter

Allows filtering by one or more discrete values using OR logic operator only. For example:

$filter=TypeCode eq 'LocalPupShipment' or TypeCode eq 'DispatchShipment'

$filter=ShipmentUid eq '76c7b...8725c' or ShipmentUid eq '7ed8...3b16'

Range Filter

Allows filtering using ge, gt, lt, le comparison operators and using the AND logic operator only. For example:

$filter=DateCreated ge 2020-01-01T00:00:00Z and DateCreated lt 2021-01-01T00:00:00Z

$filter=DateCreated ge 2020-01-01T00:00:00Z

Supported Fields

  • Only the fields listed below support server-side filtering.
  • Filters must be applied in the correct format for each field type to ensure optimal performance.
  • For date fields, use ISO 8601 format (e.g., 2020-01-01T00:00:00Z) .

Shipment

Field Single Value Multiple Values Range
ShipmentUid ✓
TypeCode ✓
StateCode ✓
PickUpPointName ✓
DateCreated ✓ ✓
StateDate ✓ ✓

ShipmentState

Field Single Value Multiple Values Range
ShipmentUid ✓
IsCurrent ✓
StateDate ✓ ✓

Account

Field Single Value Multiple Values Range
DateCreated ✓ ✓
DateLastActivity ✓ ✓
EmailAddress ✓
PickUpPointName ✓