Public APIs

Public APIs / Development / Vtex APIs

Vtex APIs

34 REST APIs from vtex.local, each with an OpenAPI spec. Vtex APIs documented with an OpenAPI spec.

Open the Vtex APIs documentation Build something with it

Key facts

Category
Development
Authentication
See docs
HTTPS
Yes
CORS
Unknown
Listed in
APIs.guru

Authentication is described in the provider's OpenAPI spec and documentation. Most need a key or OAuth.

What you could build with Vtex APIs

Development APIs are tools for developers: screenshots, code, QR codes, IP lookups, mock data and much more.

  • Internal tools that save developer hours
  • Automated website screenshots and reports
  • A status page and uptime monitor

OpenAPI spec

Vtex APIs has a machine-readable OpenAPI definition. Load it into Postman, Insomnia or a code generator to get every endpoint and a typed client in minutes.

Download the OpenAPI spec (JSON)

34 Vtex APIs REST APIs

  • Pets Api 1.0.0 spec
  • Orders API 1.0
    >Check the new Orders onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX spec
  • Catalog API 1.0
    > Check the new Catalog onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX spec
  • Pricing API 1.0
    > Check the new Pricing onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX spec
  • Pricing Hub 1.0
    > This feature is in closed beta, available only for selected customers. If you have any questions, contact our Support spec
  • Suggestions 1.0
    The Marketplace API enables marketplaces and sellers hosted on VTEX to perform their collaborative operations spec
  • VTEX Do API 1.0
    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 spec
  • Checkout API 1.0
    >ℹ️ Check the new Checkout onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX spec
  • GiftCard API 1.0
    >ℹ️ Onboarding guide > > Check the new Payments onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX spec
  • Logistics API 1.0
    >Check the Fulfillment onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX spec
  • Profile System 1.0
    Create shopper profiles and manage their information spec
  • Marketplace API 1.0
    The Marketplace API enables marketplaces and sellers hosted on VTEX to perform their collaborative operations spec
  • GiftCard Hub API 1.0
    >ℹ️ Check the new Payments onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX spec
  • MasterData API - 1.0 spec
  • SKU Bindings API 1.0 spec
  • Legacy Search API 1.0
    > Check the new Search onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX spec
  • Master Data API - 1.0
    VTEX Master Data is an easy-to-use, secure, fast, scalable and extensible repository spec
  • VTEX Headless CMS 0.31.2
    The VTEX Headless CMS is a no-code management system for storefront content spec
  • Message Center API 1.0.0 spec
  • Customer Credit API 1.0
    With Customer Credit your store can enable credit payments through the checkout. You can also control invoices and the credit limits of your clients spec
  • License Manager API 1.0
    The License Manager API allows you to create users, modify their names and emails, as well as add and remove roles from users spec
  • Policies System API 1.0.0
    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 spec
  • Session Manager API 1.0
    This documentation goes in detail how to interact with Session Manager's API. For a more top-level approach, check the design documentation spec
  • Marketplace Protocol 1.0
    The _Marketplace Protocol_ is a set of API requests and definitions to help you integrate external sellers into a VTEX marketplace as well as external marketplaces into VTEX sellers spec
  • Payments Gateway API 1.0
    >ℹ️ Onboarding guide > > Check the new Payments onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX spec
  • Price Simulations API 1.0
    > Check the new Pricing onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX spec
  • Intelligent Search API 0.1.12
    >ℹ️ Onboarding guide > > Check the new Search onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX spec
  • Promotions & Taxes API 1.0
    > Check the new Promotions onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX spec
  • Subscriptions API (v3) 1.0
    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 spec
  • Reviews and Ratings API 1.0
    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 spec
  • Orders API (PII version) 1.0
    Endpoints that deal with order management. New version of the orders API spec
  • Catalog API - Seller Portal 1.0.0
    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 spec
  • Subscription (v1 - deprecated) 1.0 spec
  • Subscriptions API (v2 - DEPRECATED) 1.0
    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 spec

How we would integrate Vtex APIs

  1. Generate a typed client from the OpenAPI spec, so every endpoint and field is checked at build time.
  2. Sign up with the provider, get a key and store it on the server in an env.php or secret store.
  3. Put a small backend in front of it, so the browser talks to your server and your server talks to the API.
  4. Cache results in your own database, so pages stay fast and you stay inside rate limits.
  5. Add monitoring: if the API goes down or changes, you get an alert before your customers notice.

Questions about Vtex APIs

Does the Vtex APIs need an API key?

Authentication is described in the provider's OpenAPI spec and documentation. Most need a key or OAuth.

Is there an OpenAPI (Swagger) spec for Vtex APIs?

Yes. The spec is linked on this page, so you can generate a client or import it into Postman.

Can I call Vtex APIs from the browser?

It is not documented. Plan for a small server-side proxy to be safe.

Does Vtex APIs support HTTPS?

Yes, it is served over HTTPS.

Can you build an app with Vtex APIs for me?

Yes. FullStack Partner has developers who build and run products on APIs like this one. Send us a few lines and we reply with a plan and a fixed price.

Want a product built on Vtex APIs?

We have the tech people: developers, designers and project managers who have shipped dozens of live products. Tell us what you want to build and we reply with a plan and a fixed price. Are you interested?

No sales spam. One reply from a real person, usually within a day.

More Development APIs

See all 495 Development APIs