{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/LogisticsInfo2",
"title": "LogisticsInfo2",
"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.",
"example": "9ec276fd3a604eb1aa151b5333ca5db7"
},
"slas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SlaV2"
},
"description": "Information on Service Level Agreement (SLA) of the change order."
},
"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": "Item's final price, calculated in cents.",
"example": 600
},
"listPrice": {
"type": "integer",
"description": "Item's price list, calculated in cents.",
"example": 600
},
"shippingEstimate": {
"type": "string",
"nullable": true,
"description": "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": "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": "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": [
{
"courierId": "1c083bf",
"warehouseId": "1_1",
"dockId": "1",
"courierName": "Donkey",
"quantity": 1,
"kitItemDetails": [],
"accountCarrierName": null
}
],
"shippingEstimate": "25bd",
"shippingEstimateDate": "2023-08-30T10:17:24.6436519Z",
"lockTTL": "12d",
"availableDeliveryWindows": [],
"deliveryWindow": null,
"price": 180,
"listPrice": 180,
"tax": 0,
"pickupStoreInfo": {
"isPickupStore": false,
"friendlyName": null,
"address": null,
"additionalInfo": null,
"dockId": null
},
"pickupPointId": null,
"pickupDistance": null,
"polygonName": "",
"transitTime": "25bd"
},
{
"id": "Normal",
"deliveryChannel": "delivery",
"name": "Normal",
"deliveryIds": [
{
"courierId": "1",
"warehouseId": "1_1",
"dockId": "1",
"courierName": "Transportadora",
"quantity": 1,
"kitItemDetails": [],
"accountCarrierName": null
}
],
"shippingEstimate": "3bd",
"shippingEstimateDate": null,
"lockTTL": "12d",
"availableDeliveryWindows": [],
"deliveryWindow": null,
"price": 500,
"listPrice": 500,
"tax": 0,
"pickupStoreInfo": {
"isPickupStore": false,
"friendlyName": null,
"address": null,
"additionalInfo": null,
"dockId": null
},
"pickupPointId": null,
"pickupDistance": null,
"polygonName": "",
"transitTime": "3bd"
},
{
"id": "Pickup",
"deliveryChannel": "delivery",
"name": "Pickup",
"deliveryIds": [
{
"courierId": "ech018654",
"warehouseId": "1_1",
"dockId": "1",
"courierName": "Retirada",
"quantity": 1,
"kitItemDetails": [],
"accountCarrierName": null
}
],
"shippingEstimate": "25bd",
"shippingEstimateDate": null,
"lockTTL": "12d",
"availableDeliveryWindows": [],
"deliveryWindow": null,
"price": 700,
"listPrice": 700,
"tax": 0,
"pickupStoreInfo": {
"isPickupStore": false,
"friendlyName": null,
"address": null,
"additionalInfo": null,
"dockId": null
},
"pickupPointId": null,
"pickupDistance": null,
"polygonName": "",
"transitTime": "25bd"
}
],
"shipsTo": [
"BRA"
],
"itemId": "31",
"deliveryChannels": [
{
"id": "delivery"
}
],
"price": 180,
"listPrice": 180,
"shippingEstimate": "25bd",
"dockEstimate": null,
"shippingEstimateDate": "2023-08-30T10:17:24.6436519Z",
"lockTTL": "12d",
"deliveryCompany": null,
"polygonName": "",
"transitTime": "25bd",
"sellingPrice": 180,
"deliveryIds": [
{
"courierId": "1c083bf",
"warehouseId": "1_1",
"dockId": "1",
"courierName": "Donkey",
"quantity": 1,
"kitItemDetails": null,
"accountCarrierName": "qastoreecho"
}
],
"deliveryWindow": null,
"pickupPointId": null,
"pickupStoreInfo": {
"isPickupStore": false,
"friendlyName": null,
"address": null,
"additionalInfo": null,
"dockId": null
},
"pickupDistance": null
}
}