API Reference

Integration Guides
External Seller
Store setup for VTEX Marketplace

For a VTEX store to act as a marketplace and sell products from external sellers, it has to do the following for each external seller:

This article explains what must be done to complete each of these configuration steps.

Register the seller in the marketplace Admin

An external seller can only integrate into a VTEX store if it is registered there. The responsibility for creating this seller registration lies with the marketplace.

You can call the Configure Seller Account to add the external seller through API.

The article Configuring a seller shows the path to create the seller in the Admin and explains the form fields.

The Fulfillment Endpoint field should be filled in with the endpoint that will be implemented for the seller to receive the Fulfillment Simulation requests from the marketplace. This implementation is explained in the next section of this guide.

{"base64":"  ","img":{"width":3733,"height":2150,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":204205,"url":""}}

The seller ID, created during this step, will be essential for the integration. Most of the API requests explained in the next section of this guide will use it to identify the seller.

Activate the seller for a trade policy

Trade policies are used in VTEX to group catalog, pricing, promotions, inventory, shipping, and payment settings for different sales channels. In a VTEX marketplace, each trade policy may apply to a different set of sellers. So, after creating a new seller, the marketplace needs to activate this seller for the trade policies that make sense for the business.

To do this, in the marketplace management panel's main menu, click on the option Trade Policies, then choose the trade policy you want to edit by clicking on the button Alter next to it. Next, select the sellers you want to activate. In the example of the image below, the trade policy "Marketplace" is only enabled for the seller "Store 1".

{"base64":"  ","img":{"width":1772,"height":735,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":41275,"url":""}}

Check out the Help Center documentation to get the complete explanation on how to enable the seller for a trade policy.

Set up API authentication credentials

Every private API request to the VTEX system requires authentication through a pair of appKey and appToken. So you will need to create these credentials before you can start building the integration.

Read the Authentication guide to learn how to create and use the appKey and appToken.

Once the authentication credentials are created, keep the appKey / appToken pair stored in a safe place until you can securely share it with the external seller.

Photo of the contributor
Photo of the contributor
Photo of the contributor
+ 3 contributors
Was this helpful?
Suggest edits (Github)
Marketplace / Seller architecture
« Previous
External seller processing payments
Next »
Photo of the contributor
Photo of the contributor
Photo of the contributor
+ 3 contributors
On this page