Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Oms |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |Cancel order
Change order
|\r\n| inStore Sales Person |Cancel order
Change order
|\r\n\r\n>❗ 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-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).", + "content": "Change Order feature allows you to modify an order, whether the change is motivated by customer mistakes, product unavailability, or others. Both sellers and marketplaces can use this endpoint and change orders in multiple scenarios, and it is possible to make a single change or combine multiple ones in the same request. \r\nThe possible change order operations you can perform are the following:\r\n- **Add:** Adding items, quantity, or product weight.\r\n- **Remove:** Removing a part of items or the total quantity.\r\n- **Replace:** Changing items' quantity, weight, or price. You can also replace one or more items with different ones, including weighable products.\r\n\r\n>❗ When removing or adding items to an order, your [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) is not automatically updated. You can use the [Update inventory by SKU and warehouse](https://developers.vtex.com/docs/api-reference/logistics-api#put-/api/logistics/pvt/inventory/skus/-skuId-/warehouses/-warehouseId-) endpoint.\r\n\r\nThe next sections are listed below:\r\n- [Number of changes per order](#number-of-changes-per-order)\r\n- [Acceptable order status for changes](#acceptable-order-status-for-changes)\r\n- [Order change and price](#order-changes-and-price)\r\n- [Combining multiples operations](#combining-multiples-operations)\r\n\r\n## Number of changes per order\r\nBesides being able to combine multiple change operations - add, remove, and replace - in a single request, you can make different change requests, and there is no limit to how many times an order can be changed.\r\n\r\nEach order has its change history, you can retrieve it using the Get order change history endpoint.\r\n\r\n## Acceptable order status for changes\r\nYou can only change an order when it is one of the following [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) status:\r\n- `handling`\r\n- `waiting-for-fulfillment` \r\n- `ready for invoicing`\r\n\r\nIt is not possible to change an order when the payment transaction is complete.\r\n\r\n## Order change and price\r\nWhen you add, remove or replace items using this endpoint, the order and payment transaction values are automatically updated. Change Order calculates the update of the following values:\r\n- Item value\r\n- Total value \r\n\r\n**Example:** If you send the request body for replacing items without the unit multiplier (`unitMultiplier`) or measurement (`measurementUnit`), Change Order will get this information on your store’s Catalog, Pricing and Payment systems. \r\n>⚠️ Increasing the price of an order is allowed only when the order was paid by credit card, [payable notes](https://help.vtex.com/en/tutorial/setting-up-payments-with-promissory--5pW7avTwtyQcMu4uiW8quQ), cash, or [credit control](https://help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0). In addition, the [acquirer](https://help.vtex.com/en/tutorial/what-is-an-acquirer--7N1oRTG8dGmOiIugC0cs4E) must allow transactions without the CVV code and two charging transactions in the same order.\r\n\r\nFor order changes with discounts, Order Management System (OMS) considers that you still can change the order’s transactional value, as long as its status in Transaction Details is not `Finished`.\r\n\r\n## Order change and payment transaction flow\r\n\r\nAn order's [transaction flow](https://help.vtex.com/tracks/payments--6GAS7ZzGAm7AGoEAwDbwJG/1xjzgJZvqwaI1rfxLMCC3Y) goes through various payment statuses before its conclusion. Within certain conditions, it is possible to change settled orders. The requirements are the following:\r\n\r\n- The order's [payment method](https://help.vtex.com/en/tutorial/difference-between-payment-methods-and-payment-conditions--3azJenhGFyUy2gsocms42Q) is a credit card.\r\n- The settlement occurs before the order is invoiced.\r\n- The payment connector is configured to allow partial refunds.\r\n\r\n> Currently, [Adyen](https://help.vtex.com/en/tutorial/configuring-payment-with-adyenv3--7xAz67E2Eg63LWCQNjVdwv) is the only payment connector that supports that operation.\r\n\r\nIf the order change increases or decreases the cost for the client, the platform has the following behavior:\r\n\r\n- **Smaller price after order change:** An automatic notification is sent to the payment [gateway](https://help.vtex.com/tracks/payments--6GAS7ZzGAm7AGoEAwDbwJG/kdPbEIWf8Xq8tESQvViMB#gateway) to reimburse the client for the difference.\r\n- **Higher price after order change:** An automatic notification is sent to the payment gateway to require the client to pay for the additional cost.\r\n\r\n## Combining multiples operations\r\nYou can use this endpoint to make a single change operation or combine them in the same request. See some examples below.\r\n\r\n### Add request body example:\r\n\r\n```json\r\n{\r\n \"add\": {\r\n \"items\": [\r\n {\r\n \"id\": \"8\",\r\n \"quantity\": 1,\r\n \"measurementUnit\": \"un\",\r\n \"unitMultiplier\": 1\r\n }\r\n ]\r\n }\r\n}\r\n```\r\n\r\n### Remove request body example:\r\n\r\n```json\r\n{\r\n \"reason\": \"The client wants to remove a product.\",\r\n \"remove\": {\r\n \"items\": [\r\n {\r\n \"id\": \"8\",\r\n \"quantity\": 2,\r\n \"measurementUnit\": \"un\",\r\n \"unitMultiplier\": 1\r\n }\r\n ]\r\n }\r\n}\r\n```\r\n\r\n### Replace request body example:\r\n```json\r\n{\r\n \"reason\": \"The client wants to increase the product weight.\",\r\n \"replace\": [\r\n {\r\n \"from\": {\r\n \"items\": [\r\n {\r\n \"id\": \"1\",\r\n \"quantity\": 1\r\n }\r\n ]\r\n },\r\n \"to\": {\r\n \"items\": [\r\n {\r\n \"id\": \"1\",\r\n \"quantity\": 1,\r\n \"measurementUnit\": \"kg\",\r\n \"unitMultiplier\": 1.0\r\n }\r\n ],\r\n \"shippingData\": {\r\n \"logisticsInfo\": [\r\n {\r\n \"itemIndex\": 0,\r\n \"slaId\": \"Normal\",\r\n \"deliveryChannel\": \"delivery\",\r\n \"addressId\": \"12334048475146857\",\r\n \"price\": 1000\r\n }\r\n ]\r\n }\r\n }\r\n }\r\n ]\r\n}\r\n```\r\n\r\n\r\n### Add, remove and replace request body example:\r\n\r\n\r\n```json\r\n{\r\n \"reason\": \"The client wants to add, remove and replace a weighable product.\",\r\n \"manualDiscountValue\": 0,\r\n \"add\": {\r\n \"items\": [\r\n {\r\n \"id\": \"8\",\r\n \"quantity\": 1,\r\n \"measurementUnit\": \"un\",\r\n \"unitMultiplier\": 1\r\n }\r\n ]\r\n },\r\n \"remove\": {\r\n \"items\": [\r\n {\r\n \"id\": \"31\",\r\n \"quantity\": 1,\r\n \"measurementUnit\": \"un\",\r\n \"unitMultiplier\": 1\r\n }\r\n ]\r\n },\r\n \"replace\": [\r\n {\r\n \"from\": {\r\n \"items\": [\r\n {\r\n \"id\": \"1\",\r\n \"quantity\": 1\r\n }\r\n ]\r\n },\r\n \"to\": {\r\n \"items\": [\r\n {\r\n \"id\": \"1\",\r\n \"quantity\": 1,\r\n \"measurementUnit\": \"kg\",\r\n \"unitMultiplier\": 1.0\r\n }\r\n ],\r\n \"shippingData\": {\r\n \"logisticsInfo\": [\r\n {\r\n \"itemIndex\": 0,\r\n \"slaId\": \"Normal\",\r\n \"deliveryChannel\": \"delivery\",\r\n \"addressId\": \"12334048475146857\",\r\n \"price\": 1000\r\n }\r\n ]\r\n }\r\n }\r\n }\r\n ]\r\n}\r\n```\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou 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):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Oms |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |Cancel order
Change order
|\r\n| inStore Sales Person |Cancel order
Change order
|\r\n\r\n>❗ 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-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).", "type": "text/plain" }, "url": { @@ -2388,7 +2375,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "643ff834-d763-4890-a65a-cb1552bd8bec", + "id": "ec039ad2-403d-43eb-9c65-9816c058a3bc", "name": "Accepted", "originalRequest": { "url": { @@ -2498,13 +2485,13 @@ { "listen": "test", "script": { - "id": "555df05b-f1f0-4e72-83b4-c05e7f39fea2", + "id": "d3c6b1ff-d75c-4ada-bb15-119ec473713a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/order-system/orders/:changeOrderId/changes - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[PATCH]::/api/order-system/orders/:changeOrderId/changes - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[PATCH]::/api/order-system/orders/:changeOrderId/changes - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"allOf\":[{\"title\":\"response202\",\"required\":[\"requestId\",\"workflowId\",\"reason\",\"manualDiscountValue\",\"manualIncrementValue\",\"totalChangeValue\",\"totals\",\"add\",\"remove\",\"replace\",\"date\",\"origin\",\"settings\"],\"type\":\"object\",\"properties\":{\"requestId\":{\"type\":\"string\",\"description\":\"Unique code that identifies a change order request.\",\"example\":\"e8532a32-7f7e-434a-88ec-29609f0ede46\"},\"workflowId\":{\"type\":\"string\",\"description\":\"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).\",\"example\":\"74f40e7a-68c6-4699-b874-a8a297fb3f6a\"},\"reason\":{\"type\":\"string\",\"description\":\"Reason that motivated the order change.\",\"example\":\"The client wants to change the items weight.\"},\"manualDiscountValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"This field shows if a manual price was applied to the total order amount. The value is in cents.\",\"example\":0},\"manualIncrementValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"This field shows if an increment value was applied to the total order amount. The value is in cents.\",\"example\":0},\"totalChangeValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"This field shows how much the order total price is considering that price changes might have been made. The value is in cents.\",\"example\":0},\"totals\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array containing information about change prices per item.\",\"example\":null},\"add\":{\"type\":\"array\",\"description\":\"Array with information about the `add` operation, when applicable. The schema will correspond to the object `to` inside the `replace` array.\",\"example\":null},\"remove\":{\"type\":\"array\",\"description\":\"Array with information about the `remove` operation, when applicable. The schema will correspond to the object `from` inside the `replace` array.\",\"example\":null},\"replace\":{\"type\":\"array\",\"items\":{\"title\":\"Replace1\",\"required\":[\"from\",\"to\"],\"type\":\"object\",\"properties\":{\"from\":{\"title\":\"From1\",\"required\":[\"paymentData\",\"items\",\"shippingData\"],\"type\":\"object\",\"properties\":{\"paymentData\":{\"title\":\"PaymentDataV2\",\"required\":[\"transactions\"],\"type\":\"object\",\"properties\":{\"transactions\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"example\":null},\"description\":\"Array containing financial information. This is an optional field.\"}},\"example\":{\"transactions\":[]}},\"items\":{\"type\":\"array\",\"items\":{\"title\":\"Item2V2\",\"required\":[\"id\",\"quantity\",\"price\",\"measurementUnit\",\"unitMultiplier\",\"sellingPrice\",\"name\",\"detailUrl\",\"imageUrl\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SKU ID of the item been replaced.\",\"example\":\"1\"},\"quantity\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Quantity of items been replaced.\",\"example\":1},\"price\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping price for the item been replaced. It does not account for the whole order's shipping price and is presented in cents.\",\"example\":1000},\"measurementUnit\":{\"type\":[\"string\",\"null\"],\"description\":\"Measurement unit of the item been replaced. For example, `kg` for kilograms or `un` for unitary items.\",\"example\":\"kg\"},\"unitMultiplier\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Unit multiplier for item been update.\",\"example\":3},\"sellingPrice\":{\"type\":\"string\",\"description\":\"Selling price of the item been replaced.\",\"example\":100},\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the item been replaced.\",\"example\":\"T-shirt with logo\"},\"detailUrl\":{\"type\":[\"string\",\"null\"],\"description\":\"URL slug of the item been replaced.\",\"example\":\"/tshirt-logo/p\"},\"imageUrl\":{\"type\":[\"string\",\"null\"],\"description\":\"Image URL slug of the item been replaced.\",\"example\":\"http://store.com.br/ids/155419-55-55//tshirt-logo.png?v=6378858562367\"}},\"example\":{\"id\":\"31\",\"quantity\":1,\"price\":null,\"measurementUnit\":null,\"unitMultiplier\":0,\"sellingPrice\":null,\"name\":null,\"detailUrl\":null,\"imageUrl\":null}}},\"shippingData\":{\"title\":\"ShippingData1\",\"required\":[\"logisticsInfo\"],\"type\":\"object\",\"properties\":{\"logisticsInfo\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"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.\"}},\"example\":{\"logisticsInfo\":[]}}},\"example\":{\"paymentData\":{\"transactions\":[]},\"items\":[{\"id\":\"31\",\"quantity\":1,\"price\":null,\"measurementUnit\":null,\"unitMultiplier\":0,\"sellingPrice\":null,\"name\":null,\"detailUrl\":null,\"imageUrl\":null}],\"shippingData\":{\"logisticsInfo\":[]}}},\"to\":{\"title\":\"To1\",\"required\":[\"items\",\"paymentData\",\"receiptData\",\"shippingData\"],\"type\":\"object\",\"properties\":{\"items\":{\"type\":\"array\",\"items\":{\"title\":\"Item3\",\"required\":[\"uniqueId\",\"id\",\"productId\",\"productRefId\",\"refId\",\"ean\",\"name\",\"skuName\",\"modalType\",\"parentItemIndex\",\"parentAssemblyBinding\",\"assemblies\",\"priceValidUntil\",\"tax\",\"price\",\"listPrice\",\"manualPrice\",\"manualPriceAppliedBy\",\"sellingPrice\",\"rewardValue\",\"isGift\",\"additionalInfo\",\"preSaleDate\",\"productCategoryIds\",\"productCategories\",\"quantity\",\"seller\",\"sellerChain\",\"imageUrl\",\"detailUrl\",\"components\",\"bundleItems\",\"attachments\",\"attachmentOfferings\",\"offerings\",\"priceTags\",\"availability\",\"measurementUnit\",\"unitMultiplier\",\"manufacturerCode\",\"priceDefinition\"],\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Item's unique ID in the change order request.\",\"example\":\"40E763F4378E4F40AD1FE915FE1078E1\"},\"id\":{\"type\":\"string\",\"description\":\"SKU ID of the item replacing the previous one.\",\"example\":\"3\"},\"productId\":{\"type\":[\"string\",\"null\"],\"description\":\"Product ID of the item replacing the previous one.\",\"example\":\"7\"},\"productRefId\":{\"type\":[\"string\",\"null\"],\"description\":\"Product Ref ID of the item replacing the previous one.\",\"example\":\"smallcup\"},\"refId\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference ID of the item replacing the previous one.\",\"example\":\"356\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number (EAN) of the item replacing the previous one.\",\"example\":\"8745121641680\"},\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the Product associated with the item replacing the previous one.\",\"example\":\"Small cup of coffee with pink logo\"},\"skuName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the SKU replacing the previous one.\",\"example\":\"Small blue cup\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"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.\",\"example\":\"GLASS\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index of the item replacing the previous one.\",\"example\":0},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding of the item replacing the previous one.\",\"example\":null},\"assemblies\":{\"type\":[\"array\",\"null\"],\"items\":{\"type\":\"string\"},\"description\":\"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\":{\"type\":[\"string\",\"null\"],\"description\":\"Price expiration date of item replacing the previous one. The value is in the format `yyyy-mm-ddThh:mm:ss.sss`.\",\"example\":\"2023-03-01T22:58:28.143\"},\"tax\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Tax in cents of the item replacing the previous one, when applicable.\",\"example\":0},\"price\":{\"type\":[\"string\",\"null\"],\"description\":\"Final price of the item replacing the previous one, calculated in cents.\",\"example\":600},\"listPrice\":{\"type\":[\"string\",\"null\"],\"description\":\"Item's price list for the item replacing the previous one.\",\"example\":600},\"manualPrice\":{\"type\":[\"integer\",\"null\"],\"description\":\"Manual price of the item replacing the previous one. It is calculated in cents.\",\"example\":6500},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User ID or appKey that made the manual price change of the item replacing the previous one.\",\"example\":\"4cc81d44-e42e-464b-8199-1e883bf4ab6b\"},\"sellingPrice\":{\"type\":[\"integer\",\"null\"],\"description\":\"Selling price of the item replacing the previous one. It is calculated in cents.\",\"example\":600},\"rewardValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reward value of the item replacing the previous one. It is calculated in cents.\",\"example\":50},\"isGift\":{\"type\":\"boolean\",\"description\":\"This field is `true` when the replacing item is a gift in the order context and `false` when it is not.\",\"example\":false},\"additionalInfo\":{\"title\":\"AdditionalInfoV2\",\"required\":[\"dimension\",\"brandName\",\"brandId\",\"offeringInfo\",\"offeringType\",\"offeringTypeId\",\"categoriesIds\",\"productClusterId\",\"commercialConditionId\"],\"type\":\"object\",\"properties\":{\"dimension\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing tem's dimensions in the measure unit configured in the catalog.\",\"example\":null},\"brandName\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item's brand name.\",\"example\":\"Special coffee cup\"},\"brandId\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item's brand ID.\",\"example\":\"2000001\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\",\"example\":null},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\",\"example\":null},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\",\"example\":null},\"categoriesIds\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the replacing item product category.\",\"example\":null},\"productClusterId\":{\"type\":[\"string\",\"null\"],\"description\":\"All product clusters related to the replacing item.\",\"example\":\"135,137,143,518,1272\"},\"commercialConditionId\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item commercial conditions ID.\",\"example\":\"5\"}},\"example\":{\"dimension\":null,\"brandName\":null,\"brandId\":null,\"offeringInfo\":null,\"offeringType\":null,\"offeringTypeId\":null,\"categoriesIds\":null,\"productClusterId\":null,\"commercialConditionId\":null}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Pre sale date of the item replacing the previous one.\",\"example\":\"2023-01-01T00:00:00.0000000+00:00\"},\"productCategoryIds\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item's category path composed of category IDs separated by `/`. For example: `/3/15/`.\",\"example\":\"/2/\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object containing product categories of the replacing item. Structure: `{CategoryID}: {CategoryName}`. Both the key and the value are strings.\",\"example\":{\"2\":\"Clothes\"}},\"quantity\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Quantity of replacing items.\",\"example\":1},\"seller\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller ID that identifies the seller the replacing item belongs to.\",\"example\":\"1\"},\"sellerChain\":{\"type\":\"array\",\"items\":{\"type\":[\"string\",\"null\"]},\"description\":\"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\":{\"type\":[\"string\",\"null\"],\"description\":\"Image URL slug of the replacing item.\",\"example\":\"http://store.com.br/ids/155419-55-55//cupcoffee.png?v=6368858582363\"},\"detailUrl\":{\"type\":[\"string\",\"null\"],\"description\":\"URL slug of the replacing item.\",\"example\":\"/cup-coffee/p\"},\"components\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array with information about replacing item's components.\"},\"bundleItems\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array with information about services sold along with the replacing item, such as a gift package.\"},\"attachments\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array containing information on attachments.\"},\"attachmentOfferings\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array with the properties of the content declared in the field `attachments`.\"},\"offerings\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array with replacing items Item's offerings.\"},\"priceTags\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array containing objects with replacing item's price modifiers.\"},\"availability\":{\"type\":[\"string\",\"null\"],\"description\":\"Availability to fulfill the order with the item.\",\"example\":\"available\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Replacing item's measurement unit.\",\"example\":\"un\"},\"unitMultiplier\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Replacing item's unit multiplier.\",\"example\":1},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Provided by the manufacturers to identify their product. This field should be completed if the replacing item has a manufacturer's code.\",\"example\":\"manf-00005\"},\"priceDefinition\":{\"type\":[\"string\",\"null\"],\"description\":\"replacing item's price information.\",\"example\":null}},\"example\":{\"uniqueId\":\"40E763F4378E4F40AD1FE915FE1078E1\",\"id\":\"1\",\"productId\":null,\"productRefId\":null,\"refId\":null,\"ean\":null,\"name\":null,\"skuName\":null,\"modalType\":null,\"parentItemIndex\":null,\"parentAssemblyBinding\":null,\"assemblies\":[],\"priceValidUntil\":null,\"tax\":0,\"price\":null,\"listPrice\":null,\"manualPrice\":null,\"manualPriceAppliedBy\":null,\"sellingPrice\":null,\"rewardValue\":0,\"isGift\":false,\"additionalInfo\":{\"dimension\":null,\"brandName\":null,\"brandId\":null,\"offeringInfo\":null,\"offeringType\":null,\"offeringTypeId\":null,\"categoriesIds\":null,\"productClusterId\":null,\"commercialConditionId\":null},\"preSaleDate\":null,\"productCategoryIds\":null,\"productCategories\":{},\"quantity\":1,\"seller\":null,\"sellerChain\":[null],\"imageUrl\":null,\"detailUrl\":null,\"components\":[],\"bundleItems\":[],\"attachments\":[],\"attachmentOfferings\":[],\"offerings\":[],\"priceTags\":[],\"availability\":null,\"measurementUnit\":\"un\",\"unitMultiplier\":1,\"manufacturerCode\":null,\"priceDefinition\":null}},\"description\":\"Array containing information about the item replacing the previous one.\"},\"paymentData\":{\"title\":\"PaymentDataV2\",\"required\":[\"transactions\"],\"type\":\"object\",\"properties\":{\"transactions\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"example\":null},\"description\":\"Array containing financial information. This is an optional field.\"}},\"example\":{\"transactions\":[]}},\"receiptData\":{\"type\":[\"object\",\"null\"],\"description\":\"Information about the receipt after order change.\",\"example\":null},\"shippingData\":{\"title\":\"ShippingData2\",\"required\":[\"logisticsInfo\"],\"type\":\"object\",\"properties\":{\"logisticsInfo\":{\"type\":\"array\",\"items\":{\"title\":\"LogisticsInfo1\",\"required\":[\"itemIndex\",\"selectedSla\",\"selectedDeliveryChannel\",\"addressId\",\"slas\",\"shipsTo\",\"itemId\",\"deliveryChannels\",\"price\",\"listPrice\",\"shippingEstimate\",\"dockEstimate\",\"shippingEstimateDate\",\"lockTTL\",\"deliveryCompany\",\"polygonName\",\"transitTime\",\"sellingPrice\",\"deliveryIds\",\"deliveryWindow\",\"pickupPointId\",\"pickupStoreInfo\",\"pickupDistance\"],\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Index that identifies the position of the replacing item in the array, starting from `0`.\",\"example\":0},\"selectedSla\":{\"type\":\"string\",\"description\":\"Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the replacing order.\",\"example\":\"Normal\"},\"selectedDeliveryChannel\":{\"type\":\"string\",\"description\":\"Delivery channel selected by the customer, like `delivery` or `pickup-in-point`. This field is being deprecated and the information it retrieves can be usually be found in `deliveryChannel`.\",\"example\":\"delivery\"},\"addressId\":{\"type\":\"string\",\"description\":\"Shipping address ID of the replacing item.\",\"example\":\"9ec276fd3a604eb1aa151b5333ca5db7\"},\"slas\":{\"type\":\"array\",\"items\":{\"title\":\"SlaV2\",\"required\":[\"id\",\"deliveryChannel\",\"name\",\"deliveryIds\",\"shippingEstimate\",\"shippingEstimateDate\",\"lockTTL\",\"availableDeliveryWindows\",\"deliveryWindow\",\"price\",\"listPrice\",\"tax\",\"pickupStoreInfo\",\"pickupPointId\",\"pickupDistance\",\"polygonName\",\"transitTime\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the order delivery or pickup.\",\"example\":\"Normal\"},\"deliveryChannel\":{\"type\":\"string\",\"description\":\"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.\",\"example\":\"delivery\"},\"name\":{\"type\":\"string\",\"description\":\"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.\",\"example\":\"Normal\"},\"deliveryIds\":{\"type\":\"array\",\"items\":{\"title\":\"DeliveryIdV2\",\"required\":[\"courierId\",\"warehouseId\",\"dockId\",\"courierName\",\"quantity\",\"kitItemDetails\",\"accountCarrierName\"],\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).\",\"example\":\"136769c\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).\",\"example\":\"w_156\"},\"dockId\":{\"type\":\"string\",\"description\":\"ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).\",\"example\":\"ld931\"},\"courierName\":{\"type\":\"string\",\"description\":\"Name of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).\",\"example\":\"Crossborder\"},\"quantity\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Quantity of items.\",\"example\":1},\"kitItemDetails\":{\"type\":\"array\",\"items\":{\"type\":[\"string\",\"null\"],\"description\":\"Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), when applicable to the order.\",\"example\":null}},\"accountCarrierName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the account's [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE).\",\"example\":\"vtexlog\"}},\"example\":{\"courierId\":\"1c083bf\",\"warehouseId\":\"1_1\",\"dockId\":\"1\",\"courierName\":\"Donkey\",\"quantity\":1,\"kitItemDetails\":[],\"accountCarrierName\":null}},\"description\":\"Information about delivery IDs.\"},\"shippingEstimate\":{\"type\":[\"string\",\"null\"],\"description\":\"Total shipping duration estimated in days. For instance, three business days is represented as `3bd`.\",\"example\":\"3bd\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.\",\"example\":\"2023-07-27T17:52:18.6483116Z\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"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`.\",\"example\":\"1bd\"},\"availableDeliveryWindows\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Available [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, for when the shipping policy has shipping windows configurations.\"},\"deliveryWindow\":{\"type\":[\"object\",\"null\"],\"description\":\"[Scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.\",\"example\":null},\"price\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Shipping price for the item in cents. Does not account for the whole order's shipping price.\",\"example\":600},\"listPrice\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Item's price list for a specific trade policy.\",\"example\":600},\"tax\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Tax in cents, when applicable.\",\"example\":0},\"pickupStoreInfo\":{\"title\":\"PickupStoreInfoV2\",\"required\":[\"isPickupStore\",\"friendlyName\",\"address\",\"additionalInfo\",\"dockId\"],\"type\":\"object\",\"properties\":{\"isPickupStore\":{\"type\":[\"boolean\",\"null\"],\"description\":\"This field is related to converting a loading dock into a pickup point. It should always correspond to `false` because it has been deprecated.\",\"default\":false,\"deprecated\":true},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the loading dock converted to pickup point to be displayed at checkout. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"address\":{\"type\":[\"string\",\"null\"],\"description\":\"Address of the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information about the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true}},\"deprecated\":true,\"example\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":\"dockAjs28\"}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID is the unique identifier of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) related to the SLA.\",\"example\":\"pup215rkw\"},\"pickupDistance\":{\"type\":[\"number\",\"null\"],\"description\":\"Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.\",\"example\":1},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.\",\"example\":\"114 - Polanco _ H-05\"},\"transitTime\":{\"type\":[\"string\",\"null\"],\"description\":\"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`.\",\"example\":\"3bd\"}},\"example\":{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}},\"description\":\"Information on Service Level Agreement (SLA) of the change order shipping policy.\"},\"shipsTo\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Country name represented in a three letters code ISO 3166 ALPHA-3.\",\"example\":\"BRA\"},\"description\":\"List of countries of the change order shipping address.\"},\"itemId\":{\"type\":\"string\",\"description\":\"Replacing item's SKU ID, which is a unique numerical identifier.\",\"example\":\"3\"},\"deliveryChannels\":{\"type\":\"array\",\"items\":{\"title\":\"DeliveryChannel\",\"required\":[\"id\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Change 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.\",\"example\":\"delivery\"}},\"example\":{\"id\":\"delivery\"}},\"description\":\"Array with the delivery channels associated with the trade policy.\"},\"price\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Replacing item's final price, calculated in cents.\",\"example\":600},\"listPrice\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Replacing item's price list, calculated in cents.\",\"example\":600},\"shippingEstimate\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item's shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.\",\"example\":\"2023-07-29T17:52:18.6483116Z\"},\"dockEstimate\":{\"type\":[\"string\",\"null\"],\"description\":\"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`.\",\"example\":\"1bd\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item's total shipping duration estimated in days. For instance, three business days are represented as `3bd`.\",\"example\":\"3bd\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"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`.\",\"example\":\"1bd\"},\"deliveryCompany\":{\"type\":[\"string\",\"null\"],\"description\":\"[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) company's name.\",\"example\":\"Correios\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.\",\"example\":\"114 - Polanco _ H-05\"},\"transitTime\":{\"type\":[\"string\",\"null\"],\"description\":\"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`.\",\"example\":\"3bd\"},\"sellingPrice\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Change item's selling price.\",\"example\":600},\"deliveryIds\":{\"type\":\"array\",\"items\":{\"title\":\"DeliveryIdV2\",\"required\":[\"courierId\",\"warehouseId\",\"dockId\",\"courierName\",\"quantity\",\"kitItemDetails\",\"accountCarrierName\"],\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).\",\"example\":\"136769c\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).\",\"example\":\"w_156\"},\"dockId\":{\"type\":\"string\",\"description\":\"ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).\",\"example\":\"ld931\"},\"courierName\":{\"type\":\"string\",\"description\":\"Name of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).\",\"example\":\"Crossborder\"},\"quantity\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Quantity of items.\",\"example\":1},\"kitItemDetails\":{\"type\":\"array\",\"items\":{\"type\":[\"string\",\"null\"],\"description\":\"Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), when applicable to the order.\",\"example\":null}},\"accountCarrierName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the account's [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE).\",\"example\":\"vtexlog\"}},\"example\":{\"courierId\":\"1c083bf\",\"warehouseId\":\"1_1\",\"dockId\":\"1\",\"courierName\":\"Donkey\",\"quantity\":1,\"kitItemDetails\":[],\"accountCarrierName\":null}},\"description\":\"Array with delivery information.\"},\"deliveryWindow\":{\"type\":[\"string\",\"null\"],\"description\":\"Change order [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.\",\"example\":null},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\",\"example\":\"pup215rkw\"},\"pickupStoreInfo\":{\"title\":\"PickupStoreInfoV2\",\"required\":[\"isPickupStore\",\"friendlyName\",\"address\",\"additionalInfo\",\"dockId\"],\"type\":\"object\",\"properties\":{\"isPickupStore\":{\"type\":[\"boolean\",\"null\"],\"description\":\"This field is related to converting a loading dock into a pickup point. It should always correspond to `false` because it has been deprecated.\",\"default\":false,\"deprecated\":true},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the loading dock converted to pickup point to be displayed at checkout. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"address\":{\"type\":[\"string\",\"null\"],\"description\":\"Address of the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information about the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true}},\"deprecated\":true,\"example\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":\"dockAjs28\"}},\"pickupDistance\":{\"type\":[\"number\",\"null\"],\"description\":\"Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.\",\"example\":\"1.0\"}},\"example\":{\"itemIndex\":0,\"selectedSla\":\"Lenta\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"slas\":[{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}],\"shipsTo\":[],\"itemId\":\"1\",\"deliveryChannels\":[],\"price\":600,\"listPrice\":600,\"shippingEstimate\":null,\"dockEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"deliveryCompany\":null,\"polygonName\":null,\"transitTime\":null,\"sellingPrice\":600,\"deliveryIds\":[],\"deliveryWindow\":null,\"pickupPointId\":null,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupDistance\":null}},\"description\":\"Array with shipping information.\"}},\"example\":{\"logisticsInfo\":[{\"itemIndex\":0,\"selectedSla\":\"Lenta\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"slas\":[{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}],\"shipsTo\":[],\"itemId\":\"1\",\"deliveryChannels\":[],\"price\":600,\"listPrice\":600,\"shippingEstimate\":null,\"dockEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"deliveryCompany\":null,\"polygonName\":null,\"transitTime\":null,\"sellingPrice\":600,\"deliveryIds\":[],\"deliveryWindow\":null,\"pickupPointId\":null,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupDistance\":null}]}}},\"example\":{\"items\":[{\"uniqueId\":\"40E763F4378E4F40AD1FE915FE1078E1\",\"id\":\"1\",\"productId\":null,\"productRefId\":null,\"refId\":null,\"ean\":null,\"name\":null,\"skuName\":null,\"modalType\":null,\"parentItemIndex\":null,\"parentAssemblyBinding\":null,\"assemblies\":[],\"priceValidUntil\":null,\"tax\":0,\"price\":null,\"listPrice\":null,\"manualPrice\":null,\"manualPriceAppliedBy\":null,\"sellingPrice\":null,\"rewardValue\":0,\"isGift\":false,\"additionalInfo\":{\"dimension\":null,\"brandName\":null,\"brandId\":null,\"offeringInfo\":null,\"offeringType\":null,\"offeringTypeId\":null,\"categoriesIds\":null,\"productClusterId\":null,\"commercialConditionId\":null},\"preSaleDate\":null,\"productCategoryIds\":null,\"productCategories\":{},\"quantity\":1,\"seller\":null,\"sellerChain\":[null],\"imageUrl\":null,\"detailUrl\":null,\"components\":[],\"bundleItems\":[],\"attachments\":[],\"attachmentOfferings\":[],\"offerings\":[],\"priceTags\":[],\"availability\":null,\"measurementUnit\":\"un\",\"unitMultiplier\":1,\"manufacturerCode\":null,\"priceDefinition\":null}],\"paymentData\":{\"transactions\":[]},\"receiptData\":null,\"shippingData\":{\"logisticsInfo\":[{\"itemIndex\":0,\"selectedSla\":\"Lenta\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"slas\":[{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}],\"shipsTo\":[],\"itemId\":\"1\",\"deliveryChannels\":[],\"price\":600,\"listPrice\":600,\"shippingEstimate\":null,\"dockEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"deliveryCompany\":null,\"polygonName\":null,\"transitTime\":null,\"sellingPrice\":600,\"deliveryIds\":[],\"deliveryWindow\":null,\"pickupPointId\":null,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupDistance\":null}]}}}},\"example\":{\"from\":{\"paymentData\":{\"transactions\":[]},\"items\":[{\"id\":\"31\",\"quantity\":1,\"price\":null,\"measurementUnit\":null,\"unitMultiplier\":0,\"sellingPrice\":null,\"name\":null,\"detailUrl\":null,\"imageUrl\":null}],\"shippingData\":{\"logisticsInfo\":[]}},\"to\":{\"items\":[{\"uniqueId\":\"40E763F4378E4F40AD1FE915FE1078E1\",\"id\":\"1\",\"productId\":null,\"productRefId\":null,\"refId\":null,\"ean\":null,\"name\":null,\"skuName\":null,\"modalType\":null,\"parentItemIndex\":null,\"parentAssemblyBinding\":null,\"assemblies\":[],\"priceValidUntil\":null,\"tax\":0,\"price\":null,\"listPrice\":null,\"manualPrice\":null,\"manualPriceAppliedBy\":null,\"sellingPrice\":null,\"rewardValue\":0,\"isGift\":false,\"additionalInfo\":{\"dimension\":null,\"brandName\":null,\"brandId\":null,\"offeringInfo\":null,\"offeringType\":null,\"offeringTypeId\":null,\"categoriesIds\":null,\"productClusterId\":null,\"commercialConditionId\":null},\"preSaleDate\":null,\"productCategoryIds\":null,\"productCategories\":{},\"quantity\":1,\"seller\":null,\"sellerChain\":[null],\"imageUrl\":null,\"detailUrl\":null,\"components\":[],\"bundleItems\":[],\"attachments\":[],\"attachmentOfferings\":[],\"offerings\":[],\"priceTags\":[],\"availability\":null,\"measurementUnit\":\"un\",\"unitMultiplier\":1,\"manufacturerCode\":null,\"priceDefinition\":null}],\"paymentData\":{\"transactions\":[]},\"receiptData\":null,\"shippingData\":{\"logisticsInfo\":[{\"itemIndex\":0,\"selectedSla\":\"Lenta\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"slas\":[{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}],\"shipsTo\":[],\"itemId\":\"1\",\"deliveryChannels\":[],\"price\":600,\"listPrice\":600,\"shippingEstimate\":null,\"dockEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"deliveryCompany\":null,\"polygonName\":null,\"transitTime\":null,\"sellingPrice\":600,\"deliveryIds\":[],\"deliveryWindow\":null,\"pickupPointId\":null,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupDistance\":null}]}}}},\"description\":\"Array with information about the `replace` operation, when applicable.\"},\"date\":{\"type\":\"string\",\"description\":\"Date and time of the request. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.\",\"example\":\"2023-07-27T17:52:18.6483116Z\"},\"origin\":{\"title\":\"OriginV2\",\"required\":[\"account\",\"orderId\",\"component\"],\"type\":\"object\",\"properties\":{\"account\":{\"type\":\"string\",\"description\":\"Name of the account where the order was made.\",\"example\":\"qastore\"},\"orderId\":{\"type\":\"string\",\"description\":\"Order ID is a unique code that identifies an order.\",\"example\":\"v12772213qst-02\"},\"component\":{\"type\":\"string\",\"description\":\"Component information.\",\"example\":\"MarketplaceComponent\"}},\"description\":\"Object containing information about the order origin.\",\"example\":{\"account\":\"qastore\",\"orderId\":\"v12772213qst-02\",\"component\":\"MarketplaceComponent\"}},\"settings\":{\"title\":\"Settings\",\"required\":[\"customPaymentSystemsAllowed\"],\"type\":\"object\",\"properties\":{\"customPaymentSystemsAllowed\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"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.\",\"example\":[]}},\"example\":{\"customPaymentSystemsAllowed\":[]}}},\"example\":{\"requestId\":\"e8532a32-7f7e-434a-88ec-29609f0ede46\",\"workflowId\":\"74f40e7a-68c6-4699-b874-a8a297fb3f6a\",\"reason\":\"The client wants to change the items weight.\",\"manualDiscountValue\":0,\"manualIncrementValue\":0,\"totalChangeValue\":0,\"totals\":[],\"add\":null,\"remove\":null,\"replace\":[{\"from\":{\"paymentData\":{\"transactions\":[]},\"items\":[{\"id\":\"31\",\"quantity\":1,\"price\":null,\"measurementUnit\":null,\"unitMultiplier\":0,\"sellingPrice\":null,\"name\":null,\"detailUrl\":null,\"imageUrl\":null}],\"shippingData\":{\"logisticsInfo\":[]}},\"to\":{\"items\":[{\"uniqueId\":\"40E763F4378E4F40AD1FE915FE1078E1\",\"id\":\"1\",\"productId\":null,\"productRefId\":null,\"refId\":null,\"ean\":null,\"name\":null,\"skuName\":null,\"modalType\":null,\"parentItemIndex\":null,\"parentAssemblyBinding\":null,\"assemblies\":[],\"priceValidUntil\":null,\"tax\":0,\"price\":null,\"listPrice\":null,\"manualPrice\":null,\"manualPriceAppliedBy\":null,\"sellingPrice\":null,\"rewardValue\":0,\"isGift\":false,\"additionalInfo\":{\"dimension\":null,\"brandName\":null,\"brandId\":null,\"offeringInfo\":null,\"offeringType\":null,\"offeringTypeId\":null,\"categoriesIds\":null,\"productClusterId\":null,\"commercialConditionId\":null},\"preSaleDate\":null,\"productCategoryIds\":null,\"productCategories\":{},\"quantity\":1,\"seller\":null,\"sellerChain\":[null],\"imageUrl\":null,\"detailUrl\":null,\"components\":[],\"bundleItems\":[],\"attachments\":[],\"attachmentOfferings\":[],\"offerings\":[],\"priceTags\":[],\"availability\":null,\"measurementUnit\":\"un\",\"unitMultiplier\":1,\"manufacturerCode\":null,\"priceDefinition\":null}],\"paymentData\":{\"transactions\":[]},\"receiptData\":null,\"shippingData\":{\"logisticsInfo\":[{\"itemIndex\":0,\"selectedSla\":\"Lenta\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"slas\":[{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}],\"shipsTo\":[],\"itemId\":\"1\",\"deliveryChannels\":[],\"price\":600,\"listPrice\":600,\"shippingEstimate\":null,\"dockEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"deliveryCompany\":null,\"polygonName\":null,\"transitTime\":null,\"sellingPrice\":600,\"deliveryIds\":[],\"deliveryWindow\":null,\"pickupPointId\":null,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupDistance\":null}]}}}],\"date\":\"2023-07-27T17:52:18.6483116Z\",\"origin\":{\"account\":\"qastore\",\"orderId\":\"v12772213qst-02\",\"component\":\"MarketplaceComponent\"},\"settings\":{\"customPaymentSystemsAllowed\":[]}}},{\"example\":{\"requestId\":\"e8532a32-7f7e-434a-88ec-29609f0ede46\",\"workflowId\":\"74f40e7a-68c6-4699-b874-a8a297fb3f6a\",\"reason\":\"The client did not like the size.\",\"manualDiscountValue\":0,\"manualIncrementValue\":0,\"totalChangeValue\":0,\"totals\":[],\"add\":null,\"remove\":null,\"replace\":[{\"from\":{\"paymentData\":{\"transactions\":[]},\"items\":[{\"id\":\"31\",\"quantity\":1,\"price\":null,\"measurementUnit\":null,\"unitMultiplier\":0,\"sellingPrice\":null,\"name\":null,\"detailUrl\":null,\"imageUrl\":null}],\"shippingData\":{\"logisticsInfo\":[]}},\"to\":{\"items\":[{\"uniqueId\":\"40E763F4378E4F40AD1FE915FE1078E1\",\"id\":\"1\",\"productId\":null,\"productRefId\":null,\"refId\":null,\"ean\":null,\"name\":null,\"skuName\":null,\"modalType\":null,\"parentItemIndex\":null,\"parentAssemblyBinding\":null,\"assemblies\":[],\"priceValidUntil\":null,\"tax\":0,\"price\":null,\"listPrice\":null,\"manualPrice\":null,\"manualPriceAppliedBy\":null,\"sellingPrice\":null,\"rewardValue\":0,\"isGift\":false,\"additionalInfo\":{\"dimension\":null,\"brandName\":null,\"brandId\":null,\"offeringInfo\":null,\"offeringType\":null,\"offeringTypeId\":null,\"categoriesIds\":null,\"productClusterId\":null,\"commercialConditionId\":null},\"preSaleDate\":null,\"productCategoryIds\":null,\"productCategories\":{},\"quantity\":1,\"seller\":null,\"sellerChain\":[null],\"imageUrl\":null,\"detailUrl\":null,\"components\":[],\"bundleItems\":[],\"attachments\":[],\"attachmentOfferings\":[],\"offerings\":[],\"priceTags\":[],\"availability\":null,\"measurementUnit\":\"un\",\"unitMultiplier\":1,\"manufacturerCode\":null,\"priceDefinition\":null}],\"paymentData\":{\"transactions\":[]},\"receiptData\":null,\"shippingData\":{\"logisticsInfo\":[{\"itemIndex\":0,\"selectedSla\":\"Lenta\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"slas\":[{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}],\"shipsTo\":[],\"itemId\":\"1\",\"deliveryChannels\":[],\"price\":600,\"listPrice\":600,\"shippingEstimate\":null,\"dockEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"deliveryCompany\":null,\"polygonName\":null,\"transitTime\":null,\"sellingPrice\":600,\"deliveryIds\":[],\"deliveryWindow\":null,\"pickupPointId\":null,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupDistance\":null}]}}}],\"date\":\"2023-07-27T17:52:18.6483116Z\",\"origin\":{\"account\":\"qastore\",\"orderId\":\"v12772213qst-02\",\"component\":\"MarketplaceComponent\"},\"settings\":{\"customPaymentSystemsAllowed\":[]}}}]}\n\n// Validate if response matches JSON schema \npm.test(\"[PATCH]::/api/order-system/orders/:changeOrderId/changes - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"allOf\":[{\"title\":\"response202\",\"required\":[\"requestId\",\"workflowId\",\"reason\",\"manualDiscountValue\",\"manualIncrementValue\",\"totalChangeValue\",\"totals\",\"add\",\"remove\",\"replace\",\"date\",\"origin\",\"settings\"],\"type\":\"object\",\"properties\":{\"requestId\":{\"type\":\"string\",\"description\":\"Unique code that identifies a change order request.\",\"example\":\"e8532a32-7f7e-434a-88ec-29609f0ede46\"},\"workflowId\":{\"type\":\"string\",\"description\":\"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).\",\"example\":\"74f40e7a-68c6-4699-b874-a8a297fb3f6a\"},\"reason\":{\"type\":\"string\",\"description\":\"Reason that motivated the order change.\",\"example\":\"The client wants to change the items weight.\"},\"manualDiscountValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"This field shows if a manual price was applied to the total order amount. The value is in cents.\",\"example\":0},\"manualIncrementValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"This field shows if an increment value was applied to the total order amount. The value is in cents.\",\"example\":0},\"totalChangeValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"This field shows how much the order total price is considering that price changes might have been made. The value is in cents.\",\"example\":0},\"totals\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array containing information about change prices per item.\",\"example\":null},\"add\":{\"type\":\"array\",\"description\":\"Array with information about the `add` operation, when applicable. The schema will correspond to the object `to` inside the `replace` array.\",\"example\":null},\"remove\":{\"type\":\"array\",\"description\":\"Array with information about the `remove` operation, when applicable. The schema will correspond to the object `from` inside the `replace` array.\",\"example\":null},\"replace\":{\"type\":\"array\",\"items\":{\"title\":\"Replace1\",\"required\":[\"from\",\"to\"],\"type\":\"object\",\"properties\":{\"from\":{\"title\":\"From1\",\"required\":[\"paymentData\",\"items\",\"shippingData\"],\"type\":\"object\",\"properties\":{\"paymentData\":{\"title\":\"PaymentDataV2\",\"required\":[\"transactions\"],\"type\":\"object\",\"properties\":{\"transactions\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"example\":null},\"description\":\"Array containing financial information. This is an optional field.\"}},\"example\":{\"transactions\":[]}},\"items\":{\"type\":\"array\",\"items\":{\"title\":\"Item2V2\",\"required\":[\"id\",\"quantity\",\"price\",\"measurementUnit\",\"unitMultiplier\",\"sellingPrice\",\"name\",\"detailUrl\",\"imageUrl\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SKU ID of the item been replaced.\",\"example\":\"1\"},\"quantity\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Quantity of items been replaced.\",\"example\":1},\"price\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping price for the item been replaced. It does not account for the whole order's shipping price and is presented in cents.\",\"example\":1000},\"measurementUnit\":{\"type\":[\"string\",\"null\"],\"description\":\"Measurement unit of the item been replaced. For example, `kg` for kilograms or `un` for unitary items.\",\"example\":\"kg\"},\"unitMultiplier\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Unit multiplier for item been update.\",\"example\":3},\"sellingPrice\":{\"type\":\"string\",\"description\":\"Selling price of the item been replaced.\",\"example\":100},\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the item been replaced.\",\"example\":\"T-shirt with logo\"},\"detailUrl\":{\"type\":[\"string\",\"null\"],\"description\":\"URL slug of the item been replaced.\",\"example\":\"/tshirt-logo/p\"},\"imageUrl\":{\"type\":[\"string\",\"null\"],\"description\":\"Image URL slug of the item been replaced.\",\"example\":\"http://store.com.br/ids/155419-55-55//tshirt-logo.png?v=6378858562367\"}},\"example\":{\"id\":\"31\",\"quantity\":1,\"price\":null,\"measurementUnit\":null,\"unitMultiplier\":0,\"sellingPrice\":null,\"name\":null,\"detailUrl\":null,\"imageUrl\":null}}},\"shippingData\":{\"title\":\"ShippingData1\",\"required\":[\"logisticsInfo\"],\"type\":\"object\",\"properties\":{\"logisticsInfo\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"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.\"}},\"example\":{\"logisticsInfo\":[]}}},\"example\":{\"paymentData\":{\"transactions\":[]},\"items\":[{\"id\":\"31\",\"quantity\":1,\"price\":null,\"measurementUnit\":null,\"unitMultiplier\":0,\"sellingPrice\":null,\"name\":null,\"detailUrl\":null,\"imageUrl\":null}],\"shippingData\":{\"logisticsInfo\":[]}}},\"to\":{\"title\":\"To1\",\"required\":[\"items\",\"paymentData\",\"receiptData\",\"shippingData\"],\"type\":\"object\",\"properties\":{\"items\":{\"type\":\"array\",\"items\":{\"title\":\"Item3\",\"required\":[\"uniqueId\",\"id\",\"productId\",\"productRefId\",\"refId\",\"ean\",\"name\",\"skuName\",\"modalType\",\"parentItemIndex\",\"parentAssemblyBinding\",\"assemblies\",\"priceValidUntil\",\"tax\",\"price\",\"listPrice\",\"manualPrice\",\"manualPriceAppliedBy\",\"sellingPrice\",\"rewardValue\",\"isGift\",\"additionalInfo\",\"preSaleDate\",\"productCategoryIds\",\"productCategories\",\"quantity\",\"seller\",\"sellerChain\",\"imageUrl\",\"detailUrl\",\"components\",\"bundleItems\",\"attachments\",\"attachmentOfferings\",\"offerings\",\"priceTags\",\"availability\",\"measurementUnit\",\"unitMultiplier\",\"manufacturerCode\",\"priceDefinition\"],\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Item's unique ID in the change order request.\",\"example\":\"40E763F4378E4F40AD1FE915FE1078E1\"},\"id\":{\"type\":\"string\",\"description\":\"SKU ID of the item replacing the previous one.\",\"example\":\"3\"},\"productId\":{\"type\":[\"string\",\"null\"],\"description\":\"Product ID of the item replacing the previous one.\",\"example\":\"7\"},\"productRefId\":{\"type\":[\"string\",\"null\"],\"description\":\"Product Ref ID of the item replacing the previous one.\",\"example\":\"smallcup\"},\"refId\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference ID of the item replacing the previous one.\",\"example\":\"356\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number (EAN) of the item replacing the previous one.\",\"example\":\"8745121641680\"},\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the Product associated with the item replacing the previous one.\",\"example\":\"Small cup of coffee with pink logo\"},\"skuName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the SKU replacing the previous one.\",\"example\":\"Small blue cup\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"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.\",\"example\":\"GLASS\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index of the item replacing the previous one.\",\"example\":0},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding of the item replacing the previous one.\",\"example\":null},\"assemblies\":{\"type\":[\"array\",\"null\"],\"items\":{\"type\":\"string\"},\"description\":\"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\":{\"type\":[\"string\",\"null\"],\"description\":\"Price expiration date of item replacing the previous one. The value is in the format `yyyy-mm-ddThh:mm:ss.sss`.\",\"example\":\"2023-03-01T22:58:28.143\"},\"tax\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Tax in cents of the item replacing the previous one, when applicable.\",\"example\":0},\"price\":{\"type\":[\"string\",\"null\"],\"description\":\"Final price of the item replacing the previous one, calculated in cents.\",\"example\":600},\"listPrice\":{\"type\":[\"string\",\"null\"],\"description\":\"Item's price list for the item replacing the previous one.\",\"example\":600},\"manualPrice\":{\"type\":[\"integer\",\"null\"],\"description\":\"Manual price of the item replacing the previous one. It is calculated in cents.\",\"example\":6500},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User ID or appKey that made the manual price change of the item replacing the previous one.\",\"example\":\"4cc81d44-e42e-464b-8199-1e883bf4ab6b\"},\"sellingPrice\":{\"type\":[\"integer\",\"null\"],\"description\":\"Selling price of the item replacing the previous one. It is calculated in cents.\",\"example\":600},\"rewardValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reward value of the item replacing the previous one. It is calculated in cents.\",\"example\":50},\"isGift\":{\"type\":\"boolean\",\"description\":\"This field is `true` when the replacing item is a gift in the order context and `false` when it is not.\",\"example\":false},\"additionalInfo\":{\"title\":\"AdditionalInfoV2\",\"required\":[\"dimension\",\"brandName\",\"brandId\",\"offeringInfo\",\"offeringType\",\"offeringTypeId\",\"categoriesIds\",\"productClusterId\",\"commercialConditionId\"],\"type\":\"object\",\"properties\":{\"dimension\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing tem's dimensions in the measure unit configured in the catalog.\",\"example\":null},\"brandName\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item's brand name.\",\"example\":\"Special coffee cup\"},\"brandId\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item's brand ID.\",\"example\":\"2000001\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\",\"example\":null},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\",\"example\":null},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\",\"example\":null},\"categoriesIds\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the replacing item product category.\",\"example\":null},\"productClusterId\":{\"type\":[\"string\",\"null\"],\"description\":\"All product clusters related to the replacing item.\",\"example\":\"135,137,143,518,1272\"},\"commercialConditionId\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item commercial conditions ID.\",\"example\":\"5\"}},\"example\":{\"dimension\":null,\"brandName\":null,\"brandId\":null,\"offeringInfo\":null,\"offeringType\":null,\"offeringTypeId\":null,\"categoriesIds\":null,\"productClusterId\":null,\"commercialConditionId\":null}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Pre sale date of the item replacing the previous one.\",\"example\":\"2023-01-01T00:00:00.0000000+00:00\"},\"productCategoryIds\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item's category path composed of category IDs separated by `/`. For example: `/3/15/`.\",\"example\":\"/2/\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object containing product categories of the replacing item. Structure: `{CategoryID}: {CategoryName}`. Both the key and the value are strings.\",\"example\":{\"2\":\"Clothes\"}},\"quantity\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Quantity of replacing items.\",\"example\":1},\"seller\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller ID that identifies the seller the replacing item belongs to.\",\"example\":\"1\"},\"sellerChain\":{\"type\":\"array\",\"items\":{\"type\":[\"string\",\"null\"]},\"description\":\"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\":{\"type\":[\"string\",\"null\"],\"description\":\"Image URL slug of the replacing item.\",\"example\":\"http://store.com.br/ids/155419-55-55//cupcoffee.png?v=6368858582363\"},\"detailUrl\":{\"type\":[\"string\",\"null\"],\"description\":\"URL slug of the replacing item.\",\"example\":\"/cup-coffee/p\"},\"components\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array with information about replacing item's components.\"},\"bundleItems\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array with information about services sold along with the replacing item, such as a gift package.\"},\"attachments\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array containing information on attachments.\"},\"attachmentOfferings\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array with the properties of the content declared in the field `attachments`.\"},\"offerings\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array with replacing items Item's offerings.\"},\"priceTags\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array containing objects with replacing item's price modifiers.\"},\"availability\":{\"type\":[\"string\",\"null\"],\"description\":\"Availability to fulfill the order with the item.\",\"example\":\"available\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Replacing item's measurement unit.\",\"example\":\"un\"},\"unitMultiplier\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Replacing item's unit multiplier.\",\"example\":1},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Provided by the manufacturers to identify their product. This field should be completed if the replacing item has a manufacturer's code.\",\"example\":\"manf-00005\"},\"priceDefinition\":{\"type\":[\"string\",\"null\"],\"description\":\"replacing item's price information.\",\"example\":null}},\"example\":{\"uniqueId\":\"40E763F4378E4F40AD1FE915FE1078E1\",\"id\":\"1\",\"productId\":null,\"productRefId\":null,\"refId\":null,\"ean\":null,\"name\":null,\"skuName\":null,\"modalType\":null,\"parentItemIndex\":null,\"parentAssemblyBinding\":null,\"assemblies\":[],\"priceValidUntil\":null,\"tax\":0,\"price\":null,\"listPrice\":null,\"manualPrice\":null,\"manualPriceAppliedBy\":null,\"sellingPrice\":null,\"rewardValue\":0,\"isGift\":false,\"additionalInfo\":{\"dimension\":null,\"brandName\":null,\"brandId\":null,\"offeringInfo\":null,\"offeringType\":null,\"offeringTypeId\":null,\"categoriesIds\":null,\"productClusterId\":null,\"commercialConditionId\":null},\"preSaleDate\":null,\"productCategoryIds\":null,\"productCategories\":{},\"quantity\":1,\"seller\":null,\"sellerChain\":[null],\"imageUrl\":null,\"detailUrl\":null,\"components\":[],\"bundleItems\":[],\"attachments\":[],\"attachmentOfferings\":[],\"offerings\":[],\"priceTags\":[],\"availability\":null,\"measurementUnit\":\"un\",\"unitMultiplier\":1,\"manufacturerCode\":null,\"priceDefinition\":null}},\"description\":\"Array containing information about the item replacing the previous one.\"},\"paymentData\":{\"title\":\"PaymentDataV2\",\"required\":[\"transactions\"],\"type\":\"object\",\"properties\":{\"transactions\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"example\":null},\"description\":\"Array containing financial information. This is an optional field.\"}},\"example\":{\"transactions\":[]}},\"receiptData\":{\"type\":[\"object\",\"null\"],\"description\":\"Information about the receipt after order change.\",\"example\":null},\"shippingData\":{\"title\":\"ShippingData2\",\"required\":[\"logisticsInfo\"],\"type\":\"object\",\"properties\":{\"logisticsInfo\":{\"type\":\"array\",\"items\":{\"title\":\"LogisticsInfo1\",\"required\":[\"itemIndex\",\"selectedSla\",\"selectedDeliveryChannel\",\"addressId\",\"slas\",\"shipsTo\",\"itemId\",\"deliveryChannels\",\"price\",\"listPrice\",\"shippingEstimate\",\"dockEstimate\",\"shippingEstimateDate\",\"lockTTL\",\"deliveryCompany\",\"polygonName\",\"transitTime\",\"sellingPrice\",\"deliveryIds\",\"deliveryWindow\",\"pickupPointId\",\"pickupStoreInfo\",\"pickupDistance\"],\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Index that identifies the position of the replacing item in the array, starting from `0`.\",\"example\":0},\"selectedSla\":{\"type\":\"string\",\"description\":\"Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the replacing order.\",\"example\":\"Normal\"},\"selectedDeliveryChannel\":{\"type\":\"string\",\"description\":\"Delivery channel selected by the customer, like `delivery` or `pickup-in-point`. This field is being deprecated and the information it retrieves can be usually be found in `deliveryChannel`.\",\"example\":\"delivery\"},\"addressId\":{\"type\":\"string\",\"description\":\"Shipping address ID of the replacing item.\",\"example\":\"9ec276fd3a604eb1aa151b5333ca5db7\"},\"slas\":{\"type\":\"array\",\"items\":{\"title\":\"SlaV2\",\"required\":[\"id\",\"deliveryChannel\",\"name\",\"deliveryIds\",\"shippingEstimate\",\"shippingEstimateDate\",\"lockTTL\",\"availableDeliveryWindows\",\"deliveryWindow\",\"price\",\"listPrice\",\"tax\",\"pickupStoreInfo\",\"pickupPointId\",\"pickupDistance\",\"polygonName\",\"transitTime\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the order delivery or pickup.\",\"example\":\"Normal\"},\"deliveryChannel\":{\"type\":\"string\",\"description\":\"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.\",\"example\":\"delivery\"},\"name\":{\"type\":\"string\",\"description\":\"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.\",\"example\":\"Normal\"},\"deliveryIds\":{\"type\":\"array\",\"items\":{\"title\":\"DeliveryIdV2\",\"required\":[\"courierId\",\"warehouseId\",\"dockId\",\"courierName\",\"quantity\",\"kitItemDetails\",\"accountCarrierName\"],\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).\",\"example\":\"136769c\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).\",\"example\":\"w_156\"},\"dockId\":{\"type\":\"string\",\"description\":\"ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).\",\"example\":\"ld931\"},\"courierName\":{\"type\":\"string\",\"description\":\"Name of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).\",\"example\":\"Crossborder\"},\"quantity\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Quantity of items.\",\"example\":1},\"kitItemDetails\":{\"type\":\"array\",\"items\":{\"type\":[\"string\",\"null\"],\"description\":\"Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), when applicable to the order.\",\"example\":null}},\"accountCarrierName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the account's [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE).\",\"example\":\"vtexlog\"}},\"example\":{\"courierId\":\"1c083bf\",\"warehouseId\":\"1_1\",\"dockId\":\"1\",\"courierName\":\"Donkey\",\"quantity\":1,\"kitItemDetails\":[],\"accountCarrierName\":null}},\"description\":\"Information about delivery IDs.\"},\"shippingEstimate\":{\"type\":[\"string\",\"null\"],\"description\":\"Total shipping duration estimated in days. For instance, three business days is represented as `3bd`.\",\"example\":\"3bd\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.\",\"example\":\"2023-07-27T17:52:18.6483116Z\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"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`.\",\"example\":\"1bd\"},\"availableDeliveryWindows\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Available [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, for when the shipping policy has shipping windows configurations.\"},\"deliveryWindow\":{\"type\":[\"object\",\"null\"],\"description\":\"[Scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.\",\"example\":null},\"price\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Shipping price for the item in cents. Does not account for the whole order's shipping price.\",\"example\":600},\"listPrice\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Item's price list for a specific trade policy.\",\"example\":600},\"tax\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Tax in cents, when applicable.\",\"example\":0},\"pickupStoreInfo\":{\"title\":\"PickupStoreInfoV2\",\"required\":[\"isPickupStore\",\"friendlyName\",\"address\",\"additionalInfo\",\"dockId\"],\"type\":\"object\",\"properties\":{\"isPickupStore\":{\"type\":[\"boolean\",\"null\"],\"description\":\"This field is related to converting a loading dock into a pickup point. It should always correspond to `false` because it has been deprecated.\",\"default\":false,\"deprecated\":true},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the loading dock converted to pickup point to be displayed at checkout. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"address\":{\"type\":[\"string\",\"null\"],\"description\":\"Address of the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information about the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true}},\"deprecated\":true,\"example\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":\"dockAjs28\"}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID is the unique identifier of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) related to the SLA.\",\"example\":\"pup215rkw\"},\"pickupDistance\":{\"type\":[\"number\",\"null\"],\"description\":\"Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.\",\"example\":1},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.\",\"example\":\"114 - Polanco _ H-05\"},\"transitTime\":{\"type\":[\"string\",\"null\"],\"description\":\"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`.\",\"example\":\"3bd\"}},\"example\":{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}},\"description\":\"Information on Service Level Agreement (SLA) of the change order shipping policy.\"},\"shipsTo\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Country name represented in a three letters code ISO 3166 ALPHA-3.\",\"example\":\"BRA\"},\"description\":\"List of countries of the change order shipping address.\"},\"itemId\":{\"type\":\"string\",\"description\":\"Replacing item's SKU ID, which is a unique numerical identifier.\",\"example\":\"3\"},\"deliveryChannels\":{\"type\":\"array\",\"items\":{\"title\":\"DeliveryChannel\",\"required\":[\"id\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Change 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.\",\"example\":\"delivery\"}},\"example\":{\"id\":\"delivery\"}},\"description\":\"Array with the delivery channels associated with the trade policy.\"},\"price\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Replacing item's final price, calculated in cents.\",\"example\":600},\"listPrice\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Replacing item's price list, calculated in cents.\",\"example\":600},\"shippingEstimate\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item's shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.\",\"example\":\"2023-07-29T17:52:18.6483116Z\"},\"dockEstimate\":{\"type\":[\"string\",\"null\"],\"description\":\"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`.\",\"example\":\"1bd\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item's total shipping duration estimated in days. For instance, three business days are represented as `3bd`.\",\"example\":\"3bd\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"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`.\",\"example\":\"1bd\"},\"deliveryCompany\":{\"type\":[\"string\",\"null\"],\"description\":\"[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) company's name.\",\"example\":\"Correios\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.\",\"example\":\"114 - Polanco _ H-05\"},\"transitTime\":{\"type\":[\"string\",\"null\"],\"description\":\"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`.\",\"example\":\"3bd\"},\"sellingPrice\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Change item's selling price.\",\"example\":600},\"deliveryIds\":{\"type\":\"array\",\"items\":{\"title\":\"DeliveryIdV2\",\"required\":[\"courierId\",\"warehouseId\",\"dockId\",\"courierName\",\"quantity\",\"kitItemDetails\",\"accountCarrierName\"],\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).\",\"example\":\"136769c\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).\",\"example\":\"w_156\"},\"dockId\":{\"type\":\"string\",\"description\":\"ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).\",\"example\":\"ld931\"},\"courierName\":{\"type\":\"string\",\"description\":\"Name of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).\",\"example\":\"Crossborder\"},\"quantity\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Quantity of items.\",\"example\":1},\"kitItemDetails\":{\"type\":\"array\",\"items\":{\"type\":[\"string\",\"null\"],\"description\":\"Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), when applicable to the order.\",\"example\":null}},\"accountCarrierName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the account's [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE).\",\"example\":\"vtexlog\"}},\"example\":{\"courierId\":\"1c083bf\",\"warehouseId\":\"1_1\",\"dockId\":\"1\",\"courierName\":\"Donkey\",\"quantity\":1,\"kitItemDetails\":[],\"accountCarrierName\":null}},\"description\":\"Array with delivery information.\"},\"deliveryWindow\":{\"type\":[\"string\",\"null\"],\"description\":\"Change order [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.\",\"example\":null},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\",\"example\":\"pup215rkw\"},\"pickupStoreInfo\":{\"title\":\"PickupStoreInfoV2\",\"required\":[\"isPickupStore\",\"friendlyName\",\"address\",\"additionalInfo\",\"dockId\"],\"type\":\"object\",\"properties\":{\"isPickupStore\":{\"type\":[\"boolean\",\"null\"],\"description\":\"This field is related to converting a loading dock into a pickup point. It should always correspond to `false` because it has been deprecated.\",\"default\":false,\"deprecated\":true},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the loading dock converted to pickup point to be displayed at checkout. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"address\":{\"type\":[\"string\",\"null\"],\"description\":\"Address of the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information about the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true}},\"deprecated\":true,\"example\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":\"dockAjs28\"}},\"pickupDistance\":{\"type\":[\"number\",\"null\"],\"description\":\"Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.\",\"example\":\"1.0\"}},\"example\":{\"itemIndex\":0,\"selectedSla\":\"Lenta\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"slas\":[{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}],\"shipsTo\":[],\"itemId\":\"1\",\"deliveryChannels\":[],\"price\":600,\"listPrice\":600,\"shippingEstimate\":null,\"dockEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"deliveryCompany\":null,\"polygonName\":null,\"transitTime\":null,\"sellingPrice\":600,\"deliveryIds\":[],\"deliveryWindow\":null,\"pickupPointId\":null,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupDistance\":null}},\"description\":\"Array with shipping information.\"}},\"example\":{\"logisticsInfo\":[{\"itemIndex\":0,\"selectedSla\":\"Lenta\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"slas\":[{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}],\"shipsTo\":[],\"itemId\":\"1\",\"deliveryChannels\":[],\"price\":600,\"listPrice\":600,\"shippingEstimate\":null,\"dockEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"deliveryCompany\":null,\"polygonName\":null,\"transitTime\":null,\"sellingPrice\":600,\"deliveryIds\":[],\"deliveryWindow\":null,\"pickupPointId\":null,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupDistance\":null}]}}},\"example\":{\"items\":[{\"uniqueId\":\"40E763F4378E4F40AD1FE915FE1078E1\",\"id\":\"1\",\"productId\":null,\"productRefId\":null,\"refId\":null,\"ean\":null,\"name\":null,\"skuName\":null,\"modalType\":null,\"parentItemIndex\":null,\"parentAssemblyBinding\":null,\"assemblies\":[],\"priceValidUntil\":null,\"tax\":0,\"price\":null,\"listPrice\":null,\"manualPrice\":null,\"manualPriceAppliedBy\":null,\"sellingPrice\":null,\"rewardValue\":0,\"isGift\":false,\"additionalInfo\":{\"dimension\":null,\"brandName\":null,\"brandId\":null,\"offeringInfo\":null,\"offeringType\":null,\"offeringTypeId\":null,\"categoriesIds\":null,\"productClusterId\":null,\"commercialConditionId\":null},\"preSaleDate\":null,\"productCategoryIds\":null,\"productCategories\":{},\"quantity\":1,\"seller\":null,\"sellerChain\":[null],\"imageUrl\":null,\"detailUrl\":null,\"components\":[],\"bundleItems\":[],\"attachments\":[],\"attachmentOfferings\":[],\"offerings\":[],\"priceTags\":[],\"availability\":null,\"measurementUnit\":\"un\",\"unitMultiplier\":1,\"manufacturerCode\":null,\"priceDefinition\":null}],\"paymentData\":{\"transactions\":[]},\"receiptData\":null,\"shippingData\":{\"logisticsInfo\":[{\"itemIndex\":0,\"selectedSla\":\"Lenta\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"slas\":[{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}],\"shipsTo\":[],\"itemId\":\"1\",\"deliveryChannels\":[],\"price\":600,\"listPrice\":600,\"shippingEstimate\":null,\"dockEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"deliveryCompany\":null,\"polygonName\":null,\"transitTime\":null,\"sellingPrice\":600,\"deliveryIds\":[],\"deliveryWindow\":null,\"pickupPointId\":null,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupDistance\":null}]}}}},\"example\":{\"from\":{\"paymentData\":{\"transactions\":[]},\"items\":[{\"id\":\"31\",\"quantity\":1,\"price\":null,\"measurementUnit\":null,\"unitMultiplier\":0,\"sellingPrice\":null,\"name\":null,\"detailUrl\":null,\"imageUrl\":null}],\"shippingData\":{\"logisticsInfo\":[]}},\"to\":{\"items\":[{\"uniqueId\":\"40E763F4378E4F40AD1FE915FE1078E1\",\"id\":\"1\",\"productId\":null,\"productRefId\":null,\"refId\":null,\"ean\":null,\"name\":null,\"skuName\":null,\"modalType\":null,\"parentItemIndex\":null,\"parentAssemblyBinding\":null,\"assemblies\":[],\"priceValidUntil\":null,\"tax\":0,\"price\":null,\"listPrice\":null,\"manualPrice\":null,\"manualPriceAppliedBy\":null,\"sellingPrice\":null,\"rewardValue\":0,\"isGift\":false,\"additionalInfo\":{\"dimension\":null,\"brandName\":null,\"brandId\":null,\"offeringInfo\":null,\"offeringType\":null,\"offeringTypeId\":null,\"categoriesIds\":null,\"productClusterId\":null,\"commercialConditionId\":null},\"preSaleDate\":null,\"productCategoryIds\":null,\"productCategories\":{},\"quantity\":1,\"seller\":null,\"sellerChain\":[null],\"imageUrl\":null,\"detailUrl\":null,\"components\":[],\"bundleItems\":[],\"attachments\":[],\"attachmentOfferings\":[],\"offerings\":[],\"priceTags\":[],\"availability\":null,\"measurementUnit\":\"un\",\"unitMultiplier\":1,\"manufacturerCode\":null,\"priceDefinition\":null}],\"paymentData\":{\"transactions\":[]},\"receiptData\":null,\"shippingData\":{\"logisticsInfo\":[{\"itemIndex\":0,\"selectedSla\":\"Lenta\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"slas\":[{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}],\"shipsTo\":[],\"itemId\":\"1\",\"deliveryChannels\":[],\"price\":600,\"listPrice\":600,\"shippingEstimate\":null,\"dockEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"deliveryCompany\":null,\"polygonName\":null,\"transitTime\":null,\"sellingPrice\":600,\"deliveryIds\":[],\"deliveryWindow\":null,\"pickupPointId\":null,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupDistance\":null}]}}}},\"description\":\"Array with information about the `replace` operation, when applicable.\"},\"date\":{\"type\":\"string\",\"description\":\"Date and time of the request. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.\",\"example\":\"2023-07-27T17:52:18.6483116Z\"},\"origin\":{\"title\":\"OriginV2\",\"required\":[\"account\",\"orderId\",\"component\"],\"type\":\"object\",\"properties\":{\"account\":{\"type\":\"string\",\"description\":\"Name of the account where the order was made.\",\"example\":\"qastore\"},\"orderId\":{\"type\":\"string\",\"description\":\"Order ID is a unique code that identifies an order.\",\"example\":\"v12772213qst-02\"},\"component\":{\"type\":\"string\",\"description\":\"Component information.\",\"example\":\"MarketplaceComponent\"}},\"description\":\"Object containing information about the order origin.\",\"example\":{\"account\":\"qastore\",\"orderId\":\"v12772213qst-02\",\"component\":\"MarketplaceComponent\"}},\"settings\":{\"title\":\"Settings\",\"required\":[\"customPaymentSystemsAllowed\"],\"type\":\"object\",\"properties\":{\"customPaymentSystemsAllowed\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"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.\",\"example\":[]}},\"example\":{\"customPaymentSystemsAllowed\":[]}}}}]}\n\n// Validate if response matches JSON schema \npm.test(\"[PATCH]::/api/order-system/orders/:changeOrderId/changes - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -2514,7 +2501,7 @@ } }, { - "id": "9f7e9388-b19e-436e-ac1a-6b6a782910a8", + "id": "122196cf-d6d5-4ce6-b93c-4b7c6cf1d68e", "name": "Get order change history", "request": { "name": "Get order change history", @@ -2588,7 +2575,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "e76a497c-188b-4597-a028-e00b1fc04310", + "id": "b20c6998-efd3-4624-8edb-61a7ccd13e55", "name": "OK", "originalRequest": { "url": { @@ -2690,7 +2677,7 @@ { "listen": "test", "script": { - "id": "52f9a997-6796-40e8-ab2e-11d14e5e9c0f", + "id": "99d7ccb9-ad21-45cc-a761-8e74e87acdfb", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/order-system/orders/:changeOrderId/changes - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2706,12 +2693,12 @@ } }, { - "id": "9642690c-04e6-47d2-871e-c376f80851f7", + "id": "9fd5244c-df10-4a5d-895b-33867907c4c6", "name": "Get order change detail", "request": { "name": "Get order change detail", "description": { - "content": "This endpoint retrieves detailed information about a specific order change. So after creating multiple changes, you can get information on each one of them by its `changeRequestId`, the unique identification code generated by the Change order endpoint.\r\n\r\nThe successful status code is `200 OK`, and its response body schema is very similar to the Change order endpoint, with some additional fields:\r\n\r\n- `status`: The change request status in the workflow, which progresses in the following order:\r\n - `waiting-acknowledgement`\r\n - `waiting-confirmation`\r\n - `done`\r\n - `canceled`\r\n\r\n- `inProgress`: When set as `true`, the order is still progressing in the order flow, when set as `false`, it is complete, whether by cancellation or because the customer received it.\r\n\r\n- `logs`: Lists the workflow processing logs.\r\n\r\n> If you want information about all the changes made to an order, use the Get order change history endpoint.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou 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):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Oms |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |Cancel order
Change order
|\r\n| inStore Sales Person |Cancel order
Change order
|\r\n\r\n>❗ 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-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).", + "content": "This endpoint retrieves detailed information about a specific order change. So after creating multiple changes, you can get information on each one of them by its `changeRequestId`, the unique identification code generated by the Change order endpoint.\r\n\r\nThe successful status code is `200 OK`, and its response body schema is very similar to the Create order change endpoint, with some additional fields:\r\n\r\n- `status`: The change request status in the workflow, which progresses in the following order:\r\n - `waiting-acknowledgement`\r\n - `waiting-confirmation`\r\n - `done`\r\n - `canceled`\r\n\r\n- `inProgress`: When set as `true`, the order is still progressing in the order flow, when set as `false`, it is complete, whether by cancellation or because the customer received it.\r\n\r\n- `logs`: Lists the workflow processing logs.\r\n\r\n> If you want information about all the changes made to an order, use the Get order change history endpoint.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou 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):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Oms |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |Cancel order
Change order
|\r\n| inStore Sales Person |Cancel order
Change order
|\r\n\r\n>❗ 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-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).", "type": "text/plain" }, "url": { @@ -2791,7 +2778,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "424f0ec1-5976-468a-90c8-41451fdec03c", + "id": "09341c6c-c78a-40ad-866d-86bc665db7d8", "name": "OK", "originalRequest": { "url": { @@ -2904,13 +2891,13 @@ { "listen": "test", "script": { - "id": "4d690cd8-8300-4828-9601-7f95b9e9d1b9", + "id": "13bc916e-9864-460f-83c9-8f186dc3a89b", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/order-system/orders/:changeOrderId/changes/:changeRequestId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/order-system/orders/:changeOrderId/changes/:changeRequestId - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/order-system/orders/:changeOrderId/changes/:changeRequestId - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"allOf\":[{\"title\":\"GetChangeDetailbyschlee\",\"required\":[\"requestId\",\"workflowId\",\"status\",\"inProgress\",\"reason\",\"manualDiscountValue\",\"manualIncrementValue\",\"totalChangeValue\",\"totals\",\"add\",\"remove\",\"replace\",\"date\",\"origin\",\"settings\"],\"type\":\"object\",\"properties\":{\"requestId\":{\"type\":\"string\",\"description\":\"Unique code that identifies a change order request.\",\"example\":\"e8532a32-7f7e-434a-88ec-29609f0ede46\"},\"workflowId\":{\"type\":\"string\",\"description\":\"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).\",\"example\":\"74f40e7a-68c6-4699-b874-a8a297fb3f6a\"},\"status\":{\"type\":\"string\",\"description\":\"Order status in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196).\",\"example\":\"handling\"},\"inProgress\":{\"type\":\"boolean\",\"description\":\"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 shopper received it.\",\"example\":true},\"reason\":{\"type\":\"string\",\"description\":\"Reason that motivated the order change.\",\"example\":\"The client wants to change the items weight.\"},\"manualDiscountValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"This field shows if a manual price was applied to the total order amount. The value is in cents.\",\"example\":0},\"manualIncrementValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"This field shows if an increment value was applied to the total order amount. The value is in cents.\",\"example\":0},\"totalChangeValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"This field shows how much is the order total price considering that price changes might have been made. The value is in cents.\",\"example\":0},\"totals\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array containing information about change prices per item.\",\"example\":null},\"add\":{\"type\":\"array\",\"description\":\"Array with information about the `add` operation, when applicable. The schema will correspond to the object `to` inside the `replace` array.\",\"example\":null},\"remove\":{\"type\":\"array\",\"description\":\"Array with information about the `remove` operation, when applicable. The schema will correspond to the object `from` inside the `replace` array.\",\"example\":null},\"replace\":{\"type\":\"array\",\"items\":{\"title\":\"Replace1\",\"required\":[\"from\",\"to\"],\"type\":\"object\",\"properties\":{\"from\":{\"title\":\"From1\",\"required\":[\"paymentData\",\"items\",\"shippingData\"],\"type\":\"object\",\"properties\":{\"paymentData\":{\"title\":\"PaymentDataV2\",\"required\":[\"transactions\"],\"type\":\"object\",\"properties\":{\"transactions\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"example\":null},\"description\":\"Array containing financial information. This is an optional field.\"}},\"example\":{\"transactions\":[]}},\"items\":{\"type\":\"array\",\"items\":{\"title\":\"Item2V2\",\"required\":[\"id\",\"quantity\",\"price\",\"measurementUnit\",\"unitMultiplier\",\"sellingPrice\",\"name\",\"detailUrl\",\"imageUrl\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SKU ID of the item been replaced.\",\"example\":\"1\"},\"quantity\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Quantity of items been replaced.\",\"example\":1},\"price\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping price for the item been replaced. It does not account for the whole order's shipping price and is presented in cents.\",\"example\":1000},\"measurementUnit\":{\"type\":[\"string\",\"null\"],\"description\":\"Measurement unit of the item been replaced. For example, `kg` for kilograms or `un` for unitary items.\",\"example\":\"kg\"},\"unitMultiplier\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Unit multiplier for item been update.\",\"example\":3},\"sellingPrice\":{\"type\":\"string\",\"description\":\"Selling price of the item been replaced.\",\"example\":100},\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the item been replaced.\",\"example\":\"T-shirt with logo\"},\"detailUrl\":{\"type\":[\"string\",\"null\"],\"description\":\"URL slug of the item been replaced.\",\"example\":\"/tshirt-logo/p\"},\"imageUrl\":{\"type\":[\"string\",\"null\"],\"description\":\"Image URL slug of the item been replaced.\",\"example\":\"http://store.com.br/ids/155419-55-55//tshirt-logo.png?v=6378858562367\"}},\"example\":{\"id\":\"31\",\"quantity\":1,\"price\":null,\"measurementUnit\":null,\"unitMultiplier\":0,\"sellingPrice\":null,\"name\":null,\"detailUrl\":null,\"imageUrl\":null}}},\"shippingData\":{\"title\":\"ShippingData1\",\"required\":[\"logisticsInfo\"],\"type\":\"object\",\"properties\":{\"logisticsInfo\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"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.\"}},\"example\":{\"logisticsInfo\":[]}}},\"example\":{\"paymentData\":{\"transactions\":[]},\"items\":[{\"id\":\"31\",\"quantity\":1,\"price\":null,\"measurementUnit\":null,\"unitMultiplier\":0,\"sellingPrice\":null,\"name\":null,\"detailUrl\":null,\"imageUrl\":null}],\"shippingData\":{\"logisticsInfo\":[]}}},\"to\":{\"title\":\"To1\",\"required\":[\"items\",\"paymentData\",\"receiptData\",\"shippingData\"],\"type\":\"object\",\"properties\":{\"items\":{\"type\":\"array\",\"items\":{\"title\":\"Item3\",\"required\":[\"uniqueId\",\"id\",\"productId\",\"productRefId\",\"refId\",\"ean\",\"name\",\"skuName\",\"modalType\",\"parentItemIndex\",\"parentAssemblyBinding\",\"assemblies\",\"priceValidUntil\",\"tax\",\"price\",\"listPrice\",\"manualPrice\",\"manualPriceAppliedBy\",\"sellingPrice\",\"rewardValue\",\"isGift\",\"additionalInfo\",\"preSaleDate\",\"productCategoryIds\",\"productCategories\",\"quantity\",\"seller\",\"sellerChain\",\"imageUrl\",\"detailUrl\",\"components\",\"bundleItems\",\"attachments\",\"attachmentOfferings\",\"offerings\",\"priceTags\",\"availability\",\"measurementUnit\",\"unitMultiplier\",\"manufacturerCode\",\"priceDefinition\"],\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Item's unique ID in the change order request.\",\"example\":\"40E763F4378E4F40AD1FE915FE1078E1\"},\"id\":{\"type\":\"string\",\"description\":\"SKU ID of the item replacing the previous one.\",\"example\":\"3\"},\"productId\":{\"type\":[\"string\",\"null\"],\"description\":\"Product ID of the item replacing the previous one.\",\"example\":\"7\"},\"productRefId\":{\"type\":[\"string\",\"null\"],\"description\":\"Product Ref ID of the item replacing the previous one.\",\"example\":\"smallcup\"},\"refId\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference ID of the item replacing the previous one.\",\"example\":\"356\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number (EAN) of the item replacing the previous one.\",\"example\":\"8745121641680\"},\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the Product associated with the item replacing the previous one.\",\"example\":\"Small cup of coffee with pink logo\"},\"skuName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the SKU replacing the previous one.\",\"example\":\"Small blue cup\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"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.\",\"example\":\"GLASS\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index of the item replacing the previous one.\",\"example\":0},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding of the item replacing the previous one.\",\"example\":null},\"assemblies\":{\"type\":[\"array\",\"null\"],\"items\":{\"type\":\"string\"},\"description\":\"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\":{\"type\":[\"string\",\"null\"],\"description\":\"Price expiration date of item replacing the previous one. The value is in the format `yyyy-mm-ddThh:mm:ss.sss`.\",\"example\":\"2023-03-01T22:58:28.143\"},\"tax\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Tax in cents of the item replacing the previous one, when applicable.\",\"example\":0},\"price\":{\"type\":[\"string\",\"null\"],\"description\":\"Final price of the item replacing the previous one, calculated in cents.\",\"example\":600},\"listPrice\":{\"type\":[\"string\",\"null\"],\"description\":\"Item's price list for the item replacing the previous one.\",\"example\":600},\"manualPrice\":{\"type\":[\"integer\",\"null\"],\"description\":\"Manual price of the item replacing the previous one. It is calculated in cents.\",\"example\":6500},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User ID or appKey that made the manual price change of the item replacing the previous one.\",\"example\":\"4cc81d44-e42e-464b-8199-1e883bf4ab6b\"},\"sellingPrice\":{\"type\":[\"integer\",\"null\"],\"description\":\"Selling price of the item replacing the previous one. It is calculated in cents.\",\"example\":600},\"rewardValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reward value of the item replacing the previous one. It is calculated in cents.\",\"example\":50},\"isGift\":{\"type\":\"boolean\",\"description\":\"This field is `true` when the replacing item is a gift in the order context and `false` when it is not.\",\"example\":false},\"additionalInfo\":{\"title\":\"AdditionalInfoV2\",\"required\":[\"dimension\",\"brandName\",\"brandId\",\"offeringInfo\",\"offeringType\",\"offeringTypeId\",\"categoriesIds\",\"productClusterId\",\"commercialConditionId\"],\"type\":\"object\",\"properties\":{\"dimension\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing tem's dimensions in the measure unit configured in the catalog.\",\"example\":null},\"brandName\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item's brand name.\",\"example\":\"Special coffee cup\"},\"brandId\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item's brand ID.\",\"example\":\"2000001\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\",\"example\":null},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\",\"example\":null},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\",\"example\":null},\"categoriesIds\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the replacing item product category.\",\"example\":null},\"productClusterId\":{\"type\":[\"string\",\"null\"],\"description\":\"All product clusters related to the replacing item.\",\"example\":\"135,137,143,518,1272\"},\"commercialConditionId\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item commercial conditions ID.\",\"example\":\"5\"}},\"example\":{\"dimension\":null,\"brandName\":null,\"brandId\":null,\"offeringInfo\":null,\"offeringType\":null,\"offeringTypeId\":null,\"categoriesIds\":null,\"productClusterId\":null,\"commercialConditionId\":null}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Pre sale date of the item replacing the previous one.\",\"example\":\"2023-01-01T00:00:00.0000000+00:00\"},\"productCategoryIds\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item's category path composed of category IDs separated by `/`. For example: `/3/15/`.\",\"example\":\"/2/\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object containing product categories of the replacing item. Structure: `{CategoryID}: {CategoryName}`. Both the key and the value are strings.\",\"example\":{\"2\":\"Clothes\"}},\"quantity\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Quantity of replacing items.\",\"example\":1},\"seller\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller ID that identifies the seller the replacing item belongs to.\",\"example\":\"1\"},\"sellerChain\":{\"type\":\"array\",\"items\":{\"type\":[\"string\",\"null\"]},\"description\":\"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\":{\"type\":[\"string\",\"null\"],\"description\":\"Image URL slug of the replacing item.\",\"example\":\"http://store.com.br/ids/155419-55-55//cupcoffee.png?v=6368858582363\"},\"detailUrl\":{\"type\":[\"string\",\"null\"],\"description\":\"URL slug of the replacing item.\",\"example\":\"/cup-coffee/p\"},\"components\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array with information about replacing item's components.\"},\"bundleItems\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array with information about services sold along with the replacing item, such as a gift package.\"},\"attachments\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array containing information on attachments.\"},\"attachmentOfferings\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array with the properties of the content declared in the field `attachments`.\"},\"offerings\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array with replacing items Item's offerings.\"},\"priceTags\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array containing objects with replacing item's price modifiers.\"},\"availability\":{\"type\":[\"string\",\"null\"],\"description\":\"Availability to fulfill the order with the item.\",\"example\":\"available\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Replacing item's measurement unit.\",\"example\":\"un\"},\"unitMultiplier\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Replacing item's unit multiplier.\",\"example\":1},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Provided by the manufacturers to identify their product. This field should be completed if the replacing item has a manufacturer's code.\",\"example\":\"manf-00005\"},\"priceDefinition\":{\"type\":[\"string\",\"null\"],\"description\":\"replacing item's price information.\",\"example\":null}},\"example\":{\"uniqueId\":\"40E763F4378E4F40AD1FE915FE1078E1\",\"id\":\"1\",\"productId\":null,\"productRefId\":null,\"refId\":null,\"ean\":null,\"name\":null,\"skuName\":null,\"modalType\":null,\"parentItemIndex\":null,\"parentAssemblyBinding\":null,\"assemblies\":[],\"priceValidUntil\":null,\"tax\":0,\"price\":null,\"listPrice\":null,\"manualPrice\":null,\"manualPriceAppliedBy\":null,\"sellingPrice\":null,\"rewardValue\":0,\"isGift\":false,\"additionalInfo\":{\"dimension\":null,\"brandName\":null,\"brandId\":null,\"offeringInfo\":null,\"offeringType\":null,\"offeringTypeId\":null,\"categoriesIds\":null,\"productClusterId\":null,\"commercialConditionId\":null},\"preSaleDate\":null,\"productCategoryIds\":null,\"productCategories\":{},\"quantity\":1,\"seller\":null,\"sellerChain\":[null],\"imageUrl\":null,\"detailUrl\":null,\"components\":[],\"bundleItems\":[],\"attachments\":[],\"attachmentOfferings\":[],\"offerings\":[],\"priceTags\":[],\"availability\":null,\"measurementUnit\":\"un\",\"unitMultiplier\":1,\"manufacturerCode\":null,\"priceDefinition\":null}},\"description\":\"Array containing information about the item replacing the previous one.\"},\"paymentData\":{\"title\":\"PaymentDataV2\",\"required\":[\"transactions\"],\"type\":\"object\",\"properties\":{\"transactions\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"example\":null},\"description\":\"Array containing financial information. This is an optional field.\"}},\"example\":{\"transactions\":[]}},\"receiptData\":{\"type\":[\"object\",\"null\"],\"description\":\"Information about the receipt after order change.\",\"example\":null},\"shippingData\":{\"title\":\"ShippingData2\",\"required\":[\"logisticsInfo\"],\"type\":\"object\",\"properties\":{\"logisticsInfo\":{\"type\":\"array\",\"items\":{\"title\":\"LogisticsInfo1\",\"required\":[\"itemIndex\",\"selectedSla\",\"selectedDeliveryChannel\",\"addressId\",\"slas\",\"shipsTo\",\"itemId\",\"deliveryChannels\",\"price\",\"listPrice\",\"shippingEstimate\",\"dockEstimate\",\"shippingEstimateDate\",\"lockTTL\",\"deliveryCompany\",\"polygonName\",\"transitTime\",\"sellingPrice\",\"deliveryIds\",\"deliveryWindow\",\"pickupPointId\",\"pickupStoreInfo\",\"pickupDistance\"],\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Index that identifies the position of the replacing item in the array, starting from `0`.\",\"example\":0},\"selectedSla\":{\"type\":\"string\",\"description\":\"Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the replacing order.\",\"example\":\"Normal\"},\"selectedDeliveryChannel\":{\"type\":\"string\",\"description\":\"Delivery channel selected by the customer, like `delivery` or `pickup-in-point`. This field is being deprecated and the information it retrieves can be usually be found in `deliveryChannel`.\",\"example\":\"delivery\"},\"addressId\":{\"type\":\"string\",\"description\":\"Shipping address ID of the replacing item.\",\"example\":\"9ec276fd3a604eb1aa151b5333ca5db7\"},\"slas\":{\"type\":\"array\",\"items\":{\"title\":\"SlaV2\",\"required\":[\"id\",\"deliveryChannel\",\"name\",\"deliveryIds\",\"shippingEstimate\",\"shippingEstimateDate\",\"lockTTL\",\"availableDeliveryWindows\",\"deliveryWindow\",\"price\",\"listPrice\",\"tax\",\"pickupStoreInfo\",\"pickupPointId\",\"pickupDistance\",\"polygonName\",\"transitTime\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the order delivery or pickup.\",\"example\":\"Normal\"},\"deliveryChannel\":{\"type\":\"string\",\"description\":\"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.\",\"example\":\"delivery\"},\"name\":{\"type\":\"string\",\"description\":\"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.\",\"example\":\"Normal\"},\"deliveryIds\":{\"type\":\"array\",\"items\":{\"title\":\"DeliveryIdV2\",\"required\":[\"courierId\",\"warehouseId\",\"dockId\",\"courierName\",\"quantity\",\"kitItemDetails\",\"accountCarrierName\"],\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).\",\"example\":\"136769c\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).\",\"example\":\"w_156\"},\"dockId\":{\"type\":\"string\",\"description\":\"ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).\",\"example\":\"ld931\"},\"courierName\":{\"type\":\"string\",\"description\":\"Name of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).\",\"example\":\"Crossborder\"},\"quantity\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Quantity of items.\",\"example\":1},\"kitItemDetails\":{\"type\":\"array\",\"items\":{\"type\":[\"string\",\"null\"],\"description\":\"Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), when applicable to the order.\",\"example\":null}},\"accountCarrierName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the account's [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE).\",\"example\":\"vtexlog\"}},\"example\":{\"courierId\":\"1c083bf\",\"warehouseId\":\"1_1\",\"dockId\":\"1\",\"courierName\":\"Donkey\",\"quantity\":1,\"kitItemDetails\":[],\"accountCarrierName\":null}},\"description\":\"Information about delivery IDs.\"},\"shippingEstimate\":{\"type\":[\"string\",\"null\"],\"description\":\"Total shipping duration estimated in days. For instance, three business days is represented as `3bd`.\",\"example\":\"3bd\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.\",\"example\":\"2023-07-27T17:52:18.6483116Z\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"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`.\",\"example\":\"1bd\"},\"availableDeliveryWindows\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Available [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, for when the shipping policy has shipping windows configurations.\"},\"deliveryWindow\":{\"type\":[\"object\",\"null\"],\"description\":\"[Scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.\",\"example\":null},\"price\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Shipping price for the item in cents. Does not account for the whole order's shipping price.\",\"example\":600},\"listPrice\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Item's price list for a specific trade policy.\",\"example\":600},\"tax\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Tax in cents, when applicable.\",\"example\":0},\"pickupStoreInfo\":{\"title\":\"PickupStoreInfoV2\",\"required\":[\"isPickupStore\",\"friendlyName\",\"address\",\"additionalInfo\",\"dockId\"],\"type\":\"object\",\"properties\":{\"isPickupStore\":{\"type\":[\"boolean\",\"null\"],\"description\":\"This field is related to converting a loading dock into a pickup point. It should always correspond to `false` because it has been deprecated.\",\"default\":false,\"deprecated\":true},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the loading dock converted to pickup point to be displayed at checkout. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"address\":{\"type\":[\"string\",\"null\"],\"description\":\"Address of the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information about the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true}},\"deprecated\":true,\"example\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":\"dockAjs28\"}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID is the unique identifier of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) related to the SLA.\",\"example\":\"pup215rkw\"},\"pickupDistance\":{\"type\":[\"number\",\"null\"],\"description\":\"Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.\",\"example\":1},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.\",\"example\":\"114 - Polanco _ H-05\"},\"transitTime\":{\"type\":[\"string\",\"null\"],\"description\":\"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`.\",\"example\":\"3bd\"}},\"example\":{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}},\"description\":\"Information on Service Level Agreement (SLA) of the change order shipping policy.\"},\"shipsTo\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Country name represented in a three letters code ISO 3166 ALPHA-3.\",\"example\":\"BRA\"},\"description\":\"List of countries of the change order shipping address.\"},\"itemId\":{\"type\":\"string\",\"description\":\"Replacing item's SKU ID, which is a unique numerical identifier.\",\"example\":\"3\"},\"deliveryChannels\":{\"type\":\"array\",\"items\":{\"title\":\"DeliveryChannel\",\"required\":[\"id\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Change 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.\",\"example\":\"delivery\"}},\"example\":{\"id\":\"delivery\"}},\"description\":\"Array with the delivery channels associated with the trade policy.\"},\"price\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Replacing item's final price, calculated in cents.\",\"example\":600},\"listPrice\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Replacing item's price list, calculated in cents.\",\"example\":600},\"shippingEstimate\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item's shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.\",\"example\":\"2023-07-29T17:52:18.6483116Z\"},\"dockEstimate\":{\"type\":[\"string\",\"null\"],\"description\":\"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`.\",\"example\":\"1bd\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item's total shipping duration estimated in days. For instance, three business days are represented as `3bd`.\",\"example\":\"3bd\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"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`.\",\"example\":\"1bd\"},\"deliveryCompany\":{\"type\":[\"string\",\"null\"],\"description\":\"[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) company's name.\",\"example\":\"Correios\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.\",\"example\":\"114 - Polanco _ H-05\"},\"transitTime\":{\"type\":[\"string\",\"null\"],\"description\":\"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`.\",\"example\":\"3bd\"},\"sellingPrice\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Change item's selling price.\",\"example\":600},\"deliveryIds\":{\"type\":\"array\",\"items\":{\"title\":\"DeliveryIdV2\",\"required\":[\"courierId\",\"warehouseId\",\"dockId\",\"courierName\",\"quantity\",\"kitItemDetails\",\"accountCarrierName\"],\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).\",\"example\":\"136769c\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).\",\"example\":\"w_156\"},\"dockId\":{\"type\":\"string\",\"description\":\"ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).\",\"example\":\"ld931\"},\"courierName\":{\"type\":\"string\",\"description\":\"Name of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).\",\"example\":\"Crossborder\"},\"quantity\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Quantity of items.\",\"example\":1},\"kitItemDetails\":{\"type\":\"array\",\"items\":{\"type\":[\"string\",\"null\"],\"description\":\"Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), when applicable to the order.\",\"example\":null}},\"accountCarrierName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the account's [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE).\",\"example\":\"vtexlog\"}},\"example\":{\"courierId\":\"1c083bf\",\"warehouseId\":\"1_1\",\"dockId\":\"1\",\"courierName\":\"Donkey\",\"quantity\":1,\"kitItemDetails\":[],\"accountCarrierName\":null}},\"description\":\"Array with delivery information.\"},\"deliveryWindow\":{\"type\":[\"string\",\"null\"],\"description\":\"Change order [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.\",\"example\":null},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\",\"example\":\"pup215rkw\"},\"pickupStoreInfo\":{\"title\":\"PickupStoreInfoV2\",\"required\":[\"isPickupStore\",\"friendlyName\",\"address\",\"additionalInfo\",\"dockId\"],\"type\":\"object\",\"properties\":{\"isPickupStore\":{\"type\":[\"boolean\",\"null\"],\"description\":\"This field is related to converting a loading dock into a pickup point. It should always correspond to `false` because it has been deprecated.\",\"default\":false,\"deprecated\":true},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the loading dock converted to pickup point to be displayed at checkout. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"address\":{\"type\":[\"string\",\"null\"],\"description\":\"Address of the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information about the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true}},\"deprecated\":true,\"example\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":\"dockAjs28\"}},\"pickupDistance\":{\"type\":[\"number\",\"null\"],\"description\":\"Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.\",\"example\":\"1.0\"}},\"example\":{\"itemIndex\":0,\"selectedSla\":\"Lenta\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"slas\":[{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}],\"shipsTo\":[],\"itemId\":\"1\",\"deliveryChannels\":[],\"price\":600,\"listPrice\":600,\"shippingEstimate\":null,\"dockEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"deliveryCompany\":null,\"polygonName\":null,\"transitTime\":null,\"sellingPrice\":600,\"deliveryIds\":[],\"deliveryWindow\":null,\"pickupPointId\":null,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupDistance\":null}},\"description\":\"Array with shipping information.\"}},\"example\":{\"logisticsInfo\":[{\"itemIndex\":0,\"selectedSla\":\"Lenta\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"slas\":[{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}],\"shipsTo\":[],\"itemId\":\"1\",\"deliveryChannels\":[],\"price\":600,\"listPrice\":600,\"shippingEstimate\":null,\"dockEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"deliveryCompany\":null,\"polygonName\":null,\"transitTime\":null,\"sellingPrice\":600,\"deliveryIds\":[],\"deliveryWindow\":null,\"pickupPointId\":null,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupDistance\":null}]}}},\"example\":{\"items\":[{\"uniqueId\":\"40E763F4378E4F40AD1FE915FE1078E1\",\"id\":\"1\",\"productId\":null,\"productRefId\":null,\"refId\":null,\"ean\":null,\"name\":null,\"skuName\":null,\"modalType\":null,\"parentItemIndex\":null,\"parentAssemblyBinding\":null,\"assemblies\":[],\"priceValidUntil\":null,\"tax\":0,\"price\":null,\"listPrice\":null,\"manualPrice\":null,\"manualPriceAppliedBy\":null,\"sellingPrice\":null,\"rewardValue\":0,\"isGift\":false,\"additionalInfo\":{\"dimension\":null,\"brandName\":null,\"brandId\":null,\"offeringInfo\":null,\"offeringType\":null,\"offeringTypeId\":null,\"categoriesIds\":null,\"productClusterId\":null,\"commercialConditionId\":null},\"preSaleDate\":null,\"productCategoryIds\":null,\"productCategories\":{},\"quantity\":1,\"seller\":null,\"sellerChain\":[null],\"imageUrl\":null,\"detailUrl\":null,\"components\":[],\"bundleItems\":[],\"attachments\":[],\"attachmentOfferings\":[],\"offerings\":[],\"priceTags\":[],\"availability\":null,\"measurementUnit\":\"un\",\"unitMultiplier\":1,\"manufacturerCode\":null,\"priceDefinition\":null}],\"paymentData\":{\"transactions\":[]},\"receiptData\":null,\"shippingData\":{\"logisticsInfo\":[{\"itemIndex\":0,\"selectedSla\":\"Lenta\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"slas\":[{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}],\"shipsTo\":[],\"itemId\":\"1\",\"deliveryChannels\":[],\"price\":600,\"listPrice\":600,\"shippingEstimate\":null,\"dockEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"deliveryCompany\":null,\"polygonName\":null,\"transitTime\":null,\"sellingPrice\":600,\"deliveryIds\":[],\"deliveryWindow\":null,\"pickupPointId\":null,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupDistance\":null}]}}}},\"example\":{\"from\":{\"paymentData\":{\"transactions\":[]},\"items\":[{\"id\":\"31\",\"quantity\":1,\"price\":null,\"measurementUnit\":null,\"unitMultiplier\":0,\"sellingPrice\":null,\"name\":null,\"detailUrl\":null,\"imageUrl\":null}],\"shippingData\":{\"logisticsInfo\":[]}},\"to\":{\"items\":[{\"uniqueId\":\"40E763F4378E4F40AD1FE915FE1078E1\",\"id\":\"1\",\"productId\":null,\"productRefId\":null,\"refId\":null,\"ean\":null,\"name\":null,\"skuName\":null,\"modalType\":null,\"parentItemIndex\":null,\"parentAssemblyBinding\":null,\"assemblies\":[],\"priceValidUntil\":null,\"tax\":0,\"price\":null,\"listPrice\":null,\"manualPrice\":null,\"manualPriceAppliedBy\":null,\"sellingPrice\":null,\"rewardValue\":0,\"isGift\":false,\"additionalInfo\":{\"dimension\":null,\"brandName\":null,\"brandId\":null,\"offeringInfo\":null,\"offeringType\":null,\"offeringTypeId\":null,\"categoriesIds\":null,\"productClusterId\":null,\"commercialConditionId\":null},\"preSaleDate\":null,\"productCategoryIds\":null,\"productCategories\":{},\"quantity\":1,\"seller\":null,\"sellerChain\":[null],\"imageUrl\":null,\"detailUrl\":null,\"components\":[],\"bundleItems\":[],\"attachments\":[],\"attachmentOfferings\":[],\"offerings\":[],\"priceTags\":[],\"availability\":null,\"measurementUnit\":\"un\",\"unitMultiplier\":1,\"manufacturerCode\":null,\"priceDefinition\":null}],\"paymentData\":{\"transactions\":[]},\"receiptData\":null,\"shippingData\":{\"logisticsInfo\":[{\"itemIndex\":0,\"selectedSla\":\"Lenta\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"slas\":[{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}],\"shipsTo\":[],\"itemId\":\"1\",\"deliveryChannels\":[],\"price\":600,\"listPrice\":600,\"shippingEstimate\":null,\"dockEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"deliveryCompany\":null,\"polygonName\":null,\"transitTime\":null,\"sellingPrice\":600,\"deliveryIds\":[],\"deliveryWindow\":null,\"pickupPointId\":null,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupDistance\":null}]}}}},\"description\":\"Array with information about the `replace` operation, when applicable.\"},\"date\":{\"type\":\"string\",\"description\":\"Date and time of the request. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.\",\"example\":\"2023-07-27T17:52:18.6483116Z\"},\"origin\":{\"title\":\"OriginV2\",\"required\":[\"account\",\"orderId\",\"component\"],\"type\":\"object\",\"properties\":{\"account\":{\"type\":\"string\",\"description\":\"Name of the account where the order was made.\",\"example\":\"qastore\"},\"orderId\":{\"type\":\"string\",\"description\":\"Order ID is a unique code that identifies an order.\",\"example\":\"v12772213qst-02\"},\"component\":{\"type\":\"string\",\"description\":\"Component information.\",\"example\":\"MarketplaceComponent\"}},\"description\":\"Object containing information about the order origin.\",\"example\":{\"account\":\"qastore\",\"orderId\":\"v12772213qst-02\",\"component\":\"MarketplaceComponent\"}},\"settings\":{\"title\":\"Settings\",\"required\":[\"customPaymentSystemsAllowed\"],\"type\":\"object\",\"properties\":{\"customPaymentSystemsAllowed\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"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.\",\"example\":[]}},\"example\":{\"customPaymentSystemsAllowed\":[]}}},\"example\":{\"requestId\":\"e8532a32-7f7e-434a-88ec-29609f0ede46\",\"workflowId\":\"74f40e7a-68c6-4699-b874-a8a297fb3f6a\",\"status\":\"handling\",\"inProgress\":true,\"reason\":\"The client wants to change the items weight.\",\"manualDiscountValue\":0,\"manualIncrementValue\":0,\"totalChangeValue\":0,\"totals\":[],\"add\":null,\"remove\":null,\"replace\":[{\"from\":{\"paymentData\":{\"transactions\":[]},\"items\":[{\"id\":\"31\",\"quantity\":1,\"price\":null,\"measurementUnit\":null,\"unitMultiplier\":0,\"sellingPrice\":null,\"name\":null,\"detailUrl\":null,\"imageUrl\":null}],\"shippingData\":{\"logisticsInfo\":[]}},\"to\":{\"items\":[{\"uniqueId\":\"40E763F4378E4F40AD1FE915FE1078E1\",\"id\":\"1\",\"productId\":null,\"productRefId\":null,\"refId\":null,\"ean\":null,\"name\":null,\"skuName\":null,\"modalType\":null,\"parentItemIndex\":null,\"parentAssemblyBinding\":null,\"assemblies\":[],\"priceValidUntil\":null,\"tax\":0,\"price\":null,\"listPrice\":null,\"manualPrice\":null,\"manualPriceAppliedBy\":null,\"sellingPrice\":null,\"rewardValue\":0,\"isGift\":false,\"additionalInfo\":{\"dimension\":null,\"brandName\":null,\"brandId\":null,\"offeringInfo\":null,\"offeringType\":null,\"offeringTypeId\":null,\"categoriesIds\":null,\"productClusterId\":null,\"commercialConditionId\":null},\"preSaleDate\":null,\"productCategoryIds\":null,\"productCategories\":{},\"quantity\":1,\"seller\":null,\"sellerChain\":[null],\"imageUrl\":null,\"detailUrl\":null,\"components\":[],\"bundleItems\":[],\"attachments\":[],\"attachmentOfferings\":[],\"offerings\":[],\"priceTags\":[],\"availability\":null,\"measurementUnit\":\"un\",\"unitMultiplier\":1,\"manufacturerCode\":null,\"priceDefinition\":null}],\"paymentData\":{\"transactions\":[]},\"receiptData\":null,\"shippingData\":{\"logisticsInfo\":[{\"itemIndex\":0,\"selectedSla\":\"Lenta\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"slas\":[{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}],\"shipsTo\":[],\"itemId\":\"1\",\"deliveryChannels\":[],\"price\":600,\"listPrice\":600,\"shippingEstimate\":null,\"dockEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"deliveryCompany\":null,\"polygonName\":null,\"transitTime\":null,\"sellingPrice\":600,\"deliveryIds\":[],\"deliveryWindow\":null,\"pickupPointId\":null,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupDistance\":null}]}}}],\"date\":\"2023-07-27T17:52:18.6483116Z\",\"origin\":{\"account\":\"qastore\",\"orderId\":\"v12772213qst-02\",\"component\":\"MarketplaceComponent\"},\"settings\":{\"customPaymentSystemsAllowed\":[]}}},{\"example\":{\"requests\":[{\"requestId\":\"e8532a32-7f7e-434a-88ec-29609f0ede46\",\"workflowId\":\"74f40e7a-68c6-4699-b874-a8a297fb3f6a\",\"reason\":\"The client did not like the size.\",\"manualDiscountValue\":0,\"manualIncrementValue\":0,\"totalChangeValue\":0,\"totals\":[],\"add\":null,\"remove\":null,\"replace\":[{\"from\":{\"paymentData\":{\"transactions\":[]},\"items\":[{\"id\":\"31\",\"quantity\":1,\"price\":5000,\"measurementUnit\":\"un\",\"unitMultiplier\":1,\"sellingPrice\":5000,\"name\":\"Fusca miniatura Fusca preto\",\"detailUrl\":\"/fusca-miniatura-24/p\",\"imageUrl\":\"http://qastore.vteximg.com.br/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000\"}],\"shippingData\":{\"logisticsInfo\":[{\"itemIndex\":0,\"selectedSla\":\"Lenta\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"slas\":[{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[{\"courierId\":\"1c083bf\",\"warehouseId\":\"1_1\",\"dockId\":\"1\",\"courierName\":\"Donkey\",\"quantity\":1,\"kitItemDetails\":[],\"accountCarrierName\":null}],\"shippingEstimate\":\"25bd\",\"shippingEstimateDate\":\"2023-08-30T10:17:24.6436519Z\",\"lockTTL\":\"12d\",\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":180,\"listPrice\":180,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":\"\",\"transitTime\":\"25bd\"},{\"id\":\"Normal\",\"deliveryChannel\":\"delivery\",\"name\":\"Normal\",\"deliveryIds\":[{\"courierId\":\"1\",\"warehouseId\":\"1_1\",\"dockId\":\"1\",\"courierName\":\"Transportadora\",\"quantity\":1,\"kitItemDetails\":[],\"accountCarrierName\":null}],\"shippingEstimate\":\"3bd\",\"shippingEstimateDate\":null,\"lockTTL\":\"12d\",\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":500,\"listPrice\":500,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":\"\",\"transitTime\":\"3bd\"},{\"id\":\"Pickup\",\"deliveryChannel\":\"delivery\",\"name\":\"Pickup\",\"deliveryIds\":[{\"courierId\":\"ech018654\",\"warehouseId\":\"1_1\",\"dockId\":\"1\",\"courierName\":\"Retirada\",\"quantity\":1,\"kitItemDetails\":[],\"accountCarrierName\":null}],\"shippingEstimate\":\"25bd\",\"shippingEstimateDate\":null,\"lockTTL\":\"12d\",\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":700,\"listPrice\":700,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":\"\",\"transitTime\":\"25bd\"}],\"shipsTo\":[\"BRA\"],\"itemId\":\"31\",\"deliveryChannels\":[{\"id\":\"delivery\"}],\"price\":180,\"listPrice\":180,\"shippingEstimate\":\"25bd\",\"dockEstimate\":null,\"shippingEstimateDate\":\"2023-08-30T10:17:24.6436519Z\",\"lockTTL\":\"12d\",\"deliveryCompany\":null,\"polygonName\":\"\",\"transitTime\":\"25bd\",\"sellingPrice\":180,\"deliveryIds\":[{\"courierId\":\"1c083bf\",\"warehouseId\":\"1_1\",\"dockId\":\"1\",\"courierName\":\"Donkey\",\"quantity\":1,\"kitItemDetails\":null,\"accountCarrierName\":\"qastoreecho\"}],\"deliveryWindow\":null,\"pickupPointId\":null,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupDistance\":null}]}},\"to\":{\"items\":[{\"uniqueId\":\"40E763F4378E4F40AD1FE915FE1078E1\",\"id\":\"1\",\"productId\":\"1\",\"productRefId\":\"\",\"refId\":\"codrefxicaraazul\",\"ean\":\"8745121641\",\"name\":\"xícara azul\",\"skuName\":\"azul\",\"modalType\":null,\"parentItemIndex\":null,\"parentAssemblyBinding\":null,\"assemblies\":[],\"priceValidUntil\":null,\"tax\":0,\"price\":5000,\"listPrice\":null,\"manualPrice\":null,\"manualPriceAppliedBy\":null,\"sellingPrice\":5000,\"rewardValue\":0,\"isGift\":false,\"additionalInfo\":{\"dimension\":null,\"brandName\":null,\"brandId\":null,\"offeringInfo\":null,\"offeringType\":null,\"offeringTypeId\":null,\"categoriesIds\":null,\"productClusterId\":null,\"commercialConditionId\":null},\"preSaleDate\":null,\"productCategoryIds\":\"/1/\",\"productCategories\":{\"1\":\"Category\"},\"quantity\":1,\"seller\":\"1\",\"sellerChain\":[\"1\"],\"imageUrl\":\"http://qastore.vteximg.com.br/arquivos/ids/155394-55-55/xicara.jpg?v=636565506415770000\",\"detailUrl\":\"/xicara/p\",\"components\":[],\"bundleItems\":[],\"attachments\":[],\"attachmentOfferings\":[],\"offerings\":[],\"priceTags\":[],\"availability\":null,\"measurementUnit\":\"un\",\"unitMultiplier\":1,\"manufacturerCode\":null,\"priceDefinition\":{\"calculatedSellingPrice\":5000,\"total\":5000,\"sellingPrices\":[{\"value\":5000,\"quantity\":1}]}}],\"paymentData\":{\"transactions\":[]},\"receiptData\":null,\"shippingData\":{\"logisticsInfo\":[{\"itemIndex\":0,\"selectedSla\":\"Lenta\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"slas\":[{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[{\"courierId\":\"1c083bf\",\"warehouseId\":\"1_1\",\"dockId\":\"1\",\"courierName\":\"Donkey\",\"quantity\":1,\"kitItemDetails\":[],\"accountCarrierName\":null}],\"shippingEstimate\":\"25bd\",\"shippingEstimateDate\":\"2023-08-30T10:17:24.6436519Z\",\"lockTTL\":\"12d\",\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":180,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":\"\",\"transitTime\":\"25bd\"},{\"id\":\"Normal\",\"deliveryChannel\":\"delivery\",\"name\":\"Normal\",\"deliveryIds\":[{\"courierId\":\"1\",\"warehouseId\":\"1_1\",\"dockId\":\"1\",\"courierName\":\"Transportadora\",\"quantity\":1,\"kitItemDetails\":[],\"accountCarrierName\":null}],\"shippingEstimate\":\"3bd\",\"shippingEstimateDate\":null,\"lockTTL\":\"12d\",\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":500,\"listPrice\":500,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":\"\",\"transitTime\":\"3bd\"},{\"id\":\"Pickup\",\"deliveryChannel\":\"delivery\",\"name\":\"Pickup\",\"deliveryIds\":[{\"courierId\":\"ech018654\",\"warehouseId\":\"1_1\",\"dockId\":\"1\",\"courierName\":\"Retirada\",\"quantity\":1,\"kitItemDetails\":[],\"accountCarrierName\":null}],\"shippingEstimate\":\"25bd\",\"shippingEstimateDate\":null,\"lockTTL\":\"12d\",\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":700,\"listPrice\":700,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":\"\",\"transitTime\":\"25bd\"}],\"shipsTo\":[\"BRA\"],\"itemId\":\"1\",\"deliveryChannels\":[{\"id\":\"delivery\"}],\"price\":600,\"listPrice\":180,\"shippingEstimate\":\"25bd\",\"dockEstimate\":null,\"shippingEstimateDate\":\"2023-08-30T10:17:24.6436519Z\",\"lockTTL\":\"12d\",\"deliveryCompany\":null,\"polygonName\":\"\",\"transitTime\":\"25bd\",\"sellingPrice\":600,\"deliveryIds\":[{\"courierId\":\"1c083bf\",\"warehouseId\":\"1_1\",\"dockId\":\"1\",\"courierName\":\"Donkey\",\"quantity\":1,\"kitItemDetails\":null,\"accountCarrierName\":\"qastoreecho\"}],\"deliveryWindow\":null,\"pickupPointId\":null,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupDistance\":null}]}}}],\"date\":\"2023-07-27T17:52:18.6483116Z\",\"origin\":{\"account\":\"qastore\",\"orderId\":\"v12772213qst-02\",\"component\":\"MarketplaceComponent\"},\"settings\":{\"customPaymentSystemsAllowed\":[]}}],\"actions\":[]}}]}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/order-system/orders/:changeOrderId/changes/:changeRequestId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"allOf\":[{\"title\":\"GetChangeDetailbyschlee\",\"required\":[\"requestId\",\"workflowId\",\"status\",\"inProgress\",\"reason\",\"manualDiscountValue\",\"manualIncrementValue\",\"totalChangeValue\",\"totals\",\"add\",\"remove\",\"replace\",\"date\",\"origin\",\"settings\"],\"type\":\"object\",\"properties\":{\"requestId\":{\"type\":\"string\",\"description\":\"Unique code that identifies a change order request.\",\"example\":\"e8532a32-7f7e-434a-88ec-29609f0ede46\"},\"workflowId\":{\"type\":\"string\",\"description\":\"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).\",\"example\":\"74f40e7a-68c6-4699-b874-a8a297fb3f6a\"},\"status\":{\"type\":\"string\",\"description\":\"Order status in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196).\",\"example\":\"handling\"},\"inProgress\":{\"type\":\"boolean\",\"description\":\"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 shopper received it.\",\"example\":true},\"reason\":{\"type\":\"string\",\"description\":\"Reason that motivated the order change.\",\"example\":\"The client wants to change the items weight.\"},\"manualDiscountValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"This field shows if a manual price was applied to the total order amount. The value is in cents.\",\"example\":0},\"manualIncrementValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"This field shows if an increment value was applied to the total order amount. The value is in cents.\",\"example\":0},\"totalChangeValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"This field shows how much is the order total price considering that price changes might have been made. The value is in cents.\",\"example\":0},\"totals\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array containing information about change prices per item.\",\"example\":null},\"add\":{\"type\":\"array\",\"description\":\"Array with information about the `add` operation, when applicable. The schema will correspond to the object `to` inside the `replace` array.\",\"example\":null},\"remove\":{\"type\":\"array\",\"description\":\"Array with information about the `remove` operation, when applicable. The schema will correspond to the object `from` inside the `replace` array.\",\"example\":null},\"replace\":{\"type\":\"array\",\"items\":{\"title\":\"Replace1\",\"required\":[\"from\",\"to\"],\"type\":\"object\",\"properties\":{\"from\":{\"title\":\"From1\",\"required\":[\"paymentData\",\"items\",\"shippingData\"],\"type\":\"object\",\"properties\":{\"paymentData\":{\"title\":\"PaymentDataV2\",\"required\":[\"transactions\"],\"type\":\"object\",\"properties\":{\"transactions\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"example\":null},\"description\":\"Array containing financial information. This is an optional field.\"}},\"example\":{\"transactions\":[]}},\"items\":{\"type\":\"array\",\"items\":{\"title\":\"Item2V2\",\"required\":[\"id\",\"quantity\",\"price\",\"measurementUnit\",\"unitMultiplier\",\"sellingPrice\",\"name\",\"detailUrl\",\"imageUrl\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SKU ID of the item been replaced.\",\"example\":\"1\"},\"quantity\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Quantity of items been replaced.\",\"example\":1},\"price\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping price for the item been replaced. It does not account for the whole order's shipping price and is presented in cents.\",\"example\":1000},\"measurementUnit\":{\"type\":[\"string\",\"null\"],\"description\":\"Measurement unit of the item been replaced. For example, `kg` for kilograms or `un` for unitary items.\",\"example\":\"kg\"},\"unitMultiplier\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Unit multiplier for item been update.\",\"example\":3},\"sellingPrice\":{\"type\":\"string\",\"description\":\"Selling price of the item been replaced.\",\"example\":100},\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the item been replaced.\",\"example\":\"T-shirt with logo\"},\"detailUrl\":{\"type\":[\"string\",\"null\"],\"description\":\"URL slug of the item been replaced.\",\"example\":\"/tshirt-logo/p\"},\"imageUrl\":{\"type\":[\"string\",\"null\"],\"description\":\"Image URL slug of the item been replaced.\",\"example\":\"http://store.com.br/ids/155419-55-55//tshirt-logo.png?v=6378858562367\"}},\"example\":{\"id\":\"31\",\"quantity\":1,\"price\":null,\"measurementUnit\":null,\"unitMultiplier\":0,\"sellingPrice\":null,\"name\":null,\"detailUrl\":null,\"imageUrl\":null}}},\"shippingData\":{\"title\":\"ShippingData1\",\"required\":[\"logisticsInfo\"],\"type\":\"object\",\"properties\":{\"logisticsInfo\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"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.\"}},\"example\":{\"logisticsInfo\":[]}}},\"example\":{\"paymentData\":{\"transactions\":[]},\"items\":[{\"id\":\"31\",\"quantity\":1,\"price\":null,\"measurementUnit\":null,\"unitMultiplier\":0,\"sellingPrice\":null,\"name\":null,\"detailUrl\":null,\"imageUrl\":null}],\"shippingData\":{\"logisticsInfo\":[]}}},\"to\":{\"title\":\"To1\",\"required\":[\"items\",\"paymentData\",\"receiptData\",\"shippingData\"],\"type\":\"object\",\"properties\":{\"items\":{\"type\":\"array\",\"items\":{\"title\":\"Item3\",\"required\":[\"uniqueId\",\"id\",\"productId\",\"productRefId\",\"refId\",\"ean\",\"name\",\"skuName\",\"modalType\",\"parentItemIndex\",\"parentAssemblyBinding\",\"assemblies\",\"priceValidUntil\",\"tax\",\"price\",\"listPrice\",\"manualPrice\",\"manualPriceAppliedBy\",\"sellingPrice\",\"rewardValue\",\"isGift\",\"additionalInfo\",\"preSaleDate\",\"productCategoryIds\",\"productCategories\",\"quantity\",\"seller\",\"sellerChain\",\"imageUrl\",\"detailUrl\",\"components\",\"bundleItems\",\"attachments\",\"attachmentOfferings\",\"offerings\",\"priceTags\",\"availability\",\"measurementUnit\",\"unitMultiplier\",\"manufacturerCode\",\"priceDefinition\"],\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Item's unique ID in the change order request.\",\"example\":\"40E763F4378E4F40AD1FE915FE1078E1\"},\"id\":{\"type\":\"string\",\"description\":\"SKU ID of the item replacing the previous one.\",\"example\":\"3\"},\"productId\":{\"type\":[\"string\",\"null\"],\"description\":\"Product ID of the item replacing the previous one.\",\"example\":\"7\"},\"productRefId\":{\"type\":[\"string\",\"null\"],\"description\":\"Product Ref ID of the item replacing the previous one.\",\"example\":\"smallcup\"},\"refId\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference ID of the item replacing the previous one.\",\"example\":\"356\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number (EAN) of the item replacing the previous one.\",\"example\":\"8745121641680\"},\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the Product associated with the item replacing the previous one.\",\"example\":\"Small cup of coffee with pink logo\"},\"skuName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the SKU replacing the previous one.\",\"example\":\"Small blue cup\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"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.\",\"example\":\"GLASS\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index of the item replacing the previous one.\",\"example\":0},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding of the item replacing the previous one.\",\"example\":null},\"assemblies\":{\"type\":[\"array\",\"null\"],\"items\":{\"type\":\"string\"},\"description\":\"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\":{\"type\":[\"string\",\"null\"],\"description\":\"Price expiration date of item replacing the previous one. The value is in the format `yyyy-mm-ddThh:mm:ss.sss`.\",\"example\":\"2023-03-01T22:58:28.143\"},\"tax\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Tax in cents of the item replacing the previous one, when applicable.\",\"example\":0},\"price\":{\"type\":[\"string\",\"null\"],\"description\":\"Final price of the item replacing the previous one, calculated in cents.\",\"example\":600},\"listPrice\":{\"type\":[\"string\",\"null\"],\"description\":\"Item's price list for the item replacing the previous one.\",\"example\":600},\"manualPrice\":{\"type\":[\"integer\",\"null\"],\"description\":\"Manual price of the item replacing the previous one. It is calculated in cents.\",\"example\":6500},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User ID or appKey that made the manual price change of the item replacing the previous one.\",\"example\":\"4cc81d44-e42e-464b-8199-1e883bf4ab6b\"},\"sellingPrice\":{\"type\":[\"integer\",\"null\"],\"description\":\"Selling price of the item replacing the previous one. It is calculated in cents.\",\"example\":600},\"rewardValue\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Reward value of the item replacing the previous one. It is calculated in cents.\",\"example\":50},\"isGift\":{\"type\":\"boolean\",\"description\":\"This field is `true` when the replacing item is a gift in the order context and `false` when it is not.\",\"example\":false},\"additionalInfo\":{\"title\":\"AdditionalInfoV2\",\"required\":[\"dimension\",\"brandName\",\"brandId\",\"offeringInfo\",\"offeringType\",\"offeringTypeId\",\"categoriesIds\",\"productClusterId\",\"commercialConditionId\"],\"type\":\"object\",\"properties\":{\"dimension\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing tem's dimensions in the measure unit configured in the catalog.\",\"example\":null},\"brandName\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item's brand name.\",\"example\":\"Special coffee cup\"},\"brandId\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item's brand ID.\",\"example\":\"2000001\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\",\"example\":null},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\",\"example\":null},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\",\"example\":null},\"categoriesIds\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the replacing item product category.\",\"example\":null},\"productClusterId\":{\"type\":[\"string\",\"null\"],\"description\":\"All product clusters related to the replacing item.\",\"example\":\"135,137,143,518,1272\"},\"commercialConditionId\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item commercial conditions ID.\",\"example\":\"5\"}},\"example\":{\"dimension\":null,\"brandName\":null,\"brandId\":null,\"offeringInfo\":null,\"offeringType\":null,\"offeringTypeId\":null,\"categoriesIds\":null,\"productClusterId\":null,\"commercialConditionId\":null}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Pre sale date of the item replacing the previous one.\",\"example\":\"2023-01-01T00:00:00.0000000+00:00\"},\"productCategoryIds\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item's category path composed of category IDs separated by `/`. For example: `/3/15/`.\",\"example\":\"/2/\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object containing product categories of the replacing item. Structure: `{CategoryID}: {CategoryName}`. Both the key and the value are strings.\",\"example\":{\"2\":\"Clothes\"}},\"quantity\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Quantity of replacing items.\",\"example\":1},\"seller\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller ID that identifies the seller the replacing item belongs to.\",\"example\":\"1\"},\"sellerChain\":{\"type\":\"array\",\"items\":{\"type\":[\"string\",\"null\"]},\"description\":\"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\":{\"type\":[\"string\",\"null\"],\"description\":\"Image URL slug of the replacing item.\",\"example\":\"http://store.com.br/ids/155419-55-55//cupcoffee.png?v=6368858582363\"},\"detailUrl\":{\"type\":[\"string\",\"null\"],\"description\":\"URL slug of the replacing item.\",\"example\":\"/cup-coffee/p\"},\"components\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array with information about replacing item's components.\"},\"bundleItems\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array with information about services sold along with the replacing item, such as a gift package.\"},\"attachments\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array containing information on attachments.\"},\"attachmentOfferings\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array with the properties of the content declared in the field `attachments`.\"},\"offerings\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array with replacing items Item's offerings.\"},\"priceTags\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Array containing objects with replacing item's price modifiers.\"},\"availability\":{\"type\":[\"string\",\"null\"],\"description\":\"Availability to fulfill the order with the item.\",\"example\":\"available\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Replacing item's measurement unit.\",\"example\":\"un\"},\"unitMultiplier\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Replacing item's unit multiplier.\",\"example\":1},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Provided by the manufacturers to identify their product. This field should be completed if the replacing item has a manufacturer's code.\",\"example\":\"manf-00005\"},\"priceDefinition\":{\"type\":[\"string\",\"null\"],\"description\":\"replacing item's price information.\",\"example\":null}},\"example\":{\"uniqueId\":\"40E763F4378E4F40AD1FE915FE1078E1\",\"id\":\"1\",\"productId\":null,\"productRefId\":null,\"refId\":null,\"ean\":null,\"name\":null,\"skuName\":null,\"modalType\":null,\"parentItemIndex\":null,\"parentAssemblyBinding\":null,\"assemblies\":[],\"priceValidUntil\":null,\"tax\":0,\"price\":null,\"listPrice\":null,\"manualPrice\":null,\"manualPriceAppliedBy\":null,\"sellingPrice\":null,\"rewardValue\":0,\"isGift\":false,\"additionalInfo\":{\"dimension\":null,\"brandName\":null,\"brandId\":null,\"offeringInfo\":null,\"offeringType\":null,\"offeringTypeId\":null,\"categoriesIds\":null,\"productClusterId\":null,\"commercialConditionId\":null},\"preSaleDate\":null,\"productCategoryIds\":null,\"productCategories\":{},\"quantity\":1,\"seller\":null,\"sellerChain\":[null],\"imageUrl\":null,\"detailUrl\":null,\"components\":[],\"bundleItems\":[],\"attachments\":[],\"attachmentOfferings\":[],\"offerings\":[],\"priceTags\":[],\"availability\":null,\"measurementUnit\":\"un\",\"unitMultiplier\":1,\"manufacturerCode\":null,\"priceDefinition\":null}},\"description\":\"Array containing information about the item replacing the previous one.\"},\"paymentData\":{\"title\":\"PaymentDataV2\",\"required\":[\"transactions\"],\"type\":\"object\",\"properties\":{\"transactions\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"example\":null},\"description\":\"Array containing financial information. This is an optional field.\"}},\"example\":{\"transactions\":[]}},\"receiptData\":{\"type\":[\"object\",\"null\"],\"description\":\"Information about the receipt after order change.\",\"example\":null},\"shippingData\":{\"title\":\"ShippingData2\",\"required\":[\"logisticsInfo\"],\"type\":\"object\",\"properties\":{\"logisticsInfo\":{\"type\":\"array\",\"items\":{\"title\":\"LogisticsInfo1\",\"required\":[\"itemIndex\",\"selectedSla\",\"selectedDeliveryChannel\",\"addressId\",\"slas\",\"shipsTo\",\"itemId\",\"deliveryChannels\",\"price\",\"listPrice\",\"shippingEstimate\",\"dockEstimate\",\"shippingEstimateDate\",\"lockTTL\",\"deliveryCompany\",\"polygonName\",\"transitTime\",\"sellingPrice\",\"deliveryIds\",\"deliveryWindow\",\"pickupPointId\",\"pickupStoreInfo\",\"pickupDistance\"],\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Index that identifies the position of the replacing item in the array, starting from `0`.\",\"example\":0},\"selectedSla\":{\"type\":\"string\",\"description\":\"Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the replacing order.\",\"example\":\"Normal\"},\"selectedDeliveryChannel\":{\"type\":\"string\",\"description\":\"Delivery channel selected by the customer, like `delivery` or `pickup-in-point`. This field is being deprecated and the information it retrieves can be usually be found in `deliveryChannel`.\",\"example\":\"delivery\"},\"addressId\":{\"type\":\"string\",\"description\":\"Shipping address ID of the replacing item.\",\"example\":\"9ec276fd3a604eb1aa151b5333ca5db7\"},\"slas\":{\"type\":\"array\",\"items\":{\"title\":\"SlaV2\",\"required\":[\"id\",\"deliveryChannel\",\"name\",\"deliveryIds\",\"shippingEstimate\",\"shippingEstimateDate\",\"lockTTL\",\"availableDeliveryWindows\",\"deliveryWindow\",\"price\",\"listPrice\",\"tax\",\"pickupStoreInfo\",\"pickupPointId\",\"pickupDistance\",\"polygonName\",\"transitTime\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the order delivery or pickup.\",\"example\":\"Normal\"},\"deliveryChannel\":{\"type\":\"string\",\"description\":\"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.\",\"example\":\"delivery\"},\"name\":{\"type\":\"string\",\"description\":\"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.\",\"example\":\"Normal\"},\"deliveryIds\":{\"type\":\"array\",\"items\":{\"title\":\"DeliveryIdV2\",\"required\":[\"courierId\",\"warehouseId\",\"dockId\",\"courierName\",\"quantity\",\"kitItemDetails\",\"accountCarrierName\"],\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).\",\"example\":\"136769c\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).\",\"example\":\"w_156\"},\"dockId\":{\"type\":\"string\",\"description\":\"ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).\",\"example\":\"ld931\"},\"courierName\":{\"type\":\"string\",\"description\":\"Name of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).\",\"example\":\"Crossborder\"},\"quantity\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Quantity of items.\",\"example\":1},\"kitItemDetails\":{\"type\":\"array\",\"items\":{\"type\":[\"string\",\"null\"],\"description\":\"Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), when applicable to the order.\",\"example\":null}},\"accountCarrierName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the account's [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE).\",\"example\":\"vtexlog\"}},\"example\":{\"courierId\":\"1c083bf\",\"warehouseId\":\"1_1\",\"dockId\":\"1\",\"courierName\":\"Donkey\",\"quantity\":1,\"kitItemDetails\":[],\"accountCarrierName\":null}},\"description\":\"Information about delivery IDs.\"},\"shippingEstimate\":{\"type\":[\"string\",\"null\"],\"description\":\"Total shipping duration estimated in days. For instance, three business days is represented as `3bd`.\",\"example\":\"3bd\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.\",\"example\":\"2023-07-27T17:52:18.6483116Z\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"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`.\",\"example\":\"1bd\"},\"availableDeliveryWindows\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Available [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, for when the shipping policy has shipping windows configurations.\"},\"deliveryWindow\":{\"type\":[\"object\",\"null\"],\"description\":\"[Scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.\",\"example\":null},\"price\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Shipping price for the item in cents. Does not account for the whole order's shipping price.\",\"example\":600},\"listPrice\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Item's price list for a specific trade policy.\",\"example\":600},\"tax\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Tax in cents, when applicable.\",\"example\":0},\"pickupStoreInfo\":{\"title\":\"PickupStoreInfoV2\",\"required\":[\"isPickupStore\",\"friendlyName\",\"address\",\"additionalInfo\",\"dockId\"],\"type\":\"object\",\"properties\":{\"isPickupStore\":{\"type\":[\"boolean\",\"null\"],\"description\":\"This field is related to converting a loading dock into a pickup point. It should always correspond to `false` because it has been deprecated.\",\"default\":false,\"deprecated\":true},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the loading dock converted to pickup point to be displayed at checkout. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"address\":{\"type\":[\"string\",\"null\"],\"description\":\"Address of the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information about the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true}},\"deprecated\":true,\"example\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":\"dockAjs28\"}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID is the unique identifier of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) related to the SLA.\",\"example\":\"pup215rkw\"},\"pickupDistance\":{\"type\":[\"number\",\"null\"],\"description\":\"Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.\",\"example\":1},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.\",\"example\":\"114 - Polanco _ H-05\"},\"transitTime\":{\"type\":[\"string\",\"null\"],\"description\":\"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`.\",\"example\":\"3bd\"}},\"example\":{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}},\"description\":\"Information on Service Level Agreement (SLA) of the change order shipping policy.\"},\"shipsTo\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Country name represented in a three letters code ISO 3166 ALPHA-3.\",\"example\":\"BRA\"},\"description\":\"List of countries of the change order shipping address.\"},\"itemId\":{\"type\":\"string\",\"description\":\"Replacing item's SKU ID, which is a unique numerical identifier.\",\"example\":\"3\"},\"deliveryChannels\":{\"type\":\"array\",\"items\":{\"title\":\"DeliveryChannel\",\"required\":[\"id\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Change 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.\",\"example\":\"delivery\"}},\"example\":{\"id\":\"delivery\"}},\"description\":\"Array with the delivery channels associated with the trade policy.\"},\"price\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Replacing item's final price, calculated in cents.\",\"example\":600},\"listPrice\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Replacing item's price list, calculated in cents.\",\"example\":600},\"shippingEstimate\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item's shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.\",\"example\":\"2023-07-29T17:52:18.6483116Z\"},\"dockEstimate\":{\"type\":[\"string\",\"null\"],\"description\":\"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`.\",\"example\":\"1bd\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Replacing item's total shipping duration estimated in days. For instance, three business days are represented as `3bd`.\",\"example\":\"3bd\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"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`.\",\"example\":\"1bd\"},\"deliveryCompany\":{\"type\":[\"string\",\"null\"],\"description\":\"[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) company's name.\",\"example\":\"Correios\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.\",\"example\":\"114 - Polanco _ H-05\"},\"transitTime\":{\"type\":[\"string\",\"null\"],\"description\":\"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`.\",\"example\":\"3bd\"},\"sellingPrice\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Change item's selling price.\",\"example\":600},\"deliveryIds\":{\"type\":\"array\",\"items\":{\"title\":\"DeliveryIdV2\",\"required\":[\"courierId\",\"warehouseId\",\"dockId\",\"courierName\",\"quantity\",\"kitItemDetails\",\"accountCarrierName\"],\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).\",\"example\":\"136769c\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).\",\"example\":\"w_156\"},\"dockId\":{\"type\":\"string\",\"description\":\"ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).\",\"example\":\"ld931\"},\"courierName\":{\"type\":\"string\",\"description\":\"Name of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).\",\"example\":\"Crossborder\"},\"quantity\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"Quantity of items.\",\"example\":1},\"kitItemDetails\":{\"type\":\"array\",\"items\":{\"type\":[\"string\",\"null\"],\"description\":\"Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), when applicable to the order.\",\"example\":null}},\"accountCarrierName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the account's [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE).\",\"example\":\"vtexlog\"}},\"example\":{\"courierId\":\"1c083bf\",\"warehouseId\":\"1_1\",\"dockId\":\"1\",\"courierName\":\"Donkey\",\"quantity\":1,\"kitItemDetails\":[],\"accountCarrierName\":null}},\"description\":\"Array with delivery information.\"},\"deliveryWindow\":{\"type\":[\"string\",\"null\"],\"description\":\"Change order [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.\",\"example\":null},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\",\"example\":\"pup215rkw\"},\"pickupStoreInfo\":{\"title\":\"PickupStoreInfoV2\",\"required\":[\"isPickupStore\",\"friendlyName\",\"address\",\"additionalInfo\",\"dockId\"],\"type\":\"object\",\"properties\":{\"isPickupStore\":{\"type\":[\"boolean\",\"null\"],\"description\":\"This field is related to converting a loading dock into a pickup point. It should always correspond to `false` because it has been deprecated.\",\"default\":false,\"deprecated\":true},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the loading dock converted to pickup point to be displayed at checkout. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"address\":{\"type\":[\"string\",\"null\"],\"description\":\"Address of the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information about the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the loading dock converted to pickup point. This field has been deprecated.\",\"example\":null,\"deprecated\":true}},\"deprecated\":true,\"example\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":\"dockAjs28\"}},\"pickupDistance\":{\"type\":[\"number\",\"null\"],\"description\":\"Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.\",\"example\":\"1.0\"}},\"example\":{\"itemIndex\":0,\"selectedSla\":\"Lenta\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"slas\":[{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}],\"shipsTo\":[],\"itemId\":\"1\",\"deliveryChannels\":[],\"price\":600,\"listPrice\":600,\"shippingEstimate\":null,\"dockEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"deliveryCompany\":null,\"polygonName\":null,\"transitTime\":null,\"sellingPrice\":600,\"deliveryIds\":[],\"deliveryWindow\":null,\"pickupPointId\":null,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupDistance\":null}},\"description\":\"Array with shipping information.\"}},\"example\":{\"logisticsInfo\":[{\"itemIndex\":0,\"selectedSla\":\"Lenta\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"slas\":[{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}],\"shipsTo\":[],\"itemId\":\"1\",\"deliveryChannels\":[],\"price\":600,\"listPrice\":600,\"shippingEstimate\":null,\"dockEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"deliveryCompany\":null,\"polygonName\":null,\"transitTime\":null,\"sellingPrice\":600,\"deliveryIds\":[],\"deliveryWindow\":null,\"pickupPointId\":null,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupDistance\":null}]}}},\"example\":{\"items\":[{\"uniqueId\":\"40E763F4378E4F40AD1FE915FE1078E1\",\"id\":\"1\",\"productId\":null,\"productRefId\":null,\"refId\":null,\"ean\":null,\"name\":null,\"skuName\":null,\"modalType\":null,\"parentItemIndex\":null,\"parentAssemblyBinding\":null,\"assemblies\":[],\"priceValidUntil\":null,\"tax\":0,\"price\":null,\"listPrice\":null,\"manualPrice\":null,\"manualPriceAppliedBy\":null,\"sellingPrice\":null,\"rewardValue\":0,\"isGift\":false,\"additionalInfo\":{\"dimension\":null,\"brandName\":null,\"brandId\":null,\"offeringInfo\":null,\"offeringType\":null,\"offeringTypeId\":null,\"categoriesIds\":null,\"productClusterId\":null,\"commercialConditionId\":null},\"preSaleDate\":null,\"productCategoryIds\":null,\"productCategories\":{},\"quantity\":1,\"seller\":null,\"sellerChain\":[null],\"imageUrl\":null,\"detailUrl\":null,\"components\":[],\"bundleItems\":[],\"attachments\":[],\"attachmentOfferings\":[],\"offerings\":[],\"priceTags\":[],\"availability\":null,\"measurementUnit\":\"un\",\"unitMultiplier\":1,\"manufacturerCode\":null,\"priceDefinition\":null}],\"paymentData\":{\"transactions\":[]},\"receiptData\":null,\"shippingData\":{\"logisticsInfo\":[{\"itemIndex\":0,\"selectedSla\":\"Lenta\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"slas\":[{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}],\"shipsTo\":[],\"itemId\":\"1\",\"deliveryChannels\":[],\"price\":600,\"listPrice\":600,\"shippingEstimate\":null,\"dockEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"deliveryCompany\":null,\"polygonName\":null,\"transitTime\":null,\"sellingPrice\":600,\"deliveryIds\":[],\"deliveryWindow\":null,\"pickupPointId\":null,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupDistance\":null}]}}}},\"example\":{\"from\":{\"paymentData\":{\"transactions\":[]},\"items\":[{\"id\":\"31\",\"quantity\":1,\"price\":null,\"measurementUnit\":null,\"unitMultiplier\":0,\"sellingPrice\":null,\"name\":null,\"detailUrl\":null,\"imageUrl\":null}],\"shippingData\":{\"logisticsInfo\":[]}},\"to\":{\"items\":[{\"uniqueId\":\"40E763F4378E4F40AD1FE915FE1078E1\",\"id\":\"1\",\"productId\":null,\"productRefId\":null,\"refId\":null,\"ean\":null,\"name\":null,\"skuName\":null,\"modalType\":null,\"parentItemIndex\":null,\"parentAssemblyBinding\":null,\"assemblies\":[],\"priceValidUntil\":null,\"tax\":0,\"price\":null,\"listPrice\":null,\"manualPrice\":null,\"manualPriceAppliedBy\":null,\"sellingPrice\":null,\"rewardValue\":0,\"isGift\":false,\"additionalInfo\":{\"dimension\":null,\"brandName\":null,\"brandId\":null,\"offeringInfo\":null,\"offeringType\":null,\"offeringTypeId\":null,\"categoriesIds\":null,\"productClusterId\":null,\"commercialConditionId\":null},\"preSaleDate\":null,\"productCategoryIds\":null,\"productCategories\":{},\"quantity\":1,\"seller\":null,\"sellerChain\":[null],\"imageUrl\":null,\"detailUrl\":null,\"components\":[],\"bundleItems\":[],\"attachments\":[],\"attachmentOfferings\":[],\"offerings\":[],\"priceTags\":[],\"availability\":null,\"measurementUnit\":\"un\",\"unitMultiplier\":1,\"manufacturerCode\":null,\"priceDefinition\":null}],\"paymentData\":{\"transactions\":[]},\"receiptData\":null,\"shippingData\":{\"logisticsInfo\":[{\"itemIndex\":0,\"selectedSla\":\"Lenta\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"slas\":[{\"id\":\"Lenta\",\"deliveryChannel\":\"delivery\",\"name\":\"Lenta\",\"deliveryIds\":[],\"shippingEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"availableDeliveryWindows\":[],\"deliveryWindow\":null,\"price\":600,\"listPrice\":600,\"tax\":0,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupPointId\":null,\"pickupDistance\":null,\"polygonName\":null,\"transitTime\":null}],\"shipsTo\":[],\"itemId\":\"1\",\"deliveryChannels\":[],\"price\":600,\"listPrice\":600,\"shippingEstimate\":null,\"dockEstimate\":null,\"shippingEstimateDate\":null,\"lockTTL\":null,\"deliveryCompany\":null,\"polygonName\":null,\"transitTime\":null,\"sellingPrice\":600,\"deliveryIds\":[],\"deliveryWindow\":null,\"pickupPointId\":null,\"pickupStoreInfo\":{\"isPickupStore\":false,\"friendlyName\":null,\"address\":null,\"additionalInfo\":null,\"dockId\":null},\"pickupDistance\":null}]}}}},\"description\":\"Array with information about the `replace` operation, when applicable.\"},\"date\":{\"type\":\"string\",\"description\":\"Date and time of the request. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.\",\"example\":\"2023-07-27T17:52:18.6483116Z\"},\"origin\":{\"title\":\"OriginV2\",\"required\":[\"account\",\"orderId\",\"component\"],\"type\":\"object\",\"properties\":{\"account\":{\"type\":\"string\",\"description\":\"Name of the account where the order was made.\",\"example\":\"qastore\"},\"orderId\":{\"type\":\"string\",\"description\":\"Order ID is a unique code that identifies an order.\",\"example\":\"v12772213qst-02\"},\"component\":{\"type\":\"string\",\"description\":\"Component information.\",\"example\":\"MarketplaceComponent\"}},\"description\":\"Object containing information about the order origin.\",\"example\":{\"account\":\"qastore\",\"orderId\":\"v12772213qst-02\",\"component\":\"MarketplaceComponent\"}},\"settings\":{\"title\":\"Settings\",\"required\":[\"customPaymentSystemsAllowed\"],\"type\":\"object\",\"properties\":{\"customPaymentSystemsAllowed\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"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.\",\"example\":[]}},\"example\":{\"customPaymentSystemsAllowed\":[]}}}}]}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/order-system/orders/:changeOrderId/changes/:changeRequestId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -2920,12 +2907,12 @@ } }, { - "id": "f3045648-3198-4e76-99b0-9b1acaa38b24", + "id": "ef32aa4d-274b-447b-b11f-ce196ebcdc8d", "name": "Preview order change", "request": { "name": "Preview order change", "description": { - "content": "This endpoint allows you to simulate an order change and preview what the real change will look like if you use the Change order endpoint. A preview is especially useful for more complex scenarios, such as orders with multiple items and combinations of change operations — add, remove, and replace. Ensuring you get the desired results before making the actual change helps prevent mistakes.\r\n\r\nThe request body will be the same one to be used in the Change order endpoint, and the response body of a successful request will provide a preview of the change order effect.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou 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):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Oms |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |Cancel order
Change order
|\r\n| inStore Sales Person |Cancel order
Change order
|\r\n\r\n>❗ 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-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).", + "content": "This endpoint allows you to simulate an order change and preview what the real change will look like if you use the Create order change endpoint. A preview is especially useful for more complex scenarios, such as orders with multiple items and combinations of change operations — add, remove, and replace. Ensuring you get the desired results before making the actual change helps prevent mistakes.\r\n\r\nThe request body is the same one to be used in the Change order endpoint, and the response body of a successful request provides a preview of the change order effect.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou 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):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Oms |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |Cancel order
Change order
|\r\n| inStore Sales Person |Cancel order
Change order
|\r\n\r\n>❗ 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-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).", "type": "text/plain" }, "url": { @@ -3008,7 +2995,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f419698f-0b4d-48d6-a2f3-d76b837f67b6", + "id": "7a4c5bfa-b900-4cd5-a898-bfcb3d31fe94", "name": "OK", "originalRequest": { "url": { @@ -3119,7 +3106,7 @@ { "listen": "test", "script": { - "id": "e2ce4322-6df8-40a8-8db7-2414cc5b1a26", + "id": "8fd9698f-3c53-4530-a925-1fe5b9b17766", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/order-system/orders/:changeOrderId/changes/preview - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3135,12 +3122,12 @@ } }, { - "id": "7989cee6-8ec2-4450-8088-9265b3384ef4", + "id": "2ae270a6-9e26-4107-b75a-31ebcdb8ea76", "name": "Retry order change", "request": { "name": "Retry order change", "description": { - "content": "This endpoint makes a new attempt to perform an order change previously created using the Order change endpoint that, for some reason, was not completely processed.\r\n\r\nTo make this request, you need the order's `changeRequestId`, its unique change identification code. When you retry to change an order using its `changeRequestId`, instead of creating a new change, you avoid duplications.\r\n\r\nThis endpoint's successful response status code is `204 No Content`, therefore with no response body.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou 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):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Oms |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |Cancel order
Change order
|\r\n| inStore Sales Person |Cancel order
Change order
|\r\n\r\n>❗ 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-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).", + "content": "This endpoint makes a new attempt to perform an order change previously made using the Create order change endpoint that, for some reason, was not completely processed.\r\n\r\nTo make this request, you need the `changeRequestId`, a unique change identification code that you get when you make a Create change order request. When you retry to change an order using the `changeRequestId`, instead of creating a new change, you avoid duplications.\r\n\r\nThis endpoint's successful response status code is `204 No Content`, therefore with no response body.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou 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):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Oms |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |Cancel order
Change order
|\r\n| inStore Sales Person |Cancel order
Change order
|\r\n\r\n>❗ 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-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).", "type": "text/plain" }, "url": { @@ -3230,7 +3217,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "807597ac-0492-49f7-a9d6-2456e94a40ce", + "id": "1fc54224-b55d-4e9a-8c65-3d20ecbf1ab6", "name": "No Content", "originalRequest": { "url": { @@ -3348,7 +3335,7 @@ { "listen": "test", "script": { - "id": "9fbcc8c9-2cf8-44a6-b9b8-aa497862fbcf", + "id": "bdc0541c-94de-4298-9ee5-6526178b232a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/order-system/orders/:changeOrderId/changes/:changeRequestId/retry - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3362,12 +3349,12 @@ } }, { - "id": "495ca36b-306a-4c0d-b31d-6be9aaed8c9e", + "id": "b4d11474-3829-4fc3-853f-c3618014644a", "name": "Cancel order change", "request": { "name": "Cancel order change", "description": { - "content": "This endpoint cancels an order change. It is meant for when, due to an error, a change was not completely processed, and you do not wish to retry it. For this request, you need the order's `changeRequestId`, the unique identification code generated by the Order change endpoint.\r\n\r\nOnce an order change has been successfully processed, canceling it is no longer possible. If you wish to revert the changes made to an order, you will have to create a new order change.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou 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):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Oms |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |Cancel order
Change order
|\r\n| inStore Sales Person |Cancel order
Change order
|\r\n\r\n>❗ 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-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).", + "content": "This endpoint cancels an order change. It is meant for when, due to an error, a change was not completely processed, and you do not wish to retry it. For this request, you need the order's `changeRequestId`, the unique identification code generated by the Create order change endpoint.\r\n\r\nOnce an order change has been successfully processed, canceling it is no longer possible. If you wish to revert the changes made to an order, you will have to create a new order change.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou 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):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Oms |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |Cancel order
Change order
|\r\n| inStore Sales Person |Cancel order
Change order
|\r\n\r\n>❗ 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-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).", "type": "text/plain" }, "url": { @@ -3457,7 +3444,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "c32b5d44-3b65-4bb2-b456-87ce16bdbc37", + "id": "dac61d31-19d0-4533-a47f-f6dc90ccd176", "name": "OK", "originalRequest": { "url": { @@ -3575,7 +3562,7 @@ { "listen": "test", "script": { - "id": "5f2a3d62-737c-4b36-b037-2c5744d17cb4", + "id": "ef062fbb-1d2d-4d98-9d93-09afb6dac3f1", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/order-system/orders/:changeOrderId/changes/:changeRequestId/cancel - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -3591,7 +3578,7 @@ "event": [] }, { - "id": "3df8c5be-2d22-4745-ae66-20227a9c6811", + "id": "54ce7098-89b0-431e-b1de-367046b63831", "name": "Invoice", "description": { "content": "", @@ -3599,7 +3586,7 @@ }, "item": [ { - "id": "a48b51d9-ac94-4f76-b42c-d4e051365c66", + "id": "d21c9c47-8571-4c12-92a9-622df64ded8f", "name": "Order invoice notification", "request": { "name": "Order invoice notification", @@ -3677,7 +3664,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "bf10298a-ebf6-4824-a062-4730b6b67be2", + "id": "070a6554-9eee-4e0b-8cce-6eeb65703060", "name": "OK", "originalRequest": { "url": { @@ -3783,7 +3770,7 @@ { "listen": "test", "script": { - "id": "a1d96748-67c0-411d-9656-978c46746e78", + "id": "246df8fa-3619-47a5-8902-356b27c73be0", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/oms/pvt/orders/:orderId/invoice - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3799,7 +3786,7 @@ } }, { - "id": "85d66da9-0b3b-4ecf-a5d9-f1df1bb74606", + "id": "729a79e8-d274-4df8-9432-eacd721e35ea", "name": "Update order's partial invoice (send tracking number)", "request": { "name": "Update order's partial invoice (send tracking number)", @@ -3888,7 +3875,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "a08dc58f-26ec-4435-b1fd-dcd6a2bd81a6", + "id": "05e4881f-6c31-42a9-b2ae-5c02fd681df9", "name": "OK", "originalRequest": { "url": { @@ -4005,7 +3992,7 @@ { "listen": "test", "script": { - "id": "8c53e2ca-02f9-4715-ab25-32f28a28ca64", + "id": "7f6c2ff8-8abe-41af-bede-986ee72fd9e8", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/oms/pvt/orders/:orderId/invoice/:invoiceNumber - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4024,7 +4011,7 @@ "event": [] }, { - "id": "c8c59917-60ee-403b-95a2-404474778f98", + "id": "c0f681a4-1b84-41d7-9c9d-52976853b8cd", "name": "Tracking", "description": { "content": "", @@ -4032,7 +4019,7 @@ }, "item": [ { - "id": "627ba345-286a-4778-bc40-b7615da2bcaa", + "id": "79cf5a4a-ab87-4f7a-811a-98d1a55892e8", "name": "Update order tracking status", "request": { "name": "Update order tracking status", @@ -4122,7 +4109,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "51e0ebe8-6210-48a6-bcb2-e1bb65dea95d", + "id": "0fc0ef9c-6a9d-41e7-9516-2844d0755ec3", "name": "OK", "originalRequest": { "url": { @@ -4339,7 +4326,7 @@ { "listen": "test", "script": { - "id": "b73b22cb-4948-4bba-a0f1-159954e51d10", + "id": "cb1f15bc-abc4-4aa2-8cd7-379735e84fdf", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/oms/pvt/orders/:orderId/invoice/:invoiceNumber/tracking - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4369,7 +4356,7 @@ "event": [] }, { - "id": "4b277b64-20c7-4f06-8024-9e3e4e385cf7", + "id": "e4a61c76-a50d-4e0c-a76d-6ad008055dea", "name": "Conversation", "description": { "content": "", @@ -4377,7 +4364,7 @@ }, "item": [ { - "id": "11f74226-2389-4fa7-983a-85a0a0772dbb", + "id": "b9197651-c525-4860-8ce9-b2594bc9ca40", "name": "Retrieve order conversation", "request": { "name": "Retrieve order conversation", @@ -4442,7 +4429,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "9b4b64d9-8a29-41c9-a3f3-e6ab117a8f5b", + "id": "e21ac47e-1b44-4ecd-b20a-51a0fb36fda7", "name": "OK", "originalRequest": { "url": { @@ -4648,7 +4635,7 @@ { "listen": "test", "script": { - "id": "c02e6e96-935d-4670-9ea0-5cc7f1cc60d6", + "id": "b1fdc2de-83ad-4690-a3d3-b4798ac9c86f", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/oms/pvt/orders/:orderId/conversation-message - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4679,7 +4666,7 @@ "event": [] }, { - "id": "dddf8702-edfa-453f-af83-790c28af0866", + "id": "2c1ae3e8-15ef-4ade-bae5-643ca31abd44", "name": "Payment", "description": { "content": "", @@ -4687,7 +4674,7 @@ }, "item": [ { - "id": "736fdca8-394a-4394-b818-8dffe242aae2", + "id": "fd4d33f0-b35c-40b3-bfff-07005a2072fa", "name": "Retrieve payment transaction", "request": { "name": "Retrieve payment transaction", @@ -4752,7 +4739,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "d16208fe-236d-45a7-a590-6c6022dd5f05", + "id": "13c81eb5-6a23-4a68-8752-b9078bd403aa", "name": "OK", "originalRequest": { "url": { @@ -4850,7 +4837,7 @@ { "listen": "test", "script": { - "id": "46fa5c7f-b345-4c34-87a2-c70a3600254d", + "id": "7adb23fd-71fb-478d-8afb-2ec9c794dbe9", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/oms/pvt/orders/:orderId/payment-transaction - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4866,7 +4853,7 @@ } }, { - "id": "4a7243b1-35e6-4e01-b9a6-0d4b9c61e60a", + "id": "6dbf23b1-596f-4927-b35b-522a238ba172", "name": "Send payment notification", "request": { "name": "Send payment notification", @@ -4937,7 +4924,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "d7be976e-2ee4-442b-8542-6b5a93d71319", + "id": "a57d7a19-29a0-47b9-ac10-4f45f5ad2a08", "name": "OK", "originalRequest": { "url": { @@ -5042,7 +5029,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "b7df43a8-e9f2-4b49-acb1-021eac0a91e5", + "id": "a4f44a07-eec7-41e9-a0aa-3ab8d5b0f9bf", "name": "Bad request.", "originalRequest": { "url": { @@ -5147,7 +5134,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "b96763ec-9d01-4fa7-b46c-1d61de3de67e", + "id": "2c0b1742-8eb3-4ad8-97c1-e37726efcdd0", "name": "The credentials are not enabled to access the service.", "originalRequest": { "url": { @@ -5252,7 +5239,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "d20042f2-dd10-4ca4-bcb7-4d58fb9318be", + "id": "50286e89-6e60-40f5-a920-6f28127bf610", "name": "Value not found.", "originalRequest": { "url": { @@ -5357,7 +5344,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "303e7a28-6d62-4b1d-bb2f-157e040d34e6", + "id": "45bcd2fd-10db-4c16-b98d-853438aa125a", "name": "Too many requests.", "originalRequest": { "url": { @@ -5463,7 +5450,7 @@ { "listen": "test", "script": { - "id": "9a478249-6ce0-4fc6-a813-52c51f04a653", + "id": "f82591ca-f3b2-4fe3-a773-206e930c8daf", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/oms/pvt/orders/:orderId/payments/:paymentId/payment-notification - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -5479,7 +5466,7 @@ "event": [] }, { - "id": "ef93beba-21c1-4e96-9b4e-b5f5b9fcfa40", + "id": "67916e16-1d2a-4a41-bc6f-73ef00700269", "name": "Feed v3", "description": { "content": "", @@ -5487,7 +5474,7 @@ }, "item": [ { - "id": "13100871-5432-4157-b388-8253f341695b", + "id": "fb3623aa-a8d2-427c-835d-62feeb5335bc", "name": "Get feed configuration", "request": { "name": "Get feed configuration", @@ -5540,7 +5527,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "80dcae9e-e52c-447b-b72b-5f3ee6a05111", + "id": "b95eaadd-401b-4228-98af-61ed2143d115", "name": "OK", "originalRequest": { "url": { @@ -5626,7 +5613,7 @@ { "listen": "test", "script": { - "id": "8f55a777-658e-45a2-8c8a-8f654be47108", + "id": "bbd9cc97-d1d0-468a-a5c6-eb4a6468f696", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/orders/feed/config - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -5642,7 +5629,7 @@ } }, { - "id": "524b19d2-95a5-4fe4-9391-8429fe9cecf7", + "id": "0dd1766b-6beb-4207-a31b-ec853ce0b9c2", "name": "Create or update feed configuration", "request": { "name": "Create or update feed configuration", @@ -5704,7 +5691,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "c26ff43f-1cce-4cf7-ab5b-0776335b5e12", + "id": "7ac63a32-ea21-4780-97ac-8a6f0f6ffbcd", "name": "Success", "originalRequest": { "url": { @@ -5793,7 +5780,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "25d268e4-a63c-41b2-b49c-a72a096e4b8a", + "id": "f2732fe6-9d23-49b9-ab23-d3fd3ea04d2f", "name": "The credentials are not enabled to access the service", "originalRequest": { "url": { @@ -5882,7 +5869,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "9900d30e-a10a-4def-92a9-10fecd156091", + "id": "3785f55f-c066-4fd3-8a63-1f374758f86e", "name": "Value not found", "originalRequest": { "url": { @@ -5971,7 +5958,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "700ed349-ed87-44ec-abdd-7b0010a2b23e", + "id": "63d818b8-d52d-402a-8808-209ea7bd38f2", "name": "Too many requests", "originalRequest": { "url": { @@ -6061,7 +6048,7 @@ { "listen": "test", "script": { - "id": "c9fa3ed3-8a98-4102-b1f0-894eac7508bb", + "id": "b736fa50-ca70-42b7-bc12-1817b577939a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/orders/feed/config - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -6074,7 +6061,7 @@ } }, { - "id": "f33a56d3-7225-48ae-adda-503cb95f126a", + "id": "08a043a1-e63c-4d99-97a4-2f60a0862fc7", "name": "Delete feed configuration", "request": { "name": "Delete feed configuration", @@ -6121,7 +6108,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "93361dce-e4d4-4c75-ad6c-825a39145c55", + "id": "316412d0-6824-4b87-82f7-b49cbe7cf760", "name": "OK", "originalRequest": { "url": { @@ -6202,7 +6189,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "182bf9b9-b869-4eba-92f9-c382b550eb1a", + "id": "609b9dee-0f64-4449-b440-6a5cafb81831", "name": "Bad request - Unable to check address / Only https scheme is accepted", "originalRequest": { "url": { @@ -6283,7 +6270,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "acd28a17-8b0f-4543-a4ed-76366dabb3ac", + "id": "12f23c70-ec76-4c72-81bd-7cad20c840b5", "name": "The credentials are not enabled to access the service", "originalRequest": { "url": { @@ -6364,7 +6351,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "d0b7eedc-e258-4193-82d7-78061d0df7e1", + "id": "a23b5f33-86c4-4e3a-afdf-3dd038e6491b", "name": "Value not found", "originalRequest": { "url": { @@ -6445,7 +6432,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "33f12ab5-c6ed-4a72-8a54-b8ebf3b426c3", + "id": "2f83f0cc-fe9e-489a-80a2-d102588e3ab9", "name": "Too many requests", "originalRequest": { "url": { @@ -6527,7 +6514,7 @@ { "listen": "test", "script": { - "id": "d6db8d56-3099-427a-a409-df0740e15e18", + "id": "111f0203-12e8-4cb8-a446-e5d48c9ceb2c", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/orders/feed/config - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -6540,7 +6527,7 @@ } }, { - "id": "a187e7bf-5c07-40c3-8fed-46726789c4b7", + "id": "2977e17d-02da-43f4-ae8f-143c3084bc7b", "name": "Retrieve feed items", "request": { "name": "Retrieve feed items", @@ -6602,7 +6589,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "e53aa066-323a-4d4a-b14c-7bbb15f832fc", + "id": "234748f9-caa7-4f39-83c0-ed70c7b2033b", "name": "OK", "originalRequest": { "url": { @@ -6692,7 +6679,7 @@ { "listen": "test", "script": { - "id": "17ec8e1e-48e5-4bfa-ad34-12582207a54d", + "id": "2495dcbc-4022-457e-9350-27e3e91260b8", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/orders/feed - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -6708,7 +6695,7 @@ } }, { - "id": "2528e14d-a5ed-4fcd-be24-de2c9ccbc421", + "id": "9a9b0f24-284f-4b6c-9006-9f7d023ca87d", "name": "Commit feed items", "request": { "name": "Commit feed items", @@ -6773,7 +6760,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "2965899b-5ef7-4ddd-bde3-8b5b20a05a2a", + "id": "89b95340-590d-416b-9184-d21c325554df", "name": "OK", "originalRequest": { "url": { @@ -6866,7 +6853,7 @@ { "listen": "test", "script": { - "id": "70be7544-0332-42cc-b9e3-f36ac8f45378", + "id": "83033114-0c5d-4fbe-9425-69518f6ccb5a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/orders/feed - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -6880,7 +6867,7 @@ } }, { - "id": "2bfee98b-8e26-4a6d-95ec-2167a190bb4c", + "id": "86f678e2-c636-41e2-87de-6887cf100b78", "name": "Test JSONata expression", "request": { "name": "Test JSONata expression", @@ -6946,7 +6933,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "d15b6dcc-0138-4a3a-a5e2-1db73debd2f5", + "id": "6b0e8d12-e1fb-4f61-9bde-7d1a4402a6de", "name": "OK", "originalRequest": { "url": { @@ -7040,7 +7027,7 @@ { "listen": "test", "script": { - "id": "c9455787-ec4b-4358-9e1b-9eeb9451155f", + "id": "98641b21-51d4-4449-b0f6-ce27f838d7a0", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/orders/expressions/jsonata - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -7057,7 +7044,7 @@ "event": [] }, { - "id": "129a8bd7-a984-402a-8794-e20a1502adfb", + "id": "bfe513a9-9a28-4cdb-9654-a202ed6f537d", "name": "Order hook", "description": { "content": "", @@ -7065,7 +7052,7 @@ }, "item": [ { - "id": "da90b3e5-ac45-457a-81e4-3926c3183843", + "id": "39da27d9-122f-4b72-8fa9-5ec31a1c65ee", "name": "Get hook configuration", "request": { "name": "Get hook configuration", @@ -7140,7 +7127,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "081517bb-6911-4b88-9ae2-fd2f9f8b2066", + "id": "2fd96b17-9ff3-4fbc-bb6a-809d91ded9bd", "name": "OK", "originalRequest": { "url": { @@ -7235,7 +7222,7 @@ { "listen": "test", "script": { - "id": "ae42f163-e876-4d32-a624-6c2bfc7dfd1a", + "id": "73265986-4477-43c7-9f07-71c9b35a026b", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/orders/hook/config - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -7248,7 +7235,7 @@ } }, { - "id": "9ae377ab-7627-488b-9ff4-f7c2a3357530", + "id": "a551f978-b67a-4fa7-be1e-34e0ad5b2d62", "name": "Create or update hook configuration", "request": { "name": "Create or update hook configuration", @@ -7314,7 +7301,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "3af989b9-ec17-482e-8d2b-90bc226f3ede", + "id": "5d6dfd4d-6cfa-4ce5-a12b-e698f507dbcd", "name": "OK", "originalRequest": { "url": { @@ -7408,7 +7395,7 @@ { "listen": "test", "script": { - "id": "025fe225-94b9-4f3a-aaf0-35303b0d9489", + "id": "cacb9d13-7219-4279-b3d0-697d25695058", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/orders/hook/config - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -7424,7 +7411,7 @@ } }, { - "id": "2cef9424-9eb8-4c65-b104-a796efd21412", + "id": "617c98ed-16b9-4148-997e-b46cb265cf4f", "name": "Delete hook configuration", "request": { "name": "Delete hook configuration", @@ -7471,7 +7458,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "d24e32db-fc10-47ce-bddd-c95af43f845d", + "id": "ef213d3d-ba57-4728-89bb-88155bf8127d", "name": "Success", "originalRequest": { "url": { @@ -7552,7 +7539,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "f3ba3ee8-3fe9-43ed-ae50-6a9c7ba6bf6f", + "id": "3b1e9be1-6415-4772-b917-88fe1051e9e9", "name": "The credentials are not enabled to access the service", "originalRequest": { "url": { @@ -7633,7 +7620,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "4178d81a-f8ca-44fa-9138-ecc107eecffa", + "id": "ffbd3bec-532d-4db6-b2b5-d9b01de5d49a", "name": "Value not found", "originalRequest": { "url": { @@ -7714,7 +7701,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "4b5e460e-a092-4ca2-9dbb-d4e075c9d531", + "id": "812f88e6-0bdb-4fac-ba64-6a39e828d324", "name": "Too many requests", "originalRequest": { "url": { @@ -7796,7 +7783,7 @@ { "listen": "test", "script": { - "id": "80d0cde6-2d8e-4997-87af-d0216fb17f74", + "id": "558370ce-888b-4570-8a1c-335e984344e5", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/orders/hook/config - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -7812,7 +7799,7 @@ "event": [] }, { - "id": "6e7bc0fc-f582-458e-913b-b394aab7768f", + "id": "2def1ce7-f943-42e6-9a68-5e6af3456a34", "name": "User orders", "description": { "content": "", @@ -7820,7 +7807,7 @@ }, "item": [ { - "id": "e8ec50c2-727b-4246-87fa-30011542a7a0", + "id": "c760e860-4ef5-48f3-ba23-9b391678d55c", "name": "Retrieve user's orders", "request": { "name": "Retrieve user's orders", @@ -7901,7 +7888,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "0584a68b-cfe8-4513-87de-0be6b7f6cc68", + "id": "0bce5e0e-8f5e-41fa-89b4-79faf9044a1b", "name": "OK", "originalRequest": { "url": { @@ -8000,7 +7987,7 @@ { "listen": "test", "script": { - "id": "69587fc4-e065-4bbf-82d8-6c43992f52e0", + "id": "6a9cfffe-85f0-4c27-834f-5acb2deadf84", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/oms/user/orders - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -8016,7 +8003,7 @@ } }, { - "id": "7ade4dae-9641-4aa2-9993-8a497161bd90", + "id": "7b8b3da3-041a-411c-83cf-c8450a4bdecd", "name": "Retrieve user order details", "request": { "name": "Retrieve user order details", @@ -8090,7 +8077,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "43dddf52-0c7a-4249-9f51-100bf05869e3", + "id": "2de5178e-237e-4c0a-b010-d71a01b1ebc0", "name": "OK", "originalRequest": { "url": { @@ -8192,7 +8179,7 @@ { "listen": "test", "script": { - "id": "5d7e1593-fad2-42b8-bb97-d55468842603", + "id": "84133225-2791-4c16-bf0b-a70e2e8809ac", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/oms/user/orders/:orderId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -8211,7 +8198,7 @@ "event": [] }, { - "id": "3a2a5551-d76c-4f76-9d4d-358b06ddc76f", + "id": "4958df5d-e615-4d7c-a6db-cb37dd8e4449", "name": "Change seller", "description": { "content": "", @@ -8219,7 +8206,7 @@ }, "item": [ { - "id": "492a9ae7-95d7-4bfd-ae11-fcc50dd35cec", + "id": "3cd1fc8d-5fbf-46a1-a57d-c28677e8995f", "name": "Get window to change seller", "request": { "name": "Get window to change seller", @@ -8273,7 +8260,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "68b945f2-01c9-4129-8293-8329fa7a01e7", + "id": "52201ebe-5ff2-4dfa-a6b2-640336599a46", "name": "OK", "originalRequest": { "url": { @@ -8360,7 +8347,7 @@ { "listen": "test", "script": { - "id": "a49300cd-3983-422a-9d80-3d8e100abdf4", + "id": "06b3b57b-d953-4848-b011-a02de4fe5bdc", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/checkout/pvt/configuration/window-to-change-seller - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -8374,7 +8361,7 @@ } }, { - "id": "9aad3af8-7c19-4b2f-9d47-0e75816859ad", + "id": "8563e383-8097-4db2-8d82-421964740998", "name": "Update window to change seller", "request": { "name": "Update window to change seller", @@ -8437,7 +8424,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "7a9e3de4-c18c-47e2-bffc-ac7829411070", + "id": "c1b35f79-7dfa-47d5-9051-3084d80e6b1e", "name": "Created", "originalRequest": { "url": { @@ -8528,7 +8515,7 @@ { "listen": "test", "script": { - "id": "2d82ddfb-8a0c-453c-8fee-8b2c68733c1e", + "id": "13db6c1b-6876-43ee-89fa-4d193b3fe07d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/checkout/pvt/configuration/window-to-change-seller - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -8544,7 +8531,7 @@ "event": [] }, { - "id": "14b3eff0-c80e-45f4-b112-12ad378cd673", + "id": "d4f978ad-c2eb-4d3e-afb8-727aed2405e0", "name": "Feed v2 (deprecated)", "description": { "content": "", @@ -8552,7 +8539,7 @@ }, "item": [ { - "id": "b15993b3-20da-43bd-aa5b-c0e62a058ae0", + "id": "897d5ef7-1376-4e56-b85a-3ccb5e2f0079", "name": "Get feed order status", "request": { "name": "Get feed order status", @@ -8611,7 +8598,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "0f094f49-cfa0-4a1a-af38-6ac1df148168", + "id": "97f971d8-e92a-42ab-a044-a1248567728b", "name": "OK", "originalRequest": { "url": { @@ -8700,7 +8687,7 @@ { "listen": "test", "script": { - "id": "88031257-d5de-4f0f-ae30-7b4d2607fd9f", + "id": "2dc353e9-f1af-4b5a-a202-cb9dc9694cee", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/oms/pvt/feed/orders/status - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -8763,7 +8750,7 @@ } ], "info": { - "_postman_id": "c463b7b6-5f82-449a-a9d6-47db741904b9", + "_postman_id": "23175d64-3234-492d-864f-cfb0a352f945", "name": "Orders API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { diff --git a/VTEX - Orders API.json b/VTEX - Orders API.json index 87e2a47bb..48be74de3 100644 --- a/VTEX - Orders API.json +++ b/VTEX - Orders API.json @@ -149,7 +149,6 @@ }, "value": { "type": "integer", - "format": "int32", "description": "Value in cents.", "nullable": true }, @@ -184,7 +183,6 @@ }, "value": { "type": "integer", - "format": "int32", "description": "Order's total value." } } @@ -686,8 +684,7 @@ "nullable": true }, "roundingError": { - "type": "integer", - "format": "int32" + "type": "integer" }, "orderFormId": { "type": "string" @@ -1693,7 +1690,6 @@ "explode": true, "schema": { "type": "integer", - "format": "int32", "default": 10 } }, @@ -1706,7 +1702,6 @@ "explode": true, "schema": { "type": "integer", - "format": "int32", "default": 15 } }, @@ -5854,177 +5849,6 @@ "allOf": [ { "$ref": "#/components/schemas/response202" - }, - { - "example": { - "requestId": "e8532a32-7f7e-434a-88ec-29609f0ede46", - "workflowId": "74f40e7a-68c6-4699-b874-a8a297fb3f6a", - "reason": "The client did not like the size.", - "manualDiscountValue": 0, - "manualIncrementValue": 0, - "totalChangeValue": 0, - "totals": [], - "add": null, - "remove": null, - "replace": [ - { - "from": { - "paymentData": { - "transactions": [] - }, - "items": [ - { - "id": "31", - "quantity": 1, - "price": null, - "measurementUnit": null, - "unitMultiplier": 0, - "sellingPrice": null, - "name": null, - "detailUrl": null, - "imageUrl": null - } - ], - "shippingData": { - "logisticsInfo": [] - } - }, - "to": { - "items": [ - { - "uniqueId": "40E763F4378E4F40AD1FE915FE1078E1", - "id": "1", - "productId": null, - "productRefId": null, - "refId": null, - "ean": null, - "name": null, - "skuName": null, - "modalType": null, - "parentItemIndex": null, - "parentAssemblyBinding": null, - "assemblies": [], - "priceValidUntil": null, - "tax": 0, - "price": null, - "listPrice": null, - "manualPrice": null, - "manualPriceAppliedBy": null, - "sellingPrice": null, - "rewardValue": 0, - "isGift": false, - "additionalInfo": { - "dimension": null, - "brandName": null, - "brandId": null, - "offeringInfo": null, - "offeringType": null, - "offeringTypeId": null, - "categoriesIds": null, - "productClusterId": null, - "commercialConditionId": null - }, - "preSaleDate": null, - "productCategoryIds": null, - "productCategories": {}, - "quantity": 1, - "seller": null, - "sellerChain": [ - null - ], - "imageUrl": null, - "detailUrl": null, - "components": [], - "bundleItems": [], - "attachments": [], - "attachmentOfferings": [], - "offerings": [], - "priceTags": [], - "availability": null, - "measurementUnit": "un", - "unitMultiplier": 1, - "manufacturerCode": null, - "priceDefinition": null - } - ], - "paymentData": { - "transactions": [] - }, - "receiptData": null, - "shippingData": { - "logisticsInfo": [ - { - "itemIndex": 0, - "selectedSla": "Lenta", - "selectedDeliveryChannel": "delivery", - "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", - "slas": [ - { - "id": "Lenta", - "deliveryChannel": "delivery", - "name": "Lenta", - "deliveryIds": [], - "shippingEstimate": null, - "shippingEstimateDate": null, - "lockTTL": null, - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 600, - "listPrice": 600, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": null, - "transitTime": null - } - ], - "shipsTo": [], - "itemId": "1", - "deliveryChannels": [], - "price": 600, - "listPrice": 600, - "shippingEstimate": null, - "dockEstimate": null, - "shippingEstimateDate": null, - "lockTTL": null, - "deliveryCompany": null, - "polygonName": null, - "transitTime": null, - "sellingPrice": 600, - "deliveryIds": [], - "deliveryWindow": null, - "pickupPointId": null, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupDistance": null - } - ] - } - } - } - ], - "date": "2023-07-27T17:52:18.6483116Z", - "origin": { - "account": "qastore", - "orderId": "v12772213qst-02", - "component": "MarketplaceComponent" - }, - "settings": { - "customPaymentSystemsAllowed": [] - } - } } ] }, @@ -7221,485 +7045,48 @@ "allOf": [ { "$ref": "#/components/schemas/GetChangeDetailbyschlee" - }, + } + ] + }, + "example": { + "requests": [ { - "example": { - "requests": [ - { - "requestId": "e8532a32-7f7e-434a-88ec-29609f0ede46", - "workflowId": "74f40e7a-68c6-4699-b874-a8a297fb3f6a", - "reason": "The client did not like the size.", - "manualDiscountValue": 0, - "manualIncrementValue": 0, - "totalChangeValue": 0, - "totals": [], - "add": null, - "remove": null, - "replace": [ + "requestId": "e8532a32-7f7e-434a-88ec-29609f0ede46", + "workflowId": "74f40e7a-68c6-4699-b874-a8a297fb3f6a", + "reason": "The client did not like the size.", + "manualDiscountValue": 0, + "manualIncrementValue": 0, + "totalChangeValue": 0, + "totals": [], + "add": null, + "remove": null, + "replace": [ + { + "from": { + "paymentData": { + "transactions": [] + }, + "items": [ { - "from": { - "paymentData": { - "transactions": [] - }, - "items": [ - { - "id": "31", - "quantity": 1, - "price": 5000, - "measurementUnit": "un", - "unitMultiplier": 1, - "sellingPrice": 5000, - "name": "Fusca miniatura Fusca preto", - "detailUrl": "/fusca-miniatura-24/p", - "imageUrl": "http://qastore.vteximg.com.br/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000" - } - ], - "shippingData": { - "logisticsInfo": [ - { - "itemIndex": 0, - "selectedSla": "Lenta", - "selectedDeliveryChannel": "delivery", - "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", - "slas": [ - { - "id": "Lenta", - "deliveryChannel": "delivery", - "name": "Lenta", - "deliveryIds": [ - { - "courierId": "1c083bf", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "Donkey", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "25bd", - "shippingEstimateDate": "2023-08-30T10:17:24.6436519Z", - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 180, - "listPrice": 180, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "25bd" - }, - { - "id": "Normal", - "deliveryChannel": "delivery", - "name": "Normal", - "deliveryIds": [ - { - "courierId": "1", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "Transportadora", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "3bd", - "shippingEstimateDate": null, - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 500, - "listPrice": 500, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "3bd" - }, - { - "id": "Pickup", - "deliveryChannel": "delivery", - "name": "Pickup", - "deliveryIds": [ - { - "courierId": "ech018654", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "Retirada", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "25bd", - "shippingEstimateDate": null, - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 700, - "listPrice": 700, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "25bd" - } - ], - "shipsTo": [ - "BRA" - ], - "itemId": "31", - "deliveryChannels": [ - { - "id": "delivery" - } - ], - "price": 180, - "listPrice": 180, - "shippingEstimate": "25bd", - "dockEstimate": null, - "shippingEstimateDate": "2023-08-30T10:17:24.6436519Z", - "lockTTL": "12d", - "deliveryCompany": null, - "polygonName": "", - "transitTime": "25bd", - "sellingPrice": 180, - "deliveryIds": [ - { - "courierId": "1c083bf", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "Donkey", - "quantity": 1, - "kitItemDetails": null, - "accountCarrierName": "qastoreecho" - } - ], - "deliveryWindow": null, - "pickupPointId": null, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupDistance": null - } - ] - } - }, - "to": { - "items": [ - { - "uniqueId": "40E763F4378E4F40AD1FE915FE1078E1", - "id": "1", - "productId": "1", - "productRefId": "", - "refId": "codrefxicaraazul", - "ean": "8745121641", - "name": "xícara azul", - "skuName": "azul", - "modalType": null, - "parentItemIndex": null, - "parentAssemblyBinding": null, - "assemblies": [], - "priceValidUntil": null, - "tax": 0, - "price": 5000, - "listPrice": null, - "manualPrice": null, - "manualPriceAppliedBy": null, - "sellingPrice": 5000, - "rewardValue": 0, - "isGift": false, - "additionalInfo": { - "dimension": null, - "brandName": null, - "brandId": null, - "offeringInfo": null, - "offeringType": null, - "offeringTypeId": null, - "categoriesIds": null, - "productClusterId": null, - "commercialConditionId": null - }, - "preSaleDate": null, - "productCategoryIds": "/1/", - "productCategories": { - "1": "Category" - }, - "quantity": 1, - "seller": "1", - "sellerChain": [ - "1" - ], - "imageUrl": "http://qastore.vteximg.com.br/arquivos/ids/155394-55-55/xicara.jpg?v=636565506415770000", - "detailUrl": "/xicara/p", - "components": [], - "bundleItems": [], - "attachments": [], - "attachmentOfferings": [], - "offerings": [], - "priceTags": [], - "availability": null, - "measurementUnit": "un", - "unitMultiplier": 1, - "manufacturerCode": null, - "priceDefinition": { - "calculatedSellingPrice": 5000, - "total": 5000, - "sellingPrices": [ - { - "value": 5000, - "quantity": 1 - } - ] - } - } - ], - "paymentData": { - "transactions": [] - }, - "receiptData": null, - "shippingData": { - "logisticsInfo": [ - { - "itemIndex": 0, - "selectedSla": "Lenta", - "selectedDeliveryChannel": "delivery", - "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", - "slas": [ - { - "id": "Lenta", - "deliveryChannel": "delivery", - "name": "Lenta", - "deliveryIds": [ - { - "courierId": "1c083bf", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "Donkey", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "25bd", - "shippingEstimateDate": "2023-08-30T10:17:24.6436519Z", - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 600, - "listPrice": 180, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "25bd" - }, - { - "id": "Normal", - "deliveryChannel": "delivery", - "name": "Normal", - "deliveryIds": [ - { - "courierId": "1", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "Transportadora", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "3bd", - "shippingEstimateDate": null, - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 500, - "listPrice": 500, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "3bd" - }, - { - "id": "Pickup", - "deliveryChannel": "delivery", - "name": "Pickup", - "deliveryIds": [ - { - "courierId": "ech018654", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "Retirada", - "quantity": 1, - "kitItemDetails": [], - "accountCarrierName": null - } - ], - "shippingEstimate": "25bd", - "shippingEstimateDate": null, - "lockTTL": "12d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 700, - "listPrice": 700, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": "", - "transitTime": "25bd" - } - ], - "shipsTo": [ - "BRA" - ], - "itemId": "1", - "deliveryChannels": [ - { - "id": "delivery" - } - ], - "price": 600, - "listPrice": 180, - "shippingEstimate": "25bd", - "dockEstimate": null, - "shippingEstimateDate": "2023-08-30T10:17:24.6436519Z", - "lockTTL": "12d", - "deliveryCompany": null, - "polygonName": "", - "transitTime": "25bd", - "sellingPrice": 600, - "deliveryIds": [ - { - "courierId": "1c083bf", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "Donkey", - "quantity": 1, - "kitItemDetails": null, - "accountCarrierName": "qastoreecho" - } - ], - "deliveryWindow": null, - "pickupPointId": null, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupDistance": null - } - ] - } - } - } - ], - "date": "2023-07-27T17:52:18.6483116Z", - "origin": { - "account": "qastore", - "orderId": "v12772213qst-02", - "component": "MarketplaceComponent" - }, - "settings": { - "customPaymentSystemsAllowed": [] - } - } - ], - "actions": [] - } - } - ] - }, - "example": { - "requests": [ - { - "requestId": "e8532a32-7f7e-434a-88ec-29609f0ede46", - "workflowId": "74f40e7a-68c6-4699-b874-a8a297fb3f6a", - "reason": "The client did not like the size.", - "manualDiscountValue": 0, - "manualIncrementValue": 0, - "totalChangeValue": 0, - "totals": [], - "add": null, - "remove": null, - "replace": [ - { - "from": { - "paymentData": { - "transactions": [] - }, - "items": [ - { - "id": "31", - "quantity": 1, - "price": 5000, - "measurementUnit": "un", - "unitMultiplier": 1, - "sellingPrice": 5000, - "name": "Fusca miniatura Fusca preto", - "detailUrl": "/fusca-miniatura-24/p", - "imageUrl": "http://qastore.vteximg.com.br/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000" - } - ], - "shippingData": { - "logisticsInfo": [ - { - "itemIndex": 0, - "selectedSla": "Lenta", - "selectedDeliveryChannel": "delivery", - "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", - "slas": [ + "id": "31", + "quantity": 1, + "price": 5000, + "measurementUnit": "un", + "unitMultiplier": 1, + "sellingPrice": 5000, + "name": "Fusca miniatura Fusca preto", + "detailUrl": "/fusca-miniatura-24/p", + "imageUrl": "http://qastore.vteximg.com.br/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000" + } + ], + "shippingData": { + "logisticsInfo": [ + { + "itemIndex": 0, + "selectedSla": "Lenta", + "selectedDeliveryChannel": "delivery", + "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", + "slas": [ { "id": "Lenta", "deliveryChannel": "delivery", @@ -9548,8 +8935,7 @@ "deprecated": true }, "value": { - "type": "integer", - "format": "int32" + "type": "integer" }, "creationDate": { "type": "string" @@ -9640,8 +9026,7 @@ "nullable": true }, "roundingError": { - "type": "integer", - "format": "int32" + "type": "integer" }, "orderFormId": { "type": "string" @@ -10152,7 +9537,6 @@ }, "value": { "type": "integer", - "format": "int32", "description": "Total amount of `Items`, `Discounts`, `Shipping`, `Tax` or `Change`." } }, @@ -10244,7 +9628,6 @@ }, "quantity": { "type": "integer", - "format": "int32", "description": "Quantity of items." }, "seller": { @@ -10261,12 +9644,10 @@ }, "price": { "type": "integer", - "format": "int32", "description": "Item's price." }, "listPrice": { "type": "integer", - "format": "int32", "description": "Item's list price." }, "manualPrice": { @@ -10355,12 +9736,10 @@ }, "commission": { "type": "integer", - "format": "int32", "description": "Commission value registered for the seller." }, "tax": { "type": "integer", - "format": "int32", "description": "Item's tax." }, "preSaleDate": { @@ -10377,12 +9756,10 @@ }, "unitMultiplier": { "type": "integer", - "format": "int32", "description": "Item's unit multiplier." }, "sellingPrice": { "type": "integer", - "format": "int32", "description": "Item's selling price." }, "isGift": { @@ -10396,12 +9773,10 @@ }, "rewardValue": { "type": "integer", - "format": "int32", "description": "Item's reward value." }, "freightCommission": { "type": "integer", - "format": "int32", "description": "Value of the freight commission." }, "priceDefinitions": { @@ -10470,7 +9845,9 @@ "type": "array", "description": "Retrieves information about orders item's customizations.", "nullable": true, - "items": {} + "items": { + "type": "string" + } }, "costPrice": { "type": "integer", @@ -10688,22 +10065,18 @@ }, "height": { "type": "integer", - "format": "int32", "description": "Item's height." }, "length": { "type": "integer", - "format": "int32", "description": "Item's length." }, "weight": { "type": "integer", - "format": "int32", "description": "Item's weight." }, "width": { "type": "integer", - "format": "int32", "description": "Item's width." } }, @@ -11189,7 +10562,6 @@ "properties": { "itemIndex": { "type": "integer", - "format": "int32", "description": "Index of the item starting from 0." }, "selectedSla": { @@ -11202,17 +10574,14 @@ }, "price": { "type": "integer", - "format": "int32", "description": "Shipping price for the item in cents. Does not account for the whole order's shipping price." }, "listPrice": { "type": "integer", - "format": "int32", "description": "SKU's optional price for a specific trade policy." }, "sellingPrice": { "type": "integer", - "format": "int32", "description": "Item's selling price." }, "deliveryWindow": { @@ -11469,7 +10838,6 @@ }, "price": { "type": "integer", - "format": "int32", "description": "Shipping price for the item in cents. Does not account for the whole order's shipping price." }, "deliveryChannel": { @@ -11595,7 +10963,6 @@ }, "quantity": { "type": "integer", - "format": "int32", "description": "Quantity of items." }, "warehouseId": { @@ -11610,7 +10977,9 @@ "type": "array", "description": "Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), if there are any.", "nullable": true, - "items": {} + "items": { + "type": "string" + } } }, "example": { @@ -11738,7 +11107,9 @@ "giftCards": { "type": "array", "description": "Array with information about Gift Cards.", - "items": {} + "items": { + "type": "string" + } }, "transactions": { "type": "array", @@ -11931,17 +11302,14 @@ }, "value": { "type": "integer", - "format": "int32", "description": "Payment's final amount in cents." }, "installments": { "type": "integer", - "format": "int32", "description": "Number of payment installments." }, "referenceValue": { "type": "integer", - "format": "int32", "description": "Payment's reference value in cents." }, "cardHolder": { @@ -12230,12 +11598,10 @@ }, "discountValue": { "type": "integer", - "format": "int32", "description": "Order change discount value." }, "incrementValue": { "type": "integer", - "format": "int32", "description": "Order change increment value." }, "itemsAdded": { @@ -12298,12 +11664,10 @@ }, "quantity": { "type": "integer", - "format": "int32", "description": "Quantity of items removed from the order." }, "price": { "type": "integer", - "format": "int32", "description": "Total amount of items removed from the order." }, "unitMultiplier": { @@ -12371,7 +11735,6 @@ }, "currencyLocale": { "type": "integer", - "format": "int32", "description": "Currency Locale Code in LCID in decimal." }, "currencySymbol": { @@ -12412,7 +11775,6 @@ "properties": { "CurrencyDecimalDigits": { "type": "integer", - "format": "int32", "description": "Quantity of currency decimal digits." }, "CurrencyDecimalSeparator": { @@ -12425,7 +11787,6 @@ }, "CurrencyGroupSize": { "type": "integer", - "format": "int32", "description": "Defines how many characters will be grouped." }, "StartsWithCurrencySymbol": { @@ -13073,8 +12434,7 @@ "nullable": true }, "totalValue": { - "type": "integer", - "format": "int32" + "type": "integer" }, "paymentNames": { "type": "string" @@ -13144,8 +12504,7 @@ "nullable": true }, "totalItems": { - "type": "integer", - "format": "int32" + "type": "integer" }, "currencyCode": { "type": "string" @@ -13186,20 +12545,16 @@ "type": "object", "properties": { "total": { - "type": "integer", - "format": "int32" + "type": "integer" }, "pages": { - "type": "integer", - "format": "int32" + "type": "integer" }, "currentPage": { - "type": "integer", - "format": "int32" + "type": "integer" }, "perPage": { - "type": "integer", - "format": "int32" + "type": "integer" } }, "example": { @@ -13450,34 +12805,28 @@ "type": "object", "properties": { "Count": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Max": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Mean": { "type": "number" }, "Min": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Missing": { - "type": "integer", - "format": "int32" + "type": "integer" }, "StdDev": { "type": "number" }, "Sum": { - "type": "integer", - "format": "int32" + "type": "integer" }, "SumOfSquares": { - "type": "integer", - "format": "int64" + "type": "integer" }, "Facets": { "$ref": "#/components/schemas/Facets" @@ -13638,34 +12987,28 @@ "type": "object", "properties": { "Count": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Max": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Mean": { "type": "number" }, "Min": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Missing": { - "type": "integer", - "format": "int32" + "type": "integer" }, "StdDev": { "type": "number" }, "Sum": { - "type": "integer", - "format": "int32" + "type": "integer" }, "SumOfSquares": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Facets": { "type": "string", @@ -13700,34 +13043,28 @@ "type": "object", "properties": { "Count": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Max": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Mean": { "type": "number" }, "Min": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Missing": { - "type": "integer", - "format": "int32" + "type": "integer" }, "StdDev": { "type": "number" }, "Sum": { - "type": "integer", - "format": "int32" + "type": "integer" }, "SumOfSquares": { - "type": "integer", - "format": "int64" + "type": "integer" }, "Facets": { "type": "string", @@ -13785,34 +13122,28 @@ "type": "object", "properties": { "Count": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Max": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Mean": { "type": "number" }, "Min": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Missing": { - "type": "integer", - "format": "int32" + "type": "integer" }, "StdDev": { "type": "number" }, "Sum": { - "type": "integer", - "format": "int32" + "type": "integer" }, "SumOfSquares": { - "type": "integer", - "format": "int64" + "type": "integer" }, "Facets": { "type": "string", @@ -13847,34 +13178,28 @@ "type": "object", "properties": { "Count": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Max": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Mean": { "type": "number" }, "Min": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Missing": { - "type": "integer", - "format": "int32" + "type": "integer" }, "StdDev": { "type": "number" }, "Sum": { - "type": "integer", - "format": "int32" + "type": "integer" }, "SumOfSquares": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Facets": { "$ref": "#/components/schemas/Facets1" @@ -14035,36 +13360,28 @@ "type": "object", "properties": { "Count": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Max": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Mean": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Min": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Missing": { - "type": "integer", - "format": "int32" + "type": "integer" }, "StdDev": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Sum": { - "type": "integer", - "format": "int32" + "type": "integer" }, "SumOfSquares": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Facets": { "type": "string", @@ -14099,34 +13416,28 @@ "type": "object", "properties": { "Count": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Max": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Mean": { "type": "number" }, "Min": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Missing": { - "type": "integer", - "format": "int32" + "type": "integer" }, "StdDev": { "type": "number" }, "Sum": { - "type": "integer", - "format": "int32" + "type": "integer" }, "SumOfSquares": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Facets": { "type": "string", @@ -14184,34 +13495,28 @@ "type": "object", "properties": { "Count": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Max": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Mean": { "type": "number" }, "Min": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Missing": { - "type": "integer", - "format": "int32" + "type": "integer" }, "StdDev": { "type": "number" }, "Sum": { - "type": "integer", - "format": "int32" + "type": "integer" }, "SumOfSquares": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Facets": { "type": "string", @@ -14252,13 +13557,11 @@ }, "discountValue": { "type": "integer", - "format": "int32", "description": "This field can be used to apply a discount to the total value of the order. Value in cents.", "default": 100 }, "incrementValue": { "type": "integer", - "format": "int32", "description": "This field can be used to increment the total value of the order. Value in cents.", "default": 100 }, @@ -14276,13 +13579,11 @@ }, "price": { "type": "integer", - "format": "int32", "description": "Price of the item in cents.", "default": 2499 }, "quantity": { "type": "integer", - "format": "int32", "description": "Amount of items to be removed.", "default": 1 } @@ -14303,13 +13604,11 @@ }, "price": { "type": "integer", - "format": "int32", "description": "Price of the item in cents.", "default": 2499 }, "quantity": { "type": "integer", - "format": "int32", "description": "Amount of items to be added.", "default": 1 } @@ -14485,7 +13784,6 @@ }, "price": { "type": "integer", - "format": "int32", "description": "Price in cents of the SKU being invoiced. Do not use a decimal separator, for example, the price $24.99 corresponds to `2499`. You must insert the SKU unitary price because the VTEX system will multiply the price over the quantity.", "default": 2499 }, @@ -14496,7 +13794,6 @@ }, "quantity": { "type": "integer", - "format": "int32", "description": "Quantity currently in inventory of the SKU being invoiced.", "default": 2 } @@ -14781,7 +14078,6 @@ }, "aliasMaskType": { "type": "integer", - "format": "int32", "description": "Conversation tracker mask type.", "example": 0 }, @@ -14843,7 +14139,6 @@ }, "aliasMaskType": { "type": "integer", - "format": "int32", "description": "Conversation tracker mask type.", "example": 0 }, @@ -14988,17 +14283,14 @@ }, "value": { "type": "integer", - "format": "int32", "description": "Payment value." }, "installments": { "type": "integer", - "format": "int32", "description": "Payment Installments quantity." }, "referenceValue": { "type": "integer", - "format": "int32", "description": "Payment reference Value." }, "cardHolder": { @@ -15301,13 +14593,11 @@ "visibilityTimeoutInSeconds": { "type": "integer", "description": "Period of time for which an item becomes invisible after it has been [retrieved](https://developers.vtex.com/vtex-rest-api/reference/feed-v3#getfeedorderstatus1). Measured in seconds.", - "format": "int32", "example": 250 }, "MessageRetentionPeriodInSeconds": { "type": "integer", "description": "Maximum life span of an order update in the feed. When a feed item is on the feed for this period of time, it is removed from the feed. Measured in seconds.", - "format": "int32", "example": 3456000 } } @@ -15958,7 +15248,6 @@ }, "totalValue": { "type": "integer", - "format": "int32", "description": "Total value amount." }, "paymentNames": { @@ -16050,7 +15339,6 @@ }, "totalItems": { "type": "integer", - "format": "int32", "description": "Order's total amount of items." }, "currencyCode": { @@ -16132,7 +15420,6 @@ }, "quantity": { "type": "integer", - "format": "int32", "description": "Quantity of SKUs." }, "description": { @@ -16159,12 +15446,10 @@ }, "sellingPrice": { "type": "integer", - "format": "int32", "description": "Details on item's selling price." }, "price": { "type": "integer", - "format": "int32", "description": "Item's price." } }, @@ -16269,36 +15554,28 @@ "type": "object", "properties": { "Count": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Max": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Mean": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Min": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Missing": { - "type": "integer", - "format": "int32" + "type": "integer" }, "StdDev": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Sum": { - "type": "integer", - "format": "int32" + "type": "integer" }, "SumOfSquares": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Facets": { "type": "object" @@ -16332,36 +15609,28 @@ "type": "object", "properties": { "Count": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Max": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Mean": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Min": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Missing": { - "type": "integer", - "format": "int32" + "type": "integer" }, "StdDev": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Sum": { - "type": "integer", - "format": "int32" + "type": "integer" }, "SumOfSquares": { - "type": "integer", - "format": "int32" + "type": "integer" }, "Facets": { "type": "object" @@ -16484,7 +15753,6 @@ }, "value": { "type": "integer", - "format": "int32", "description": "Order's total amount." }, "creationDate": { @@ -16641,7 +15909,6 @@ }, "roundingError": { "type": "integer", - "format": "int32", "description": "Rounding error total amount, if it applies. For example, in orders with a discount over non-integer multiplier items, the rounding price is performed per item, not after the sum of all items. That can cause a difference in the total discount amount, which is informed in this field." }, "orderFormId": { @@ -17706,7 +16973,6 @@ }, "quantity": { "type": "integer", - "format": "int32", "description": "Quantity of the item been changed.", "example": 1 } @@ -17774,7 +17040,6 @@ }, "quantity": { "type": "integer", - "format": "int32", "description": "Updated quantity of the item been changed.", "example": 1 }, @@ -17836,7 +17101,6 @@ "properties": { "itemIndex": { "type": "integer", - "format": "int32", "description": "Index that identifies the position of this item in the original array, starting from `0`.", "default": 0 }, @@ -17857,275 +17121,108 @@ }, "price": { "type": "integer", - "format": "int32", "description": "Shipping price for the item in cents. Does not account for the whole order's shipping price.", "example": 1000 } - }, - "example": { - "itemIndex": 0, - "slaId": "Normal", - "deliveryChannel": "delivery", - "addressId": "12334048475146857", - "price": 1000 - } - }, - "response202": { - "title": "response202", - "required": [ - "requestId", - "workflowId", - "reason", - "manualDiscountValue", - "manualIncrementValue", - "totalChangeValue", - "totals", - "add", - "remove", - "replace", - "date", - "origin", - "settings" - ], - "type": "object", - "properties": { - "requestId": { - "type": "string", - "description": "Unique code that identifies a change order request.", - "example": "e8532a32-7f7e-434a-88ec-29609f0ede46" - }, - "workflowId": { - "type": "string", - "description": "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).", - "example": "74f40e7a-68c6-4699-b874-a8a297fb3f6a" - }, - "reason": { - "type": "string", - "description": "Reason that motivated the order change.", - "example": "The client wants to change the items weight." - }, - "manualDiscountValue": { - "type": "integer", - "format": "int32", - "description": "This field shows if a manual price was applied to the total order amount. The value is in cents.", - "example": 0 - }, - "manualIncrementValue": { - "type": "integer", - "format": "int32", - "description": "This field shows if an increment value was applied to the total order amount. The value is in cents.", - "example": 0 - }, - "totalChangeValue": { - "type": "integer", - "format": "int32", - "description": "This field shows how much the order total price is considering that price changes might have been made. The value is in cents.", - "example": 0 - }, - "totals": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Array containing information about change prices per item.", - "example": null - }, - "add": { - "type": "array", - "description": "Array with information about the `add` operation, when applicable. The schema will correspond to the object `to` inside the `replace` array.", - "example": null - }, - "remove": { - "type": "array", - "description": "Array with information about the `remove` operation, when applicable. The schema will correspond to the object `from` inside the `replace` array.", - "example": null - }, - "replace": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Replace1" - }, - "description": "Array with information about the `replace` operation, when applicable." - }, - "date": { - "type": "string", - "description": "Date and time of the request. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.", - "example": "2023-07-27T17:52:18.6483116Z" - }, - "origin": { - "$ref": "#/components/schemas/OriginV2" - }, - "settings": { - "$ref": "#/components/schemas/Settings" - } - }, - "example": { - "requestId": "e8532a32-7f7e-434a-88ec-29609f0ede46", - "workflowId": "74f40e7a-68c6-4699-b874-a8a297fb3f6a", - "reason": "The client wants to change the items weight.", - "manualDiscountValue": 0, - "manualIncrementValue": 0, - "totalChangeValue": 0, - "totals": [], - "add": null, - "remove": null, - "replace": [ - { - "from": { - "paymentData": { - "transactions": [] - }, - "items": [ - { - "id": "31", - "quantity": 1, - "price": null, - "measurementUnit": null, - "unitMultiplier": 0, - "sellingPrice": null, - "name": null, - "detailUrl": null, - "imageUrl": null - } - ], - "shippingData": { - "logisticsInfo": [] - } - }, - "to": { - "items": [ - { - "uniqueId": "40E763F4378E4F40AD1FE915FE1078E1", - "id": "1", - "productId": null, - "productRefId": null, - "refId": null, - "ean": null, - "name": null, - "skuName": null, - "modalType": null, - "parentItemIndex": null, - "parentAssemblyBinding": null, - "assemblies": [], - "priceValidUntil": null, - "tax": 0, - "price": null, - "listPrice": null, - "manualPrice": null, - "manualPriceAppliedBy": null, - "sellingPrice": null, - "rewardValue": 0, - "isGift": false, - "additionalInfo": { - "dimension": null, - "brandName": null, - "brandId": null, - "offeringInfo": null, - "offeringType": null, - "offeringTypeId": null, - "categoriesIds": null, - "productClusterId": null, - "commercialConditionId": null - }, - "preSaleDate": null, - "productCategoryIds": null, - "productCategories": {}, - "quantity": 1, - "seller": null, - "sellerChain": [ - null - ], - "imageUrl": null, - "detailUrl": null, - "components": [], - "bundleItems": [], - "attachments": [], - "attachmentOfferings": [], - "offerings": [], - "priceTags": [], - "availability": null, - "measurementUnit": "un", - "unitMultiplier": 1, - "manufacturerCode": null, - "priceDefinition": null - } - ], - "paymentData": { - "transactions": [] - }, - "receiptData": null, - "shippingData": { - "logisticsInfo": [ - { - "itemIndex": 0, - "selectedSla": "Lenta", - "selectedDeliveryChannel": "delivery", - "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", - "slas": [ - { - "id": "Lenta", - "deliveryChannel": "delivery", - "name": "Lenta", - "deliveryIds": [], - "shippingEstimate": null, - "shippingEstimateDate": null, - "lockTTL": null, - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 600, - "listPrice": 600, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": null, - "transitTime": null - } - ], - "shipsTo": [], - "itemId": "1", - "deliveryChannels": [], - "price": 600, - "listPrice": 600, - "shippingEstimate": null, - "dockEstimate": null, - "shippingEstimateDate": null, - "lockTTL": null, - "deliveryCompany": null, - "polygonName": null, - "transitTime": null, - "sellingPrice": 600, - "deliveryIds": [], - "deliveryWindow": null, - "pickupPointId": null, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupDistance": null - } - ] - } - } + }, + "example": { + "itemIndex": 0, + "slaId": "Normal", + "deliveryChannel": "delivery", + "addressId": "12334048475146857", + "price": 1000 + } + }, + "response202": { + "title": "response202", + "required": [ + "requestId", + "workflowId", + "reason", + "manualDiscountValue", + "manualIncrementValue", + "totalChangeValue", + "totals", + "add", + "remove", + "replace", + "date", + "origin", + "settings" + ], + "type": "object", + "properties": { + "requestId": { + "type": "string", + "description": "Unique code that identifies a change order request.", + "example": "e8532a32-7f7e-434a-88ec-29609f0ede46" + }, + "workflowId": { + "type": "string", + "description": "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).", + "example": "74f40e7a-68c6-4699-b874-a8a297fb3f6a" + }, + "reason": { + "type": "string", + "description": "Reason that motivated the order change.", + "example": "The client wants to change the items weight." + }, + "manualDiscountValue": { + "type": "integer", + "description": "This field shows if a manual price was applied to the total order amount. The value is in cents.", + "example": 0 + }, + "manualIncrementValue": { + "type": "integer", + "description": "This field shows if an increment value was applied to the total order amount. The value is in cents.", + "example": 0 + }, + "totalChangeValue": { + "type": "integer", + "description": "This field shows how much the order total price is considering that price changes might have been made. The value is in cents.", + "example": 0 + }, + "totals": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array containing information about change prices per item.", + "example": null + }, + "add": { + "type": "array", + "description": "Array with information about the `add` operation, when applicable. The schema will correspond to the object `to` inside the `replace` array.", + "example": null, + "items": { + "type": "string" } - ], - "date": "2023-07-27T17:52:18.6483116Z", + }, + "remove": { + "type": "array", + "description": "Array with information about the `remove` operation, when applicable. The schema will correspond to the object `from` inside the `replace` array.", + "example": null, + "items": { + "type": "string" + } + }, + "replace": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Replace1" + }, + "description": "Array with information about the `replace` operation, when applicable." + }, + "date": { + "type": "string", + "description": "Date and time of the request. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.", + "example": "2023-07-27T17:52:18.6483116Z" + }, "origin": { - "account": "qastore", - "orderId": "v12772213qst-02", - "component": "MarketplaceComponent" + "$ref": "#/components/schemas/OriginV2" }, "settings": { - "customPaymentSystemsAllowed": [] + "$ref": "#/components/schemas/Settings" } } }, @@ -18378,7 +17475,6 @@ }, "quantity": { "type": "integer", - "format": "int32", "description": "Quantity of items been replaced.", "example": 1 }, @@ -18396,7 +17492,6 @@ }, "unitMultiplier": { "type": "integer", - "format": "int32", "description": "Unit multiplier for item been update.", "example": 3 }, @@ -18737,7 +17832,6 @@ }, "tax": { "type": "integer", - "format": "int32", "description": "Tax in cents of the item replacing the previous one, when applicable.", "example": 0 }, @@ -18773,7 +17867,6 @@ }, "rewardValue": { "type": "integer", - "format": "int32", "description": "Reward value of the item replacing the previous one. It is calculated in cents.", "example": 50 }, @@ -18806,7 +17899,6 @@ }, "quantity": { "type": "integer", - "format": "int32", "description": "Quantity of replacing items.", "example": 1 }, @@ -18891,7 +17983,6 @@ }, "unitMultiplier": { "type": "integer", - "format": "int32", "description": "Replacing item's unit multiplier.", "example": 1 }, @@ -19154,7 +18245,6 @@ "properties": { "itemIndex": { "type": "integer", - "format": "int32", "description": "Index that identifies the position of the replacing item in the array, starting from `0`.", "example": 0 }, @@ -19203,13 +18293,11 @@ }, "price": { "type": "integer", - "format": "int32", "description": "Replacing item's final price, calculated in cents.", "example": 600 }, "listPrice": { "type": "integer", - "format": "int32", "description": "Replacing item's price list, calculated in cents.", "example": 600 }, @@ -19257,7 +18345,6 @@ }, "sellingPrice": { "type": "integer", - "format": "int32", "description": "Change item's selling price.", "example": 600 }, @@ -19426,19 +18513,16 @@ }, "price": { "type": "integer", - "format": "int32", "description": "Shipping price for the item in cents. Does not account for the whole order's shipping price.", "example": 600 }, "listPrice": { "type": "integer", - "format": "int32", "description": "Item's price list for a specific trade policy.", "example": 600 }, "tax": { "type": "integer", - "format": "int32", "description": "Tax in cents, when applicable.", "example": 0 }, @@ -20099,19 +19183,16 @@ }, "manualDiscountValue": { "type": "integer", - "format": "int32", "description": "This field shows if it was applied a manual price for the total order amount. The value is in cents.", "example": 0 }, "manualIncrementValue": { "type": "integer", - "format": "int32", "description": "This field shows if an increment value was applied to the total order amount. The value is in cents.", "example": 0 }, "totalChangeValue": { "type": "integer", - "format": "int32", "description": "This field shows how much the order total price is, considering that price changes might have been made. The value is in cents.", "example": 0 }, @@ -21228,7 +20309,6 @@ }, "quantity": { "type": "integer", - "format": "int32", "description": "Quantity of items been replaced.", "example": 1 }, @@ -21246,7 +20326,6 @@ }, "unitMultiplier": { "type": "integer", - "format": "int32", "description": "Item's unit multiplier.", "example": 3 }, @@ -21490,7 +20569,6 @@ "properties": { "itemIndex": { "type": "integer", - "format": "int32", "description": "Index that identifies the position of the replacing item in the array, starting from `0`.", "example": 0 }, @@ -21539,13 +20617,11 @@ }, "price": { "type": "integer", - "format": "int32", "description": "Item's final price, calculated in cents.", "example": 600 }, "listPrice": { "type": "integer", - "format": "int32", "description": "Item's price list, calculated in cents.", "example": 600 }, @@ -21593,7 +20669,6 @@ }, "sellingPrice": { "type": "integer", - "format": "int32", "description": "Item's selling price.", "example": 600 }, @@ -21815,7 +20890,6 @@ }, "quantity": { "type": "integer", - "format": "int32", "description": "Quantity of items.", "example": 1 }, @@ -22134,12 +21208,10 @@ "type": "object", "properties": { "calculatedSellingPrice": { - "type": "integer", - "format": "int32" + "type": "integer" }, "total": { - "type": "integer", - "format": "int32" + "type": "integer" }, "sellingPrices": { "type": "array", @@ -22169,12 +21241,10 @@ "type": "object", "properties": { "value": { - "type": "integer", - "format": "int32" + "type": "integer" }, "quantity": { - "type": "integer", - "format": "int32" + "type": "integer" } }, "example": { @@ -22230,19 +21300,16 @@ }, "manualDiscountValue": { "type": "integer", - "format": "int32", "description": "This field shows if a manual price was applied to the total order amount. The value is in cents.", "example": 0 }, "manualIncrementValue": { "type": "integer", - "format": "int32", "description": "This field shows if an increment value was applied to the total order amount. The value is in cents.", "example": 0 }, "totalChangeValue": { "type": "integer", - "format": "int32", "description": "This field shows how much is the order total price considering that price changes might have been made. The value is in cents.", "example": 0 }, @@ -22257,12 +21324,18 @@ "add": { "type": "array", "description": "Array with information about the `add` operation, when applicable. The schema will correspond to the object `to` inside the `replace` array.", - "example": null + "example": null, + "items": { + "type": "string" + } }, "remove": { "type": "array", "description": "Array with information about the `remove` operation, when applicable. The schema will correspond to the object `from` inside the `replace` array.", - "example": null + "example": null, + "items": { + "type": "string" + } }, "replace": { "type": "array", @@ -22282,177 +21355,6 @@ "settings": { "$ref": "#/components/schemas/Settings" } - }, - "example": { - "requestId": "e8532a32-7f7e-434a-88ec-29609f0ede46", - "workflowId": "74f40e7a-68c6-4699-b874-a8a297fb3f6a", - "status": "handling", - "inProgress": true, - "reason": "The client wants to change the items weight.", - "manualDiscountValue": 0, - "manualIncrementValue": 0, - "totalChangeValue": 0, - "totals": [], - "add": null, - "remove": null, - "replace": [ - { - "from": { - "paymentData": { - "transactions": [] - }, - "items": [ - { - "id": "31", - "quantity": 1, - "price": null, - "measurementUnit": null, - "unitMultiplier": 0, - "sellingPrice": null, - "name": null, - "detailUrl": null, - "imageUrl": null - } - ], - "shippingData": { - "logisticsInfo": [] - } - }, - "to": { - "items": [ - { - "uniqueId": "40E763F4378E4F40AD1FE915FE1078E1", - "id": "1", - "productId": null, - "productRefId": null, - "refId": null, - "ean": null, - "name": null, - "skuName": null, - "modalType": null, - "parentItemIndex": null, - "parentAssemblyBinding": null, - "assemblies": [], - "priceValidUntil": null, - "tax": 0, - "price": null, - "listPrice": null, - "manualPrice": null, - "manualPriceAppliedBy": null, - "sellingPrice": null, - "rewardValue": 0, - "isGift": false, - "additionalInfo": { - "dimension": null, - "brandName": null, - "brandId": null, - "offeringInfo": null, - "offeringType": null, - "offeringTypeId": null, - "categoriesIds": null, - "productClusterId": null, - "commercialConditionId": null - }, - "preSaleDate": null, - "productCategoryIds": null, - "productCategories": {}, - "quantity": 1, - "seller": null, - "sellerChain": [ - null - ], - "imageUrl": null, - "detailUrl": null, - "components": [], - "bundleItems": [], - "attachments": [], - "attachmentOfferings": [], - "offerings": [], - "priceTags": [], - "availability": null, - "measurementUnit": "un", - "unitMultiplier": 1, - "manufacturerCode": null, - "priceDefinition": null - } - ], - "paymentData": { - "transactions": [] - }, - "receiptData": null, - "shippingData": { - "logisticsInfo": [ - { - "itemIndex": 0, - "selectedSla": "Lenta", - "selectedDeliveryChannel": "delivery", - "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", - "slas": [ - { - "id": "Lenta", - "deliveryChannel": "delivery", - "name": "Lenta", - "deliveryIds": [], - "shippingEstimate": null, - "shippingEstimateDate": null, - "lockTTL": null, - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 600, - "listPrice": 600, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": null, - "polygonName": null, - "transitTime": null - } - ], - "shipsTo": [], - "itemId": "1", - "deliveryChannels": [], - "price": 600, - "listPrice": 600, - "shippingEstimate": null, - "dockEstimate": null, - "shippingEstimateDate": null, - "lockTTL": null, - "deliveryCompany": null, - "polygonName": null, - "transitTime": null, - "sellingPrice": 600, - "deliveryIds": [], - "deliveryWindow": null, - "pickupPointId": null, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupDistance": null - } - ] - } - } - } - ], - "date": "2023-07-27T17:52:18.6483116Z", - "origin": { - "account": "qastore", - "orderId": "v12772213qst-02", - "component": "MarketplaceComponent" - }, - "settings": { - "customPaymentSystemsAllowed": [] - } } }, "PreviewChangebyschleeRequest": { @@ -22535,16 +21437,13 @@ "type": "string" }, "manualDiscountValue": { - "type": "integer", - "format": "int32" + "type": "integer" }, "manualIncrementValue": { - "type": "integer", - "format": "int32" + "type": "integer" }, "totalChangeValue": { - "type": "integer", - "format": "int32" + "type": "integer" }, "totals": { "type": "array", @@ -23034,8 +21933,7 @@ "type": "string" }, "value": { - "type": "integer", - "format": "int32" + "type": "integer" } }, "example": {