v54

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

Inventory

Update inventory lead time by SKU and warehouse

Configures the lead time for a SKU of a warehouse, and the period is added to the order's total shipping time.

Among other main use cases, lead time can represent an item's manufacturing time or scenarios where there are third-party suppliers, for example.

Lead time is an optional configuration and by default is set to 0 days.

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:

Product	Category	Resource
Logistics	Logistics access	Logistics full access
Logistics	Logistics access	Logistics inventory full access

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

Role	Resource
Logistics - Full access	Logistics full access
OMS - Full access	Logistics full access
Logistics - Full access	Logistics inventory full access
OMS - Full access	Logistics 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.

patch/api/logistics/pvt/inventory/skus/{skuId}/warehouses/{warehouseId}/lead-time

Path parameters

skuIdstring required

Example:25

Unique identifier of the SKU you wish to update.

warehouseIdstring required

Example:storeWarehouse

Unique identifier of the warehouse of the SKU you wish to update.

Headers

Content-Typestring required

Example:application/json

Type of the content being sent.

Acceptstring required

Example:application/json

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

Request body

leadTimestring required

Defines the lead time, a configuration for shipping time at SKU level. You can set a shipping period for a warehouse SKU, and this time will be added to the order's total shipping time. Note that:

The format is DD.HH:MM:SS, or DD. The endpoint allows configuring hours and minutes, but the UI only shows days.
If you mistake hours for days, the system will accept the value as days. For example, sending 78:00:00 updates the lead time to 78 days.
Sending an empty field or a value in an incorrect format will result in a 400 Bad Request.

Example request

{
  "leadTime": "8.00:00:00"
}

Response

No Content