VTEX · Schema

ShippingData2

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
logisticsInfo array Array with shipping information.
View JSON Schema on GitHub

JSON Schema

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