Sign in

v54

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

List supply lots

Lists supply lots of a SKU in a given warehouse.

In architectures with franchise accounts or multiple sellers, the scheduled lead time of supply lots is not considered during seller selection or SLA calculation, so this feature may not behave as expected in these scenarios.

In architectures that use Delivery Promise, supply lots are not considered in the SLA calculation, which may cause divergences between the lead time configured in the supply lot and the lead time displayed to the shopper.

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}/warehouses/{warehouseId}/supplyLots

Path parameters

skuIdstring required
Example:36

SKU ID.

warehouseIdstring required
Example:whs15hs6c

ID of the warehouse where the SKU is located.

Headers

Acceptstring required
Example:application/json

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

Content-Typestring required
Example:application/json

Type of the content being sent.

Response

OK

skuIdstring

SKU ID related to the supply lot.

warehouseIdstring

Warehouse ID where the SKU supply lot will arrive.

dockIdstring

Loading dock ID.

totalQuantityinteger

Total quantity scheduled for the SKU in the supply lot.

reservedQuantityinteger

Total reserved quantity scheduled for the SKU in the supply lot.

availableQuantityinteger

Available quantity scheduled for the SKU in the supply lot.

isUnlimitedboolean

Indicates if the unlimited inventory is activated so the SKU availability for sales is unlimited (true), or not (false).

salesChannelstring[]

List of sales channels (trade policies associated with the supply lot.

deliveryChannelsstring[]

List of delivery channels type associated with the supply lot.

timeToRefillstring nullable

Time to refill in the format HH:MM:SS.

dateOfSupplyUtcstring

Date and time scheduled for the SKU from the warehouse to have quantity and availability for sales again. The format is ISO 8601 time zone offset, as in YYYY-MM-DDThh:mm:ss.ssZ.

supplyLotIdstring

Supply lot ID.

keepSellingAfterExpirationboolean

Defines if the SKU from the warehouse should be available for sales after running out-of-stock (true), or not (false).

transferstring nullable

Transfer system.

leadTimestring nullable

Lead time is an optional time configuration for a SKU in a warehouse. It can be handling time, fabrication or how long it takes for the item to be available to be shipped to customers. The lead time is a part of the total shipping time and is considered for shipping date calculation. The format is DD.HH:MM:SS.