Vtex APIs
APIs26 in catalogue
Endpoints592 indexed
CategoriesE Commerce, Payments, HR recruiting, Communications, Developer Tools, Marketing, CRM, Identity Auth
Categories
API Catalog
Catalog API
> Check the new [Catalog onboarding guide](https://developers.vtex.com/docs/guides/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey. The Catalog API is a crucial part of the VTEX ecommerce platform, empowering developers t. The API exposes 162 endpoints secured with apiKey authentication.
162 endpoints
Catalog API - Seller Portal
With the Catalog API for Seller Portal, you will be able to create, edit and consult products and their variations, brands, and categories. >ℹ️ This API is part of the [Seller Portal Catalog](https://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp). This functionality is in the beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will no. The API exposes 16 endpoints secured with apiKey authentication.
16 endpoints
Checkout API
>ℹ️ Check the new [Checkout onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/checkout-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about the Checkout and is organized by focusing on the developer's journey. The Checkout API allows you to obtain and configure information about the. The API exposes 33 endpoints secured with apiKey authentication.
33 endpoints
Customer Credit API
With Customer Credit your store can enable **credit payments** through the checkout. You can also control **invoices** and the **credit limits** of your clients. Learn more about Customer Credit in our [Help Center article](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/36grlQ69NK6OCuioeekyCs). Additionally, you can find more information on installment paym. The API exposes 25 endpoints secured with apiKey authentication.
25 endpoints
Giftcard API
>ℹ️ Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey. The gift card is a payment method configured as a cash value associated with a clien. The API exposes 11 endpoints secured with apiKey authentication.
11 endpoints
Giftcard Hub API
>ℹ️ Check the new [Payments onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey. The Gift Card Hub API allows interactions with all Gift card providers regist. The API exposes 15 endpoints secured with apiKey authentication.
15 endpoints
Intelligent Search API
>ℹ️ Onboarding guide > > Check the new [Search onboarding guide](https://developers.vtex.com/docs/guides/search-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Search and is organized by focusing on the developer's journey. [VTEX Intelligent Search](https://help.vtex.com/en/tracks/vtex-intell. The API exposes 7 endpoints.
7 endpoints
Legacy Search API
> Check the new [Search onboarding guide](https://developers.vtex.com/docs/guides/search-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Search and is organized by focusing on the developer's journey. This API lets you search and sort products in the Catalog using Fulltext, Category and Brand. The API exposes 15 endpoints secured with apiKey authentication.
15 endpoints
License Manager API
The License Manager API allows you to create users, modify their names and emails, add and remove [roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) from users, and create and manage [appKeys](https://help.vtex.com/en/tutorial/application-keys--2iffYzlvvz4BDMr6WGUtet). Common parameters |Attribute name | Description | |:------------|--------------| |`accountName` | Account na. The API exposes 13 endpoints secured with apiKey authentication.
13 endpoints
Logistics API
[Logistics or fulfillment](https://help.vtex.com/en/tutorial/logistics--53udnvI5eBy8DKo8FOjMoP) is the process of planning and executing the transportation, storage of merchandise, and shipping orders to customers. You can accomplish all of this with the VTEX platform, which allows you to manage your inventory, shipping rates, pickup points and more. Logistics API Index Shipping Policies - `GET` [. The API exposes 55 endpoints secured with apiKey authentication.
55 endpoints
Marketplace API
The **Marketplace API** enables marketplaces and sellers hosted on VTEX to perform their collaborative operations. >⚠️ The marketplace must [create an appKey and appToken](https://developers.vtex.com/docs/guides/getting-started-authentication) 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 ha. The API exposes 22 endpoints secured with apiKey authentication.
22 endpoints
Master Data API - v1
Master Data is a highly customizable VTEX database solution, which enables you to create applications. By default, Master Data is used to store and organize Customer data from your store. It features a powerful search engine, allowing you to store, search, expand, and customize data. Learn more about [Master Data v1](https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw). Index Dat. The API exposes 25 endpoints secured with apiKey authentication.
25 endpoints
Master Data API - v2
>ℹ️ Master Data v2 is not compatible with data entities from previous versions, such as CL and AD. [Master Data](https://developers.vtex.com/docs/guides/master-data-introduction) is a secure, fast, scalable, and extensible solution that allows users to create their own entities, store data, and retrieve information directly from the storefront or external integrations. Several internal VTEX module. The API exposes 20 endpoints secured with apiKey authentication.
20 endpoints
Message Center API
Message Center corresponds to [order transactional email templates](https://help.vtex.com/en/tutorial/order-transactional-email-templates--3g2S2kqBOoSGcCaqMYK2my). The store can configure templates to automatically send emails to customers and notify them about their order events, such as payment confirmation and shipping. Message Center API Index DKIM configuration - `POST` [Generate DKIM keys](h. The API exposes 1 endpoints secured with apiKey authentication.
1 endpoint
Orders API
Each purchase a customer makes in your store generates an [order](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) on VTEX. With the Orders API, you can view orders statuses and manage multiple aspects involved in order fulfillment, such as financial transactions, invoicing, shipping, and subscriptions. You can also [modify orders](https://developers.vtex.com/docs/api-refere. The API exposes 35 endpoints secured with apiKey authentication.
35 endpoints
Policies System API
This API will create promotion alarms when selling products with undesired prices and promotions. It will create conditions that will check if the prices and the promotions are correct. If not, the system will alarm the store with information about the product sold at unexpected prices. Index - `GET` [Get Policy List](https://developers.vtex.com/docs/api-reference/policies-system-api#get-/api/poli. The API exposes 6 endpoints secured with apiKey authentication.
6 endpoints
Pricing API
Check the new [Pricing onboarding guide](https://developers.vtex.com/docs/guides/pricing-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Pricing and is organized by focusing on the developer's journey. Pricing is the VTEX module responsible for the SKU's price list. In this module, we have th. The API exposes 16 endpoints secured with apiKey authentication.
16 endpoints
Pricing Hub (DEPRECATED)
>⚠️ This API has been deprecated. If you need to associate prices with customers, we recommend using the [Audience API](https://developers.vtex.com/docs/api-reference/audience-api).\ n\n. In the B2B scenario, it is common for stores to have personalized prices per customer and complex pricing systems that require external integrations. Pricing Hub is a system developed for the B2B context that wor. The API exposes 2 endpoints secured with apiKey authentication.
2 endpoints
Profile System - PII data architecture
>⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions. > > This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want . The API exposes 31 endpoints secured with apiKey authentication.
31 endpoints
Promotions & Taxes API
Check the new [Promotions onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/promotions-overview). 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. The API exposes 31 endpoints secured with apiKey authentication.
31 endpoints
Reviews and Ratings API
[Reviews & Ratings](https://developers.vtex.com/vtex-developer-docs/docs/vtex-reviews-and-ratings) is a VTEX IO app that allows shoppers to submit reviews and ratings for products, and view them while navigating the store. With the Reviews and Ratings API you can manage the reviews and ratings associated with the products in your store. Index Rating - `GET` [Get product rating](https://developers. The API exposes 8 endpoints secured with apiKey authentication.
8 endpoints
Session Manager API
Session Manager tracks the current browsing sessions of all customers on the VTEX platform. Important session information is automatically captured and stored in a secure and easily accessible location. This includes data such as relevant cookies, query strings, authentication credentials, current profile and pricing information, if applicable. Session Manager API allows developers to retrieve and. The API exposes 4 endpoints secured with apiKey authentication.
4 endpoints
SKU Bindings API
vtex.local/SKU-Bindings-API version 1.0. The API exposes 12 endpoints secured with apiKey authentication.
12 endpoints
Suggestions
The **Marketplace API** enables marketplaces and sellers hosted on VTEX to perform their collaborative operations. >⚠️ The marketplace must [create an appKey and appToken](https://developers.vtex.com/docs/guides/getting-started-authentication) 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 ha. The API exposes 16 endpoints secured with apiKey authentication.
16 endpoints
VTEX DO API
[VTEX DO](https://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu) is a task management system for authorized [users](https://help.vtex.com/en/tutorial/how-to-manage-users--tutorials_512) to process VTEX store orders. The functionality allows you to control notes, and create, update, list, and retrieve tasks. VTEX DO API Index Note - `POST` [Create Note](https://developers.vtex.com/docs/. The API exposes 8 endpoints secured with apiKey authentication.
8 endpoints
VTEX Headless CMS
The [VTEX Headless CMS](https://www.faststore.dev/docs/headless-cms-overview) is a solution for storefront content management. You can use the Headless CMS API to fetch data about your project's pages and content types, including `status`, `id`, and `type`. Index Pages - `GET` [Get all Content Types](https://developers.vtex.com/docs/api-reference/headless-cms-api#get-/_v/cms/api/-projectId-) - `GE. The API exposes 3 endpoints.
3 endpoints
BOOK A DEMO
Start Connecting APIs to Your AI Agents
Browse thousands of APIs and connect them all to your agent with Jentic One. One layer, one credential — every API your agent needs.