api.jobs.update_item

PUT /job/{jobDisplayId}/item/{itemId} — ACPortal

Python

api.jobs.update_item(job_display_id: int, item_id: str, *, data: ItemUpdateRequest | dict) -> ServiceBaseResponse

CLI

ab jobs update_item <job_display_id> <item_id> [--data ...]

PUT /job/{jobDisplayId}/item/{itemId}.

Args: job_display_id: Job display ID. item_id: Item identifier. data: Item update payload with description, quantity, and weight. Accepts an :class:ItemUpdateRequest instance or a dict.

Request model: :class:ItemUpdateRequest

Request body — ItemUpdateRequest

Field	Type	Required	Description
description	Optional[str]	no	Updated description
quantity	Optional[int]	no	Updated quantity
weight	Optional[float]	no	Updated weight

Response

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]]	no	Document URLs/references generated by operation
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

---

← Back to api.jobs