Vtex Calculatesla Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "CalculateSLA",
"method": "POST",
"path": "/api/logistics/pvt/shipping/calculate",
"summary": "VTex Calculate SLA",
"requestExamples": [
{
"contentType": "application/json; charset=utf-8",
"example": [
{
"items": [
{
"id": "1",
"groupItemId": null,
"kitItem": [
{
"id": "2000042",
"groupItemId": null,
"kitItem": [],
"quantity": 1,
"price": 0,
"additionalHandlingTime": "00:00:00",
"dimension": {
"weight": 150,
"height": 5,
"width": 17,
"length": 17
}
},
{
"id": "2390059",
"groupItemId": null,
"kitItem": [],
"quantity": 1,
"price": 0,
"additionalHandlingTime": "00:00:00",
"dimension": {
"weight": 150,
"height": 5,
"width": 17,
"length": 17
}
}
],
"quantity": 1,
"price": 0,
"additionalHandlingTime": "00:00:00",
"dimension": {
"weight": 150,
"height": 5,
"width": 17,
"length": 17
}
}
],
"location": {
"zipCode": "22780084",
"country": "BRA",
"point": [
-43.32475950000003,
-22.9999575
]
},
"salesChannel": "1"
}
]
}
],
"responseExamples": [
{
"status": "200",
"contentType": "application/json; charset=utf-8",
"example": [
[
{
"itemId": "2389945",
"quantity": 1,
"availabilityQuantity": 500,
"salesChannel": "1",
"slaType": "Entrega Agendada",
"slaTypeName": "Entrega Agendada",
"freightTableName": "Entrega Agendada",
"freightTableId": "teste1",
"listPrice": 5.25,
"transitTime": "2.00:00:00",
"dockTime": "00:00:00",
"timeToDockPlusDockTime": "1.00:00:00",
"aditionalTimeBlockedDays": "00:00:00",
"totalTime": "3.00:00:00",
"deliveryWindows": [
{
"startDateUtc": "2016-04-20T08:00:00+00:00",
"endDateUtc": "2016-04-20T12:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-20T12:01:00+00:00",
"endDateUtc": "2016-04-20T18:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-21T08:00:00+00:00",
"endDateUtc": "2016-04-21T12:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-21T12:01:00+00:00",
"endDateUtc": "2016-04-21T18:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-22T08:00:00+00:00",
"endDateUtc": "2016-04-22T12:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-22T12:01:00+00:00",
"endDateUtc": "2016-04-22T18:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-23T08:00:00+00:00",
"endDateUtc": "2016-04-23T12:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-23T12:01:00+00:00",
"endDateUtc": "2016-04-23T18:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-24T08:00:00+00:00",
"endDateUtc": "2016-04-24T12:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-24T12:01:00+00:00",
"endDateUtc": "2016-04-24T18:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-25T08:00:00+00:00",
"endDateUtc": "2016-04-25T12:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-25T12:01:00+00:00",
"endDateUtc": "2016-04-25T18:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-26T08:00:00+00:00",
"endDateUtc": "2016-04-26T12:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-26T12:01:00+00:00",
"endDateUtc": "2016-04-26T18:00:00+00:00",
"listPrice": 10
}
],
"wareHouseId": "1937054",
"dockId": "1_1_1",
"location": {
"zipCode": "22220070",
"country": "BRA",
"deliveryPointId": null,
"point": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
}
},
"deliveryOnWeekends": false,
"carrierSchedule": [],
"restrictedFreight": null,
"coordinates": null,
"pickupStoreInfo": null
},
{
"itemId": "2390059",
"quantity": 1,
"availabilityQuantity": 500,
"salesChannel": "1",
"slaType": "Entrega Agendada",
"slaTypeName": "Entrega Agendada",
"freightTableName": "Entrega Agendada",
"freightTableId": "teste1",
"listPrice": 5.25,
"transitTime": "2.00:00:00",
"dockTime": "00:00:00",
"timeToDockPlusDockTime": "1.00:00:00",
"aditionalTimeBlockedDays": "00:00:00",
"totalTime": "3.00:00:00",
"deliveryWindows": [
{
"startDateUtc": "2016-04-20T08:00:00+00:00",
"endDateUtc": "2016-04-20T12:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-20T12:01:00+00:00",
"endDateUtc": "2016-04-20T18:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-21T08:00:00+00:00",
"endDateUtc": "2016-04-21T12:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-21T12:01:00+00:00",
"endDateUtc": "2016-04-21T18:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-22T08:00:00+00:00",
"endDateUtc": "2016-04-22T12:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-22T12:01:00+00:00",
"endDateUtc": "2016-04-22T18:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-23T08:00:00+00:00",
"endDateUtc": "2016-04-23T12:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-23T12:01:00+00:00",
"endDateUtc": "2016-04-23T18:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-24T08:00:00+00:00",
"endDateUtc": "2016-04-24T12:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-24T12:01:00+00:00",
"endDateUtc": "2016-04-24T18:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-25T08:00:00+00:00",
"endDateUtc": "2016-04-25T12:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-25T12:01:00+00:00",
"endDateUtc": "2016-04-25T18:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-26T08:00:00+00:00",
"endDateUtc": "2016-04-26T12:00:00+00:00",
"listPrice": 10
},
{
"startDateUtc": "2016-04-26T12:01:00+00:00",
"endDateUtc": "2016-04-26T18:00:00+00:00",
"listPrice": 10
}
],
"wareHouseId": "1937054",
"dockId": "1_1_1",
"location": {
"zipCode": "22220070",
"country": "BRA",
"deliveryPointId": null,
"point": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
}
},
"deliveryOnWeekends": false,
"carrierSchedule": [],
"restrictedFreight": null,
"coordinates": null,
"pickupStoreInfo": null
},
{
"itemId": "2389945",
"quantity": 1,
"availabilityQuantity": 500,
"salesChannel": "1",
"slaType": "Normal",
"slaTypeName": "Normal",
"freightTableName": "Correios PAC",
"freightTableId": "11cc4b6",
"listPrice": 7.88,
"transitTime": "2.00:00:00",
"dockTime": "00:00:00",
"timeToDockPlusDockTime": "1.00:00:00",
"aditionalTimeBlockedDays": "00:00:00",
"totalTime": "3.00:00:00",
"deliveryWindows": [],
"wareHouseId": "1937054",
"dockId": "1_1_1",
"location": {
"zipCode": "22220070",
"country": "BRA",
"deliveryPointId": null,
"point": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
}
},
"deliveryOnWeekends": true,
"carrierSchedule": [],
"restrictedFreight": null,
"coordinates": null,
"pickupStoreInfo": null
},
{
"itemId": "2390059",
"quantity": 1,
"availabilityQuantity": 500,
"salesChannel": "1",
"slaType": "Normal",
"slaTypeName": "Normal",
"freightTableName": "Correios PAC",
"freightTableId": "11cc4b6",
"listPrice": 7.88,
"transitTime": "2.00:00:00",
"dockTime": "00:00:00",
"timeToDockPlusDockTime": "1.00:00:00",
"aditionalTimeBlockedDays": "00:00:00",
"totalTime": "3.00:00:00",
"deliveryWindows": [],
"wareHouseId": "1937054",
"dockId": "1_1_1",
"location": {
"zipCode": "22220070",
"country": "BRA",
"deliveryPointId": null,
"point": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
}
},
"deliveryOnWeekends": true,
"carrierSchedule": [],
"restrictedFreight": null,
"coordinates": null,
"pickupStoreInfo": null
}
]
]
}
]
}