API Reference

Filter Routings

post
https://api.freight.fyi/api/v2/domestic_shipment_routings/filter

Return routing requests scoped to the authenticated customer, with their freight units, the PO line items / SKUs allocated to each unit, and the routing's contract/bid associations (contract_associations), each carrying registry-resolved custom columns and the linked domestic invoice contract (including contract_distance). Every filter in the body is optional and AND-combined; customer is never an accepted filter (always auto-scoped). Soft-deleted routings are excluded. Datetimes are FC-local and echoed back exactly as stored. Sorting is controlled by the optional order_by list (single object or list of {field, direction}, applied in order, uuid ASC always appended as the final tiebreaker); default sort is created_dt DESC.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Filter body for the routing-request query.

Every filter is optional and AND-combined; results are always auto-scoped to
the authenticated customer (customer is never an accepted filter).
requested_pickup_ / must_arrive_by_ bounds are FC-local and naive — any tz
offset is dropped (not converted). created_* bounds compare against the
TZ-aware created_dt column, so they are coerced to UTC instead (naive
values are assumed UTC).

Filter by vendor uuid.

array | null

Filter by destination distribution center uuid(s). Single value or list.

array | null

Filter by routing status. One of: routing_requested, validated, mode_selected, tendering, spot_bidding, awarded, in_transit, delivered, closed, cancelled. Single value or list.

array | null

Filter by mode: FTL, LTL, PTL, Parcel. Single value or list.

array | null

Filter by load_type: brand_inbound, fc_transfer, ltl_consolidation, prepaid, international_appt. Single value or list.

Exact match on load_number.

Inclusive lower bound on requested_pickup_dt.

Inclusive upper bound on requested_pickup_dt.

Inclusive lower bound on must_arrive_by_dt.

Inclusive upper bound on must_arrive_by_dt.

Inclusive lower bound on created_dt.

Inclusive upper bound on created_dt.

array | null

Sort keys applied in order, e.g. [{"field": "requested_pickup_dt", "direction": "DESC"}]. Single object or list. uuid ASC is always appended as the final tiebreaker so pagination stays deterministic. Unknown fields return 404. Default: created_dt DESC.

integer
≥ 0
Defaults to 0

Zero-indexed page number.

integer
1 to 75
Defaults to 50

Number of routing requests per page.

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?