Shipments
Filter shipments
Search for shipments using filter criteria.
Common Filters
- Active shipments: { "filter": { "status": { "notIn": ["DELIVERED", "CANCELED"] } } }
- Delivered today: { "filter": { "deliveredAt": { "greaterThanOrEqualTo": "2025-01-15T00:00:00Z" } } }
- By customer: { "filter": { "customerId": { "equalTo": "uuid" } } }
post/shipments/filter
Request body
Response
Shipments matching filter criteria
Example response
{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "SHP-12345",
"customer": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-CUSTOMER-ACME",
"name": "Acme Manufacturing Corp",
"friendlyId": "A123456",
"status": "ACTIVE",
"phoneNumber": "+1-555-123-4567",
"website": "https://acme-manufacturing.com",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
},
"customerRep": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-USER-12345",
"email": "john.doe@example.com",
"name": "John Doe",
"phone": "+1-555-123-4567",
"phoneExt": "123",
"status": "ACTIVE",
"avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
},
"orders": [
{
"stops": [
{
"location": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-USER-12345"
},
"address": {
"line1": "123 Main St",
"line2": "Suite 400",
"city": "Chicago",
"country": "USA",
"market": "CHI",
"latitude": "41.8781",
"longitude": "-87.6298",
"isSmartyValidated": true,
"obeysDst": true
}
}
],
"charges": [
{
"chargeCode": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-USER-12345"
}
}
],
"equipment": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-USER-12345"
}
],
"specialRequirements": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-USER-12345"
}
]
}
],
"loads": [
{
"carriers": [
{
"carrier": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-CARRIER-SWIFT",
"name": "Swift Transportation",
"phoneNumber": "+1-555-987-6543",
"email": "dispatch@swifttrans.com",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
}
}
]
}
],
"services": [
{
"vendor": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-VENDOR-ABC-001",
"friendlyId": "V123456",
"name": "ABC Warehouse Services",
"email": "billing@abcwarehouse.com",
"phone": "+1-555-123-4567",
"status": "ACTIVE",
"currency": "USD",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
}
}
]
}
],
"pagination": {
"pageSize": 50,
"hasNextPage": true,
"endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
}
}