v60

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-01361201.5 MB

Order modifications

Cancel order modifications

This endpoint cancels an order modification. It is meant for when, due to an error, a modification was not completely processed, and you do not wish to retry it. For this request, you need the order's changeRequestId, the unique identification code generated by the Create order modifications endpoint.

⚠️ Once an order modification has been successfully processed, canceling it is no longer possible. If you wish to revert the modifications made to an order, you will have to create a new order modification.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

Product	Category	Resource
Checkout	CheckoutResources	Orders Full Access
OMS	OMS access	Cancel order
OMS	OMS access	Change order

You can create a custom role with that resource or use one of the following predefined roles:

Role	Resource
Checkout Admin	Orders Full Access
OMS - Full access	<p>Cancel order</p><p>Change order</p>
IntegrationProfile - Fulfillment Oms	<p>Cancel order</p><p>Change order</p>
IntegrationProfile - Fulfillment Gateway	Cancel order
IntegrationProfile - Fulfillment Gateway Oms	<p>Cancel order</p><p>Change order</p>
inStore Sales Person	<p>Cancel order</p><p>Change order</p>

❗ Assigning a predefined role to users or application keys usually grants permission to multiple License Manager resources. If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see Best practices for using application keys.

To learn more about machine authentication at VTEX, see Authentication overview.

post/api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/cancel

Path parameters

changeOrderIdstring required

Example:v12772213qst-02

Order ID of the order with the modifications you wish to cancel.

changeRequestIdstring required

Example:e8532a32-7f7e-434a-88ec-29609f0ede46

Once you make an order modification, you generate a requestId code that identifies the modifications made to that order. This field should be filled with that code. After cancelling an order modification, the changeRequestId will no longer be valid.

Query parameters

anstring required

Example:storeName

Name of the VTEX account that created the order.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

reasonstring required

Reason why you wish to cancel the order modification. The customer will not view the value inserted in this field.

Example request

{
  "reason": "I want to cancel this order modification request because it's stopped on a blocking error."
}

v60