PRproject44
Filter Suggestions

Retrieve a list of suggested values which can be used as search criteria in other endpoints

A suggestion is defined as a value which has existed at some point in time for the given field type in any shipment visible to the tenant performing the call.

Suggestions are sorted such that the most relevant results will be at the top, and any equally relevant results are sorted alphabetically.

post/services/unified-search/v1/suggestions

Request

Request body

fieldType'ATTRIBUTE_KEY' | 'ATTRIBUTE_VALUE' | 'CARRIER_NAME' | 'CARRIER_IATA' | 'CARRIER_ICAO' | 'CARRIER_SCAC' | 'CARRIER_US_DOT_NUMBER' | 'CARRIER_MC_NUMBER' | 'CARRIER_NMC_ID' | 'CARRIER_MASTER_ID' | 'VESSEL_NAME' | 'VESSEL_MMSI' | 'VESSEL_IMO' | 'VESSEL_CALL_SIGN' | 'TRAILER_ID' | 'VEHICLE_ID' | 'LICENSE_PLATE' | 'RAIL_CAR_ID' | 'FLIGHT_NUMBER' | 'DRIVER_MOBILE_PHONE_NUMBER' | 'WAGON_ID' | 'TRAIN_NUMBER' | 'EXPORT_CUSTOMS_BROKER' | 'IMPORT_CUSTOMS_BROKER' | 'POL_QUALITY_CONTROL_PROVIDER' | 'POD_QUALITY_CONTROL_PROVIDER' | 'ORIGIN_LOCATION_NAME' | 'ORIGIN_ADDRESS' | 'ORIGIN_CITY' | 'ORIGIN_STATE' | 'ORIGIN_COUNTRY' | 'ORIGIN_ZIP' | 'ORIGIN_PORT_CODE' | 'ORIGIN_AIRPORT_CODE' | 'DESTINATION_LOCATION_NAME' | 'DESTINATION_ADDRESS' | 'DESTINATION_CITY' | 'DESTINATION_STATE' | 'DESTINATION_COUNTRY' | 'DESTINATION_ZIP' | 'DESTINATION_PORT_CODE' | 'DESTINATION_AIRPORT_CODE' | 'STOP_LOCATION_NAME' | 'STOP_ADDRESS' | 'STOP_CITY' | 'STOP_STATE' | 'STOP_COUNTRY' | 'STOP_ZIP' | 'STOP_PORT_CODE' | 'STOP_AIRPORT_CODE' | 'EVENT_DESCRIPTION' | 'EVENT_LOCATION_NAME' | 'EVENT_ADDRESS' | 'EVENT_CITY' | 'EVENT_STATE' | 'EVENT_COUNTRY' | 'EVENT_ZIP' | 'EVENT_PORT_CODE' | 'EVENT_AIRPORT_CODE' | 'ORDER_IDENTIFIER_CONTRACT' | 'ORDER_IDENTIFIER_LAUNCH_CODE' | 'ORDER_IDENTIFIER_LOAD' | 'ORDER_IDENTIFIER_MANUFACTURER' | 'ORDER_IDENTIFIER_PROMOTION' | 'ORDER_IDENTIFIER_SEASON' | 'ORDER_IDENTIFIER_VENDOR' | 'ORDER_IDENTIFIER_CUSTOMER_ORDER' | 'ORDER_ATTRIBUTE_KEY' | 'ORDER_ATTRIBUTE_VALUE' | 'ORDER_TAG_ANALYST' | 'ORDER_TAG_CARRIER' | 'ORDER_TAG_CATEGORY' | 'ORDER_TAG_COMMODITY' | 'ORDER_TAG_DEPARTMENT' | 'ORDER_TAG_DIRECTOR' | 'ORDER_TAG_FAMILY' | 'ORDER_TAG_GROUP' | 'ORDER_TAG_MANAGER' | 'ORDER_TAG_SECTOR' | 'ORDER_TAG_BATCH' | 'ORDER_ORIGIN_LOCATION_ID' | 'ORDER_ORIGIN_LOCATION_NAME' | 'ORDER_ORIGIN_CITY' | 'ORDER_ORIGIN_STATE' | 'ORDER_ORIGIN_COUNTRY' | 'ORDER_ORIGIN_POSTAL_CODE' | 'ORDER_DESTINATION_LOCATION_ID' | 'ORDER_DESTINATION_LOCATION_NAME' | 'ORDER_DESTINATION_CITY' | 'ORDER_DESTINATION_STATE' | 'ORDER_DESTINATION_COUNTRY' | 'ORDER_DESTINATION_POSTAL_CODE' | 'ORDER_SUPPLIER_LOCATION_ID' | 'ORDER_SUPPLIER_LOCATION_NAME' | 'ORDER_SUPPLIER_CITY' | 'ORDER_SUPPLIER_STATE' | 'ORDER_SUPPLIER_COUNTRY' | 'ORDER_SUPPLIER_POSTAL_CODE' | 'ORDER_BILLING_LOCATION_ID' | 'ORDER_BILLING_LOCATION_NAME' | 'ORDER_BILLING_CITY' | 'ORDER_BILLING_STATE' | 'ORDER_BILLING_COUNTRY' | 'ORDER_BILLING_POSTAL_CODE' | 'LOAD_ITEM_DESCRIPTION' | 'SHARING_RECIPIENT_TENANT_NAME' | 'SHARING_ORIGINATOR_TENANT_NAME' | 'SUMMARIZED_CONNECTION_TYPE' | 'CONNECTION_TRANSMISSION_METHOD' | 'CONNECTION_DATA_FORMAT' | 'CONNECTION_SOURCE_TYPE'

The target field for which to retrieve suggestions.

fieldNamestring

Optional - intended to further narrow the search scope when dealing with key-value pairs.

For example, when searching with fieldType = ATTRIBUTE_VALUE, setting this to "WAREHOUSE" will return suggestions only for attributes where the key/name is "WAREHOUSE".

limitinteger

The maximum number of suggestions to return.

querystring

The input with which to search.

Response

OK

suggestionsstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.