Marketplace Protocol
Last updated: March 3, 2023
Description
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.
External Seller
Here you will find the endpoints involved in the integration between a VTEX marketplace and an external seller. Note that some of these requests are typically sent by the seller while others are received.
| Request | From | To |
|---|---|---|
| Fulfillment simulation | Marketplace | Seller |
| Order placement | Marketplace | Seller |
| Authorize fulfillment | Marketplace | Seller |
| Marketplace order cancellation | Marketplace | Seller |
| Send invoice | Seller | Marketplace |
| Send tracking information | Seller | Marketplace |
| Update tracking status | Seller | Marketplace |
| Cancel order in marketplace | Seller | Marketplace |
For a detailed explanation of the steps required to develop a custom connector to sell products from an external seller in your storefront, check out our complete External Seller Integration Guide.
External Marketplace
In this section, you will find the endpoints involved in the VTEX integration between an external marketplace and a VTEX seller.
| Request | From | To |
|---|---|---|
| VTEX Mapper Registration | External marketplace | VTEX system |
| Send Category Mapping to VTEX Mapper | External marketplace | VTEX system |
| Authorize fulfillment | Marketplace | Seller |
| Place fulfillment order | External marketplace | VTEX Seller |
| Authorize dispatch for fulfillment order | External marketplace | VTEX Seller |
For a detailed explanation of the steps required to develop a custom connector to become an external marketplace for VTEX sellers, check out our complete External Marketplace Integration Guide.