Cancel order
Change order
| | IntegrationProfile - Fulfillment Oms |Cancel order
Change order
| | IntegrationProfile - Fulfillment Gateway | Cancel order | | IntegrationProfile - Fulfillment Gateway Oms |Cancel order
Change order
| | inStore Sales Person |Cancel order
Change order
| >❗ 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 - `changeRequestId` string, required ## Query parameters - `an` string, required ## Headers - `Content-Type` string, required - `Accept` string, required ## Response `200` OK - object - `requestId` string, required — Unique code that identifies an order modification request. - `workflowId` string, required — Code that identifies the transaction of changing the orders in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). - `status` string, required — Order status in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). - `inProgress` boolean, required — When set as `true`, the order is still progressing in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196), when set as `false`, it is complete, whether by cancellation or because the customer received it. - `reason` string, required — Reason that motivated the order modifications. - `manualDiscountValue` integer, required — This field shows if a manual price was applied to 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 is the order total price 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` string[], nullable, required — Array with information about the `add` operation, when applicable. The schema will correspond to the object `to` inside the `replace` array. - `remove` string[], nullable, required — Array with information about the `remove` operation, when applicable. The schema will correspond to the object `from` inside the `replace` array. - `replace` Replace1[], required — Array with information about the `replace` operation, when applicable. - `from` object, required — Information about what items were replaced. - `paymentData` PaymentDataV2, required — Payment data object. - `transactions` string[], required — Information about financial transactions. - `items` object[], required — Array with items information. - `id` string, required — SKU ID of the item being replaced. - `quantity` integer, required — Quantity of items been replaced. - `price` integer, nullable, required — Shipping price for the replaced item, in cents. It does not account for the whole order's shipping price. - `measurementUnit` string, nullable, required — Measurement unit of the item being replaced. For example, `kg` for kilograms or `un` for unitary items. - `unitMultiplier` integer, required — Unit multiplier for item being updated. - `sellingPrice` integer, nullable, required — Selling price of the item being replaced. - `name` string, nullable, required — Name of the item being replaced. - `detailUrl` string, nullable, required — URL slug of the item being replaced. - `imageUrl` string, nullable, required — Image URL slug of the item being replaced. - `shippingData` ShippingData1, required — Shipping data object. - `logisticsInfo` string[], required — Array with logistics information about the order been replaced. If not sent in the original request, it will be an empty array in the response. - `to` object, required — Information about items that replaced the previous one. - `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` object, required — Shipping data object. - `logisticsInfo` LogisticsInfo1[], 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 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. - `clientProfileData` object[] - `firstName` string — Customer's first name. - `lastName` string — Customer's last name. - `documentType` string — Type of the document informed by the customer. - `document` string — Document number informed by the customer. - `phone` string — Customer's phone number. - `corporateName` string — If it's a legal entity, here goes the company name. - `tradeName` string — If it's a legal entity, here goes the trade name. - `corporateDocument` string — If it's a legal entity, here goes the corporate document. - `stateInscription` string — If it's a legal entity, here goes the state inscription. - `corporatePhone` string — If it's a legal entity, here goes the company phone. - `isCorporate` boolean — It has the value `true` if it's a legal entity. - `date` string, required — Date and time of the request in UTC ISO 8601 format, as in `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. ## Changes > 62 revisions in range; 7 could not be searched. - **2026-06-16** `62f0cb2bad6c` — 1 breaking - the `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/:changeRequestId/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)