v60

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

Order modifications

Update Order modifications settings

Updates the Order modifications settings from a store.

ℹ️ To know more about Order modifications, see How Order modifications works.

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.

put/api/order-system/orders/changes/settings

Query parameters

anstring required

Example:storename

VTEX account name.

Headers

Content-Typestring required

Example:application/json

Type of the content being sent.

Acceptstring required

Example:application/json

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

Request body

Example request

{
  "pipelineConfiguration": {
    "compensateShippingChanges": true
  }
}

v60