Documentation
Feedback
Guides
API Reference

API Reference
Filter By
Post
Get
Put
Delete
Patch

Marketplace Protocol

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
New Order Integration External marketplace VTEX system
Update Order Status External marketplace VTEX system
Fulfillment simulation - External Marketplace External marketplace VTEX system
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.

Endpoints

External Seller

SummaryMethodPath
Fulfillment simulation - external sellerPOST/pvt/orderForms/simulation
Order placementPOST/pvt/orders
Authorize fulfillmentPOST/pvt/orders/{sellerOrderId}/fulfill
Marketplace order cancellationPOST/pvt/orders/{orderId}/cancel

Loading API specification...