Shipments
Search shipments
Search shipments using OpenSearch-powered full-text and field-specific search.
This endpoint provides fast, indexed search across shipment data with support for:
- Full-text search across multiple fields (references, locations, parties)
- Field-specific filtering with various operators
- Sorting and pagination
- Saved search preferences
Note: Only active (non-deleted) shipments are searchable. Soft-deleted records are automatically excluded from all search results.
Response Formats:
- flat (default): Returns indexed fields only for faster performance
- full: Returns complete shipment objects with all relationships
post/shipments/search
Request body
Example request
{
"criteria": {
"id": {
"operator": "EQUALS",
"values": [
"550e8400-e29b-41d4-a716-446655440000"
]
},
"friendlyId": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"status": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"orderStatus": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"loadStatuses": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"mode": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"tonu": {
"operator": "TRUE"
},
"pickUp": {
"operator": "INCLUDES",
"values": [
"search term"
]
},
"pickUpCity": {
"operator": "INCLUDES",
"values": [
"search term"
]
},
"pickUpState": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"pickUpZipCode": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"pickUpCountry": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"dropOff": {
"operator": "INCLUDES",
"values": [
"search term"
]
},
"dropOffCity": {
"operator": "INCLUDES",
"values": [
"search term"
]
},
"dropOffState": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"dropOffZipCode": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"dropOffCountry": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"pickUpStartDatetime": {
"operator": "AFTER",
"value": "2025-01-01T00:00:00Z"
},
"dropOffStartDatetime": {
"operator": "AFTER",
"value": "2025-01-01T00:00:00Z"
},
"bookedAt": {
"operator": "AFTER",
"value": "2025-01-01T00:00:00Z"
},
"shipperId": {
"operator": "EQUALS",
"values": [
"550e8400-e29b-41d4-a716-446655440000"
]
},
"shipperName": {
"operator": "INCLUDES",
"values": [
"search term"
]
},
"carrierIds": {
"operator": "EQUALS",
"values": [
"550e8400-e29b-41d4-a716-446655440000"
]
},
"carrierNames": {
"operator": "INCLUDES",
"values": [
"search term"
]
},
"primaryRepId": {
"operator": "EQUALS",
"values": [
"550e8400-e29b-41d4-a716-446655440000"
]
},
"primaryRepName": {
"operator": "INCLUDES",
"values": [
"search term"
]
},
"bookingRepIds": {
"operator": "EQUALS",
"values": [
"550e8400-e29b-41d4-a716-446655440000"
]
},
"bookingRepNames": {
"operator": "INCLUDES",
"values": [
"search term"
]
},
"groupId": {
"operator": "EQUALS",
"values": [
"550e8400-e29b-41d4-a716-446655440000"
]
},
"groupName": {
"operator": "INCLUDES",
"values": [
"search term"
]
},
"equipmentType": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"weight": {
"operator": "GREATER_THAN",
"value": 1000.5
},
"totalMiles": {
"operator": "GREATER_THAN",
"value": 1000.5
},
"revenue": {
"operator": "GREATER_THAN",
"value": 1000.5
},
"cost": {
"operator": "GREATER_THAN",
"value": 1000.5
},
"profit": {
"operator": "GREATER_THAN",
"value": 1000.5
},
"profitMargin": {
"operator": "GREATER_THAN",
"value": 1000.5
},
"referenceValues": {
"operator": "INCLUDES",
"values": [
"search term"
]
},
"customerRef": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"bol": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"po": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"quoteId": {
"operator": "EQUALS",
"values": [
"550e8400-e29b-41d4-a716-446655440000"
]
},
"quoteFriendlyId": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"arInvoiceId": {
"operator": "EQUALS",
"values": [
"550e8400-e29b-41d4-a716-446655440000"
]
},
"arInvoiceFriendlyId": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"apInvoiceIds": {
"operator": "EQUALS",
"values": [
"550e8400-e29b-41d4-a716-446655440000"
]
},
"apInvoiceFriendlyIds": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
},
"createdAt": {
"operator": "AFTER",
"value": "2025-01-01T00:00:00Z"
},
"orderCreatedAt": {
"operator": "AFTER",
"value": "2025-01-01T00:00:00Z"
}
},
"pagination": {
"pageNumber": 1,
"pageSize": 50
},
"sort": [
{
"field": "createdAt",
"order": "desc"
}
],
"savedSearch": {
"id": "550e8400-e29b-41d4-a716-446655440000"
}
}Response
Successful search results
Example response
{
"data": [
{
"friendlyId": "SHP-0001"
}
],
"pagination": {
"pageNumber": 1,
"pageSize": 50,
"totalPages": 25
}
}