`api.jobs.shipment.get_rates_state`

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

Python

api.jobs.shipment.get_rates_state(job_display_id: int) -> RatesState

CLI

ab jobs shipment get_rates_state <job_display_id>

GET /job/{jobDisplayId}/shipment/ratesstate

Response

Returns RatesState.

Field	Type	Required	Description
`state`	`Optional[str]`	no	Current rates state
`rates`	`Optional[list[dict]]`	no	Available rates
`fromZip`	`Optional[str]`	no	Origin ZIP code
`toZip`	`Optional[str]`	no	Destination ZIP code
`itemWeight`	`Optional[float]`	no	Total item weight
`services`	`Optional[list]`	no	Available services
`parcelItems`	`Optional[list]`	no	Parcel items
`parcelServices`	`Optional[list]`	no	Parcel services
`shipOutDate`	`Optional[str]`	no	Ship out date