# Filter loads

Search for loads using filter criteria.

## Common Filters

- By shipment: { "filter": { "shipmentId": { "equalTo": "uuid" } } }
- Active loads: { "filter": { "status": { "notIn": ["DELIVERED", "CANCELED"] } } }
- TL loads: { "filter": { "mode": { "equalTo": "TL" } } }

Endpoint: POST /loads/filter
Version: 1.0.0
Security: BearerAuth

## Request fields (application/json):

  - `filter` (object)

  - `filter.id` (object)
    Filter options for UUID fields (all operations)

  - `filter.id.equalTo` (string)
    Exact match

  - `filter.id.notEqualTo` (string)
    Not equal to

  - `filter.id.in` (array)
    Matches any UUID in the array

  - `filter.id.notIn` (array)
    Does not match any UUID in the array

  - `filter.id.isNull` (boolean)
    Field is null (true) or not null (false)

  - `filter.shipmentId` (object)
    Filter options for UUID fields (all operations)

  - `filter.status` (object)

  - `filter.status.equalTo` (string)
    Current status of the load.

Pre-transit:
- SOURCING: Looking for carrier
- BOOKED: Carrier booked
- DISPATCHED: Dispatched to carrier

In-transit:
- LOADING: Loading at pickup
- PICKED_UP: Picked up
- IN_TRANSIT: In transit
- UNLOADING: Unloading at delivery

Final:
- DELIVERED: Delivered
- CANCELED: Canceled
    Enum: "SOURCING", "BOOKED", "DISPATCHED", "LOADING", "PICKED_UP", "IN_TRANSIT", "UNLOADING", "DELIVERED", "CANCELED"

  - `filter.status.notEqualTo` (string)
    Current status of the load.

Pre-transit:
- SOURCING: Looking for carrier
- BOOKED: Carrier booked
- DISPATCHED: Dispatched to carrier

In-transit:
- LOADING: Loading at pickup
- PICKED_UP: Picked up
- IN_TRANSIT: In transit
- UNLOADING: Unloading at delivery

Final:
- DELIVERED: Delivered
- CANCELED: Canceled
    Enum: "SOURCING", "BOOKED", "DISPATCHED", "LOADING", "PICKED_UP", "IN_TRANSIT", "UNLOADING", "DELIVERED", "CANCELED"

  - `filter.status.in` (array)
    Enum: "SOURCING", "BOOKED", "DISPATCHED", "LOADING", "PICKED_UP", "IN_TRANSIT", "UNLOADING", "DELIVERED", "CANCELED"

  - `filter.status.notIn` (array)
    Enum: "SOURCING", "BOOKED", "DISPATCHED", "LOADING", "PICKED_UP", "IN_TRANSIT", "UNLOADING", "DELIVERED", "CANCELED"

  - `filter.mode` (object)

  - `filter.mode.equalTo` (string)
    Transportation mode.
- TL: Full Truckload
- LTL: Less than Truckload
- AIR: Air freight
- OCEAN: Ocean freight
- RAIL: Rail freight
- INTERMODAL: Intermodal (multiple modes)
- DRAYAGE: Drayage/cartage
    Enum: "TL", "LTL", "AIR", "OCEAN", "RAIL", "INTERMODAL", "DRAYAGE"

  - `filter.createdAt` (object)
    Filter options for datetime fields

  - `filter.createdAt.lessThan` (string)
    Before this datetime

  - `filter.createdAt.lessThanOrEqualTo` (string)
    On or before this datetime

  - `filter.createdAt.greaterThan` (string)
    After this datetime

  - `filter.createdAt.greaterThanOrEqualTo` (string)
    On or after this datetime

  - `filter.deliveredAt` (object)
    Filter options for datetime fields

  - `filter.and` (array)

  - `filter.or` (array)

  - `filter.not` (object)

  - `pageSize` (integer)

  - `cursor` (string)

## Response 200 fields (application/json):

  - `data` (array, required)

  - `data.id` (string, required)
    Example: "550e8400-e29b-41d4-a716-446655440000"

  - `data.key` (string,null)
    Human-readable load ID
    Example: "LD-12345"

  - `data.shipmentId` (string)
    Parent shipment

  - `data.shipmentKey` (string,null)
    Parent shipment friendly ID

  - `data.mode` (string)
    Transportation mode.
- TL: Full Truckload
- LTL: Less than Truckload
- AIR: Air freight
- OCEAN: Ocean freight
- RAIL: Rail freight
- INTERMODAL: Intermodal (multiple modes)
- DRAYAGE: Drayage/cartage
    Enum: "TL", "LTL", "AIR", "OCEAN", "RAIL", "INTERMODAL", "DRAYAGE"

  - `data.status` (string, required)
    Current status of the load.

Pre-transit:
- SOURCING: Looking for carrier
- BOOKED: Carrier booked
- DISPATCHED: Dispatched to carrier

In-transit:
- LOADING: Loading at pickup
- PICKED_UP: Picked up
- IN_TRANSIT: In transit
- UNLOADING: Unloading at delivery

Final:
- DELIVERED: Delivered
- CANCELED: Canceled
    Enum: "SOURCING", "BOOKED", "DISPATCHED", "LOADING", "PICKED_UP", "IN_TRANSIT", "UNLOADING", "DELIVERED", "CANCELED"

  - `data.stops` (array)
    Load stops

  - `data.stops.orderStopId` (string)
    Reference to the order stop

  - `data.stops.sequence` (integer)

  - `data.stops.type` (string)
    Enum: "PICKUP", "DELIVERY", "CROSS_DOCK"

  - `data.stops.address` (object)
    Physical address/location details (nested, without id).

