API Reference

API Reference
Filter by
API Reference
Use our API reference documentation to build custom solutions that fit your business.
API Reference
Antifraud Provider API
Use the Antifraud Provider Protocol to integrate your antifraud service API into the VTEX platform.
Legacy CMS Portal API
Update your websites’ internet communication protocol
Catalog API
Manipulate your store’s sales channels, categories, brands, products, SKUs and specifications.
Catalog API - Seller Portal
Create, edit and consult products and their variations, brands, and categories for a Seller Portal account
Checkout API
Access and manipulate items and data from a checkout cart.
Customer Credit API
Enable credit payments on your store and control invoices and credit limits.
Gift Card API
Retrieve and update gift cards from our native Gift Card System.
Gift Card Hub API
Interact with all Gift Card Providers registered to a store from a single point.
Gift Card Provider Protocol API
Integrate your Gift Card API into VTEX platform.
No-code management system for storefront content.
Intelligent Search API
Assist your customers in their purchase journey, presenting results from search bar interactions.
License Manager API
Manage users, roles, hosts, AppKeys and AppTokens from a VTEX store.
Logistics API
Manage all store logistics data by accessing warehouses, docks, pick up points, inventory, carriers and shipping rates.
Marketplace API
Enables marketplaces and sellers hosted on VTEX to perform their collaborative operations.
Master Data API
Manage and retrieve all data entities, applications and records from the Master Data database.
Orders API
Receive, process, and manage every order through our APIs.
Payments Provider Protocol API
Integrate your payment processing API into the VTEX platform,
Payments Gateway API
Get payment data and process your transactions.
Policies System API
Create promotion alarms when selling products with undesired prices and promotions.
Pricing API
Create, retrieve and edit prices for each SKU, sales channel or price table.
Price Simulations API
Configure custom price selectors for B2B stores.
Pricing Hub API
Intermediary between VTEX and external pricing systems for B2B context.
Promotions & Taxes API
Manage and retrieve all promotions, coupons and tax rules from a VTEX store.
Reviews and Ratings API
Allow shoppers to submit reviews and ratings for products.
Search API
Search and sort products in the catalog using fulltext, category and brand search terms. Retrieve product data to custom searches and product shelves.
Session Manager API
Track relevant information about the client's current browsing session and integrate with several VTEX systems using a call.
SKU Bindings API
Manage SKU Bindings in your catalog.
Subscriptions API
Manage store's subscription rules to generate recurrent revenue and reduce bounce rate and churn.
Manage and retrieve notes or tasks related to orders from the VTEX DO task manager.
VTEX Shipping Network API
Integrate your carrier with VTEX Shipping Network’s Hub.
VTEX Tracking
Manage all delivery solutions powered by VTEX Tracking service.