VTEX

aid: vtex
url: https://raw.githubusercontent.com/api-evangelist/vtex/refs/heads/main/apis.yml
name: VTEX
description: VTEX is a global enterprise digital commerce platform that provides end-to-end solutions for businesses to create,
  manage, and scale their online stores. Founded in Brazil, VTEX serves thousands of merchants across 38 countries with capabilities
  spanning catalog management, checkout, payments, logistics, marketplace, promotions, search, and customer identity. The
  platform offers an extensive API ecosystem enabling headless commerce, composable architectures, and deep integrations with
  third-party tools and marketplaces.
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
tags:
  - Commerce
  - E-Commerce
  - Retail
  - Marketplace
  - Payments
created: '2024-06-07'
modified: '2026-05-19'
specificationVersion: '0.19'
kind: contract
access: 3rd-Party
position: Consuming
apis:
  - aid: vtex:vtex-anti-fraud-provider-api
    name: VTEX Anti-Fraud Provider API
    description: The VTEX Anti-Fraud Provider API defines the integration protocol between VTEX and anti-fraud providers. It
      enables third-party anti-fraud services to connect with the VTEX payment ecosystem, receive transaction data, assess fraud
      risk, and return risk scores and recommendations in real time.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works
    baseURL: https://{providerApiEndpoint}
    tags:
    - Anti-Fraud
    - Fraud Prevention
    - Payments
    - Security
    properties:
    - url: openapi/vtex-anti-fraud-provider-openapi-original.yml
      type: OpenAPI
    - url: https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/anti-fraud-provider-anti-fraud-flow.yaml
    - type: NaftikoCapability
      url: capabilities/anti-fraud-provider-oauth-flow.yaml
  - aid: vtex:vtex-buyer-organization-api
    name: VTEX Buyer Organization API
    description: The VTEX Buyer Organization API enables B2B commerce capabilities by allowing businesses to manage buyer organizations,
      their members, roles, and cost centers. It supports bulk import of buyer organizations and manages permissions for B2B
      purchasing workflows.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet
    baseURL: https://{accountName}.{environment}.com.br
    tags:
    - B2B
    - Commerce
    - Organizations
    - Purchasing
    properties:
    - url: openapi/vtex-buyer-organization-openapi-original.yml
      type: OpenAPI
    - url: https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/buyer-organization-bulk-import.yaml
  - aid: vtex:vtex-catalog-api-seller-portal
    name: VTEX Catalog API - Seller Portal
    description: The VTEX Catalog API for Seller Portal provides endpoints for sellers to manage their product catalog within
      the VTEX seller portal experience. It enables product creation, category mapping, attribute management, and SKU synchronization
      between seller catalogs and marketplace catalogs.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://developers.vtex.com/docs/guides/catalog-api-seller-portal-overview
    baseURL: https://{accountName}.{environment}.com.br
    tags:
    - Catalog
    - Commerce
    - Marketplace
    - Seller
    properties:
    - url: openapi/vtex-catalog-api-seller-portal-openapi-original.yml
      type: OpenAPI
    - url: https://developers.vtex.com/docs/guides/catalog-api-seller-portal-overview
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/catalog-api-seller-portal-brand.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-api-seller-portal-category.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-api-seller-portal-product.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-api-seller-portal-sku.yaml
  - aid: vtex:vtex-catalog-api
    name: VTEX Catalog API
    description: The VTEX Catalog API provides comprehensive product catalog management for VTEX stores. It covers categories,
      brands, products, SKUs, product specifications, product images, product attachments, and collection management. This is
      the primary API for building and maintaining product catalogs in VTEX.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://developers.vtex.com/docs/guides/catalog-overview
    baseURL: https://{accountName}.{environment}.com.br
    tags:
    - Catalog
    - Commerce
    - Products
    - SKU
    properties:
    - url: openapi/vtex-catalog-openapi-original.yml
      type: OpenAPI
    - url: https://developers.vtex.com/docs/guides/catalog-overview
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/catalog-attachment.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-brand.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-category.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-category-specification.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-collection-beta.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-commercial-conditions.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-gift-list.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-legacy-collection.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-legacy-subcollection.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-non-structured-specification.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-product.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-product-indexing.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-product-specification.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-sku.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-sku-attachment.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-sku-complement.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-sku-ean.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-sku-file.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-sku-kit.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-sku-seller.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-sku-service.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-sku-service-attachment.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-sku-service-type.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-sku-service-value.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-sku-specification.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-sales-channel.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-seller.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-similar-category.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-specification.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-specification-field.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-specification-field-value.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-specification-group.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-specification-value.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-supplier.yaml
    - type: NaftikoCapability
      url: capabilities/catalog-trade-policy.yaml
  - aid: vtex:vtex-checkout-api
    name: VTEX Checkout API
    description: The VTEX Checkout API manages the complete checkout lifecycle for VTEX stores. It handles cart management,
      order simulation, address validation, payment selection, order placement, and cart attachment operations. This API is
      central to the purchase flow in any VTEX storefront.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://developers.vtex.com/docs/guides/checkout-overview
    baseURL: https://{accountName}.{environment}.com.br
    tags:
    - Cart
    - Checkout
    - Commerce
    - Orders
    properties:
    - url: openapi/vtex-checkout-openapi-original.yml
      type: OpenAPI
    - url: https://developers.vtex.com/docs/guides/checkout-overview
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/checkout-cart-attachments.yaml
    - type: NaftikoCapability
      url: capabilities/checkout-configuration.yaml
    - type: NaftikoCapability
      url: capabilities/checkout-custom-data.yaml
    - type: NaftikoCapability
      url: capabilities/checkout-fulfillment.yaml
    - type: NaftikoCapability
      url: capabilities/checkout-order-placement.yaml
    - type: NaftikoCapability
      url: capabilities/checkout-region.yaml
    - type: NaftikoCapability
      url: capabilities/checkout-shopping-cart.yaml
  - aid: vtex:vtex-customer-credit-api
    name: VTEX Customer Credit API
    description: The VTEX Customer Credit API manages credit lines for B2B and B2C customers. It enables merchants to create
      credit accounts, set credit limits, track outstanding balances, open and close invoices, and manage credit terms. Useful
      for businesses that extend net-terms or credit facilities to their buyers.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0
    baseURL: https://{accountName}.{environment}.com.br
    tags:
    - B2B
    - Commerce
    - Credit
    - Finance
    properties:
    - url: openapi/vtex-customer-credit-openapi-original.yml
      type: OpenAPI
    - url: https://help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/customer-credit-account.yaml
    - type: NaftikoCapability
      url: capabilities/customer-credit-invoices.yaml
    - type: NaftikoCapability
      url: capabilities/customer-credit-store-configuration.yaml
  - aid: vtex:vtex-data-subject-rights-api
    name: VTEX Data Subject Rights API
    description: The VTEX Data Subject Rights API enables GDPR and LGPD compliance by allowing organizations to process data
      subject requests. It supports the right to access, rectify, erase, and restrict processing of personal data stored in
      VTEX systems.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://help.vtex.com/en/tutorial/data-subject-rights--6imchxTx09icupKMbzHVIM
    baseURL: https://api.vtex.com
    tags:
    - Compliance
    - Data Privacy
    - GDPR
    - Privacy
    properties:
    - url: openapi/vtex-data-subject-rights-openapi-original.yml
      type: OpenAPI
    - url: https://help.vtex.com/en/tutorial/data-subject-rights--6imchxTx09icupKMbzHVIM
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/data-subject-rights-data-subject-rights.yaml
  - aid: vtex:vtex-do-api
    name: VTEX DO API
    description: The VTEX DO API provides task and note management capabilities for VTEX store operators. It allows creating,
      updating, listing, and deleting tasks and notes associated with orders and other store objects, enabling internal operational
      workflows.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://developers.vtex.com/docs/api-reference/do-api
    baseURL: https://{accountName}.{environment}.com.br/api/do
    tags:
    - Commerce
    - Operations
    - Tasks
    - Workflow
    properties:
    - url: openapi/vtex-do-openapi-original.yml
      type: OpenAPI
    - url: https://developers.vtex.com/docs/api-reference/do-api
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/do-note.yaml
    - type: NaftikoCapability
      url: capabilities/do-task.yaml
  - aid: vtex:vtex-gift-card-hub-api
    name: VTEX Gift Card Hub API
    description: The VTEX Gift Card Hub API provides a central integration point for managing gift card providers on the VTEX
      platform. It enables merchants to list, activate, and deactivate gift card providers, and process gift card transactions
      through a unified interface.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://developers.vtex.com/docs/guides/managing-vtex-gift-cards
    baseURL: https://{accountName}.{environment}.com.br
    tags:
    - Commerce
    - Gift Cards
    - Payments
    - Promotions
    properties:
    - url: openapi/vtex-gift-card-hub-openapi-original.yml
      type: OpenAPI
    - url: https://developers.vtex.com/docs/guides/managing-vtex-gift-cards
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/gift-card-hub-provider.yaml
    - type: NaftikoCapability
      url: capabilities/gift-card-hub-transaction.yaml
  - aid: vtex:vtex-gift-card-api
    name: VTEX Gift Card API
    description: The VTEX Gift Card API manages the lifecycle of gift cards within the VTEX native gift card provider. It supports
      creating, redeeming, crediting, debiting, and canceling gift card transactions, as well as listing and retrieving gift
      card information.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://developers.vtex.com/docs/guides/managing-vtex-gift-cards
    baseURL: https://{accountName}.{environment}.com.br/api/
    tags:
    - Commerce
    - Gift Cards
    - Payments
    - Promotions
    properties:
    - url: openapi/vtex-gift-card-openapi-original.yml
      type: OpenAPI
    - url: https://developers.vtex.com/docs/guides/managing-vtex-gift-cards
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/gift-card-gift-card.yaml
    - type: NaftikoCapability
      url: capabilities/gift-card-transaction.yaml
  - aid: vtex:vtex-gift-card-provider-protocol-api
    name: VTEX Gift Card Provider Protocol API
    description: The VTEX Gift Card Provider Protocol defines the interface for integrating external gift card providers with
      VTEX. It specifies the endpoints external providers must implement to handle gift card transactions, balance checks, and
      redemption flows within VTEX checkout.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://developers.vtex.com/docs/guides/gift-card-integration-guide
    baseURL: https://{providerApiEndpoint}
    tags:
    - Commerce
    - Gift Cards
    - Integration
    - Payments
    properties:
    - url: openapi/vtex-gift-card-provider-protocol-openapi-original.yml
      type: OpenAPI
    - url: https://developers.vtex.com/docs/guides/gift-card-integration-guide
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/gift-card-provider-protocol-gift-cards.yaml
    - type: NaftikoCapability
      url: capabilities/gift-card-provider-protocol-transactions.yaml
  - aid: vtex:vtex-headless-cms-api
    name: VTEX Headless CMS API
    description: The VTEX Headless CMS API provides content management capabilities for FastStore and headless VTEX storefronts.
      It enables managing CMS pages, sections, content types, and building blocks that compose headless commerce experiences.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://developers.vtex.com/docs/guides/faststore/headless-cms-overview
    baseURL: https://{accountName}.myvtex.com
    tags:
    - CMS
    - Commerce
    - Content Management
    - Headless
    properties:
    - url: openapi/vtex-headless-cms-openapi-original.yml
      type: OpenAPI
    - url: https://developers.vtex.com/docs/guides/faststore/headless-cms-overview
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/headless-cms-pages.yaml
  - aid: vtex:vtex-id-api
    name: VTEX ID API
    description: The VTEX ID API provides authentication and identity management for VTEX stores. It handles user login, token
      generation, authentication renewal, and password management for customers, store operators, and API integrations.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://developers.vtex.com/docs/api-reference/vtex-id-api
    baseURL: https://{accountName}.{environment}.com.br
    tags:
    - Authentication
    - Commerce
    - Identity
    - Security
    properties:
    - url: openapi/vtex-id-openapi-original.yml
      type: OpenAPI
    - url: https://developers.vtex.com/docs/api-reference/vtex-id-api
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/id-authentication.yaml
  - aid: vtex:vtex-intelligent-search-events-api
    name: VTEX Intelligent Search Events API
    description: The VTEX Intelligent Search Events API captures behavioral signals from shoppers to improve search relevance.
      It collects events such as search queries, product clicks, and purchase completions to feed the machine learning models
      powering VTEX Intelligent Search.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/3qgT47zY08biLP3d5os3DG
    baseURL: https://sp.vtex.com/event-api/v1/{accountName}
    tags:
    - Analytics
    - Commerce
    - Events
    - Search
    properties:
    - url: openapi/vtex-intelligent-search-events-openapi-original.yml
      type: OpenAPI
    - url: https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/3qgT47zY08biLP3d5os3DG
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/intelligent-search-events-events.yaml
  - aid: vtex:vtex-intelligent-search-api
    name: VTEX Intelligent Search API
    description: The VTEX Intelligent Search API delivers AI-powered search and product discovery features for VTEX storefronts.
      It provides product search with faceted filtering, autocomplete suggestions, banners, product recommendations, and spelling
      correction powered by machine learning.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://developers.vtex.com/docs/apps/vtex.search@1.0.8
    baseURL: https://{accountName}.{environment}.com.br/api/io/_v/api/intelligent-search
    tags:
    - AI
    - Commerce
    - Product Discovery
    - Search
    properties:
    - url: openapi/vtex-intelligent-search-openapi-original.yml
      type: OpenAPI
    - url: https://developers.vtex.com/docs/apps/vtex.search@1.0.8
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/intelligent-search-autocomplete.yaml
    - type: NaftikoCapability
      url: capabilities/intelligent-search-product-list-page.yaml
  - aid: vtex:vtex-legacy-cms-portal-api
    name: VTEX Legacy CMS Portal API
    description: The VTEX Legacy CMS Portal API provides access to the classic VTEX CMS system used in traditional VTEX stores.
      It enables managing HTML templates, site structure, shelves, and custom pages within the legacy CMS portal.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/1oN446gRGcR2s70RvBCAmj
    baseURL: https://{accountName}.{environment}.com.br
    tags:
    - CMS
    - Commerce
    - Content Management
    - Legacy
    properties:
    - url: openapi/vtex-legacy-cms-portal-openapi-original.yml
      type: OpenAPI
    - url: https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/1oN446gRGcR2s70RvBCAmj
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/legacy-cms-portal-change-uri-schema.yaml
  - aid: vtex:vtex-legacy-search-api
    name: VTEX Legacy Search API
    description: The VTEX Legacy Search API supports product search and discovery for traditional VTEX storefronts not yet migrated
      to Intelligent Search. It provides catalog browsing, text search, faceted filtering, category navigation, and product
      listing page capabilities.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://developers.vtex.com/docs/guides/search-overview
    baseURL: https://{accountName}.{environment}.com.br
    tags:
    - Catalog
    - Commerce
    - Legacy
    - Search
    properties:
    - url: openapi/vtex-legacy-search-openapi-original.yml
      type: OpenAPI
    - url: https://developers.vtex.com/docs/guides/search-overview
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/legacy-search-autocomplete.yaml
    - type: NaftikoCapability
      url: capabilities/legacy-search-crossselling.yaml
    - type: NaftikoCapability
      url: capabilities/legacy-search-facets.yaml
    - type: NaftikoCapability
      url: capabilities/legacy-search-offers.yaml
    - type: NaftikoCapability
      url: capabilities/legacy-search-search.yaml
  - aid: vtex:vtex-license-manager-api
    name: VTEX License Manager API
    description: The VTEX License Manager API manages access control and permissions within the VTEX platform. It handles user
      accounts, roles, resources, app permissions, and account access tokens, serving as the primary authorization layer for
      VTEX administrative operations.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3
    baseURL: https://{accountName}.{environment}.com.br
    tags:
    - Access Control
    - Authorization
    - Commerce
    - Permissions
    properties:
    - url: openapi/vtex-license-manager-openapi-original.yml
      type: OpenAPI
    - url: https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/license-manager-account.yaml
    - type: NaftikoCapability
      url: capabilities/license-manager-app-keys.yaml
    - type: NaftikoCapability
      url: capabilities/license-manager-roles.yaml
    - type: NaftikoCapability
      url: capabilities/license-manager-stores.yaml
    - type: NaftikoCapability
      url: capabilities/license-manager-users.yaml
  - aid: vtex:vtex-logistics-api
    name: VTEX Logistics API
    description: The VTEX Logistics API manages the complete fulfillment infrastructure for VTEX stores. It covers warehouses,
      inventory management, shipping carriers, freight calculations, pickup points, geolocation zones, scheduled delivery windows,
      and dock management to support complex omnichannel fulfillment scenarios.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://developers.vtex.com/docs/guides/fulfillment
    baseURL: https://{accountName}.{environment}.com.br
    tags:
    - Commerce
    - Fulfillment
    - Inventory
    - Logistics
    properties:
    - url: openapi/vtex-logistics-openapi-original.yml
      type: OpenAPI
    - url: https://developers.vtex.com/docs/guides/fulfillment
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/logistics-docks.yaml
    - type: NaftikoCapability
      url: capabilities/logistics-freight-values.yaml
    - type: NaftikoCapability
      url: capabilities/logistics-holidays.yaml
    - type: NaftikoCapability
      url: capabilities/logistics-inventory.yaml
    - type: NaftikoCapability
      url: capabilities/logistics-pickup-points.yaml
    - type: NaftikoCapability
      url: capabilities/logistics-polygons.yaml
    - type: NaftikoCapability
      url: capabilities/logistics-reservations.yaml
    - type: NaftikoCapability
      url: capabilities/logistics-sla.yaml
    - type: NaftikoCapability
      url: capabilities/logistics-scheduled-delivery.yaml
    - type: NaftikoCapability
      url: capabilities/logistics-shipping-policies.yaml
    - type: NaftikoCapability
      url: capabilities/logistics-warehouses.yaml
  - aid: vtex:vtex-marketplace-api
    name: VTEX Marketplace API
    description: The VTEX Marketplace API manages the relationships and operations between VTEX marketplaces and their sellers.
      It supports seller onboarding, offer management, seller portal access, and the coordination of catalog and order flows
      between marketplace operators and their sellers.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://developers.vtex.com/docs/guides/marketplace-overview
    baseURL: https://{accountName}.{environment}.com.br/api
    tags:
    - Commerce
    - Marketplace
    - Multi-Seller
    - Retail
    properties:
    - url: openapi/vtex-marketplace-openapi-original.yml
      type: OpenAPI
    - url: https://developers.vtex.com/docs/guides/marketplace-overview
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/marketplace-matched-offers.yaml
    - type: NaftikoCapability
      url: capabilities/marketplace-notification.yaml
    - type: NaftikoCapability
      url: capabilities/marketplace-sales-channel-mapping.yaml
    - type: NaftikoCapability
      url: capabilities/marketplace-seller-commissions.yaml
    - type: NaftikoCapability
      url: capabilities/marketplace-seller-invite.yaml
    - type: NaftikoCapability
      url: capabilities/marketplace-sellers.yaml
  - aid: vtex:vtex-marketplace-protocol-external-mapper-api
    name: VTEX Marketplace Protocol - External Mapper API
    description: The VTEX Marketplace Protocol External Mapper API defines the catalog mapping protocol for external marketplace
      connectors. It enables synchronization of product categories, brands, and specifications between external marketplace
      catalogs and the VTEX catalog.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://developers.vtex.com/updates/release-notes/marketplace-protocol-documentation-update
    baseURL: https://portal.{environment}.com.br
    tags:
    - Catalog
    - Integration
    - Marketplace
    - Protocol
    properties:
    - url: openapi/vtex-marketplace-protocol-external-mapper-openapi-original.yml
      type: OpenAPI
    - url: https://developers.vtex.com/updates/release-notes/marketplace-protocol-documentation-update
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/marketplace-protocol-external-mapper-external-marketplace.yaml
  - aid: vtex:vtex-marketplace-protocol-external-orders-api
    name: VTEX Marketplace Protocol - External Orders API
    description: The VTEX Marketplace Protocol External Orders API defines the order flow protocol for external marketplace
      integrations. It specifies how external marketplaces send orders to VTEX sellers, handle order status updates, and manage
      cancellations.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://developers.vtex.com/docs/guides/external-marketplace-integration-guide
    baseURL: https://{accountName}.{environment}.com.br
    tags:
    - Integration
    - Marketplace
    - Orders
    - Protocol
    properties:
    - url: openapi/vtex-marketplace-protocol-external-orders-openapi-original.yml
      type: OpenAPI
    - url: https://developers.vtex.com/docs/guides/external-marketplace-integration-guide
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/marketplace-protocol-external-orders-external-marketplace.yaml
  - aid: vtex:vtex-marketplace-protocol-external-seller-fulfillment-api
    name: VTEX Marketplace Protocol - External Seller Fulfillment API
    description: The VTEX Marketplace Protocol External Seller Fulfillment API defines endpoints that external sellers must
      implement to receive and fulfill orders from VTEX marketplaces. It covers order notification, fulfillment status updates,
      and delivery tracking callbacks.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://developers.vtex.com/docs/guides/external-seller-integration-connector
    baseURL: https://{fulfillmentEndpoint}
    tags:
    - Fulfillment
    - Integration
    - Marketplace
    - Seller
    properties:
    - url: openapi/vtex-marketplace-protocol-external-seller-fulfillment-openapi-original.yml
      type: OpenAPI
    - url: https://developers.vtex.com/docs/guides/external-seller-integration-connector
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/marketplace-protocol-external-seller-fulfillment-external-seller.yaml
  - aid: vtex:vtex-marketplace-protocol-external-seller-marketplace-api
    name: VTEX Marketplace Protocol - External Seller Marketplace API
    description: The VTEX Marketplace Protocol External Seller Marketplace API defines the protocol for VTEX acting as a seller
      on external marketplaces. It enables VTEX stores to list products, receive orders, and send fulfillment updates to external
      marketplace platforms.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://developers.vtex.com/docs/guides/external-seller-integration-guide
    baseURL: https://{marketplaceServicesEndpoint}
    tags:
    - Integration
    - Marketplace
    - Protocol
    - Seller
    properties:
    - url: openapi/vtex-marketplace-protocol-external-seller-marketplace-openapi-original.yml
      type: OpenAPI
    - url: https://developers.vtex.com/docs/guides/external-seller-integration-guide
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/marketplace-protocol-external-seller-marketplace-external-seller.yaml
  - aid: vtex:vtex-master-data-api
    name: VTEX Master Data API
    description: The VTEX Master Data API is a NoSQL document store built into the VTEX platform. It provides schema-flexible
      data entity management with CRUD operations, full-text search, and indexing. Used for storing customer profiles, wishlists,
      subscriptions, and custom business data.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw
    baseURL: https://{accountName}.{environment}.com.br
    tags:
    - Commerce
    - Customer Data
    - Data Management
    - NoSQL
    properties:
    - url: openapi/vtex-master-data-openapi-original.yml
      type: OpenAPI
    - url: https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw
      type: Documentation
    - type: NaftikoCapability
      url: capabilities/master-data-clusters.yaml
    - type: NaftikoCapability
      url: capabilities/master-data-documents.yaml
    - type: NaftikoCapability
      url: capabilities/master-data-indices.yaml
    - type: NaftikoCapability
      url: capabilities/master-data-schemas.yaml
    - type: NaftikoCapability
      url: capabilities/master-data-scroll.yaml
    - type: NaftikoCapability
      url: capabilities/master-data-search.yaml
    - type: NaftikoCapability
      url: capabilities/master-data-versions.yaml
  - aid: vtex:vtex-message-center-api
    name: VTEX Message Center API
    description: The VTEX Message Center API manages transactional email templates and message flows for VTEX stores. It handles
      email template management and message triggers for order confirmations, shipping notifications, and other transactional
      communications.
    image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
    humanURL: https://help.vtex.com/en/tutorial/understanding-the-message-center--tutorials_84
    baseURL: https://{accountName}.{environment}.com.br
    tags:
    - Commerce
    - Email
    - Messaging
    - Notifications
    properties:
    - url: openapi/vtex-message-center-openapi-original.yml
      type: OpenAPI
    - url: https://help.vtex.com/en/tutorial/understanding-the-mess

# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vtex/refs/heads/main/apis.yml