`api.shipments.get_shipment`

GET /shipment — ACPortal

Python

api.shipments.get_shipment(*, franchisee_id: str | None = None, provider_id: str | None = None, pro_number: str | None = None) -> ShipmentInfo

CLI

ab shipments get_shipment [--franchisee-id ...] [--provider-id ...] [--pro-number ...]

GET /shipment

Query parameters — `ShipmentParams`

Field	Type	Required	Description
`franchiseeId`	`Optional[str]`	no	Franchisee UUID
`providerId`	`Optional[str]`	no	Provider UUID
`proNumber`	`Optional[str]`	no	PRO/tracking number

Returns ShipmentInfo.

Field	Type	Required	Description
`shipmentId`	`Optional[str]`	no	Shipment identifier
`status`	`Optional[str]`	no	Current status
`carrier`	`Optional[str]`	no	Carrier name
`proNumber`	`Optional[str]`	no	PRO tracking number
`usedAPI`	`Optional[int]`	no	API used for shipment
`historyProviderName`	`Optional[str]`	no	Tracking history provider
`historyStatuses`	`Optional[list]`	no	Tracking status history
`weight`	`Optional[ShipmentWeight]`	no	Shipment weight details
`jobWeight`	`Optional[float]`	no	Job total weight
`successfully`	`Optional[bool]`	no	Whether shipment was successful
`errorMessage`	`Optional[str]`	no	Error message if failed
`multipleShipments`	`Optional[bool]`	no	Multiple shipments flag
`packages`	`Optional[list]`	no	Package details
`estimatedDelivery`	`Optional[str]`	no	Estimated delivery date