> Check the new Promotions onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Promotions and is organized by focusing on the developer's journey. The Promotions & Taxes API allows you to manage and retrieve all promotions, coupons and tax rules from your VTEX store. ## Index ### Coupons `POST` Create multiple coupons `POST` Create coupon `GET` Get coupon by coupon code `GET` Get archived coupon by coupon code `POST` Archive coupon by coupon code `POST` Update coupon `GET` Get all coupons `POST` Coupon Massive Generation `GET` Get coupon usage `POST` Unarchive coupon by coupon code ### Promotions and Taxes `GET` Get All Promotions `GET` Get All Taxes `GET` Get Promotion or Tax By ID `POST` Create or Update Promotion or Tax `POST` Create Multiple SKU Promotion `PUT` Update Multiple SKU Promotion `POST` Archive Promotion or Tax `POST` Unarchive Promotion or Tax `GET` List archived Promotions `GET` List archived Taxes ### Campaign Audiences `GET` Get campaign audience configuration `POST` Create campaign audience
Reviews & Ratings is a VTEX IO native solution that allows shoppers to submit reviews and ratings for products, as well as see them while navigating the store. ## Rating - Get Product Rating ## Review - Get Review by Review ID - Delete Review - Update a Review - Get a list of Reviews - Create Multiple Reviews - Delete Multiple Reviews - Create a Review
Subscription (v1 - deprecated): API definition published in the OpenAPI directory for vtex.local. See the linked specification for supported operations.
VTEX Subscriptions REST API Documentation This documentation describes the available REST APIs for VTEX Subscription System. With Subscriptions you can set up regularly scheduled deliveries. All requests need authorization (VTEX Id authentication token or VTEX Appkey and Apptoken headers)
A **Subscription** is a list of items (SKUs) tied to certain recurring purchase settings: - User profile - Address - Payment method - Frequency - Cycle Once you have configured subscriptions in your store, the Subscriptions API allows you to create, manage and monitor your customers' subscriptions. !image To read more about the Subscriptions feature, check our article How Subscription works.
The **Marketplace API** enables marketplaces and sellers hosted on VTEX to perform their collaborative operations. >⚠️ The marketplace must create an appKey and appToken for each non-VTEX seller that will use this API. ## Index ### Notification Endpoints used by sellers to notify marketplaces that the price or inventory language has changed for one of their SKUs. `POST` Notify marketplace of price update `POST` Notify marketplace of inventory update ### Suggestions #### Get Suggestions Search and filter all suggestions using specific criteria. `GET` Get all SKU Suggestions `GET` Get SKU Suggestion by ID #### Manage Suggestions Send or delete SKU suggestions from the seller to marketplace. `PUT` Send SKU Suggestion `DELETE` Delete SKU Suggestion #### Get Versions Search and filter all versions of suggestions, using specific criteria. `GET` Get all versions `GET` Get version by ID #### Match Received SKUs Match SKU suggestions received in the marketplace. `PUT` Match Received SKUs individually `PUT` Match Multiple Received SKUs #### SKU Approval Settings Allows marketplaces to configure rules for automatically and manually approving SKUs received from sellers. `GET`Get autoApprove St
VTEX DO is a task management system for authorized users to process orders. It is possible to control notes, and create, update, list, and retrieve tasks.
The VTEX Headless CMS is a no-code management system for storefront content. That means you can store your content as structured data in a layer decoupled from the frontend and use the VTEX Headless CMS to access and deliver your content to your storefront project. Notice that the VTEX Headless CMS typically works with **FastStore** projects only. In this case, you can use this API to fetch data using SSR (NextJS and Gatsby v4+) or SSG (NextJS). **Servers** - `https://{account}.myvtex.com/` - `https://{workspace}--{account}.myvtex.com/` **Server variables** - `accountName`: Name of your VTEX account. - `workspace`: Name of your VTEX workspace.