VTvtex
Order modifications

Get order modifications summary

Changed on

This endpoint retrieves a summary of modifications of every successful Create order modifications request 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.

Permissions

Any user or API key must have the appropriate License Manager resource to successfully run this request:

ProductCategoryResource
OMSOMS accessOMS Viewer
You can create a custom role with this resource or use one of the following predefined roles:
get/api/orders/pvt/document/{orderId}/change-summary

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br
  • URL
    https://apiexamples.vtexcommercestable.com.br/api/orders/pvt/document/{orderId}/change-summary
  • Auth
    • API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
    • or API key in header VtexIdclientAutCookie

Path parameters

orderIdstring required
Example:v12772213qst-02

Order ID.

Headers

Acceptstring required

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

Content-Typestring required

Type of the content being sent.

Response

OK

manualDiscountValueAggregatedinteger

This field shows if a manual price was applied to the total order amount. The value is in cents.

manualIncrementValueAggregatedinteger

This field shows if an increment value was applied to the total order amount. The value is in cents.

totalChangeValueAggregatedinteger

This field shows how much the order total price is, considering that price modifications might have been made. The value is in cents.

lastChangestring

Date and time of the last change in ISO 8601 time zone offset format, as in YYYY-MM-DDThh:mm:ssZ.

Example response

