api.jobs.shipment.get_rate_quotes

GET /job/{jobDisplayId}/shipment/ratequotes — ACPortal

Python

api.jobs.shipment.get_rate_quotes(job_display_id: int) -> list[RateQuote]

CLI

ab jobs shipment get_rate_quotes <job_display_id>

GET /job/{jobDisplayId}/shipment/ratequotes

Query parameters — RateQuotesParams

Field

Type

Required

Description

ShipOutDate

Optional[str]

no

Requested ship-out date (ISO 8601)

RatesSources

Optional[str]

no

Comma-separated rate source identifiers

SettingsKey

Optional[str]

no

Settings configuration key

Response

Returns a list of List[RateQuote].

Field

Type

Required

Description

carrierName

Optional[str]

no

Carrier company name

serviceType

Optional[str]

no

Service level

totalCharge

Optional[float]

no

Total quoted price

transitDays

Optional[int]

no

Estimated transit time

accessorialCharges

Optional[list[dict]]

no

Itemized extras

providerOptionIndex

Optional[int]

no

Index for booking selection

errors

Optional[list]

no

Rate quote errors

rates

Optional[list]

no

Available rates

ratesKey

Optional[str]

no

Rates cache key

requestSnapshot

Optional[dict]

no

Original request snapshot

carrierCode

Optional[str]

no

Carrier code identifier

usedCarrierAccountInfo

Optional[dict]

no

Carrier account info used for quoting

serviceDays

Optional[int]

no

Service delivery days

price

Optional[float]

no

Quoted price

accessorials

Optional[list]

no

Accessorial services


← Back to api.jobs