`api.jobs.shipment.book`

POST /job/{jobDisplayId}/shipment/book — ACPortal

Python

api.jobs.shipment.book(job_display_id: int, *, data: ShipmentBookRequest | dict) -> ServiceBaseResponse

CLI

ab jobs shipment book <job_display_id> [--data ...]

POST /job/{jobDisplayId}/shipment/book

Request model: :class:ShipmentBookRequest.

Request body — `ShipmentBookRequest`

Field	Type	Required	Description
`quoteOptionIndex`	`Optional[int]`	no	Selected rate quote option index
`shipOutDate`	`Optional[str]`	no	Requested ship-out date (ISO-8601 date-time); required for non-UPS carriers
`internationalParams`	`Optional[dict]`	no	International shipment export parameters
`carrierSpecificParams`	`Optional[dict]`	no	Carrier-specific booking parameters
`documentByteCodeRequired`	`Optional[bool]`	no	Whether the response should include document byte codes (labels)

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