Delivery Promise Notification API

Delivery Promise (Beta) is VTEX's solution that allows customers to view only the products they can buy in their shopping experience, considering both the product availability in the seller inventory and the valid shipping methods for their delivery address.

The Delivery Promise Notification API notifies the VTEX store of the external seller's product availability and delivery promises — that is, in which delivery zones, times, and methods the product is available.

This feature is in beta, which means that we are working to improve it. If you have any questions, please contact our Support Center.

Delivery Promise

• PUT Update product availability

• PATCH Update delivery promises for an external seller's item

When to use this API

This API is intended only for external sellers. It is not required for:

• Franchise accounts.
• Sellers using VTEX Seller Portal.
• VTEX sellers already integrated into the marketplace ecosystem.

In these cases, availability and delivery options are managed natively by VTEX.

PUT vs PATCH

• Use PUT Update product availability when you want to create or fully replace all promises for one or more items.
• Use PATCH Update delivery promises for an external seller's item when you want to update specific promises for a single item.

Before running a PATCH for an item, that item must have been previously created with a PUT request. PATCH is an update operation whose key is the id previously sent in the PUT request.

Making a SKU unavailable

To make a SKU unavailable for a given delivery context, send a request with availability: 0. This action explicitly updates the Delivery Promise state. Unlike Seller Portal integrations, this change is not automatically propagated and must be triggered via API.