Search capacity reservations in time range

Retrieves information of all capacity reservations made to scheduled delivery windows in a given time range.

⚠️ While most of our API endpoints return time fields in UTC format, this endpoint returns time adjusted to the configured time zone of the VTEX account.

Note that the combined string carrier@{capacityType}@{shippingPolicyId} can be referred to as a resource in request messages.

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.