---
title: "Get Order modifications settings"
method: GET
path: "/api/order-system/orders/changes/settings"
tags: ["Order modifications"]
---

# Get Order modifications settings

`GET /api/order-system/orders/changes/settings`

Retrieves the [Order modifications settings](https://developers.vtex.com/docs/api-reference/orders-api#put-/api/order-system/orders/changes/settings) from a store.

>ℹ️ To know more about **Order modifications**, see [How Order modifications works](https://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ).

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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** |
| --------------- | ----------------- | ----------------- |
| OMS | OMS access | **View order** |
| Checkout         | CheckoutResources | **Orders Full Access** |

You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):

| **Role** | **Resource** | 
| --------------- | ----------------- | 
| OMS - Full access | View order |
| Checkout Admin | View order |
| IntegrationProfile - Fulfillment Oms | View order |
| OMS - Full access | Orders Full Access |
| Checkout Admin | Orders Full Access |
| IntegrationProfile - Fulfillment Oms | Orders Full Access |

>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).

## Query parameters

- `an` string, required

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Response `200`

OK

- ChangeOrderSettingsResponse — Object with all VTEX account settings related to the **Order modifications** feature.
  - `paymentConfiguration` object — [Order modifications](https://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ) payment configurations.
    - `customPaymentSystemsAllowed` string[] — List of custom payment system IDs configured for the VTEX account.
  - `rolloutConfiguration` object — **Order modifications** settings regarding VTEX Admin, [Orders API](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes?endpoint=patch-/api/order-system/orders/-changeOrderId-/changes) and **My Account** feature.
    - `usingDefaultBehavior` boolean — Defines if the **Order modifications** configurations are the default behaviour (`true`) or if the account made customizations to it (`false`). Subaccounts will have the same configurations as the main account.
    - `enableApi` boolean — Defines if the account enabled the [Order modifications API](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) (`true`) or not (`false`). The account can only use the [Order modifications via VTEX Admin](https://help.vtex.com/en/tutorial/how-to-change-orders-beta--7btlG91rb6sHpW1dkd2kBw) or [via API](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) if this field is set to `true`.
    - `enableAdminOrders` object — Object about enabling the [Order modifications feature via VTEX Admin](https://help.vtex.com/en/tutorial/how-to-change-orders-beta--7btlG91rb6sHpW1dkd2kBw).
      - `enabledWorkspaces` string[] — List with the workspaces' names that have the **Order modifications** feature enabled via VTEX Admin.
    - `enableMyOrders` object — Object about enabling the **Order modifications** feature via [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh).
      - `enabledWorkspaces` string[] — List with the workspace names that have the **Order modifications** feature enabled via **My Account**.
  - `pipelineConfiguration` object — **Order modifications** settings related to taxes and shipping calculation.
    - `enableTaxHubRecalculation` boolean — Defines if the tax calculation is enabled for **Order modifications** (`true`) or not (`false`).
    - `compensateShippingChanges` boolean — Defines if orders changed will have zero shipping cost (`true`) or not (`false`). Merchants usually enable this configuration to change only items and prices, without impacting the orders original freight costs.
    - `enablePromotionRecalculation` boolean — Defines if the promotion recalculation is enabled for **Order modifications** (`true`) or not (`false`).
    - `enableNativeTaxRecalculation` boolean — Defines if the native tax recalculation is enabled for **Order modifications** (`true`) or not (`false`).

---

[API](https://skmtc.dev/vtex/apis/orders-api.md) · [All operations](https://skmtc.dev/vtex/apis/orders-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vtex/orders-api/revisions/cb5fa08e400c/schema)