External Promotions Protocol API

The External Promotions Protocol API is a set of definitions that allows merchants to integrate their own external promotions engine with the VTEX platform. This is a protocol, which means the merchant must implement the endpoints described in this documentation as a web API (REST) on their own infrastructure.

⚠️ This feature is only available for accounts using Headless Checkout.

VTEX will call these endpoints during the shopping cart calculation and order lifecycle to:

• Calculate promotions and discounts for a given shopping cart.
• Notify the external promotions provider when an order is created or cancelled, reporting which promotions and coupons were applied.

This feature is in a closed beta testing phase. If you are interested in participating, open a ticket with the VTEX Support team.

Index

External promotions

• POST Calculate promotions: calculates the promotions and discounts for a given shopping cart.
• POST Notify promotion usage: receives a notification when an order is created or cancelled, informing which promotions and coupons were applied.

Common parameters

Parameter name	Description	Type
{{providerApiEndpoint}}	External promotions provider endpoint URL.	Server variable.