VTEX · Schema

LogisticsInfo

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 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). The 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.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
price	integer	Integer indicating the shipping price for this SKU. If the value is `USD20.50`, convert it to the format → `2050`.
selectedDeliveryChannel	string	String with the selected delivery channel. This field supports the following values: - `delivery`, - `pickup-in-point`.
selectedSla	string	String with the selected delivery SLA.
lockTTL	string	String with the inventory reservation period in VTEX's logistics system. To fill in this field insert the number of days, followed by the letter for the chosen unit. - Days: `d` - Business days: `bd`.
shippingEstimate	string	String with the order's estimated delivery time. To fill in this field, insert a number, followed by the letter for the chosen unit. - Days: `d` - Business days: `bd`. - Hours: `h` - Minutes: `m`. Exa
deliveryIds	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LogisticsInfo",
  "title": "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.",
  "required": [
    "price",
    "selectedDeliveryChannel",
    "selectedSla",
    "lockTTL",
    "shippingEstimate",
    "deliveryIds"
  ],
  "type": "object",
  "properties": {
    "price": {
      "type": "integer",
      "title": "price",
      "description": "Integer indicating the shipping price for this SKU. If the value is `USD20.50`, convert it to the format \u2192 `2050`.",
      "example": 2050
    },
    "selectedDeliveryChannel": {
      "type": "string",
      "title": "selectedDeliveryChannel",
      "description": "String with the selected delivery channel. This field supports the following values:  \n\n- `delivery`,  \n\n- `pickup-in-point`.",
      "example": "delivery"
    },
    "selectedSla": {
      "type": "string",
      "title": "selectedSla",
      "description": "String with the selected delivery SLA.",
      "example": "T-G1-2-Express"
    },
    "lockTTL": {
      "type": "string",
      "title": "lockTTL",
      "description": "String with the inventory reservation period in VTEX's logistics system. To fill in this field insert the number of days, followed by the letter for the chosen unit. \n\n- Days: `d` \n\n- Business days: `bd`. \n\nExample formats: `12d`, `5d`.",
      "example": "5d"
    },
    "shippingEstimate": {
      "type": "string",
      "title": "shippingEstimate",
      "description": "String with the order's estimated delivery time. To fill in this field, insert a number,  followed by the letter for the chosen unit. \n\n- Days: `d` \n\n- Business days: `bd`. \n\n- Hours: `h` \n\n- Minutes: `m`. \n\nExample formats: `12d`, `5bd`, `3h`, `50m`.",
      "example": "7d"
    },
    "deliveryIds": {
      "$ref": "#/components/schemas/DeliveryIds"
    }
  },
  "example": {
    "price": 2050,
    "selectedDeliveryChannel": "delivery",
    "selectedSla": "Express",
    "lockTTL": "1d",
    "shippingEstimate": "2d",
    "deliveryIds": {
      "warehouseId": "AR1"
    }
  }
}