List inventory with dispatched reservations

Reservation is the VTEX solution that prevents stores from selling the same item more than once. Adding products to the shopping cart does not create a reservation, this only happens after the shopper completes the purchase.

This endpoint lists your inventory information about dispatched reservations from a given warehouse. A reservation is considered dispatched after the order has passed the authorize-fulfillment status in the order flow and is not canceled.

Response 400 Bad Request: When the store has more than 2.000 active reservations, you receive a 400 Bad Request error with the message: Too many active reservations.

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:

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

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