A combination of criteria is expected (but not required) in the request body.
The count is implicitly limited to shipments visible to the tenant performing the call.
If no criteria is present in the request body, then the response will contain a count of shipments visible to the tenant making the request.
OK
Bad Request
{- "searchText": "string",
- "shipmentIds": [
- {
- "values": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "operator": "EQUALS"
}
], - "shipmentIdentifiers": [
- {
- "types": [
- "AIR_WAYBILL"
], - "values": [
- "string"
], - "operator": "EQUALS"
}
], - "shipmentAttributes": [
- {
- "name": "string",
- "values": [
- "string"
], - "operator": "EQUALS"
}
], - "transportationModes": [
- {
- "scopes": [
- "CURRENT"
], - "types": [
- "AIR"
], - "operator": "EQUALS"
}
], - "shipmentStates": [
- {
- "types": [
- "UNKNOWN"
], - "operator": "EQUALS"
}
], - "shipmentEvents": [
- {
- "type": "UNKNOWN",
- "dateRanges": [
- {
- "type": "PLANNED_DATETIME",
- "startDateTime": "2019-08-24T14:15:22Z",
- "endDateTime": "2019-08-24T14:15:22Z",
- "offsetMinutes": 0,
- "operator": "WITHIN"
}
], - "deltas": [
- {
- "type": "RUNNING_EARLY",
- "value": 0,
- "operator": "MORE_THAN"
}
], - "stopProperties": [
- {
- "propertyName": "LOCATION_NAME",
- "values": [
- "string"
], - "operator": "EQUALS"
}
], - "stopIdentifiers": [
- {
- "types": [
- "AIRPORT_IATA"
], - "values": [
- "string"
], - "operator": "EQUALS"
}
], - "stopType": {
- "types": [
- "UNKNOWN"
], - "operator": "EQUALS"
}
}
], - "shipmentTrackingStatusEvents": [
- {
- "scopes": [
- "LATEST"
], - "types": [
- "TRACKING_INITIATE"
], - "operator": "EQUALS"
}
], - "shipmentStops": [
- {
- "properties": [
- {
- "propertyName": "LOCATION_NAME",
- "values": [
- "string"
], - "operator": "EQUALS"
}
], - "identifiers": [
- {
- "types": [
- "AIRPORT_IATA"
], - "values": [
- "string"
], - "operator": "EQUALS"
}
], - "stopType": {
- "types": [
- "UNKNOWN"
], - "operator": "EQUALS"
}, - "scopes": [
- "ANY_INBOUND"
]
}
], - "sharingContextTenants": [
- {
- "scopes": [
- "RECIPIENT"
], - "names": [
- "string"
], - "operator": "EQUALS"
}
], - "orderIdentifierTypes": [
- {
- "types": [
- "PURCHASE_ORDER"
], - "operator": "EQUALS"
}
], - "orderIdentifiers": [
- {
- "type": "PURCHASE_ORDER",
- "values": [
- "string"
], - "operator": "EQUALS"
}
], - "orderIds": [
- {
- "values": [
- "string"
], - "operator": "EQUALS"
}
], - "orderSupplierIds": [
- {
- "values": [
- "string"
], - "operator": "EQUALS"
}
], - "orderDateRanges": [
- {
- "type": "SUPPLIER_READY_START_DATETIME",
- "startDateTime": "2019-08-24T14:15:22Z",
- "endDateTime": "2019-08-24T14:15:22Z",
- "offsetMinutes": 0,
- "operator": "WITHIN"
}
], - "orderDeltas": [
- {
- "type": "RUNNING_EARLY",
- "durationInMinutes": 0,
- "operator": "MORE_THAN"
}
], - "orderTags": [
- {
- "types": [
- "ANALYST"
], - "values": [
- "string"
], - "operator": "EQUALS"
}
], - "orderAdditionalIdentifiers": [
- {
- "types": [
- "CONTRACT"
], - "values": [
- "string"
], - "operator": "EQUALS"
}
], - "loadItemIdentifiers": [
- {
- "types": [
- "SKU"
], - "values": [
- "string"
], - "operator": "EQUALS"
}
], - "loadItemDescriptions": [
- {
- "values": [
- "string"
], - "operator": "EQUALS"
}
]
}
{- "total": 0
}