Vtex Createreservation 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": "CreateReservation",
"method": "POST",
"path": "/api/logistics/pvt/inventory/reservations",
"summary": "VTex Create reservation",
"requestExamples": [
{
"contentType": "application/json; charset=utf-8",
"example": {
"salesChannel": "1",
"lockId": null,
"autorizationExpirationTTL": "00:10:00",
"deliveryItemOptions": [
{
"item": {
"id": "2390059",
"groupItemId": null,
"kitItem": [],
"quantity": 1,
"price": 0,
"additionalHandlingTime": "00:00:00",
"dimension": {
"weight": 150,
"height": 1,
"width": 1,
"length": 1
}
},
"slaType": "Expressa",
"slaTypeName": "Expressa",
"listPrice": 10.5,
"promotionalPrice": 10.5,
"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": null,
"dockId": "1a8bce3",
"location": {
"zipCode": "22220070",
"country": "BRA",
"inStore": {
"IsCheckedIn": false,
"StoreId": null
}
}
}
]
}
}
],
"responseExamples": [
{
"status": "200",
"contentType": "application/json; charset=utf-8",
"example": {
"LastUpdateDateUtc": "2016-04-15T19:59:20.0397988+00:00",
"SalesChannel": "2",
"LockId": "3bfe679d-c0a8-475a-b315-706f84a9deb4",
"ReservationDateUtc": "2016-04-15T19:59:20.0397988+00:00",
"MaximumConfirmationDateUtc": "2016-04-15T20:09:20.0397988+00:00",
"Status": 1,
"SlaRequest": [
{
"item": {
"id": "2390059",
"groupItemId": null,
"quantity": 1,
"price": 0,
"modal": null,
"additionalHandlingTime": "00:00:00",
"dimension": {
"weight": 800,
"height": 10,
"width": 12,
"length": 35,
"maxSumDimension": 0
},
"kitItem": [],
"unlimitedQuantity": false
},
"slaType": "Normal",
"slaTypeName": "Normal",
"freightTableName": "Correios PAC",
"freightTableId": "11cc4b6",
"listPrice": 10.5,
"promotionalPrice": 10.5,
"transitTime": "2.00:00:00",
"dockTime": "00:00:00",
"timeToDockPlusDockTime": "1.00:00:00",
"totalTime": "3.00:00:00",
"deliveryWindows": null,
"wareHouseId": "1937054",
"dockId": "1_1_1",
"wmsEndPoint": "",
"location": {
"zipCode": "22220070",
"country": "BRA",
"deliveryPointId": null,
"point": null,
"inStore": {
"IsCheckedIn": false,
"StoreId": "180082"
}
},
"pickupStoreInfo": null
}
],
"PickupPointItemOptions": null,
"CanceledDateUtc": "0001-01-01T00:00:00+00:00",
"AuthorizedDateUtc": "2016-04-15T19:59:20.0397988+00:00",
"ConfirmedDateUtc": "0001-01-01T00:00:00+00:00",
"Errors": [],
"IsSucess": true
}
}
]
}