Documentation
Feedback
Guides
API Reference

API Reference
Filter By
Post
Get
Put
Delete
Patch

External Promotions Protocol API

The External Promotions Protocol API allows merchants to integrate their own external promotions engine with VTEX, enabling native and external promotions to interact in the same Cart. 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.

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 were applied.

This feature is only available for accounts using Headless Checkout.

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

Endpoints

External promotions

SummaryMethodPath
Calculate promotionsPOST/calculatePromotion
Notify promotion usagePOST/notifyUsage

Loading API specification...