openapi: 3.0.0
info:
  title: VTex Anti-fraud Provider Account Change Order (Beta) API
  description: ">ℹ️ Onboarding guide\r\n>\r\n> Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.\r\n\r\nThe Anti-fraud Provider Protocol is a set of definitions to help you integrate your anti-fraud service API into VTEX platform.\r\n\r\nTo achieve this, you need to implement a web API (REST) following the specifications described in this documentation.\r\n\r\n>⚠️ You can also access our [template on GitHub](https://github.com/vtex-apps/antifraud-provider-example) to help you quickly develop your anti-fraud connector using the Anti-fraud Provider Protocol and VTEX IO.\r\n\r\nTo learn more about the Anti-fraud Provider Protocol, check our [developer guide](https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works).\r\n\r\n## Anti-fraud Provider API Index\r\n\r\n### Anti-fraud  Flow\r\n\r\n- `POST` [Send Anti-fraud Pre-Analysis Data (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/pre-analysis)\r\n- `POST` [Send Anti-fraud Data](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/transactions)\r\n- `PUT` [Update Anti-fraud Transactions (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#put-/transactions/-transactionId-)\r\n- `GET` [List Anti-fraud Provider Manifest](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/manifest)\r\n- `GET` [Get Anti-fraud Status](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/transactions/-transactions.id-)\r\n- `DELETE` [Stop Anti-fraud Analysis (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#delete-/transactions/-transactions.Id-)\r\n\r\n### OAuth Flow\r\n\r\n1. `POST` [Retrieve Token](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/authorization/token)\r\n2. `GET` [Redirect](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/redirect)\r\n3. `GET` [Return to VTEX](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorizationCode)\r\n4. `GET` [Get Credentials](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorization/credentials)"
  version: '1.0'
servers:
- url: https://{providerApiEndpoint}
  description: Anti-fraud provider endpoint URL.
  variables:
    providerApiEndpoint:
      description: Anti-fraud provider endpoint URL.
      default: '{providerApiEndpoint}'
