Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1425213171.1 KB

Allows sellers (proposers) to withdraw an existing agreement cancellation request that is in a pending state. Once cancelled, the cancellation request transitions to CANCELLED status and can no longer be approved or rejected by the buyer.

Only cancellation requests in PENDING_APPROVAL status can be cancelled. A ConflictException is thrown if the cancellation request is in any other status.

post/#X-Amz-Target=AWSMPCommerceService_v20200301.CancelAgreementCancellationRequest

Headers

X-Amz-Target'AWSMPCommerceService_v20200301.CancelAgreementCancellationRequest' required

Request body

agreementIdstring required

The unique identifier of the agreement associated with the cancellation request.

agreementCancellationRequestIdstring required

The unique identifier of the cancellation request to cancel.

cancellationReasonstring password required

A required message explaining why the cancellation request is being withdrawn (1-2000 characters).

Response

Success

agreementCancellationRequestIdstring

The unique identifier of the cancelled cancellation request.

agreementIdstring

The unique identifier of the agreement associated with this cancellation request.

reasonCode'INCORRECT_TERMS_ACCEPTED' | 'REPLACING_AGREEMENT' | 'TEST_AGREEMENT' | 'ALTERNATIVE_PROCUREMENT_CHANNEL' | 'PRODUCT_DISCONTINUED' | 'UNINTENDED_RENEWAL' | 'BUYER_DISSATISFACTION' | 'OTHER'

The original reason code provided when the cancellation request was created.

descriptionstring password

The detailed description of the original cancellation reason, if provided.

status'PENDING_APPROVAL' | 'APPROVED' | 'REJECTED' | 'CANCELLED' | 'VALIDATION_FAILED'

The updated status of the cancellation request, which is <code>CANCELLED</code>.

statusMessagestring

A message providing additional context about the cancellation request status.

createdAtstring date-time

The date and time when the cancellation request was originally created.

updatedAtstring date-time

The date and time when the cancellation request was cancelled.