Tutorials & Solutions
Orders management
Inventory and shipping
Subscriptions
Payments
Catalog
Prices
Rates & Benefits
Insights
Master data
Message Center
Sales Policies
CMS
Checkout
Sellers
Integrations
Orders
Products
Tracking
Price
Inventory
Integration Settings
Authentications
Account management
Billing
Apps
Other

Integration guide for marketplaces

VTEX Team
VTEX Team
Last updated
1/23/2020

Marketplaces and sellers

E-commerce model between Marketplace and Seller, may stores are hosted or not on VTEX platform. Sales between Marketplace and Seller involve a negotiation between the two parts, the owner of the product (the Seller) and the owner of the showcase (the Marketplace). This negotiation usually involves commercial policy of traded items (SKUs) and maintenance of payment.

The VTEX besides offering integrations with the biggest market players, also offers a set of APIs and instructions to third parties integrate themselves.

  • Seller - Responsible for accomplish the order's delivery (the owner of the product).
  • SKU - Defines a variation of a product, Example: 110V white refrigerator.
  • Marketplace - Showcase where the SKUs are exposed (the owner of the showcase).
  • SLA - Service agreement, Example: deadline and cost of delivery.
  • API - Service interfaces for communication between computer systems.

Support tools to the integrator

Postman

Chrome browser extension, in this tool is possible to test, store history, save access requests collections from all APIs of the VTEX modules (OMS, Logistics, Pricing, GCS, Catalog, Payments, etc.), besides it allows to export and import requests from other developers.

[Developer] - VTEX API Collection

It's very important the integrator get the knowledge of this kind of tools, or other similar tools before start an integration process using the REST VTEX APIs.

Credentials of access on the REST APIs

Every call made to REST APIs from VTEX must be made in “https” and must have in its header the authentication keys. The authentication keys of the header (to access the REST APIs) must be requested to the store administrator or to the operations team that is deploying the store.

WarningAn exclusive key and token must be created to each integrator, a key from the own store mustn't be used.

Integration models

Seller selling in marketplace hosted on VTEX platform

This model allows a seller not hosted on VTEX platform, exhibit and sell their products (SKUs) in Marketplaces hosted on VTEX platform. To implement this model, the Seller shall exhibit some endpoints that will be called by the Marketplace and call some endpoints exposed by the Marketplace, following the VTEX protocol. In this model the Marketplace controls all the payment process. Find the instructions to do this integration below:

[Guide] Seller Selling in Marketplace Hosted on VTEX Platform

Seller selling in marketplace hosted on VTEX platform and processing the payment

This model allows a seller not hosted on VTEX platform, exhibit and sell their products (SKUs) in Marketplaces hosted on VTEX platform. To implement this model, the Seller shall exhibit some endpoints that will be called by the Marketplace and call some endpoints exposed by the Marketplace, following the VTEX protocol. In this model the Marketplace sends payment data to be processed at the Seller. Following are the instructions to do this integration.

[Guide] Seller Selling in Marketplace Hosted on VTEX Platform and Processing the Payment

Marketplace selling to seller hosted on VTEX platform

This model allows a seller not hosted on VTEX platform, exhibit and sell their products (SKUs) from Sellers hosted on VTEX platform. To implement this model, the Marktplace shall exhibit some endpoints that will be called by the Seller and call some endpoints exposed by the Seller, following the VTEX protocol. In this model the Marketplace controls all the payment transaction. Following are the instructions to do this integration.

[Guide] Marketplace non VTEX Selling to Seller Hosted on VTEX Platform

Marketplace selling to seller hosted on VTEX platform sending payment

This model allows a marketplace not VTEX exhibit and sell products (SKUs) from Sellers hosted on VTEX platform. To implement this model, the Marktplace shall exhibit some endpoints that will be called by the Seller and call some endpoints exposed by the Seller, following the VTEX protocol. In this model the Marketplace creates the payment transaction in the Seller. Following are the instructions to do this integration.

[Guide] Marketplace Selling to Seller Hosted on VTEX Platform Sending Payment

Still got questions?
Ask the community
Find solutions and share ideas in VTEX's community.
Talk to our experts
Get in touch if you have something specific to ask about the platform.
  • PT
  • ES
VTEX website