tags:
- name: Change Order (Beta)
paths:
  /api/order-system/orders/{changeOrderId}/changes:
    patch:
      tags:
      - Change Order (Beta)
      summary: VTex Create order change
      operationId: Createchange
      description: "[Change order](https://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ) 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 \r\n- Acceptable order status for changes \r\n- Order change and price \r\n- 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](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes) 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 customer, 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 customer for the difference.\r\n- **Higher price after order change:** An automatic notification is sent to the payment gateway to require the customer 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 | <p>Cancel order</p><p>Change order</p> |\r\n| IntegrationProfile - Fulfillment Oms | <p>Cancel order</p><p>Change order</p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms | <p>Cancel order</p><p>Change order</p> |\r\n| inStore Sales Person | <p>Cancel order</p><p>Change order</p> |\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)."
      parameters:
      - name: an
        in: query
        description: Name of the VTEX account that created the order.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: storeName
      - name: Content-Type
        in: header
        description: Type of the content being sent.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: Accept
        in: header
        description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: changeOrderId
        in: path
        description: Order ID of the order you wish to change.
        required: true
        style: simple
        schema:
          type: string
          example: v12772213qst-02
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/Createchange'
              - 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
            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
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                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: []
    get:
      tags:
      - Change Order (Beta)
      summary: VTex Get order change history
      operationId: GetChangeHistory
      description: "This endpoint retrieves a history of every successful [Change order request](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) made to an order and provides detailed information about each request.\r\n\r\nYou can access an order's history using the `changeOrderId`, which corresponds to its `orderId`.\r\n\r\n> If you want detailed information about a single change request, you can use the endpoint [Get order change details](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-).\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 | <p>Cancel order</p><p>Change order</p> |\r\n| IntegrationProfile - Fulfillment Oms | <p>Cancel order</p><p>Change order</p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms | <p>Cancel order</p><p>Change order</p> |\r\n| inStore Sales Person | <p>Cancel order</p><p>Change order</p> |\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)."
      parameters:
      - name: an
        in: query
        description: Name of the VTEX account that created the order.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: storeName
      - name: Content-Type
        in: header
        description: Type of the content being sent.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: Accept
        in: header
        description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: changeOrderId
        in: path
        description: Order ID of the order you wish to get the change history.
        required: true
        style: simple
        schema:
          type: string
          example: v12772213qst-02
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/GetChangeHistory'
                - 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: []
              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: []
  /api/order-system/orders/{changeOrderId}/changes/{changeRequestId}:
    get:
      tags:
      - Change Order (Beta)
      summary: VTex Get order change details
      description: "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 [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint.\r\n\r\nThe successful status code is `200 OK`, and its response body schema is very similar to the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) 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](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes) 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 | <p>Cancel order</p><p>Change order</p> |\r\n| IntegrationProfile - Fulfillment Oms | <p>Cancel order</p><p>Change order</p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms | <p>Cancel order</p><p>Change order</p> |\r\n| inStore Sales Person | <p>Cancel order</p><p>Change order</p> |\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)."
      operationId: GetChangeDetail
      parameters:
      - name: an
        in: query
        description: Name of the VTEX account that created the order.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: storeName
      - name: Content-Type
        in: header
        description: Type of the content being sent.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: Accept
        in: header
        description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: changeOrderId
        in: path
        description: Order ID of the order you wish to get the change detail.
        required: true
        style: simple
        schema:
          type: string
          example: v12772213qst-02
      - name: changeRequestId
        in: path
        description: Once you make an order change, you generate a `requestId` code that identifies the changes made to that order. This field should be filled with that code. There are no limits to changes you can perform using the same `changeRequestId`, and we recommend keeping all changes of a given order grouped by the same `changeRequestId`, so you will have a unified change history.
        required: true
        style: simple
        schema:
          type: string
          example: e8532a32-7f7e-434a-88ec-29609f0ede46
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/GetChangeDetail'
              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: []
  /api/order-system/orders/{changeOrderId}/changes/preview:
    post:
      tags:
      - Change Order (Beta)
      summary: VTex Preview order change
      operationId: PreviewChange
      description: "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](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) 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 [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) 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 | <p>Cancel order</p><p>Change order</p> |\r\n| IntegrationProfile - Fulfillment Oms | <p>Cancel order</p><p>Change order</p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms | <p>Cancel order</p><p>Change order</p> |\r\n| inStore Sales Person | <p>Cancel order</p><p>Change order</p> |\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)."
      parameters:
      - name: an
        in: query
        description: Name of the VTEX account that created the order.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: storeName
      - name: Content-Type
        in: header
        description: Type of the content being sent.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: Accept
        in: header
        description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: changeOrderId
        in: path
        description: Order ID of the order you wish to preview change.
        required: true
        style: simple
        schema:
          type: string
          example: v12772213qst-02
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PreviewChange'
              - 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
            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
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/PreviewChange1'
                - example:
                    reason: I would like to receive a preview.
                    manualDiscountValue: 0
                    manualIncrementValue: 0
                    totalChangeValue: 420
                    totals:
                    - id: ManualValues
                      name: Manual Values Total
                      value: 0
                    - id: Shipping
                      name: Shipping Total
                      value: 420
                    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: 303A1E4534984FF295BA571BF08C8297
                          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-27T18:01:26.4743309Z'
                    origin:
                      account: qastore
                      orderId: v12772213qst-02
                      component: MarketplaceComponent
                    settings:
                      customPaymentSystemsAllowed: []
              example:
                reason: I would like to receive a preview.
                manualDiscountValue: 0
                manualIncrementValue: 0
                totalChangeValue: 420
                totals:
                - id: ManualValues
                  name: Manual Values Total
                  value: 0
                - id: Shipping
                  name: Shipping Total
                  value: 420
                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: 303A1E4534984FF295BA571BF08C8297
                      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-27T18:01:26.4743309Z'
                origin:
                  account: qastore
                  orderId: v12772213qst-02
                  component: MarketplaceComponent
                settings:
                  customPaymentSystemsAllowed: []
  /api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/retry:
    post:
      tags:
      - Change Order (Beta)
      summary: VTex Retry order change
      operationId: RetryChange
      description: "This endpoint makes a new attempt to perform an order change previously made using the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) 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 order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) 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 | <p>Cancel order</p><p>Change order</p> |\r\n| IntegrationProfile - Fulfillment Oms | <p>Cancel order</p><p>Change order</p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms | <p>Cancel order</p><p>Change order</p> |\r\n| inStore Sales Person | <p>Cancel order</p><p>Change order</p> |\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)."
      parameters:
      - name: Content-Type
        in: header
        description: Type of the content being sent.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: Accept
        in: header
        description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: an
        in: query
        description: Name of the VTEX account that created the order.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: storeName
      - name: changeOrderId
        in: path
        description: Order ID of the order you wish to retry change.
        required: true
        style: simple
        schema:
          type: string
          example: v12772213qst-02
      - name: changeRequestId
        in: path
        description: "Once you make an order change, you generate a `requestId` code that identifies the changes made to that order. This field should be filled with that code.\r\n\r\nThere are no limits to changes you can perform using the same `changeRequestId`, and we recommend keeping all changes of a given order grouped by the same `changeRequestId`, so you will have a unified change history."
        required: true
        style: simple
        schema:
          type: string
          example: e8532a32-7f7e-434a-88ec-29609f0ede46
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/Createchange'
              - 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
            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
        required: true
      responses:
        '204':
          description: No Content
          content: {}
  /api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/cancel:
    post:
      tags:
      - Change Order (Beta)
      summary: VTex Cancel order change
      operationId: CancelChangeStoppedonError
      description: "This endpoint cancels an [order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes). It is meant for when, due to an error, a change was not completely processed, and you do not wish to [retry](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-/retry) it. For this request, you need the order's `changeRequestId`, the unique identification code generated by the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint.\r\n\r\n>⚠️ Once 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](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes).\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 | <p>Cancel order</p><p>Change order</p> |\r\n| IntegrationProfile - Fulfillment Oms | <p>Cancel order</p><p>Change order</p> |\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms | <p>Cancel order</p><p>Change order</p> |\r\n| inStore Sales Person | <p>Cancel order</p><p>Change order</p> |\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)."
      parameters:
      - name: Content-Type
        in: header
        description: Type of the content being sent.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: Accept
        in: header
        description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: an
        in: query
        description: Name of the VTEX account that created the order.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: storeName
      - name: changeOrderId
        in: path
        description: Order ID of the order with the changes you wish to cancel.
        required: true
        style: simple
        schema:
          type: string
          example: v12772213qst-02
      - name: changeRequestId
        in: path
        description: Once you make an order change, you generate a `requestId` code that identifies the changes made to that order. This field should be filled with that code. After cancelling an order change, the `changeRequestId` will no longer be valid.
        required: true
        style: simple
        schema:
          type: string
          example: e8532a32-7f7e-434a-88ec-29609f0ede46
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CancelChangeStoppedonError'
              - example:
                  reason: I want to cancel this change order request because it's stopped on a blocking error.
            example:
              reason: I want to cancel this change order request because it's stopped on a blocking error.
        required: true
      responses:
        '200':
          description: OK
