---
title: "Get order modifications summary"
method: GET
path: "/api/orders/pvt/document/{orderId}/change-summary"
tags: ["Order modifications"]
---

# Get order modifications summary

`GET /api/orders/pvt/document/{orderId}/change-summary`

This endpoint retrieves a summary of modifications 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 an overview of each request.
 > ⚠️ If you want information about all the modifications made to an order, use the [Get order modifications history endpoint](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes).
## Permissions
Any user or API key must have the appropriate License Manager resource to successfully run this request:
| Product | Category | Resource |
|---------|----------|----------|
| OMS | OMS access | **OMS Viewer** |
You can create a custom role with this resource or use one of the following predefined roles:
- **OMS - Full access** (OMS Viewer)
- **Checkout Admin** (OMS Viewer)
- **IntegrationProfile - Fulfillment Oms** (OMS Viewer)
For more information about security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).

## Path parameters

- `orderId` string, required

## Headers

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

## Response `200`

OK

- ChangeSummary — Summary of modifications made to an order.
  - `original` object[] — Summary of the original items in the order before modifications.
    - `totalQuantity` integer — Total quantity of the item.
    - `quantity` integer — Quantity of the item.
    - `deliveryIds` DeliveryIdResponse[], nullable
      - `courierId` string — ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).
      - `warehouseId` string — ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).
      - `dockId` string — ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).
      - `courierName` string — Name of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).
      - `quantity` integer — Quantity of items in the warehouse or dock.
      - `totalListPrice` integer, nullable — Total list price in cents.
      - `accountCarrierName` string — Name of the account's [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE).
      - `kitItemDetails` string[], nullable — Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) items, when applicable.
    - `itemIndex` integer — Each item in the order is identified by an index. The position starts in `0`, followed by `1`, `2`, and so on.
    - `uniqueId` string — Alphanumeric sequence that identifies an SKU in a given order.
    - `id` string — Unique identifier of the SKU.
    - `productId` string — ID of the product associated with the item.
    - `lockId` string — Reservation ID.
    - `ean` string, nullable — EAN of the SKU.
    - `seller` string — Seller related to the order.
    - `sellerSku` string — SKU ID from the seller perspective.
    - `priceValidUntil` string, nullable — Date until when the price is going to be valid if there is a promotion. The date uses [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.
    - `name` string — Name of the item as displayed to customers in the storefront.
    - `additionalInfo` object — Additional information about the item.
      - `brandName` string — Item's brand name.
      - `brandId` string — Item's brand ID.
      - `categoriesIds` string — Item's category ID.
      - `dimension` object — Item's dimension.
        - `cubicweight` number — Item's cubic weight.
        - `height` number — Item's height.
        - `length` number — Item's length.
        - `weight` number — Item's weight.
        - `width` number — Item's width.
      - `productClusterId` string — All product clusters related to the item.
      - `commercialConditionId` string — Commercial conditions ID.
      - `offeringInfo` object, nullable — Information about services related to the item. For example: guarantee or installation.
      - `offeringType` string, nullable — Offering type.
      - `offeringTypeId` string — Offering type ID.
      - `categories` object[] — Items categories information.
        - `id` number — Category ID.
        - `name` string — Category name.
    - `attachments` string[] — Array containing information on attachments.
    - `attachmentOfferings` object[], nullable — Array containing attachments details.
      - `name` string, nullable — Name of the attachment.
      - `required` boolean, nullable — Defines if the attachment is required (`true`) or not (`false`).
    - `assemblies` string[], nullable — Information about items customization.
    - `refId` string — SKU reference ID.
    - `shippingPrice` integer, nullable — Item's shipping price.
    - `price` integer — Item's price.
    - `sellingPrice` integer — Item's selling price.
    - `manualPrice` integer, nullable — Item's [manual price](https://help.vtex.com/en/tutorial/change-the-price-of-an-item-in-the-shopping-cart--7Cd37aCAmtL1qmoZJJvjNf).
    - `manualPriceAppliedBy` string, nullable — User ID or appKey that made the manual price modification.
    - `tax` integer — Tax in cents, when applicable.
    - `customTax` number, nullable — Custom tax in cents, when applicable.
    - `rewardValue` integer — Item's reward value.
    - `freightCommission` integer — Value of the freight commission.
    - `commission` integer — Commission value registered for the seller.
    - `priceTags` object[] — List of objects with item's price modifiers.
    - `imageUrl` string — SKU image URL.
    - `detailUrl` string — SKU slug.
    - `components` string[] — Item's components.
    - `bundleItems` object[] — This field groups offerings (services) related to the item and displays their ID and quantity. A gift package is an example of an offering.
      - `id` integer — Offering ID.
      - `quantity` integer — Offering quantity.
    - `offerings` string[] — Item's offerings, which are services related to the item. For example, guarantee or installation.
    - `preSaleDate` string, nullable — Item's pre sale date.
    - `isGift` boolean — This field is `true` when the item is a gift in order context and `false` when it is not.
    - `taxCode` string, nullable — Item's tax code.
    - `measurementUnit` string — Item's measurement unit.
    - `unitMultiplier` number — Item's unit multiplier.
    - `marketingData` object, nullable — Information about promotions and marketing. For example, coupon tracking information and internal or external UTMs.
      - `id` string — Object ID. The expected value is `marketingData`.
      - `utmSource` string — Value of the `utm_source` parameter of the URL that led to the request.
      - `utmPartner` string — UTM Source Parameters.
      - `utmMedium` string — Value of the `utm_medium` parameter of the URL that led to the request.
      - `utmCampaign` string — Value of the `utm_campaign` parameter of the URL that led to the request.
      - `coupon` string — Coupon code.
      - `utmiCampaign` string — Internal UTM value `utmi_cp`.
      - `utmipage` string — Internal UTM value `utmi_p`.
      - `utmiPart` string — Internal UTM value `utmi_pc`.
      - `marketingTags` string — Marketing tags information. This field can be used to register campaign data or informative tags regarding promotions.
    - `parentAssemblyBinding` string, nullable — When items are indexed in between each other, this field returns the assembly option ID. This response is `null` for items that are not [assembly options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH).
    - `parentItemIndex` integer, nullable — Ranking number that shows how related items are indexed in between each other. It starts at `0` as the primary item reference and counts up to `1`, `2`, and so on. For example, a customer bought sunglasses and hired a warranty service. Since the sunglasses are index `0`, the warranty service (the [assembly option](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH)) is index `1` and has the `parentItemIndex` value `0`. This response is `null` for items that are not assembly options.
    - `callCenterOperator` string, nullable — Identification code of the call center operator responsible for the order.
    - `priceDefinition` object — Item's price information.
      - `calculatedSellingPrice` integer — Item's calculated unitary selling price in cents.
      - `total` integer — Total value of all item's units in cents.
      - `sellingPrices` object[] — Details on item's selling price.
        - `value` integer — Total value of items in cents.
        - `quantity` integer — Quantity of items.
      - `reason` string — Reason for the price change.
    - `costPrice` integer — Item's cost price in cents.
  - `added` object[] — Array containing information on added items of order modification.
    - `id` string — SKU ID of the item being added.
    - `uniqueId` string — Unique ID of the item being added.
    - `totalQuantity` integer — Total quantity of the item being added.
    - `quantity` integer — Quantity of the item being added.
    - `price` integer — Price of the item being added.
    - `measurementUnit` string — Measurement unit of the item being added.
    - `unitMultiplier` number — Unit multiplier of the item being added.
    - `imageUrl` string — Image URL of the item being added.
    - `sellingPrice` integer — Selling price of the item being added.
    - `priceTags` string[] — List of objects with item's price modifiers.
    - `detailUrl` string — Slug of the SKU being added.
    - `name` string — Name of the item being added.
    - `refId` string — SKU reference ID of the item being added.
    - `deliveryIds` DeliveryIdResponse[], nullable — Array containing information about the delivery IDs of the item being added.
      - `courierId` string — ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).
      - `warehouseId` string — ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).
      - `dockId` string — ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).
      - `courierName` string — Name of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).
      - `quantity` integer — Quantity of items in the warehouse or dock.
      - `totalListPrice` integer, nullable — Total list price in cents.
      - `accountCarrierName` string — Name of the account's [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE).
      - `kitItemDetails` string[], nullable — Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) items, when applicable.
  - `removed` object[] — Array containing information on removed items of order modification.
    - `id` string — SKU ID of the item being removed.
    - `uniqueId` string — Unique ID of the item being removed.
    - `quantity` integer — Quantity of the item being removed.
    - `price` integer — Price of the item being removed.
    - `measurementUnit` string — Measurement unit of the item being removed.
    - `unitMultiplier` number — Unit multiplier of the item being removed.
    - `imageUrl` string — Image URL of the item being removed.
    - `sellingPrice` integer — Selling price of the item being removed.
    - `priceTags` string[] — List of objects with item's price modifiers.
    - `detailUrl` string — Slug of the SKU being removed.
    - `name` string — Name of the item being removed.
    - `refId` string — SKU reference ID of the item being removed.
    - `deliveryIds` DeliveryIdResponse[], nullable — Array containing information about the delivery IDs of the item being removed.
      - `courierId` string — ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).
      - `warehouseId` string — ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).
      - `dockId` string — ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).
      - `courierName` string — Name of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).
      - `quantity` integer — Quantity of items in the warehouse or dock.
      - `totalListPrice` integer, nullable — Total list price in cents.
      - `accountCarrierName` string — Name of the account's [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE).
      - `kitItemDetails` string[], nullable — Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) items, when applicable.
  - `replaced` object[] — Array containing information on replaced items of order modification.
    - `replaceType` 'ItemReplacement' | 'WeightChange' | 'PriceChange' | 'QuantityChange' — Type of replacement operation.
    - `userInputType` 'ItemReplacement' | 'WeightChange' | 'PriceChange' | 'QuantityChange' — Type of replacement operation.
    - `from` object — Information about item being replaced.
      - `items` object[]
        - `id` string — SKU ID of the item being replaced.
        - `uniqueId` string — Unique ID of the item being replaced.
        - `quantity` integer — Quantity of the item being replaced.
        - `price` integer — Price of the item being replaced.
        - `measurementUnit` string — Measurement unit of the item being replaced.
        - `unitMultiplier` number — Unit multiplier of the item being replaced.
        - `imageUrl` string — Image URL of the item being replaced.
        - `sellingPrice` integer — Selling price of the item being replaced.
        - `priceTags` string[] — List of objects with item's price modifiers.
        - `detailUrl` string — URL slug of the item being replaced.
        - `name` string — Name of the item being replaced.
        - `refId` string — SKU reference ID of the item being replaced.
        - `deliveryIds` DeliveryIdResponse[], nullable — Array containing information about the delivery IDs of the item being replaced.
          - `courierId` string — ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).
          - `warehouseId` string — ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).
          - `dockId` string — ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).
          - `courierName` string — Name of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).
          - `quantity` integer — Quantity of items in the warehouse or dock.
          - `totalListPrice` integer, nullable — Total list price in cents.
          - `accountCarrierName` string — Name of the account's [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE).
          - `kitItemDetails` string[], nullable — Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) items, when applicable.
      - `shippingData` object, nullable — Shipping data object.
        - `logisticsInfo` LogisticsInfo1[]
          - `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 of the replacing item.
          - `slas` SlaV2[], required — Information on Service Level Agreement (SLA) of the order modifications shipping policy.
            - `id` string, required — Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the order delivery or pickup.
            - `deliveryChannel` string, required — Order shipping type, which can be `pickup-in-point` for [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R), and `delivery` for delivery.
            - `name` string, required — Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the order delivery or pickup. It corresponds to the `id` value.
            - `deliveryIds` DeliveryIdV2[], required — Information about delivery IDs.
              - …
            - `shippingEstimate` string, nullable, required — Total shipping duration estimated in days. For instance, three business days is represented as `3bd`.
            - `shippingEstimateDate` string, nullable, required — Shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.
            - `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`.
            - `availableDeliveryWindows` string[], required — Available [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, for when the shipping policy has shipping windows configurations.
            - `deliveryWindow` object, nullable, required — [Scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.
              - …
            - `price` integer, required — Shipping price for the item in cents. Does not account for the whole order's shipping price.
            - `listPrice` integer, required — Item's price list for a specific trade policy.
            - `tax` integer, required — Tax in cents, when applicable.
            - `pickupStoreInfo` PickupStoreInfoV2, required — Information about a loading dock that was transformed into a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).
              - …
            - `pickupPointId` string, nullable, required — Pickup point ID is the unique identifier of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) related to the SLA.
            - `pickupDistance` number, nullable, required — Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.
            - `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 is represented as `3bd`.
          - `shipsTo` string[], required — List of countries of the order modification 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.
            - `id` string, required — Order modifications shipping type, which can be `pickup-in-point` for [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R), and `delivery` for delivery.
          - `price` integer, required — Replacing item's final price, calculated in cents.
          - `listPrice` integer, required — Replacing item's price list, calculated in cents.
          - `shippingEstimate` string, nullable, required — Replacing item's shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.
          - `dockEstimate` string, nullable, required — Replacing 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 — Change item's selling price.
          - `deliveryIds` DeliveryIdV2[], required — Array with delivery information.
            - `courierId` string, required — ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).
            - `warehouseId` string, required — ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).
            - `dockId` string, required — ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).
            - `courierName` string, required — Name of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).
            - `quantity` integer, required — Quantity of items.
            - `kitItemDetails` string[], required
            - `accountCarrierName` string, nullable, required — Name of the account's [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE).
          - `deliveryWindow` string, nullable, required — Order modification [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).
            - `isPickupStore` boolean, nullable, required — This field is related to converting a loading dock into a pickup point. It should always correspond to `false` because it has been deprecated.
            - `friendlyName` string, nullable, required — Name of the loading dock converted to pickup point to be displayed at checkout. This field has been deprecated.
            - `address` string, nullable, required — Address of the loading dock converted to pickup point. This field has been deprecated.
            - `additionalInfo` string, nullable, required — Additional information about the loading dock converted to pickup point. This field has been deprecated.
            - `dockId` string, nullable, required — ID of the loading dock converted to pickup point. This field has been deprecated.
          - `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` object — Information about item replacing the previous one.
      - `items` object[]
        - `id` string — SKU ID of the item being replaced.
        - `uniqueId` string — Unique ID of the item replacing the previous one.
        - `quantity` integer — Quantity of the item replacing the previous one.
        - `price` integer — Price of the item replacing the previous one.
        - `measurementUnit` string — Measurement unit of the item replacing the previous one.
        - `unitMultiplier` number — Unit multiplier of the item replacing the previous one.
        - `imageUrl` string — Image URL of the item replacing the previous one.
        - `sellingPrice` integer — Selling price of the item replacing the previous one.
        - `priceTags` string[] — List of objects with item's price modifiers.
        - `detailUrl` string — URL slug of the item being replaced.
        - `name` string — Name of the item replacing the previous one.
        - `refId` string — SKU reference ID of the item replacing the previous one.
        - `deliveryIds` DeliveryIdResponse[], nullable — Array containing information about the delivery IDs of the item being replaced.
          - `courierId` string — ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).
          - `warehouseId` string — ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).
          - `dockId` string — ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).
          - `courierName` string — Name of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).
          - `quantity` integer — Quantity of items in the warehouse or dock.
          - `totalListPrice` integer, nullable — Total list price in cents.
          - `accountCarrierName` string — Name of the account's [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE).
          - `kitItemDetails` string[], nullable — Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) items, when applicable.
      - `shippingData` object, nullable — Shipping data object.
        - `logisticsInfo` LogisticsInfo1[] — 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 of the replacing item.
          - `slas` SlaV2[], required — Information on Service Level Agreement (SLA) of the order modifications shipping policy.
            - `id` string, required — Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the order delivery or pickup.
            - `deliveryChannel` string, required — Order shipping type, which can be `pickup-in-point` for [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R), and `delivery` for delivery.
            - `name` string, required — Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the order delivery or pickup. It corresponds to the `id` value.
            - `deliveryIds` DeliveryIdV2[], required — Information about delivery IDs.
              - …
            - `shippingEstimate` string, nullable, required — Total shipping duration estimated in days. For instance, three business days is represented as `3bd`.
            - `shippingEstimateDate` string, nullable, required — Shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.
            - `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`.
            - `availableDeliveryWindows` string[], required — Available [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, for when the shipping policy has shipping windows configurations.
            - `deliveryWindow` object, nullable, required — [Scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.
              - …
            - `price` integer, required — Shipping price for the item in cents. Does not account for the whole order's shipping price.
            - `listPrice` integer, required — Item's price list for a specific trade policy.
            - `tax` integer, required — Tax in cents, when applicable.
            - `pickupStoreInfo` PickupStoreInfoV2, required — Information about a loading dock that was transformed into a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).
              - …
            - `pickupPointId` string, nullable, required — Pickup point ID is the unique identifier of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) related to the SLA.
            - `pickupDistance` number, nullable, required — Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.
            - `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 is represented as `3bd`.
          - `shipsTo` string[], required — List of countries of the order modification 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.
            - `id` string, required — Order modifications shipping type, which can be `pickup-in-point` for [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R), and `delivery` for delivery.
          - `price` integer, required — Replacing item's final price, calculated in cents.
          - `listPrice` integer, required — Replacing item's price list, calculated in cents.
          - `shippingEstimate` string, nullable, required — Replacing item's shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.
          - `dockEstimate` string, nullable, required — Replacing 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 — Change item's selling price.
          - `deliveryIds` DeliveryIdV2[], required — Array with delivery information.
            - `courierId` string, required — ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).
            - `warehouseId` string, required — ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).
            - `dockId` string, required — ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).
            - `courierName` string, required — Name of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).
            - `quantity` integer, required — Quantity of items.
            - `kitItemDetails` string[], required
            - `accountCarrierName` string, nullable, required — Name of the account's [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE).
          - `deliveryWindow` string, nullable, required — Order modification [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).
            - `isPickupStore` boolean, nullable, required — This field is related to converting a loading dock into a pickup point. It should always correspond to `false` because it has been deprecated.
            - `friendlyName` string, nullable, required — Name of the loading dock converted to pickup point to be displayed at checkout. This field has been deprecated.
            - `address` string, nullable, required — Address of the loading dock converted to pickup point. This field has been deprecated.
            - `additionalInfo` string, nullable, required — Additional information about the loading dock converted to pickup point. This field has been deprecated.
            - `dockId` string, nullable, required — ID of the loading dock converted to pickup point. This field has been deprecated.
          - `pickupDistance` number, nullable, required — Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.
    - `type` 'UserInput' | 'System' — Type of replacement operation.
  - `manualDiscountValueAggregated` integer — This field shows if a manual price was applied to the total order amount. The value is in cents.
  - `manualIncrementValueAggregated` integer — This field shows if an increment value was applied to the total order amount. The value is in cents.
  - `totalChangeValueAggregated` integer — This field shows how much the order total price is, considering that price modifications might have been made. The value is in cents.
  - `totals` TotalsUpdated[]
    - object[] — Information about the order totals.
      - `id` 'Items' | 'Discounts' | 'Shipping' | 'Tax' — Total ID, which defines what the total is about.
      - `name` string — Total name.
      - `value` integer — Total value in cents.
      - `alternativeTotals` object[], nullable — Information about the order alternative totals, when applicable. For example, when there is a discount for items in the marketplace that results in a difference in the `Items` total value, the `alternativeTotals` can retrieve details about it.
        - `id` string — Alternative total ID, which can be related to items, discounts, shipping or taxes.
        - `name` string — Alternative total name.
        - `value` integer — Alternative total value in cents.
  - `lastChange` string — Date and time of the last change in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.

## Other responses

- `401` — Unauthorized Invalid or missing authentication.
- `403` — Forbidden Insufficient permissions.
- `404` — Not Found Order not found.

## Changes

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

- **2026-02-04** `fef036b9966c` — 3 breaking
  - removed the media type `application/json` for the response with the status `403`
  - removed the media type `application/json` for the response with the status `404`
  - the `type` response's property type/format changed from `string`/`uri` to `string`/`` for status `401`
- **2025-11-05** `52ed432c0725` — 1 warning
  - deleted the `query` request parameter `an`
- **2025-11-04** `3ba6f173250f` — 2 breaking, 4 warning
  - the `totals` response's property type/format changed from `array`/`` to ``/`` for status `200`
  - the `totals/items/` response's property type/format changed from `object`/`` to `array`/`` for status `200`
  - removed the optional property `totals/items/alternativeTotals` from the response with the `200` status
  - removed the optional property `totals/items/id` from the response with the `200` status
  - …2 more
- **2025-11-04** `d44d525ab9ee` — 1 warning, 4 info
  - removed the optional property `message` from the response with the `401` status
  - added the optional property `status` to the response with the `401` status
  - added the optional property `title` to the response with the `401` status
  - added the optional property `traceId` to the response with the `401` status
  - …1 more
- …earlier changes not shown

[Full history](https://skmtc.dev/vtex/apis/orders-api/changes/api/orders/pvt/document/:orderId/change-summary/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)