api.jobs.freight_providers.list

GET /job/{jobDisplayId}/freightproviders — ACPortal

Python

api.jobs.freight_providers.list(job_display_id: int, *, provider_indexes: list[int] | None = None, shipment_types: list[str] | None = None, only_active: bool | None = None) -> list[PricedFreightProvider]

CLI

ab jobs freight_providers list <job_display_id> [--provider-indexes ...] [--shipment-types ...] [--only-active ...]

GET /job/{jobDisplayId}/freightproviders

Query parameters — FreightProvidersParams

Field	Type	Required	Description
ProviderIndexes	Optional[list[int]]	no	Filter by provider option indexes
ShipmentTypes	Optional[list[str]]	no	Filter by shipment type UUIDs
OnlyActive	Optional[bool]	no	Show only active providers

Response

Returns a list of List[PricedFreightProvider].

Field	Type	Required	Description
optionIndex	Optional[int]	no	Provider option index
shipmentType	Optional[str]	no	Shipment type UUID
providerAPI	Optional[int]	no	Carrier API type (CarrierAPI enum int)
providerId	Optional[str]	no	Provider company UUID
providerCode	Optional[str]	no	Provider code
providerCompanyName	Optional[str]	no	Provider company name
totalSell	Optional[float]	no	Total sell price
transit	Optional[int]	no	Transit days
quoteNo	Optional[str]	no	Quote number
proNum	Optional[str]	no	PRO number
optionActive	Optional[bool]	no	Whether option is active
shipmentAccepted	Optional[bool]	no	Whether shipment is accepted
shipmentAcceptedDate	Optional[str]	no	Shipment accepted timestamp
obtainNFMJobState	Optional[str]	no	NFM job state
usedCarrierAccountInfo	Optional[CarrierAccountInfo]	no	Carrier account info

---

← Back to api.jobs