API usage
List of REST APIs
See how to use our APIs to integrate third-party solutions with a single platform for all experiences.
| Name | Description |
|---|---|
| Anti-fraud Provider API | Defines the requirements to integrate an anti-fraud service into VTEX. |
| Legacy CMS Portal API | Manages Legacy CMS Portal via API. |
| Catalog API - Seller Portal | Creates, edits, and retrieves products and their variations, brands, and categories in the Seller Portal. |
| Catalog API | Allows performing operations on your store sales channels, categories, brands, products, SKUs, and specifications. |
| Checkout API | Allows access and operations on data from items in a shopping cart. |
| Customer Credit API | Enables credit payments on your store and controls invoices and credit limits. |
| GiftCard API | Retrieves and updates gift cards from our native gift card system. |
| GiftCard Provider Protocol API | Defines the requirements to become a gift card provider on VTEX. |
| GiftCard Hub API | Interacts with all gift card providers in a store from a single place. |
| Headless CMS API | Structures a no-code management system for storefront content. |
| Intelligent Search API | Helps customers in their buying journey through search results. |
| Intelligent Search Events API - Headless | Collects search events to improve your search results, such as page interactions and conversion, in a headless implementation. |
| License Manager API | Manages users, roles, hosts, AppKeys, and AppTokens from a VTEX store. |
| Logistics API | Manages all store logistics data by allowing access to warehouses, docks, pickup points, carriers, and shipping rates. Gets or updates the inventory of each SKU. |
| Marketplace API | Enables marketplaces and sellers hosted on VTEX to perform operations related to collaboration. |
| Marketplace Protocol | Connects external sellers to a VTEX marketplace and external marketplaces to VTEX sellers. |
| Master Data API v2 | Manages and retrieves all data entities, applications, and records from the Master Data database. |
| Master Data API v1 | Manages and retrieves all data entities, applications, and records from the Master Data database. |
| Message Center API | Manages settings for VTEX mail servers. |
| Orders API | Receives, processes, and manages all orders through our APIs. |
| Payment Provider Protocol API | Defines the requirements to integrate a payment processing API with VTEX. |
| Payments Gateway API | Retrieves payment data and processes your transactions. |
| Policies System API | Creates promotion alarms when selling products with undesired prices and promotions. |
| Pricing API | Creates, reads, and edits prices for each SKU, sales channel or price table. |
| Pricing Hub API | Connects with external pricing systems using Pricing Hub. |
| Promotions & Taxes API | Manages and retrieves all promotions, coupons, and tax rules from a VTEX store. |
| Reviews and Ratings API | Allows customers to submit product reviews and ratings. |
| SKU Bindings API | Links shared SKUs between sellers and marketplaces. |
| Search API | Searches and sorts products in the catalog using full-text, category, and brand search terms. Retrieves product information to create custom searches and product shelves. |
| Session Manager API | Tracks relevant information about the customer's current browsing session and integrates with several VTEX systems using a single call. |
| Subscriptions API v3 | Manages store subscription rules to maximize revenue and reduce bounce and churn rates. |
| VTEX Shipping Network API | Sets up your app to integrate with VTEX Shipping Network. |
| VTEX Tracking API | Manages all delivery solutions powered by a VTEX Tracking service. |
| VTEX Do API | Manages and retrieves notes or tasks from VTEX Do. |
| VTEX ID API | Manages tokens from a given app key and app token pair. |