This is an embedded object representing a Location record. The id is managed
internally and not exposed in the API.

  - `data.stops.address.line1` (string, required)
    Primary street address line
    Example: "123 Main St"

  - `data.stops.address.line2` (string,null)
    Secondary address line (suite, floor, etc.)
    Example: "Suite 400"

  - `data.stops.address.city` (string, required)
    City name
    Example: "Chicago"

  - `data.stops.address.country` (string, required)
    Country name or code
    Example: "USA"

  - `data.stops.address.market` (string, required)
    Market or region identifier
    Example: "CHI"

  - `data.stops.address.latitude` (string,null)
    Latitude coordinate
    Example: "41.8781"

  - `data.stops.address.longitude` (string,null)
    Longitude coordinate
    Example: "-87.6298"

  - `data.stops.address.isAirportOrAirbase` (boolean, required)
    Whether this location is an airport or airbase

  - `data.stops.address.isConstructionOrUtilitySite` (boolean, required)
    Whether this location is a construction or utility site

  - `data.stops.address.isSmartyValidated` (boolean, required)
    Whether address has been validated by SmartyStreets
    Example: true

  - `data.stops.address.obeysDst` (boolean, required)
    Whether this location observes daylight saving time
    Example: true

  - `data.stops.address.cityId` (string,null)
    Reference to standardized city record (internal use)

  - `data.stops.scheduledArrival` (string,null)

  - `data.stops.actualArrival` (string,null)

  - `data.stops.actualDeparture` (string,null)

  - `data.carriers` (array)
    Carrier assignments (flattened from LoadCarriersConnection)

  - `data.carriers.carrier` (object)
    Enhanced reference to a carrier resource (returned in responses).
Includes full carrier details in addition to id/key.

Note: Does NOT include nested references (contacts, etc.) to prevent recursion.
Maximum nesting depth: 1 level.

  - `data.carriers.carrier.id` (string, required)
    Carrier UUID
    Example: "550e8400-e29b-41d4-a716-446655440000"

  - `data.carriers.carrier.key` (string,null)
    Client-defined reference ID if set
    Example: "ERP-CARRIER-SWIFT"

  - `data.carriers.carrier.name` (string, required)
    Carrier company name
    Example: "Swift Transportation"

  - `data.carriers.carrier.phoneNumber` (string,null)
    Primary phone number
    Example: "+1-555-987-6543"

  - `data.carriers.carrier.email` (string,null)
    Primary email address
    Example: "dispatch@swifttrans.com"

  - `data.carriers.carrier.createdAt` (string, required)
    When the carrier was created
    Example: "2025-01-15T10:00:00Z"

  - `data.carriers.carrier.updatedAt` (string, required)
    When the carrier was last updated
    Example: "2025-01-15T14:30:00Z"

  - `data.carriers.carrier.deletedAt` (string,null)
    When the carrier was soft deleted (null if active)

  - `data.carriers.contact` (object)

  - `data.carriers.contact.name` (string)

  - `data.carriers.contact.phone` (string,null)

  - `data.carriers.contact.email` (string,null)

  - `data.carriers.status` (string)
    Status of the carrier assignment.
- ACTIVE: Carrier is actively assigned
- TONU: Truck Ordered Not Used (carrier dispatched but cancelled)
- BOUNCED: Carrier bounced/rejected load
    Enum: "ACTIVE", "TONU", "BOUNCED"

  - `data.carriers.billingStatus` (string)
    Billing status for the load (AP side).
- AWAITING_INVOICE: Waiting for carrier invoice
- INVOICE_IN_REVIEW: Invoice received, under review
- APPROVED_TO_PAY: Approved for payment
- PAID: Paid to carrier
    Enum: "AWAITING_INVOICE", "INVOICE_IN_REVIEW", "APPROVED_TO_PAY", "PAID"

  - `data.carriers.bookedAt` (string,null)

  - `data.carriers.dispatchedAt` (string,null)

  - `data.carriers.charges` (array)
    Flattened charges array

  - `data.carriers.charges.chargeCode` (object)
    Reference to another resource (returned in responses)

  - `data.carriers.charges.chargeCode.id` (string, required)
    Resource UUID

  - `data.carriers.charges.description` (string,null)

  - `data.carriers.charges.amount` (number)

  - `data.carriers.charges.quantity` (number)

  - `data.carriers.totalCost` (number,null)
    Sum of all charges

  - `data.carriers.driverName` (string,null)

  - `data.carriers.driverPhone` (string,null)

  - `data.carriers.truckNumber` (string,null)

  - `data.carriers.trailerNumber` (string,null)

  - `data.carriers.createdAt` (string)

  - `data.carriers.updatedAt` (string,null)

  - `data.totalCost` (number,null)
    Total carrier costs

  - `data.pickedUpAt` (string,null)

  - `data.deliveredAt` (string,null)

  - `pagination` (object, required)

  - `pagination.pageSize` (integer, required)
    Number of items per page
    Example: 50

  - `pagination.hasNextPage` (boolean, required)
    Whether there are more pages
    Example: true

  - `pagination.hasPreviousPage` (boolean)
    Whether there are previous pages

  - `pagination.endCursor` (string,null)
    Cursor for the next page (null if no next page)
    Example: "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"

## Response 400 fields (application/json):

  - `error` (string, required)
    Error code

  - `message` (string, required)
    Human-readable error message

## Response 401 fields (application/json):

  - `error` (string, required)
    Error code

  - `message` (string, required)
    Human-readable error message

## Response 422 fields (application/json):

  - `error` (string, required)
    Error code
    Example: "validation_error"

  - `message` (string, required)
    Human-readable error message

  - `details` (array, required)
    Validation error details

  - `details.field` (string, required)
    Field name that failed validation

  - `details.message` (string, required)
    Validation error message