VTEX · Schema

LogisticsInfoV2

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
itemIndex integer Index that identifies the position of this item in the original array, starting from `0`.
slaId string Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the order.
deliveryChannel string Order shipping type, which can be `pickup-in-point` for [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R), and `delivery` for delivery.
addressId string Shipping address ID.
price integer Shipping price for the item in cents. Does not account for the whole order's shipping price.
View JSON Schema on GitHub

JSON Schema

vtex-logisticsinfov2-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LogisticsInfoV2",
  "title": "LogisticsInfoV2",
  "required": [
    "itemIndex",
    "slaId",
    "deliveryChannel",
    "addressId",
    "price"
  ],
  "type": "object",
  "properties": {
    "itemIndex": {
      "type": "integer",
      "description": "Index that identifies the position of this item in the original array, starting from `0`.",
      "example": 0
    },
    "slaId": {
      "type": "string",
      "description": "Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the order.",
      "example": "Normal"
    },
    "deliveryChannel": {
      "type": "string",
      "description": "Order shipping type, which can be `pickup-in-point` for [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R), and `delivery` for delivery.",
      "example": "delivery"
    },
    "addressId": {
      "type": "string",
      "description": "Shipping address ID.",
      "example": "9ec276fd3a604eb1aa151b5333ca5db7"
    },
    "price": {
      "type": "integer",
      "description": "Shipping price for the item in cents. Does not account for the whole order's shipping price.",
      "example": 1000
    }
  },
  "example": {
    "itemIndex": 0,
    "slaId": "Normal",
    "deliveryChannel": "delivery",
    "addressId": "12334048475146857",
    "price": 1000
  }
}