{
  "original": [
    {
      "totalQuantity": 3,
      "quantity": 3,
      "deliveryIds": [
        {
          "courierId": "1",
          "warehouseId": "1_1",
          "dockId": "1",
          "courierName": "Transportadora",
          "quantity": 4,
          "totalListPrice": null,
          "accountCarrierName": "Store Name",
          "kitItemDetails": []
        }
      ],
      "itemIndex": 0,
      "uniqueId": "368A04D405BE40F9888D23920ACA17EC",
      "id": "4",
      "productId": "4",
      "lockId": "00-1537351038731-01",
      "ean": "7896025801879",
      "seller": "1",
      "sellerSku": "4",
      "priceValidUntil": "2026-06-05T15:01:17Z",
      "name": "Banana",
      "additionalInfo": {
        "brandName": "Brand name",
        "brandId": "20000",
        "categoriesIds": "/1/",
        "dimension": {
          "cubicweight": 1,
          "height": 10,
          "length": 10,
          "weight": 5,
          "width": 10
        },
        "productClusterId": "",
        "commercialConditionId": "1",
        "offeringInfo": null,
        "offeringType": null,
        "offeringTypeId": null,
        "categories": [
          {
            "id": 1,
            "name": "Grocery"
          }
        ]
      },
      "attachments": [],
      "attachmentOfferings": null,
      "assemblies": null,
      "refId": "151762",
      "shippingPrice": null,
      "price": 1199,
      "sellingPrice": 599,
      "listPrice": 1199,
      "manualPrice": null,
      "manualPriceAppliedBy": null,
      "tax": 215,
      "customTax": null,
      "rewardValue": 0,
      "freightCommission": 0,
      "commission": 0,
      "priceTags": [
        {
          "name": "tax@price-ecc63e22-47ba-4f6c-843b-cfce4f06995e#bf555b6a-3049-4242-9f34-24a5bbb2a6ca",
          "rawValue": 0.275,
          "isPercentual": true,
          "identifier": "ecc63e22-47ba-4f6c-843b-cfce4f06995e",
          "rate": null,
          "jurisCode": null,
          "jurisType": null,
          "jurisName": null
        },
        {
          "name": "tax@price-45ef7f98-c05d-4d23-a867-593e1b8eecb7#3e134d5e-2e9b-4117-9f53-6a2ad41f8885",
          "rawValue": 1.5,
          "isPercentual": false,
          "identifier": "45ef7f98-c05d-4d23-a867-593e1b8eecb7",
          "rate": null,
          "jurisCode": null,
          "jurisType": null,
          "jurisName": null
        }
      ],
      "imageUrl": "https://example.com/image.jpg",
      "detailUrl": "/banana/p",
      "components": [],
      "bundleItems": [],
      "offerings": [],
      "preSaleDate": null,
      "isGift": false,
      "taxCode": "",
      "measurementUnit": "kg",
      "unitMultiplier": 1,
      "marketingData": null,
      "parentAssemblyBinding": null,
      "parentItemIndex": null,
      "callCenterOperator": null,
      "priceDefinition": {
        "calculatedSellingPrice": 599,
        "total": 1797,
        "sellingPrices": [
          {
            "value": 599,
            "quantity": 3
          }
        ],
        "reason": null
      },
      "costPrice": 599
    }
  ],
  "added": [
    {
      "id": "11",
      "uniqueId": "DF6E5BB06ED84724A29A68ED392F99CE",
      "totalQuantity": 1,
      "quantity": 1,
      "price": 749,
      "measurementUnit": "un",
      "unitMultiplier": 1,
      "imageUrl": "https://example.com/image.jpg",
      "sellingPrice": 749,
      "priceTags": [],
      "detailUrl": "/nuggets/p",
      "name": "Nuggets",
      "refId": "XX00021",
      "deliveryIds": [
        {
          "courierId": "1",
          "warehouseId": "1_1",
          "dockId": "1",
          "courierName": "Transportadora",
          "quantity": 5,
          "totalListPrice": null,
          "accountCarrierName": "Store Name",
          "kitItemDetails": []
        }
      ]
    }
  ],
  "removed": [
    {
      "id": "17",
      "uniqueId": "8A6A0E3F26DE4F479F9017A60784DF2F",
      "quantity": 7,
      "price": 5500,
      "measurementUnit": "un",
      "unitMultiplier": 1,
      "imageUrl": "https://example.com/image.jpg",
      "sellingPrice": 5500,
      "priceTags": [],
      "detailUrl": "/plush-shark-18/p",
      "name": "Plush shark",
      "refId": null,
      "deliveryIds": [
        {
          "courierId": "1",
          "warehouseId": "1_1",
          "dockId": "1",
          "courierName": "Transportadora",
          "quantity": 7,
          "totalListPrice": null,
          "accountCarrierName": "Store Name",
          "kitItemDetails": []
        }
      ]
    }
  ],
  "replaced": [
    {
      "replaceType": "WeightChange",
      "userInputType": "WeightChange",
      "from": {
        "items": [
          {
            "id": "1",
            "uniqueId": "6024FC8687884BC3B9AA9A8630C52804",
            "quantity": 1,
            "price": 765,
            "measurementUnit": "kg",
            "unitMultiplier": 1,
            "imageUrl": "https://example.com/image.jpg",
            "sellingPrice": 765,
            "priceTags": [],
            "detailUrl": "/apple/p",
            "name": "Apple",
            "refId": "197326",
            "deliveryIds": [
              {
                "courierId": "1",
                "warehouseId": "1_1",
                "dockId": "1",
                "courierName": "Transportadora",
                "quantity": 5,
                "totalListPrice": null,
                "accountCarrierName": "recorrenciacharlie",
                "kitItemDetails": []
              }
            ]
          }
        ],
        "shippingData": null
      },
      "to": {
        "items": [
          {
            "id": "1",
            "uniqueId": "6024FC8687884BC3B9AA9A8630C52804",
            "totalQuantity": 1,
            "quantity": 1,
            "price": 765,
            "measurementUnit": "kg",
            "unitMultiplier": 2,
            "imageUrl": "https://example.com/image.jpg",
            "sellingPrice": 1530,
            "priceTags": [],
            "detailUrl": "/apple/p",
            "name": "Apple",
            "refId": "197326",
            "deliveryIds": [
              {
                "courierId": "1",
                "warehouseId": "1_1",
                "dockId": "1",
                "courierName": "Transportadora",
                "quantity": 5,
                "totalListPrice": null,
                "accountCarrierName": "Store Name",
                "kitItemDetails": []
              }
            ]
          }
        ],
        "shippingData": null
      },
      "type": "UserInput"
    }
  ],
  "manualDiscountValueAggregated": 0,
  "manualIncrementValueAggregated": 0,
  "totalChangesValueAggregated": -37393,
  "totals": [
    {
      "id": "Items",
      "name": "Items Total",
      "value": -37684,
      "alternativeTotals": null
    },
    {
      "id": "Discounts",
      "name": "Discounts Total",
      "value": 600,
      "alternativeTotals": null
    },
    {
      "id": "Shipping",
      "name": "Shipping Total",
      "value": -94,
      "alternativeTotals": null
    },
    {
      "id": "Tax",
      "name": "Tax Total",
      "value": -215,
      "alternativeTotals": null
    }
  ],
  "lastChange": "2025-06-05T17:03:41.3219923Z"
}

Changes

  • fef036b9966cRevision changes
    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      the response's property format changed from uri to no format for status

  • 52ed432c0725Revision changes
    • warning

      deleted the query request parameter an