`api.jobs.freight_providers.save`

POST /job/{jobDisplayId}/freightproviders — ACPortal

Python

api.jobs.freight_providers.save(job_display_id: int, *, data: ShipmentPlanProvider | dict) -> None

CLI

ab jobs freight_providers save <job_display_id> [--data ...]

POST /job/{jobDisplayId}/freightproviders

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

No response body.