VTEX Ads API

VTEX Ads API enables merchants and marketplace operators to manage advertising campaigns, track ad performance, and synchronize product catalogs within the VTEX Ads platform.

This API is primarily used by:

• Store developers
• Marketplace operators
• Integration partners
• Advertising platform providers

With this API you can:

• Synchronize product catalog information for advertising
• Track ad impressions, clicks, and views
• Monitor conversion events and campaign performance
• Manage ad inventory and placements

Learn more about VTEX Ads.

Before you begin

• For bulk operations (product and inventory updates), there is a limit of 500 objects per request and 3 simultaneous requests.
• The event URLs for tracking impressions, clicks and views must not be constructed manually — always use the URLs provided from POST Get ads.
• Authentication is required using X-App-Id and X-Api-Key headers. Contact our support to obtain these credentials.

Index

Catalog synchronization

• POST Synchronize product information
• POST Synchronize inventory information

Ads events notification

• POST Track ad impressions
• POST Track ad clicks
• POST Track ad views
• POST Track conversions

Ads

• POST Get ads

Parameter name	Description	Type
X-App-Id	Publisher App ID for authorization	Authentication header
X-Api-Key	API Key for authentication	Authentication header
Content-Type	Type of the content being sent	Request header
Accept	HTTP Client Negotiation Accept Header	Request header