VTEX · Schema

ShippingData

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
logisticsInfo array List that references the SLAs responsible for delivering each item in the order. This list must contain the same number of items as the `items` list, previously defined. For example: if the order cont
selectedAddresses array
isFob boolean Boolean that indicates whether the order's delivery is the marketplace responsibility. Optional, defaulting to false.
isMarketplaceFulfillment boolean Boolean that indicates whether the order's inventory in warehouse is the marketplace's responsibility. Optional, defaulting to false.
View JSON Schema on GitHub

JSON Schema

vtex-shippingdata-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ShippingData",
  "title": "ShippingData",
  "required": [
    "logisticsInfo",
    "selectedAddresses",
    "isFob",
    "isMarketplaceFulfillment"
  ],
  "type": "object",
  "properties": {
    "logisticsInfo": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LogisticsInfo"
      },
      "description": "List that references the SLAs responsible for delivering each item in the order.  \n\nThis list must contain the same number of items as the `items` list, previously defined. For example: if the order contains 3 SKUs, you must describe 3 SLAs in this list, one for each SKU (even in cases where the same SLA will deliver all of them).  \n\nThe order of the SLAs in this list must also follow the same order as in the `items` list. For example: if the SLA named **Correios Express** will be responsible for delivering the SKU with ID equal to **1015**, which is found at index 0 of the `items` list, it must be in index 0 of the `logisticsInfo` list as well."
    },
    "selectedAddresses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SelectedAddress"
      },
      "description": ""
    },
    "isFob": {
      "type": "boolean",
      "title": "isFob",
      "description": "Boolean that indicates whether the order's delivery is the marketplace responsibility. Optional, defaulting to false.",
      "example": false
    },
    "isMarketplaceFulfillment": {
      "type": "boolean",
      "title": "isMarketplaceFulfillment",
      "description": "Boolean that indicates whether the order's inventory in warehouse is the marketplace's responsibility. Optional, defaulting to false.",
      "example": false
    }
  }
}