Sign in

v54

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-01594762.7 KB
Reservations

List reservation by ID

Lists information about a reservation, searching by reservation ID.

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
LogisticsLogistics accessLogistics viewer

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
Logistics - Full accessLogistics viewer
Logistics - Read onlyLogistics viewer

❗ 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.

get/api/logistics/pvt/inventory/reservations/{reservationId}

Path parameters

reservationIdstring required
Example:00-1336411707838-01

Reservation ID.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

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

Response

OK

LastUpdateDateUtcstring

Last update date and time in 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

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

Error details, if there are any.

IsSucessboolean

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