v60

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

Order modifications

Retry order modifications

This endpoint makes a new attempt to perform an order modification previously made using the Create order modifications endpoint that, for some reason, was not completely processed.

To make this request, you need the changeRequestId, a unique change identification code that you get when you make a Create order modifications request. When you retry to modify an order using the changeRequestId, instead of creating a new modification, you avoid duplications.

This endpoint's successful response status code is 204 No Content, therefore with no response body.

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}/retry

Path parameters

changeOrderIdstring required

Example:v12772213qst-02

Order ID of the order you wish to retry modification.

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.

There are no limits to modifications you can perform using the same changeRequestId, and we recommend keeping all modifications of a given order grouped by the same changeRequestId, so you will have a unified modification history.

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 modify order. Since you can make several modifications to an order, filling this field with a clear explanation helps organize the order modifications history. The shopper can view this field value in transactional emails and My Account.

Example request

{
  "replace": [
    {
      "to": {
        "customData": {
          "customFields": [
            {
              "fields": [
                {
                  "name": "desktop",
                  "value": "DSK-NEW"
                }
              ]
            }
          ]
        }
      }
    }
  ]
}

Response

No Content