A combination of criteria is expected (but not required) in the request body.
The search 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 page 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"
}
], - "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"
}
], - "sort": [
- {
- "fieldName": "PRIMARY_IDENTIFIER",
- "direction": "ASC"
}
], - "additionalFields": [
- {
- "type": "CUSTOM_ATTRIBUTES",
- "keys": [
- "string"
]
}
], - "pagination": {
- "pageSize": 1,
- "pageNumber": 1
}
}
{- "paginationInfo": {
- "total": 0,
- "pageSize": 0,
- "pageNumber": 0
}, - "results": [
- {
- "shipmentId": "47efd5a2-af91-4417-950a-7f546cd1b5cf",
- "createdDateTime": "2019-08-24T14:15:22Z",
- "updatedDateTime": "2019-08-24T14:15:22Z",
- "primaryShipmentIdentifier": {
- "type": "CONTAINER_ID",
- "value": "string"
}, - "allShipmentIdentifiers": [
- {
- "type": "AIR_WAYBILL",
- "value": "string"
}
], - "activeVehicleIdentifier": {
- "type": "VEHICLE_ID",
- "value": "string"
}, - "activeSegmentMode": "AIR",
- "allSegmentModes": [
- "AIR"
], - "currentState": "UNKNOWN",
- "latestTrackingStatusEvent": {
- "type": "TRACKING_INITIATE",
- "dateTime": "2019-08-24T14:15:22Z"
}, - "originLocation": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "identifiers": [
- {
- "type": "AIRPORT_IATA",
- "value": "string"
}
], - "address": {
- "postalCode": "string",
- "addressLines": [
- "str"
], - "city": "string",
- "state": "string",
- "country": "US"
}, - "coordinates": {
- "latitude": -90,
- "longitude": -180
}, - "timeZone": "string"
}, - "destinationLocation": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "identifiers": [
- {
- "type": "AIRPORT_IATA",
- "value": "string"
}
], - "address": {
- "postalCode": "string",
- "addressLines": [
- "str"
], - "city": "string",
- "state": "string",
- "country": "US"
}, - "coordinates": {
- "latitude": -90,
- "longitude": -180
}, - "timeZone": "string"
}, - "currentStopLocation": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "identifiers": [
- {
- "type": "AIRPORT_IATA",
- "value": "string"
}
], - "address": {
- "postalCode": "string",
- "addressLines": [
- "str"
], - "city": "string",
- "state": "string",
- "country": "US"
}, - "coordinates": {
- "latitude": -90,
- "longitude": -180
}, - "timeZone": "string"
}, - "carrier": "string",
- "milestones": [
- {
- "type": "DEPARTURE_FROM_FIRST_PORT",
- "stop": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "UNKNOWN",
- "location": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "identifiers": [
- null
], - "address": {
- "postalCode": null,
- "addressLines": [ ],
- "city": null,
- "state": null,
- "country": null
}, - "coordinates": {
- "latitude": null,
- "longitude": null
}, - "timeZone": "string"
}
}, - "eventType": "UNKNOWN",
- "actualDateTime": "2019-08-24T14:15:22Z",
- "plannedDateTime": "2019-08-24T14:15:22Z",
- "plannedEndDateTime": "2019-08-24T14:15:22Z",
- "estimateDateTime": "2019-08-24T14:15:22Z",
- "actualOrEstimateDateTime": "2019-08-24T14:15:22Z",
- "deltaEstimated": 0,
- "deltaActual": 0,
- "deltaActualOrEstimated": 0
}
], - "relatedOrders": [
- {
- "id": "string",
- "identifier": {
- "type": "PURCHASE_ORDER",
- "value": "string"
}, - "additionalIdentifiers": [
- {
- "type": "CONTRACT",
- "value": "string"
}
], - "tags": [
- {
- "type": "ANALYST",
- "value": "string",
- "description": "string"
}
], - "supplier": {
- "id": "string",
- "name": "string"
}, - "launchDateTime": "2019-08-24T14:15:22Z",
- "supplierReadyDateTimeWindow": {
- "startDateTime": "2019-08-24T14:15:22Z",
- "endDateTime": "2019-08-24T14:15:22Z"
}, - "originalDeliveryDateTimeWindow": {
- "startDateTime": "2019-08-24T14:15:22Z",
- "endDateTime": "2019-08-24T14:15:22Z"
}, - "deliveryEstimateDateTime": "2019-08-24T14:15:22Z"
}
], - "customAttributes": [
- {
- "name": "string",
- "value": "string",
- "values": [
- "string"
]
}
], - "sharingContext": {
- "dataOriginators": [
- {
- "tenantUuid": "e46705ba-31a8-4f12-b6d3-f41ec1d77a9a",
- "tenantName": "string",
- "tenantId": 0
}
], - "recipients": [
- {
- "tenantUuid": "e46705ba-31a8-4f12-b6d3-f41ec1d77a9a",
- "tenantName": "string",
- "tenantId": 0
}
]
}
}
]
}