VTEX · Schema

PreviewChange1

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
reason string
manualDiscountValue integer
manualIncrementValue integer
totalChangeValue integer
totals array Array containing totals information.
add string
remove string
replace array Array containing replace information.
date string
origin object
settings object
View JSON Schema on GitHub

JSON Schema

vtex-previewchange1-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/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\u00edcara 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": []
    }
  }
}