api.jobs.save_feedback

POST /job/feedback/{jobDisplayId} — ACPortal

Python

api.jobs.save_feedback(job_display_id: int | str, feedback_id: str | None = None, cancel_job: bool = False, *, data: FeedbackSaveModel | dict | None = None) -> ServiceBaseResponse

CLI

ab jobs save_feedback <job_display_id> <feedback_id> <cancel_job> [--data ...]

POST /job/feedback/{jobDisplayId} (ACPortal)

Args: job_display_id: Job display ID. feedback_id: Feedback UUID to save. cancel_job: Whether the API should cancel the job. data: Optional full feedback payload. When provided, this payload is sent instead of building one from feedback_id/cancel_job.

Request body — FeedbackSaveModel

Field

Type

Required

Description

feedbackId

Optional[str]

no

Feedback UUID

cancelJob

Optional[bool]

no

Whether to cancel the job

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