Sign in

v54

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

List inventory per dock and warehouse

Lists inventory information from the combination of a given loading dock and a warehouse.

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
LogisticsLogistics accessLogistics inventory full access
LogisticsLogistics accessLogistics inventory read only

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
Logistics - Full accessLogistics inventory full access
OMS - Full accessLogistics inventory full access
Logistics - Full accessLogistics inventory read only
Logistics - Read onlyLogistics inventory read only

❗ 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/items/{skuId}/docks/{dockId}/warehouses/{warehouseId}

Path parameters

skuIdstring required
Example:36

SKU unique identifier.

dockIdstring required
Example:dock13a

Loading dock ID.

warehouseIdstring required
Example:whs15hs6c

Warehouse 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

skuIdstring

SKU ID.

warehouseIdstring

Warehouse ID.

dockIdstring

Loading dock ID.

totalQuantityinteger

Total quantity of SKU.

reservedQuantityinteger

Reserved quantity of the SKU.

availableQuantityinteger

Amount of items available for sales. Difference between total quantity and reserved quantity.

isUnlimitedboolean

Indicates if the unlimited inventory is activated so the SKU's availability is unlimited (true) or not (false).

salesChannelstring[]

List of sales channels (trade policies associated.

deliveryChannelstring[]

List of delivery channels available.

timeToRefillstring

Time to refill (deprecated).

dateOfSupplyUtcstring

Date of supply lot in UTC.

keepSellingAfterExpirationboolean

Indicates whether SKU can continue to be sold after the available quantity gets to 0.

transferstring

Transfer.