api.jobs.shipment.post_export_data

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

Python

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

CLI

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

POST /job/{jobDisplayId}/shipment/exportdata

The body is the portal’s flat InternationalParams shape —

class:

ShipmentExportRequest, customsValue required. GET returns a jobItemId on each commodity that the POST schema forbids (additionalProperties: false), so it is stripped here to keep the GET → edit → POST round-trip legal.

Request body — ShipmentExportRequest

Field	Type	Required	Description
customsValue	float	yes	Customs declared value (portal-required)
commodities	Optional[list[dict]]	no	Commodity lines (GET adds a per-line jobItemId the POST schema forbids; the endpoint strips it)
packingInfo	Optional[list]	no	Packing information entries
invoiceNumber	Optional[str]	no	Commercial invoice number
purchaseOrderNumber	Optional[str]	no	Purchase order number
termsOfSale	Optional[str]	no	Incoterms / terms of sale
exporterTaxId	Optional[str]	no	Exporter tax identifier
consigneeTaxId	Optional[str]	no	Consignee tax identifier
totalCosts	Optional[dict]	no	Aggregate cost breakdown
soldTo	Optional[dict]	no	Sold-to contact and address
uspsSpecific	Optional[dict]	no	USPS-specific export fields
fedExSpecific	Optional[dict]	no	FedEx-specific export fields
upsSpecific	Optional[dict]	no	UPS-specific export fields
valuesSpecified	Optional[bool]	no	Whether numeric values are explicitly specified

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 | 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

---

← Back to api.jobs