VTEX · Schema

LogisticsInfo1

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
itemIndex	integer	Index that identifies the position of the replacing item in the array, starting from `0`.
selectedSla	string	Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the replacing order.
selectedDeliveryChannel	string	Delivery channel selected by the customer, like `delivery` or `pickup-in-point`. This field is being deprecated and the information it retrieves can be usually be found in `deliveryChannel`.
addressId	string	Shipping address ID of the replacing item.
slas	array	Information on Service Level Agreement (SLA) of the change order shipping policy.
shipsTo	array	List of countries of the change order shipping address.
itemId	string	Replacing item's SKU ID, which is a unique numerical identifier.
deliveryChannels	array	Array with the delivery channels associated with the trade policy.
price	integer	Replacing item's final price, calculated in cents.
listPrice	integer	Replacing item's price list, calculated in cents.
shippingEstimate	string	Replacing item's shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.
dockEstimate	string	Replacing item's estimate duration of the [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) time. For instance, one business day is represented as `1bd`.
shippingEstimateDate	string	Replacing item's total shipping duration estimated in days. For instance, three business days are represented as `3bd`.
lockTTL	string	Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA. For instance, one business day is represented as `1bd`.
deliveryCompany	string	[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) company's name.
polygonName	string	Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.
transitTime	string	Duration in business days of the time the [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) takes in transit to fulfill the order. For example, three business days
sellingPrice	integer	Change item's selling price.
deliveryIds	array	Array with delivery information.
deliveryWindow	string	Change order [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.
pickupPointId	string	ID of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).
pickupStoreInfo	object
pickupDistance	number	Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LogisticsInfo1",
  "title": "LogisticsInfo1",
  "required": [
    "itemIndex",
    "selectedSla",
    "selectedDeliveryChannel",
    "addressId",
    "slas",
    "shipsTo",
    "itemId",
    "deliveryChannels",
    "price",
    "listPrice",
    "shippingEstimate",
    "dockEstimate",
    "shippingEstimateDate",
    "lockTTL",
    "deliveryCompany",
    "polygonName",
    "transitTime",
    "sellingPrice",
    "deliveryIds",
    "deliveryWindow",
    "pickupPointId",
    "pickupStoreInfo",
    "pickupDistance"
  ],
  "type": "object",
  "properties": {
    "itemIndex": {
      "type": "integer",
      "description": "Index that identifies the position of the replacing item in the array, starting from `0`.",
      "example": 0
    },
    "selectedSla": {
      "type": "string",
      "description": "Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the replacing order.",
      "example": "Normal"
    },
    "selectedDeliveryChannel": {
      "type": "string",
      "description": "Delivery channel selected by the customer, like `delivery` or `pickup-in-point`. This field is being deprecated and the information it retrieves can be usually be found in `deliveryChannel`.",
      "example": "delivery"
    },
    "addressId": {
      "type": "string",
      "description": "Shipping address ID of the replacing item.",
      "example": "9ec276fd3a604eb1aa151b5333ca5db7"
    },
    "slas": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SlaV2"
      },
      "description": "Information on Service Level Agreement (SLA) of the change order shipping policy."
    },
    "shipsTo": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Country name represented in a three letters code ISO 3166 ALPHA-3.",
        "example": "BRA"
      },
      "description": "List of countries of the change order shipping address."
    },
    "itemId": {
      "type": "string",
      "description": "Replacing item's SKU ID, which is a unique numerical identifier.",
      "example": "3"
    },
    "deliveryChannels": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DeliveryChannel"
      },
      "description": "Array with the delivery channels associated with the trade policy."
    },
    "price": {
      "type": "integer",
      "description": "Replacing item's final price, calculated in cents.",
      "example": 600
    },
    "listPrice": {
      "type": "integer",
      "description": "Replacing item's price list, calculated in cents.",
      "example": 600
    },
    "shippingEstimate": {
      "type": "string",
      "nullable": true,
      "description": "Replacing item's shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.",
      "example": "2023-07-29T17:52:18.6483116Z"
    },
    "dockEstimate": {
      "type": "string",
      "nullable": true,
      "description": "Replacing item's estimate duration of the [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) time. For instance, one business day is represented as `1bd`.",
      "example": "1bd"
    },
    "shippingEstimateDate": {
      "type": "string",
      "nullable": true,
      "description": "Replacing item's total shipping duration estimated in days. For instance, three business days are represented as `3bd`.",
      "example": "3bd"
    },
    "lockTTL": {
      "type": "string",
      "nullable": true,
      "description": "Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA. For instance, one business day is represented as `1bd`.",
      "example": "1bd"
    },
    "deliveryCompany": {
      "type": "string",
      "nullable": true,
      "description": "[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) company's name.",
      "example": "Correios"
    },
    "polygonName": {
      "type": "string",
      "nullable": true,
      "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.",
      "example": "114 - Polanco _ H-05"
    },
    "transitTime": {
      "type": "string",
      "nullable": true,
      "description": "Duration in business days of the time the [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) takes in transit to fulfill the order. For example, three business days are represented as `3bd`.",
      "example": "3bd"
    },
    "sellingPrice": {
      "type": "integer",
      "description": "Change item's selling price.",
      "example": 600
    },
    "deliveryIds": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DeliveryIdV2"
      },
      "description": "Array with delivery information."
    },
    "deliveryWindow": {
      "type": "string",
      "nullable": true,
      "description": "Change order [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.",
      "example": null
    },
    "pickupPointId": {
      "type": "string",
      "nullable": true,
      "description": "ID of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).",
      "example": "pup215rkw"
    },
    "pickupStoreInfo": {
      "$ref": "#/components/schemas/PickupStoreInfoV2"
    },
    "pickupDistance": {
      "type": "number",
      "nullable": true,
      "description": "Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.",
      "example": "1.0"
    }
  },
  "example": {
    "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
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/vtex-logisticsinfo1"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.