api.jobs.freight_providers.final_override

POST /job/{jobDisplayId}/freightproviders — ACPortal

Python

api.jobs.freight_providers.final_override(job_display_id: int, *, provider: str | None = None, provider_id: str | None = None, provider_company_code: str | None = None, shipment_type: str | None = None, freight_amount: float | None = None, accessorial_amount: float | None = None, pro_num: str | None = None, option_index: int = 6, option_active: bool | None = None, data: ShipmentPlanProvider | dict | list[ShipmentPlanProvider | dict] | None = None) -> ServiceBaseResponse | None

CLI

ab jobs freight_providers final_override <job_display_id> [--provider ...] [--provider-id ...] [--provider-company-code ...] [--shipment-type ...] [--freight-amount ...] [--accessorial-amount ...] [--pro-num ...] [--option-index ...] [--option-active ...] [--data ...]

POST /job/{jobDisplayId}/freightproviders

Saves a final freight-provider override on API 7.11 by posting a one-item :class:ShipmentPlanProvider array to the regular save route. When data is omitted, the SDK builds the minimal body from provider identifiers, shipment type, PRO number, and optionIndex=6. The API requires optionIndex to be present, so it is added to every row when omitted.

Request model: :class:ShipmentPlanProvider.

Request body — ShipmentPlanProvider

Field	Type	Required	Description
jobID	Optional[str]	no	Job UUID
freightQuoteOptionsId	Optional[str]	no	Freight quote options UUID
providerID	Optional[str]	no	Provider company UUID
isPrimary	Optional[bool]	no	Whether this is the primary provider
providerCompanyCode	Optional[str]	no	Provider company code
providerCompanyName	Optional[str]	no	Provider company name
originalCompanyName	Optional[str]	no	Original company name
freightAmount	Optional[float]	no	Freight amount
accessorialAmount	Optional[float]	no	Accessorial charges amount
cafNote	Optional[str]	no	CAF note
quoteNo	Optional[str]	no	Quote number
proNum	Optional[str]	no	PRO number
transit	Optional[int]	no	Transit days
shipmentType	Optional[str]	no	Shipment type UUID
miles	Optional[float]	no	Distance in miles
logo	Optional[str]	no	Provider logo URL
optionIndex	Optional[int]	no	Provider option index
optionActive	Optional[bool]	no	Whether option is active
shipmentAccepted	Optional[bool]	no	Whether shipment is accepted
shipmentAcceptedDate	Optional[str]	no	Shipment accepted timestamp
usedAPI	Optional[int]	no	Carrier API type (CarrierAPI enum int)
billToFranchiseeId	Optional[str]	no	Bill-to franchisee UUID
billToCompanyCode	Optional[str]	no	Bill-to company code
obtainNFMJobState	Optional[str]	no	NFM job state
usedCarrierAccountInfo	Optional[CarrierAccountInfo]	no	Carrier account info

Response

Returns ServiceBaseResponse.

Field	Type	Required	Description
success	Optional[bool]	no	Whether the operation succeeded
errorMessage	Optional[str]	no	Error detail when success is False
jobSubManagementStatus	Optional[dict]	no	Current job sub-management status
documents	Optional[list[str | BookedDocument]]	no	Documents from the operation — URL/reference strings or document objects (label byte codes)
errors	Optional[dict]	no	Detailed error object when success is False
confirmRequired	Optional[bool]	no	Whether user confirmation is needed
notifications	Optional[list[str]]	no	Notification messages for user
shipmentId	Optional[str]	no	Shipment UUID created or modified
shipmentAcceptIdentifier	Optional[str]	no	Carrier acceptance reference
weight	Optional[ShipmentWeight]	no	Shipment weight details
totalNetChargeAmount	Optional[float]	no	Total net charge amount
currencyCode	Optional[str]	no	Currency code (e.g., USD)
internationalInfoRequired	Optional[bool]	no	Whether international info is needed
shipOutDateRequired	Optional[bool]	no	Whether ship-out date confirmation is needed
fedExExpressFreightDetailRequired	Optional[bool]	no	Whether FedEx Express freight details are required
carrierAPI	Optional[int]	no	Carrier API type code

---

← Back to api.jobs