PreviewChange

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PreviewChange",
  "title": "PreviewChange",
  "required": [
    "reason",
    "replace"
  ],
  "type": "object",
  "properties": {
    "reason": {
      "type": "string",
      "description": "Reason why you wish to change order. Since you can make several changes to an order, filling this field with a clear explanation helps organize the change order history. The shopper can view this field value in [transactional emails](https://help.vtex.com/en/tutorial/order-transactional-email-templates--3g2S2kqBOoSGcCaqMYK2my) and [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh).",
      "example": "The client wants to change a weighable product."
    },
    "replace": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Replace"
      },
      "description": "Name of the change operation you are performing, which can be `replace`, `add` or `remove`. If you want, you can combine all change operations in a single request."
    }
  },
  "example": {
    "reason": "The client wants to change a weighable product.",
    "replace": [
      {
        "from": {
          "items": [
            {
              "id": "1",
              "quantity": 1
            }
          ]
        },
        "to": {
          "items": [
            {
              "id": "1",
              "quantity": 1,
              "measurementUnit": "kg",
              "unitMultiplier": 1
            }
          ],
          "shippingData": {
            "logisticsInfo": [
              {
                "itemIndex": 0,
                "slaId": "Normal",
                "deliveryChannel": "delivery",
                "addressId": "12334048475146857",
                "price": 1000
              }
            ]
          }
        }
      }
    ]
  }
}