VTvtex
Reservations

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:

ProductCategoryResource
LogisticsLogistics accessLogistics full access

You can create a custom role with that resource or use one of the following predefined roles:

RoleResource
Logistics - Full accessLogistics full access
OMS - Full accessLogistics 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.

post/api/logistics/pvt/inventory/reservations

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br
  • URL
    https://apiexamples.vtexcommercestable.com.br/api/logistics/pvt/inventory/reservations
  • Auth
    • API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
    • or API key in header VtexIdclientAutCookie

Headers

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Content-Typestring required

Type of the content being sent.

Request body

salesChannelstring required

Sales channel (trade policy) valid for the reservation.

lockIdstring nullable required

Reservation ID.

autorizationExpirationTTLstring required

Duration before expiring the reservation, in the format DD.HH:MM:SS.

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

LastUpdateDateUtcstring

Last update date and time in the format ISO 8601 time zone offset format, as in YYYY-MM-DDThh:mm:ss.ssZ.

SalesChannelstring

Sales channel (trade policy) valid for the reservation.

LockIdstring

Reservation ID.

ReservationDateUtcstring

Reservation date and time in ISO 8601 time zone offset format, as in YYYY-MM-DDThh:mm:ss.ssZ.

MaximumConfirmationDateUtcstring

Maximum confirmation date and time in ISO 8601 time zone offset format, as in YYYY-MM-DDThh:mm:ss.ssZ.

Statusinteger

Reservation status, meaning:

  • 0: NotCommitted

  • 1: Authorized

  • 2: Confirmed

  • 3: Canceled_AbortedCommitted

  • 4: Canceled_AuthorizationExpired

  • 5: Canceled_Manually

PickupPointItemOptionsstring nullable

(Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) item options.

CanceledDateUtcstring

Reservation canceled date and time in ISO 8601 time zone offset format, as in YYYY-MM-DDThh:mm:ss.ssZ.

AuthorizedDateUtcstring

Authorized date and time in ISO 8601 time zone offset format, as in YYYY-MM-DDThh:mm:ss.ssZ.

ConfirmedDateUtcstring

Confirmed date and time in ISO 8601 time zone offset format, as in YYYY-MM-DDThh:mm:ss.ssZ.

Errorsstring[] nullable

Errors details, if there are any.

IsSucessboolean

Defines if the reservation was successful (true) or not (false).

Changes

No recorded changes to this operation across all 63 revisions of this API.