components:
  schemas:
    Replace2:
      title: Replace2
      required:
      - from
      - to
      type: object
      properties:
        from:
          $ref: '#/components/schemas/From2'
        to:
          $ref: '#/components/schemas/To2'
      example:
        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
    Item1V2:
      title: Item1V2
      required:
      - id
      - quantity
      - measurementUnit
      - unitMultiplier
      type: object
      properties:
        id:
          type: string
          description: SKU ID of the item that will replace the previous one. If you only wish to replace the product weight, you will repeat the SKU ID used in `from`.
          example: '1'
        quantity:
          type: integer
          description: Updated quantity of the item been changed.
          example: 1
        measurementUnit:
          type: string
          description: Measurement unit of the new item. The values accepted are the measurement units registered in the store's catalog. For example, `kg` for kilograms or `un` for unitary items. When you don't specify a value, the request gets the information from the Catalog.
          example: kg
        unitMultiplier:
          type: number
          description: Unit multiplier for item update. For example, if you wish to increase an order with three times more items than a single one, you would fill in with `3.0`.
          example: 3
      example:
        id: '1'
        quantity: 1
        measurementUnit: kg
        unitMultiplier: 1
    OriginV2:
      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
    ShippingData3:
      title: ShippingData3
      required:
      - logisticsInfo
      type: object
      properties:
        logisticsInfo:
          type: array
          items:
            $ref: '#/components/schemas/LogisticsInfo2'
          description: Array with shipping information.
      example:
        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
    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: []
    To2:
      title: To2
      required:
      - items
      - paymentData
      - receiptData
      - shippingData
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item3'
          description: Array containing information about the item replacing the previous one.
        paymentData:
          $ref: '#/components/schemas/PaymentDataV2'
        receiptData:
          type: object
          nullable: true
          description: Information about the receipt after order change.
          example: null
        shippingData:
          $ref: '#/components/schemas/ShippingData3'
      example:
        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
    TotalV2:
      title: TotalV2
      required:
      - id
      - name
      - value
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        value:
          type: integer
      example:
        id: ManualValues
        name: Manual Values Total
        value: 0
    LogisticsInfo1:
      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
          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:
            $ref: '#/components/schemas/SlaV2'
          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:
            $ref: '#/components/schemas/DeliveryChannel'
          description: Array with the delivery channels associated with the trade policy.
        price:
          type: integer
          description: Replacing item's final price, calculated in cents.
          example: 600
        listPrice:
          type: integer
          description: Replacing item's price list, calculated in cents.
          example: 600
        shippingEstimate:
          type: string
          nullable: true
          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
          nullable: true
          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
          nullable: true
          description: Replacing item's total shipping duration estimated in days. For instance, three business days are represented as `3bd`.
          example: 3bd
        lockTTL:
          type: string
          nullable: true
          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
          nullable: true
          description: '[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) company''s name.'
          example: Correios
        polygonName:
          type: string
          nullable: true
          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
          nullable: true
          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
          description: Change item's selling price.
          example: 600
        deliveryIds:
          type: array
          items:
            $ref: '#/components/schemas/DeliveryIdV2'
          description: Array with delivery information.
        deliveryWindow:
          type: string
          nullable: true
          description: Change order [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.
          example: null
        pickupPointId:
          type: string
          nullable: true
          description: ID of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).
          example: pup215rkw
        pickupStoreInfo:
          $ref: '#/components/schemas/PickupStoreInfoV2'
        pickupDistance:
          type: number
          nullable: true
          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
    Createchange:
      title: Createchange
      required:
      - reason
      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: "Array containing `replace` change information. Besides `replace`, you can `add` or `remove` items from an order.\r\n\r\n- `add`: the schema will correspond to the object `to` inside the `replace` array.\r\n\r\n- `remove`: the schema will correspond to the object `from` inside the `replace` array.\r\n\r\nYou will find request body examples of both cases in the endpoint description on the top of the page. The successful response `202 - Accepted` schema is the same for all three operations, whether they are used separately or combined in the same 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
    GetChangeDetail:
      title: GetChangeDetail
      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
          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 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
          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
          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:
          $ref: '#/components/schemas/OriginV2'
        settings:
          $ref: '#/components/schemas/Settings'
    Item4:
      title: Item4
      required:
      - id
      - quantity
      - price
      - measurementUnit
      - unitMultiplier
      - sellingPrice
      - name
      - detailUrl
      - imageUrl
      type: object
      properties:
        id:
          type: string
          description: SKU ID of the item.
          example: '1'
        quantity:
          type: integer
          description: Quantity of items been replaced.
          example: 1
        price:
          type: string
          nullable: true
          description: Item's shipping price. It does not account for the whole order's shipping price and is presented in cents.
          example: 1000
        measurementUnit:
          type: string
          nullable: true
          description: Item's measurement unit. For example, `kg` for kilograms or `un` for unitary items.
          example: kg
        unitMultiplier:
          type: integer
          description: Item's unit multiplier.
          example: 3
        sellingPrice:
          type: string
          description: Item's selling price.
          example: 100
        name:
          type: string
          nullable: true
          description: Item's name.
          example: T-shirt with logo
        detailUrl:
          type: string
          nullable: true
          description: Item's URL slug.
          example: /tshirt-logo/p
        imageUrl:
          type: string
          nullable: true
          description: Item's image URL slug.
          example: http://store.com.br/ids/155419-55-55//tshirt-logo.png?v=6378858562367
      example:
        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
    LogisticsInfo2:
      title: LogisticsInfo2
      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
          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.
          example: 9ec276fd3a604eb1aa151b5333ca5db7
        slas:
          type: array
          items:
            $ref: '#/components/schemas/SlaV2'
          description: Information on Service Level Agreement (SLA) of the change order.
        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:
            $ref: '#/components/schemas/DeliveryChannel'
          description: Array with the delivery channels associated with the trade policy.
        price:
          type: integer
          description: Item's final price, calculated in cents.
          example: 600
        listPrice:
          type: integer
          description: Item's price list, calculated in cents.
          example: 600
        shippingEstimate:
          type: string
          nullable: true
          description: 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
          nullable: true
          description: 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
          nullable: true
          description: Replacing item's total shipping duration estimated in days. For instance, three business days are represented as `3bd`.
          example: 3bd
        lockTTL:
          type: string
          nullable: true
          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
          nullable: true
          description: '[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) company''s name.'
          example: Correios
        polygonName:
          type: string
          nullable: true
          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
          nullable: true
          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
          description: Item's selling price.
          example: 600
        deliveryIds:
          type: array
          items:
            $ref: '#/components/schemas/DeliveryIdV2'
          description: Array with delivery information.
        deliveryWindow:
          type: string
          nullable: true
          description: Change order [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.
          example: null
        pickupPointId:
          type: string
          nullable: true
          description: ID of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).
          example: pup215rkw
        pickupStoreInfo:
          $ref: '#/components/schemas/PickupStoreInfoV2'
        pickupDistance:
          type: number
          nullable: true
          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:
          - 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
    Request:
      title: Request
      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 an order change.
          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 it was applied a manual price for 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.
        add:
          type: object
          nullable: true
          description: Information about an `add` operation, when there was one. It will have the same schema of `request.replace.to`.
          example: null
        remove:
          type: object
          nullable: true
          description: Information about a `remove` operation, when there was one. It will have the same schema of `request.replace.from`.
          example: null
        replace:
          type: array
          items:
            $ref: '#/components/schemas/Replace2'
          description: Array with information about the replacement operation performed.
        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 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: []
    Item3:
      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
          nullable: true
          description: Product ID of the item replacing the previous one.
          example: '7'
        productRefId:
          type: string
          nullable: true
          description: Product Ref ID of the item replacing the previous one.
          example: smallcup
        refId:
          type: string
          nullable: true
          description: Reference ID of the item replacing the previous one.
          example: '356'
        ean:
          type: string
          nullable: true
          description: European Article Number (EAN) of the item replacing the previous one.
          example: '8745121641680'
        name:
          type: string
          nullable: true
          description: Name of the Product associated with the item replacing the previous one.
          example: Small cup of coffee with pink logo
        skuName:
          type: string
          nullable: true
          description: Name of the SKU replacing the previous one.
          example: Small blue cup
        modalType:
          type: string
          nullable: true
          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
          nullable: true
          description: Parent item index of the item replacing the previous one.
          example: 0
        parentAssemblyBinding:
          type: string
          nullable: true
          description: Parent assembly binding of the item replacing the previous one.
          example: null
        assemblies:
          type: array
          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.
          nullable: true
        priceValidUntil:
          type: string
          nullable: true
          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
          description: Tax in cents of the item replacing the previous one, when applicable.
          example: 0
        price:
          type: string
          nullable: true
          description: Final price of the item replacing the previous one, calculated in cents.
          example: 600
        listPrice:
          type: string
          nullable: true
          description: Item's price list for the item replacing the previous one.
          example: 600
        manualPrice:
          type: integer
          nullable: true
          description: Manual price of the item replacing the previous one. It is calculated in cents.
          example: 6500
        manualPriceAppliedBy:
          type: string
          nullable: true
          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
          nullable: true
          description: Selling price of the item replacing the previous one. It is calculated in cents.
          example: 600
        rewardValue:
          type: integer
          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:
          $ref: '#/components/schemas/AdditionalInfoV2'
        preSaleDate:
          type: string
          nullable: true
          description: Pre sale date of the item replacing the previous one.
          example: '2023-01-01T00:00:00.0000000+00:00'
        productCategoryIds:
          type: string
          nullable: true
          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
          description: Quantity of replacing items.
          example: 1
        seller:
          type: string
          nullable: true
          description: Seller ID that identifies the seller the replacing item belongs to.
          example: '1'
        sellerChain:
          type: array
          items:
            type: string
            nullable: true
          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
          nullable: true
          description: Image URL slug of the replacing item.
          example: http://store.com.br/ids/155419-55-55//cupcoffee.png?v=6368858582363
        detailUrl:
          type: string
          nullable: true
          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
          nullable: true
          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
          description: Replacing item's unit multiplier.
          example: 1
        manufacturerCode:
          type: string
          nullable: true
          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
          nullable: true
          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
    PreviewChange1:
      title: PreviewChange1
      required:
      - reason
      - manualDiscountValue
      - manualIncrementValue
      - totalChangeValue
      - totals
      - add
      - remove
      - replace
      - date
      - origin
      - settings
      type: object
      properties:
        reason:
          type: string
        manualDiscountValue:
          type: integer
        manualIncrementValue:
          type: integer
        totalChangeValue:
          type: integer
        totals:
          type: array
          items:
            $ref: '#/components/schemas/TotalV2'
          description: Array containing totals information.
        add:
          type: string
          nullable: true
        remove:
          type: string
          nullable: true
        replace:
          type: array
          items:
            $ref: '#/components/schemas/Replace2'
          description: Array containing replace information.
        date:
          type: string
        origin:
          $ref: '#/components/schemas/OriginV2'
        settings:
          $ref: '#/components/schemas/Settings'
      example:
        reason: I would like to receive a preview.
        manualDiscountValue: 0
        manualIncrementValue: 0
        totalChangeValue: 420
        totals:
        - id: ManualValues
          name: Manual Values Total
          value: 0
        - id: Shipping
          name: Shipping Total
          value: 420
        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: 303A1E4534984FF295BA571BF08C8297
              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-27T18:01:26.4743309Z'
        origin:
          account: qastore
          orderId: v12772213qst-02
          component: MarketplaceComponent
        settings:
          customPaymentSystemsAllowed: []
    Replace:
      title: Replace
      required:
      - from
      - to
      type: object
      properties:
        from:
          $ref: '#/components/schemas/FromV2'
        to:
          $ref: '#/components/schemas/ToV2'
      example:
        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
    FromV2:
      title: FromV2
      required:
      - items
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ItemV2'
          description: Array with information about the item to be replaced.
      description: Object with information about the items been replaced. If instead of an order `replace` you wish to `remove` items, you will use the same schema naming the object `remove` instead of `from`. For a complete example, see the description at the top of the page.
      example:
        items:
        - id: '1'
          quantity: 1
    CancelChangeStoppedonError:
      title: CancelChangeStoppedonError
      required:
      - reason
      type: object
      properties:
        reason:
          type: string
          description: Reason why you wish to cancel the order change. The customer will not view the value inserted in this field.
          example: I want to cancel this change order request because it's stopped on a blocking error.
      example:
        reason: I want to cancel this change order request because it's stopped on a blocking error.
    DeliveryChannel:
      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
    To1:
      title: To1
      required:
      - items
      - paymentData
      - receiptData
      - shippingData
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item3'
          description: Array containing information about the item replacing the previous one.
        paymentData:
          $ref: '#/components/schemas/PaymentDataV2'
        receiptData:
          type: object
          nullable: true
          description: Information about the receipt after order change.
          example: null
        shippingData:
          $ref: '#/components/schemas/ShippingData2'
      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
    PickupStoreInfoV2:
      title: PickupStoreInfoV2
      required:
      - isPickupStore
      - friendlyName
      - address
      - additionalInfo
      - dockId
      type: object
      properties:
        isPickupStore:
          type: boolean
          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.
          example: false
          nullable: true
          deprecated: true
        friendlyName:
          type: string
          description: Name of the loading dock converted to pickup point to be displayed at checkout. This field has been deprecated.
          example: null
          nullable: true
          deprecated: true
        address:
          type: string
          nullable: true
          description: Address of the loading dock converted to pickup point. This field has been deprecated.
          example: null
          deprecated: true
        additionalInfo:
          type: string
          nullable: true
          description: Additional information about the loading dock converted to pickup point. This field has been deprecated.
          example: null
          deprecated: true
        dockId:
          type: string
          nullable: true
          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
    AdditionalInfoV2:
      title: AdditionalInfoV2
      required:
      - dimension
      - brandName
      - brandId
      - offeringInfo
      - offeringType
      - offeringTypeId
      - categoriesIds
      - productClusterId
      - commercialConditionId
      type: object
      properties:
        dimension:
          type: string
          nullable: true
          description: Replacing tem's dimensions in the measure unit configured in the catalog.
          example: null
        brandName:
          type: string
          nullable: true
          description: Replacing item's brand name.
          example: Special coffee cup
        brandId:
          type: string
          nullable: true
          description: Replacing item's brand ID.
          example: '2000001'
        offeringInfo:
          type: string
          nullable: true
          description: Offering information.
          example: null
        offeringType:
          type: string
          nullable: true
          description: Offering type.
          example: null
        offeringTypeId:
          type: string
          nullable: true
          description: Offering type ID.
          example: null
        categoriesIds:
          type: string
          nullable: true
          description: ID of the replacing item product category.
          example: null
        productClusterId:
          type: string
          nullable: true
          description: All product clusters related to the replacing item.
          example: 135,137,143,518,1272
        commercialConditionId:
          type: string
          nullable: true
          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
    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
        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:
          $ref: '#/components/schemas/OriginV2'
        settings:
          $ref: '#/components/schemas/Settings'
    ShippingDataV2:
      title: ShippingDataV2
      required:
      - logisticsInfo
      type: object
      properties:
        logisticsInfo:
          type: array
          items:
            $ref: '#/components/schemas/LogisticsInfoV2'
          description: Array containing information about the shipping address of the changed order. This field is optional, when you don't send it the request body, the system assumes there were no changes in shipping.
      example:
        logisticsInfo:
        - itemIndex: 0
          slaId: Normal
          deliveryChannel: delivery
          addressId: '12334048475146857'
          price: 1000
    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
    Item2V2:
      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
          description: Quantity of items been replaced.
          example: 1
        price:
          type: string
          nullable: true
          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
          nullable: true
          description: Measurement unit of the item been replaced. For example, `kg` for kilograms or `un` for unitary items.
          example: kg
        unitMultiplier:
          type: integer
          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
          nullable: true
          description: Name of the item been replaced.
          example: T-shirt with logo
        detailUrl:
          type: string
          nullable: true
          description: URL slug of the item been replaced.
          example: /tshirt-logo/p
        imageUrl:
          type: string
          nullable: true
          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
    ToV2:
      title: ToV2
      required:
      - items
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item1V2'
          description: Array with information about the replacing item.
        shippingData:
          $ref: '#/components/schemas/ShippingDataV2'
      description: Object with information about the new replacing items. If instead of an order `replace` you wish to `add` items, you will use the same schema naming the object `add` instead of `to`. For a complete example, see the description at the top of the page.
      example:
        items:
        - id: '1'
          quantity: 1
          measurementUnit: kg
          unitMultiplier: 1
        shippingData:
          logisticsInfo:
          - itemIndex: 0
            slaId: Normal
            deliveryChannel: delivery
            addressId: '12334048475146857'
            price: 1000
    ItemV2:
      title: ItemV2
      required:
      - id
      - quantity
      type: object
      properties:
        id:
          type: string
          description: SKU ID of the item that will be changed.
          example: '1'
        quantity:
          type: integer
          description: Quantity of the item been changed.
          example: 1
      example:
        id: '1'
        quantity: 1
    From2:
      title: From2
      required:
      - paymentData
      - items
      - shippingData
      type: object
      properties:
        paymentData:
          $ref: '#/components/schemas/PaymentDataV2'
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item4'
        shippingData:
          $ref: '#/components/schemas/ShippingData3'
      example:
        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
    LogisticsInfoV2:
      title: LogisticsInfoV2
      required:
      - itemIndex
      - slaId
      - deliveryChannel
      - addressId
      - price
      type: object
      properties:
        itemIndex:
          type: integer
          description: Index that identifies the position of this item in the original array, starting from `0`.
          example: 0
        slaId:
          type: string
          description: Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the order.
          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
        addressId:
          type: string
          description: Shipping address ID.
          example: 9ec276fd3a604eb1aa151b5333ca5db7
        price:
          type: integer
          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
    ShippingData2:
      title: ShippingData2
      required:
      - logisticsInfo
      type: object
      properties:
        logisticsInfo:
          type: array
          items:
            $ref: '#/components/schemas/LogisticsInfo1'
          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
    Replace1:
      title: Replace1
      required:
      - from
      - to
      type: object
      properties:
        from:
          $ref: '#/components/schemas/From1'
        to:
          $ref: '#/components/schemas/To1'
      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
    SlaV2:
      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:
            $ref: '#/components/schemas/DeliveryIdV2'
          description: Information about delivery IDs.
        shippingEstimate:
          type: string
          nullable: true
          description: Total shipping duration estimated in days. For instance, three business days is represented as `3bd`.
          example: 3bd
        shippingEstimateDate:
          type: string
          nullable: true
          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
          nullable: true
          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
          nullable: true
          description: '[Scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.'
          example: null
        price:
          type: integer
          description: Shipping price for the item in cents. Does not account for the whole order's shipping price.
          example: 600
        listPrice:
          type: integer
          description: Item's price list for a specific trade policy.
          example: 600
        tax:
          type: integer
          description: Tax in cents, when applicable.
          example: 0
        pickupStoreInfo:
          $ref: '#/components/schemas/PickupStoreInfoV2'
        pickupPointId:
          type: string
          nullable: true
          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
          nullable: true
          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
          nullable: true
          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
          nullable: true
          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
    DeliveryIdV2:
      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
          description: Quantity of items.
          example: 1
        kitItemDetails:
          type: array
          items:
            type: string
            description: Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), when applicable to the order.
            example: null
            nullable: true
        accountCarrierName:
          type: string
          nullable: true
          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
    ShippingData1:
      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: []
    GetChangeHistory:
      title: GetChangeHistory
      required:
      - requests
      - actions
      type: object
      properties:
        requests:
          type: array
          items:
            $ref: '#/components/schemas/Request'
          description: Array with change order requests details.
        actions:
          type: array
          items:
            type: string
          description: Array containing actions information.
      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: []
    PaymentDataV2:
      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: []
    From1:
      title: From1
      required:
      - paymentData
      - items
      - shippingData
      type: object
      properties:
        paymentData:
          $ref: '#/components/schemas/PaymentDataV2'
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item2V2'
        shippingData:
          $ref: '#/components/schemas/ShippingData1'
      example:
        paymentData:
          transactions: []
        items:
        - id: '31'
          quantity: 1
          price: null
          measurementUnit: null
          unitMultiplier: 0
          sellingPrice: null
          name: null
          detailUrl: null
          imageUrl: null
        shippingData:
          logisticsInfo: []
  securitySchemes:
    VtexIdclientAutCookie:
      type: apiKey
      in: header
      name: VtexIdclientAutCookie
      description: '[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.'