--- title: "Create reservation" method: POST path: "/api/logistics/pvt/inventory/reservations" tags: ["Reservations"] --- # Create reservation `POST /api/logistics/pvt/inventory/reservations` Creates a [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92). ## Permissions Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy): | **Role** | **Resource** | | --------------- | ----------------- | | Logistics - Full access | Logistics full access | | OMS - Full access | Logistics full access | >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication). ## Headers - `Accept` string, required - `Content-Type` string, required ## Request body - object — Reservation sales channel information. - `salesChannel` string, required — Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) valid for the reservation. - `lockId` string, nullable, required — [Reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) ID. - `autorizationExpirationTTL` string, required — Duration before expiring the reservation, in the format `DD.HH:MM:SS`. - `deliveryItemOptions` object[], required — Array with information about reserved items. - `item` object, required — Reserved item object. - `id` string, required — SKU ID. - `quantity` integer, required — Quantity of items. - `kitItem` string[], required — [Kit](https://help.vtex.com/en/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) items information, when applicable. - `price` number, required — Item price. - `modal` 'CHEMICALS' | 'ELECTRONICS' | 'FURNITURE' | 'GLASS' | 'LIQUID' | 'MATTRESSES' | 'REFRIGERATED' | 'TIRES' | 'WHITE_GOODS' | 'FIREARMS', nullable — Type of [modal](https://help.vtex.com/en/tutorial/how-the-modal-works--tutorials_125), a special freight. - `additionalHandlingTime` string, required — Additional handling time in the format `DD.HH:MM:SS`. - `dimension` object, required — Item dimensions. - `weight` number, required — Item weight. - `height` number, required — Item height. - `width` number, required — Item width. - `length` number, required — Item length. - `slaType` string, required — SLA (Service Level Agreement) type. - `slaTypeName` string, required — SLA name. - `listPrice` number, required — List price. - `promotionalPrice` number, required — Promotion price. - `transitTime` string, required — Transit time in the format `DD.HH:MM:SS`. - `dockTime` string, required — [Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`. - `timeToDockPlusDockTime` string, required — Time spent in loading dock plus `dockTime` in the format `D.HH:MM:SS`. - `aditionalTimeBlockedDays` string, required — Additional time blocked in the format `DD.HH:MM:SS`. - `totalTime` string, required — SLA total time in the format `DD.HH:MM:SS`. - `deliveryWindows` object[], nullable, required — [Delivery windows](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz). - `startDateUtc` string — Delivery window starting date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`. - `endDateUtc` string — Delivery window ending date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`. - `listPrice` string — List price. - `wareHouseId` string, nullable, required — [Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID. - `dockId` string, required — Loading dock ID. - `location` object, required — Shipping location details. - `zipCode` string, required — Shipping address postal code. - `country` string, required — Three-digit country code of the shipping address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format. - `inStore` object, required — Information related to [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc). - `IsCheckedIn` boolean, required — This field is set as `true` when the order was placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) and `false` when it was not. - `StoreId` string, nullable, required — ID of purchases made in the GoCommerce context. ## Response `200` OK - object - `LastUpdateDateUtc` string — Last update date and time in the format [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`. - `SalesChannel` string — Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) valid for the reservation. - `LockId` string — Reservation ID. - `ReservationDateUtc` string — Reservation date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`. - `MaximumConfirmationDateUtc` string — Maximum confirmation date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`. - `Status` integer — Reservation status, meaning: - `0`: `NotCommitted` - `1`: `Authorized` - `2`: `Confirmed` - `3`: `Canceled_AbortedCommitted` - `4`: `Canceled_AuthorizationExpired` - `5`: `Canceled_Manually` - `SlaRequest` object[] — SLA (Service Level Agreement) request information. - `item` object — Information about the reserved item. - `id` string — SKU ID. - `groupItemId` string, nullable — Group item ID. - `quantity` integer — Item quantity. - `price` number — Item price. - `modal` 'CHEMICALS' | 'ELECTRONICS' | 'FURNITURE' | 'GLASS' | 'LIQUID' | 'MATTRESSES' | 'REFRIGERATED' | 'TIRES' | 'WHITE_GOODS' | 'FIREARMS', nullable — Type of [modal](https://help.vtex.com/en/tutorial/how-the-modal-works--tutorials_125), a special freight. - `additionalHandlingTime` string — Additional handling time in the format `DD.HH:MM:SS`. - `dimension` object — Item dimensions. - `weight` number — Item weight. - `height` number — Item height. - `width` number — Item width. - `length` number — Item length. - `maxSumDimension` number — Maximum sum of dimensions. - `kitItem` string[], nullable — [Kit](https://help.vtex.com/en/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) item information. - `unlimitedQuantity` boolean — When set as `false`, every sold unit decreases the item's available quantity. When set as `true`, the SKU from the warehouse is always available for sale. No matter how many units are sold, the SKU available quantity never decreases, and the SKU is never out of stock. - `slaType` string — SLA (Service Level Agreement) type. - `slaTypeName` string — SLA name. - `freightTableName` string — [Shipping rate template](https://help.vtex.com/en/tutorial/shipping-rate-template--tutorials_127) name. - `freightTableId` string — Shipping rate template ID. - `listPrice` number — List price. - `promotionalPrice` number — Promotion price. - `transitTime` string — Transit time in the format `DD.HH:MM:SS`. - `dockTime` string — [Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`. - `timeToDockPlusDockTime` string — Time spent in loading dock plus `dockTime` in the format `D.HH:MM:SS`. - `totalTime` string — SLA total time in the format `DD.HH:MM:SS`. - `deliveryWindows` object, nullable — [Delivery windows](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz). - `wareHouseId` string — [Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID. - `dockId` string — [Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID. - `wmsEndPoint` string, nullable — Warehouse Management System (WMS) fulfillment endpoint. - `location` object — Shipping location information. - `zipCode` string — Shipping address postal code. - `country` string — Three-digit country code of the shipping address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format. - `deliveryPointId` string, nullable — Delivery point ID. - `point` number[], nullable — Location delivery point coordinates. - `inStore` object — Information related to [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc). - `IsCheckedIn` boolean — This field is set as `true` when the order was placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) and `false` when it was not. - `StoreId` string, nullable — ID of purchases made in the GoCommerce context. - `pickupStoreInfo` string, nullable — Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R). - `PickupPointItemOptions` string, nullable — (Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) item options. - `CanceledDateUtc` string — Reservation canceled date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`. - `AuthorizedDateUtc` string — Authorized date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`. - `ConfirmedDateUtc` string — Confirmed date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`. - `Errors` string[], nullable — Errors details, if there are any. - `IsSucess` boolean — Defines if the reservation was successful (`true`) or not (`false`). --- [API](https://skmtc.net/vtex/apis/logistics-api.md) · [All operations](https://skmtc.net/vtex/apis/logistics-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vtex/logistics-api/revisions/c08af805d8b3/schema)