---
title: "Get order modifications history"
method: GET
path: "/api/order-system/orders/{changeOrderId}/changes"
tags: ["Order modifications"]
---

# Get order modifications history

`GET /api/order-system/orders/{changeOrderId}/changes`

This endpoint retrieves a history of every successful [Create order modifications request](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) made to an order and provides detailed information about each request.

You can access an order's history using the `changeOrderId`, which corresponds to its `orderId`.

> If you want detailed information about a single modification request, you can use the endpoint [Get order modifications details](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-).

## Permissions

Any user or [API key](https:/developers.vtex.com/docs/guides/authentication-overview#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** |
| --------------- | ----------------- | ----------------- |
| Checkout | CheckoutResources | **Orders Full Access** |
| OMS | OMS access | **Cancel order** |
| OMS | OMS access | **Change order** |

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** | 
| --------------- | ----------------- | 
| 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](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-overview#machine-authentication).

## Path parameters

- `changeOrderId` string, required

## Query parameters

- `an` string, required

## Headers

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

## Response `200`

OK

- object
  - `requests` object[], required — Array with order modifications requests details.
    - `requestId` string, required — Unique code that identifies an order modification.
    - `workflowId` string, required — Code that identifies the transaction of modifying the orders in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196).
    - `reason` string, required — Reason that motivated the order modifications.
    - `manualDiscountValue` integer, required — This field shows if it was applied a manual price for the total order amount. The value is in cents.
    - `manualIncrementValue` integer, required — This field shows if an increment value was applied to the total order amount. The value is in cents.
    - `totalChangeValue` integer, required — This field shows how much the order total price is, considering that price modifications might have been made. The value is in cents.
    - `totals` object[], required — Array containing total costs information.
      - `id` string — Changing price type, for example the item price or shipping costs.
      - `name` string — Changing price name.
      - `value` number — Changing price value in cents.
    - `add` object, nullable, required — Information about an `add` operation, when there was one. It will have the same schema of `request.replace.to`.
    - `remove` object, nullable, required — Information about a `remove` operation, when there was one. It will have the same schema of `request.replace.from`.
    - `replace` object[], required — Array with information about the replacement operation performed.
      - `from` From2, required — What the order is changing from.
        - `paymentData` PaymentDataV2, required — Payment data object.
          - `transactions` string[], required — Information about financial transactions.
        - `items` Item4[], required — Items information from before the order change.
          - `id` string, required — SKU ID of the item.
          - `quantity` integer, required — Quantity of items been replaced.
          - `price` string, nullable, required — Item's shipping price. It does not account for the whole order's shipping price and is presented in cents.
          - `measurementUnit` string, nullable, required — Item's measurement unit. For example, `kg` for kilograms or `un` for unitary items.
          - `unitMultiplier` integer, required — Item's unit multiplier.
          - `sellingPrice` integer, required — Item's selling price.
          - `name` string, nullable, required — Item's name.
          - `detailUrl` string, nullable, required — Item's URL slug.
          - `imageUrl` string, nullable, required — Item's image URL slug.
        - `shippingData` ShippingData3, required
          - `logisticsInfo` LogisticsInfo2[], required — Array with shipping information.
            - `itemIndex` integer, required — Index that identifies the position of the replacing item in the array, starting from `0`.
            - `selectedSla` string, required — Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the replacing order.
            - `addressId` string, required — Shipping address ID.
            - `slas` SlaV2[], required — Information on Service Level Agreement (SLA) of the order modifications.
              - …
            - `shipsTo` string[], required — List of countries of the order modifications shipping address.
            - `itemId` string, required — Replacing item's SKU ID, which is a unique numerical identifier.
            - `deliveryChannels` DeliveryChannel[], required — Array with the delivery channels associated with the trade policy.
              - …
            - `price` integer, required — Item's final price, calculated in cents.
            - `listPrice` integer, required — Item's price list, calculated in cents.
            - `shippingEstimate` string, nullable, required — Item's shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.
            - `dockEstimate` string, nullable, required — Item's estimate duration of the [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) time. For instance, one business day is represented as `1bd`.
            - `shippingEstimateDate` string, nullable, required — Replacing item's total shipping duration estimated in days. For instance, three business days are represented as `3bd`.
            - `lockTTL` string, nullable, required — Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA. For instance, one business day is represented as `1bd`.
            - `deliveryCompany` string, nullable, required — [Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) company's name.
            - `polygonName` string, nullable, required — Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.
            - `transitTime` string, nullable, required — Duration in business days of the time the [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) takes in transit to fulfill the order. For example, three business days are represented as `3bd`.
            - `sellingPrice` integer, required — Item's selling price.
            - `deliveryIds` DeliveryIdV2[], required — Array with delivery information.
              - …
            - `deliveryWindow` string, nullable, required — Order modifications [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.
            - `pickupPointId` string, nullable, required — ID of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).
            - `pickupStoreInfo` PickupStoreInfoV2, required — Information about a loading dock that was transformed into a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).
              - …
            - `pickupDistance` number, nullable, required — Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.
      - `to` To2, required
        - `items` Item3[], required — Array containing information about the item replacing the previous one.
          - `uniqueId` string, required — Item's unique ID in the order modifications request.
          - `id` string, required — SKU ID of the item replacing the previous one.
          - `productId` string, nullable, required — Product ID of the item replacing the previous one.
          - `productRefId` string, nullable, required — Product Ref ID of the item replacing the previous one.
          - `refId` string, nullable, required — Reference ID of the item replacing the previous one.
          - `ean` string, nullable, required — European Article Number (EAN) of the item replacing the previous one.
          - `name` string, nullable, required — Name of the Product associated with the item replacing the previous one.
          - `skuName` string, nullable, required — Name of the SKU replacing the previous one.
          - `modalType` string, nullable, required — A [modal](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125) attaches an unusual product, such as meat or glass, to a carrier specialized in shipping it.
          - `parentItemIndex` integer, nullable, required — Parent item index of the item replacing the previous one.
          - `parentAssemblyBinding` string, nullable, required — Parent assembly binding of the item replacing the previous one.
          - `assemblies` string[], nullable, required — Array with information about services that may be offered for the item replacing the previous one. For example, the assembly of a piece of furniture or warranty.
          - `priceValidUntil` string, nullable, required — Price expiration date of item replacing the previous one. The value is in the format `yyyy-mm-ddThh:mm:ss.sss`.
          - `tax` integer, required — Tax in cents of the item replacing the previous one, when applicable.
          - `price` integer, nullable, required — Final price of the item replacing the previous one, calculated in cents.
          - `listPrice` integer, nullable, required — Item's price list for the item replacing the previous one.
          - `manualPrice` integer, nullable, required — Manual price of the item replacing the previous one. It is calculated in cents.
          - `manualPriceAppliedBy` string, nullable, required — User ID or appKey that made the manual price modification of the item replacing the previous one.
          - `sellingPrice` integer, nullable, required — Selling price of the item replacing the previous one. It is calculated in cents.
          - `rewardValue` integer, required — Reward value of the item replacing the previous one. It is calculated in cents.
          - `isGift` boolean, required — This field is `true` when the replacing item is a gift in the order context and `false` when it is not.
          - `additionalInfo` AdditionalInfoV2, required — Additional information object.
            - `dimension` string, nullable, required — Replacing item's dimensions in the measure unit configured in the catalog.
            - `brandName` string, nullable, required — Replacing item's brand name.
            - `brandId` string, nullable, required — Replacing item's brand ID.
            - `offeringInfo` string, nullable, required — Offering information.
            - `offeringType` string, nullable, required — Offering type.
            - `offeringTypeId` string, nullable, required — Offering type ID.
            - `categoriesIds` string, nullable, required — ID of the replacing item product category.
            - `productClusterId` string, nullable, required — All product clusters related to the replacing item.
            - `commercialConditionId` string, nullable, required — Replacing item commercial conditions ID.
          - `preSaleDate` string, nullable, required — Pre sale date of the item replacing the previous one.
          - `productCategoryIds` string, nullable, required — Replacing item's category path composed of category IDs separated by `/`. For example: `/3/15/`.
          - `productCategories` object, required — Object containing product categories of the replacing item. Structure: `{CategoryID}: {CategoryName}`. Both the key and the value are strings.
          - `quantity` integer, required — Quantity of replacing items.
          - `seller` string, nullable, required — Seller ID that identifies the seller the replacing item belongs to.
          - `sellerChain` string[], nullable, required — Array containing information about sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory) order.
          - `imageUrl` string, nullable, required — Image URL slug of the replacing item.
          - `detailUrl` string, nullable, required — URL slug of the replacing item.
          - `components` string[], required — Array with information about replacing item's components.
          - `bundleItems` string[], required — Array with information about services sold along with the replacing item, such as a gift package.
          - `attachments` string[], required — Array containing information on attachments.
          - `attachmentOfferings` string[], required — Array with the properties of the content declared in the field `attachments`.
          - `offerings` string[], required — Array with replacing items Item's offerings.
          - `priceTags` string[], required — Array containing objects with replacing item's price modifiers.
          - `availability` string, nullable, required — Availability to fulfill the order with the item.
          - `measurementUnit` string, required — Replacing item's measurement unit.
          - `unitMultiplier` integer, required — Replacing item's unit multiplier.
          - `manufacturerCode` string, nullable, required — Provided by the manufacturers to identify their product. This field must be completed if the replacing item has a manufacturer's code.
          - `priceDefinition` string, nullable, required — Replacing item's price information.
        - `paymentData` PaymentDataV2, required — Payment data object.
          - `transactions` string[], required — Information about financial transactions.
        - `receiptData` object, nullable, required — Information about the receipt after order modifications.
        - `shippingData` ShippingData3, required
          - `logisticsInfo` LogisticsInfo2[], required — Array with shipping information.
            - `itemIndex` integer, required — Index that identifies the position of the replacing item in the array, starting from `0`.
            - `selectedSla` string, required — Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the replacing order.
            - `addressId` string, required — Shipping address ID.
            - `slas` SlaV2[], required — Information on Service Level Agreement (SLA) of the order modifications.
              - …
            - `shipsTo` string[], required — List of countries of the order modifications shipping address.
            - `itemId` string, required — Replacing item's SKU ID, which is a unique numerical identifier.
            - `deliveryChannels` DeliveryChannel[], required — Array with the delivery channels associated with the trade policy.
              - …
            - `price` integer, required — Item's final price, calculated in cents.
            - `listPrice` integer, required — Item's price list, calculated in cents.
            - `shippingEstimate` string, nullable, required — Item's shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.
            - `dockEstimate` string, nullable, required — Item's estimate duration of the [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) time. For instance, one business day is represented as `1bd`.
            - `shippingEstimateDate` string, nullable, required — Replacing item's total shipping duration estimated in days. For instance, three business days are represented as `3bd`.
            - `lockTTL` string, nullable, required — Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA. For instance, one business day is represented as `1bd`.
            - `deliveryCompany` string, nullable, required — [Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) company's name.
            - `polygonName` string, nullable, required — Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.
            - `transitTime` string, nullable, required — Duration in business days of the time the [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) takes in transit to fulfill the order. For example, three business days are represented as `3bd`.
            - `sellingPrice` integer, required — Item's selling price.
            - `deliveryIds` DeliveryIdV2[], required — Array with delivery information.
              - …
            - `deliveryWindow` string, nullable, required — Order modifications [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.
            - `pickupPointId` string, nullable, required — ID of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).
            - `pickupStoreInfo` PickupStoreInfoV2, required — Information about a loading dock that was transformed into a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).
              - …
            - `pickupDistance` number, nullable, required — Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.
    - `date` string, required — Date and time of the request. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.
    - `origin` OriginV2, required — Object containing information about the order origin.
      - `account` string, required — Name of the account where the order was made.
      - `orderId` string, required — Order ID is a unique code that identifies an order.
      - `component` string, required — Component information.
    - `settings` Settings, required — Object with account settings information, such as custom payment.
      - `customPaymentSystemsAllowed` string[], required — Store's [custom payment](https://help.vtex.com/tutorial/how-to-configure-a-custom-payment--tutorials_451) information. Applicable only for stores that configured custom payment options.
  - `actions` object[], required — Array containing previous changing order actions history.

## Changes

> 62 revisions in range; 1 could not be searched.

- **2026-06-16** `62f0cb2bad6c` — 1 breaking
  - the `requests/items/replace/items/from/items/items/sellingPrice` response's property type/format changed from `string`/`` to `integer`/`` for status `200`

[Change history](https://skmtc.dev/vtex/apis/orders-api/changes/api/order-system/orders/:changeOrderId/changes/get.md)

---

[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)