VTEX · Schema

ShippingDataV2

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
logisticsInfo array 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.
View JSON Schema on GitHub

JSON Schema

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