Create reservation
Creates a reservation.
Permissions
Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:
| Product | Category | Resource |
|---|---|---|
| Logistics | Logistics access | Logistics full access |
You can create a custom role with that resource or use one of the following predefined roles:
| Role | Resource |
|---|---|
| Logistics - Full access | Logistics full access |
| OMS - Full access | Logistics full access |
❗ Assigning a predefined role to users or application keys usually grants permission to multiple License Manager resources. If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see Best practices for using application keys. To learn more about machine authentication at VTEX, see Authentication overview.
Headers
HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
Type of the content being sent.
Request body
Example request
{
"salesChannel": "1",
"autorizationExpirationTTL": "10.00:00:00",
"deliveryItemOptions": [
{
"item": {
"id": "29",
"quantity": 1,
"price": 14128.9,
"modal": "FURNITURE",
"additionalHandlingTime": "00:00:00",
"dimension": {
"weight": 186.37,
"height": 23.5,
"width": 165,
"length": 67.5
}
},
"slaType": "delivery",
"slaTypeName": "Normal delivery",
"listPrice": 10.5,
"promotionalPrice": 10.5,
"transitTime": "2.00:00:00",
"dockTime": "00:00:00",
"timeToDockPlusDockTime": "1.00:00:00",
"aditionalTimeBlockedDays": "1.00:00:00",
"totalTime": "3.00:00:00",
"deliveryWindows": [
{
"startDateUtc": "2024-02-25T09:00:00+00:00",
"endDateUtc": "2024-02-25T12:00:00+00:00",
"listPrice": "0.0"
}
],
"wareHouseId": "1937054",
"dockId": "1a8bce3",
"location": {
"zipCode": "22220070",
"country": "BRA",
"inStore": {
"StoreId": "180082"
}
}
}
]
}Response
OK