This documentation is for a version that has reached its End Of Life. Such versions are no longer supported and don't receive security updates. Consider updating to a newer version.
Shipment Search Criteria reference¶
Shipment Search Criteria are only supported by Shipment Search (ShipmentService::findShipments).
With these Criteria you can filter shipments by their shipment identifier, shipment creation date, shipment status, shipping method, and more.
Shipment Search Criteria¶
| Search Criterion | Search based on |
|---|---|
| CreatedAt | Date and time when shipment was created |
| Currency | Currency code |
| Id | Shipment ID |
| Identifier | Shipment identifier |
| LogicalAnd | Logical AND criterion that matches if all the provided Criteria match |
| LogicalOr | Logical OR criterion that matches if at least one of the provided Criteria matches |
| Owner | Owner based on the user reference |
| ShippingMethod | Shipping method applied to the shipment |
| Status | Status of the shipment |
| UpdatedAt | Date and time when status of the shipment was updated |