Sign in

v54

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

Save supply lot

Creates a new supply lot, which allows you to sell a SKU that is currently out-of-stock in your inventory and unavailable for sales. Creating a supply lot is useful when you know the date of when the SKU will have quantity and availability for sales again.

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 inventory full access

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 inventory full access
OMS - Full accessLogistics inventory full access

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

put/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots/{supplyLotId}

Path parameters

skuIdstring required
Example:36

SKU ID being scheduled for availability for sales.

warehouseIdstring required
Example:whs15hs6c

ID of the warehouse where the SKU will arrive.

supplyLotIdstring required
Example:7100-1023-04

ID of the supply lot of the SKU availability scheduling.

Headers

Acceptstring required

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

Content-Typestring required

Type of the content being sent.

Request body

quantityinteger required

Supply lot quantity for a SKU from a warehouse.

dateOfSupplyUtcstring required

Date and time of when the SKU from the warehouse will have quantity and availability for sales again. The format is ISO 8601 time zone offset, as in YYYY-MM-DDThh:mm:ss.ssZ. Since it is a prevision, this field must be a future date.

keepSellingAfterExpirationboolean

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

Example request

{
  "quantity": 1200,
  "dateOfSupplyUtc": "2025-02-25T09:00:00+00:00",
  "keepSellingAfterExpiration": true
}

Response

No Content