Documentation
Feedback
Guides
Learn how to use our APIs and extend the VTEX platform.
API Reference
Check our API Reference for more endpoints' details.
App Development
Learn how to develop apps and integrations in the cloud.
Storefront Development
Express your brand identity creating unique storefronts.
VTEX IO Apps
Find pre-built solutions to grow your business.
Troubleshooting
Find practical solutions to development issues.
Release Notes
Stay up to date with our latest releases and bug fixes.
API Reference
Filter by
Post
Get
Put
Delete
Patch
Anti-fraud Provider API
Audience API
Buyer organizations
Legacy CMS Portal API
Catalog API - Seller Portal
Catalog API
Checkout API
Customer Credit API
GiftCard API
Giftcard Provider Protocol API
GiftCard Hub API
Headless CMS
Intelligent Search API
Intelligent Search Events API - Headless
License Manager API
Logistics API
Marketplace API
Marketplace Protocol
Master Data API - v2
Master Data API - v1
Message Center API
Orders API
Payment Provider Protocol API
Payments Gateway API
Pick and Pack Last Mile Protocol API
Policies System API
Pricing API
Pricing Hub
Promotions & Taxes API
Promotions & Taxes API v2
Reviews and Ratings API
SKU Bindings API
Search API
Session Manager API
Subscriptions API (v3)
VTEX Ad Network API
VTEX Shipping Network API
VTEX Tracking APIs
VTEX DO API
VTEX ID
Profile System (Data Protection Plus)
Orders API - PII Data Architecture (Data Protection Plus)
Guides
API Reference
App Development
Storefront Development
VTEX IO Apps
Troubleshooting
Release Notes
API Reference
Filter by
Post
Get
Put
Delete
Patch
Anti-fraud Provider API
Audience API
Buyer organizations
Legacy CMS Portal API
Catalog API - Seller Portal
Catalog API
Checkout API
Customer Credit API
GiftCard API
Giftcard Provider Protocol API
GiftCard Hub API
Headless CMS
Intelligent Search API
Intelligent Search Events API - Headless
License Manager API
Logistics API
Marketplace API
Marketplace Protocol
Master Data API - v2
Master Data API - v1
Message Center API
Orders API
Payment Provider Protocol API
Payments Gateway API
Pick and Pack Last Mile Protocol API
Policies System API
Pricing API
Pricing Hub
Promotions & Taxes API
Promotions & Taxes API v2
Reviews and Ratings API
SKU Bindings API
Search API
Session Manager API
Subscriptions API (v3)
VTEX Ad Network API
VTEX Shipping Network API
VTEX Tracking APIs
VTEX DO API
VTEX ID
Profile System (Data Protection Plus)
Orders API - PII Data Architecture (Data Protection Plus)
API Reference
Use our API reference documentation to build custom solutions that fit your business.
Antifraud Provider API
Use the Antifraud Provider Protocol to integrate your antifraud service API into the VTEX platform.
See more
Legacy CMS Portal API
Update your websites’ internet communication protocol
See more
Catalog API
Manipulate your store’s sales channels, categories, brands, products, SKUs and specifications.
See more
Catalog API - Seller Portal
Create, edit and consult products and their variations, brands, and categories for a Seller Portal account
See more
Checkout API
Access and manipulate items and data from a checkout cart.
See more
Customer Credit API
Enable credit payments on your store and control invoices and credit limits.
See more
Gift Card API
Retrieve and update gift cards from our native Gift Card System.
See more
Gift Card Hub API
Interact with all Gift Card Providers registered to a store from a single point.
See more
Gift Card Provider Protocol API
Integrate your Gift Card API into VTEX platform.
See more
VTEX Headless CMS API
No-code management system for storefront content.
See more
Intelligent Search API
Assist your customers in their purchase journey, presenting results from search bar interactions.
See more
License Manager API
Manage users, roles, hosts, AppKeys and AppTokens from a VTEX store.
See more
Logistics API
Manage all store logistics data by accessing warehouses, docks, pick up points, inventory, carriers and shipping rates.
See more
Marketplace API
Enables marketplaces and sellers hosted on VTEX to perform their collaborative operations.
See more
Master Data API
Manage and retrieve all data entities, applications and records from the Master Data database.
See more
Orders API
Receive, process, and manage every order through our APIs.
See more
Payments Provider Protocol API
Integrate your payment processing API into the VTEX platform,
See more
Payments Gateway API
Get payment data and process your transactions.
See more
Policies System API
Create promotion alarms when selling products with undesired prices and promotions.
See more
Pricing API
Create, retrieve and edit prices for each SKU, sales channel or price table.
See more
Price Simulations API
Configure custom price selectors for B2B stores.
See more
Pricing Hub API
Intermediary between VTEX and external pricing systems for B2B context.
See more
Promotions & Taxes API
Manage and retrieve all promotions, coupons and tax rules from a VTEX store.
See more
Reviews and Ratings API
Allow shoppers to submit reviews and ratings for products.
See more
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.
See more
Session Manager API
Track relevant information about the client's current browsing session and integrate with several VTEX systems using a call.
See more
SKU Bindings API
Manage SKU Bindings in your catalog.
See more
Subscriptions API
Manage store's subscription rules to generate recurrent revenue and reduce bounce rate and churn.
See more
VTEX DO API
Manage and retrieve notes or tasks related to orders from the VTEX DO task manager.
See more
VTEX Shipping Network API
Integrate your carrier with VTEX Shipping Network’s Hub.
See more
VTEX Tracking
Manage all delivery solutions powered by VTEX Tracking service.
See more