VTEX

Marketplace API

The Marketplace API enables marketplaces and sellers hosted on VTEX to perform their collaborative operations. >⚠️ The marketplace must [create an appKey and…

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Marketplace API enables marketplaces and sellers hosted on VTEX to perform their collaborative operations.

>⚠️ The marketplace must create an appKey and appToken for each non-VTEX seller that will use this API.

Index

Notification

Endpoints used by sellers to notify marketplaces that the price or inventory language has changed for one of their SKUs.

POST Notify marketplace of price update

POST Notify marketplace of inventory update

Suggestions

Get Suggestions

Search and filter all suggestions using specific criteria.

GET Get all SKU Suggestions

GET Get SKU Suggestion by ID

Manage Suggestions

Send or delete SKU suggestions from the seller to marketplace.

PUT Send SKU Suggestion

DELETE Delete SKU Suggestion

Get Versions

Search and filter all versions of suggestions, using specific criteria.

GET Get all versions

GET Get version by ID

Match Received SKUs

Match SKU suggestions received in the marketplace.

PUT Match Received SKUs individually

PUT Match Multiple Received SKUs

SKU Approval Settings

Allows marketplaces to configure rules for automatically and manually approving SKUs received from sellers.

GETGet autoApprove Status in Account Settings

PUTActivate autoApprove in Marketplace's Account

GETGet Account's Approval Settings

PUTSave Account's Approval Settings

GETGet Seller's Approval Settings

PUTSave Seller's Approval Settings

PUTActivate autoApprove Setting for a Seller

Matched Offers

Offers are seller products and SKUs that were sent to the marketplace, and already have their price and inventory level configured.

GETGet Matched Offers List

GETGet Matched Offer's Data by SKU ID

GETGet Matched Offer's Data by Product ID

Endpoints 23

Sellers

  • GETList Sellers/seller-register/pvt/sellers?accountName=apiexamples&environment=vtexcommercestable&from=0&to=100&keyword=keyword&integration=vtex-seller&group =Group&isActive=false&isBetterScope=false&isVtex=false&sc=1&sellerType=1&sort=id:ascThis endpoint lists all Sellers. This call's results can be filtered by trade policies through the sc query param.
  • POSTConfigure Seller Account/seller-register/pvt/sellers?accountName=apiexamples&environment=vtexcommercestableThis endpoint is used by marketplace operators to configure the accounts of sellers that have already accepted the invitation to join their marketplaces. For…
  • GETGet Seller data by ID/seller-register/pvt/sellers/:sellerId?accountName=apiexamples&environment=vtexcommercestable&sc=1Marketplace operator may call this endpoint to retrieve information about a specific seller by filtering by ID. It is also possible to filter results by sales…
  • PATCHUpdate Seller by Seller ID/seller-register/pvt/sellers/:sellerId?accountName=apiexamples&environment=vtexcommercestableThis endpoint allows marketplace operators to update the information of sellers connected to their account. You can replace a path's value with another value…

Seller Invite

  • GETList Seller Leads/seller-register/pvt/seller-leads?accountName=apiexamples&environment=vtexcommercestable&offset=0&limit=15&isConnected=&search=user email&status=invited&orderBy=stringThis call's response includes a list of all sellers invited by the marketplace operator to join them. Retrieved results can be filtered by adding optional…
  • POSTInvite Seller Lead/seller-register/pvt/seller-leads?accountName=apiexample&environment=vtexcommercestableThis API is used by marketplace operators to invite sellers to join their marketplace. The request sends an email to the seller, inviting sellers to activate…
  • GETGet Seller Lead's Data by Id/seller-register/pvt/seller-leads/:sellerLeadId?accountName=apiexamples&environment=vtexcommercestableMarketplace operators may call this endpoint to retrieve information about a specific seller invited to the Seller Portal, by searching through their Seller…
  • PUTAccept Seller Lead/seller-register/pvt/seller-leads/:sellerLeadId?accountName=apiexamples&environment=vtexcommercestableThis endpoint is triggered by the seller onboarding wizard, once the seller confirms their invitation. It can be used by marketplace operators to manually…
  • DELETEDelete Seller Lead/seller-register/pvt/seller-leads/:sellerLeadId?accountName=apiexamples&environment=vtexcommercestableThis endpoint permanently deletes a seller previously invited to the marketplace, if the seller has not already accepted the invitation.
  • PUTCreate Seller From Lead/seller-register/pvt/seller-leads/:sellerLeadId/seller?accountName=apiexamples&environment=vtexcommercestable&isActive=falseThis endpoint is used by marketplace operators to create seller accounts. The request will only accept Seller Leads whose status is accepted. If they are…
  • PUTResend Seller Lead Invite/seller-register/pvt/seller-leads/:sellerLeadId/status?accountName=apiexamples&environment=vtexcommercestableThis endpoint allows marketplace operators to resend an invitation to a seller lead, previously invited to join their marketplace. The request will only…

Seller Commissions

  • GETList Seller Commissions by seller ID/seller-register/pvt/sellers/:sellerId/commissions?accountName=apiexamples&environment=vtexcommercestableThis endpoint retrieves all comissions configured for a specific seller.
  • PUTUpsert Seller Commissions in Bulk/seller-register/pvt/sellers/:sellerId/commissions/categories?accountName=apiexamples&environment=vtexcommercestableThis endpoint is used by marketplace operators to define comissions for multiple categories.
  • GETGet Seller Commissions by Category ID/seller-register/pvt/sellers/:sellerId/commissions/:categoryId?accountName=apiexamples&environment=vtexcommercestableThis endpoint retrieves seller comissions applied to the selected category.
  • PUTUpsert Seller Commissions by Category ID/seller-register/pvt/sellers/:sellerId/commissions/:categoryId?accountName=apiexamples&environment=vtexcommercestableThis endpoint is used by marketplace operators to define comissions for a single category, by ID.
  • DELETERemove Seller Commissions by Category ID/seller-register/pvt/sellers/:sellerId/commissions/:categoryId?accountName=apiexamples&environment=vtexcommercestableThis endpoint removes a seller comission on the selected category.

Notification

  • POSTNotify marketplace of inventory update/notificator/:sellerId/changenotification/:skuId/inventory?accountName=apiexamples&environment=vtexcommercestableThis endpoint is used by *sellers* to notify marketplaces that the inventory level has changed for one of their SKUs. There is no request body in this call,…
  • POSTNotify marketplace of price update/notificator/:sellerId/changenotification/:skuId/price?accountName=apiexamples&environment=vtexcommercestableThis endpoint is used by *sellers* to notify marketplaces that the price has changed for one of their SKUs. There is no request body in this call, indicating…

Matched Offers

  • GETGet Matched Offers List/offer-manager/pvt/offers?sort=availability,desc&rows=20&start=21&fq=skuId:172&accountName=apiexamples&environment=vtexcommercestableOffers are seller's products and SKUs that were sent to the marketplace, and already have their price and inventory level configured. This endpoint retrieves…
  • GETGet Matched Offer's Data by Product ID/offer-manager/pvt/product/:productId?accountName=apiexamples&environment=vtexcommercestableOffers are seller products and SKUs that were sent to the marketplace, and already have their price and inventory level configured. This endpoint retrieves…
  • GETGet Matched Offer's Data by SKU ID/offer-manager/pvt/product/:productId/sku/:skuId?accountName=apiexamples&environment=vtexcommercestableOffers are seller products and SKUs that were sent to the marketplace, and already have their price and inventory level configured. This endpoint retrieves…

Sales Channel Mapping

  • GETGet Sales Channel Mapping Data/seller-register/pvt/sellers/:sellerId/sales-channel/mapping?accountName=apiexamples&environment=vtexcommercestable&an=apiexamplesRetrieves information about the mapping between marketplace's sales channels and a specific seller.
  • PUTUpsert Sales Channel Mapping/seller-register/pvt/sellers/:sellerId/sales-channel/mapping?accountName=apiexamples&environment=vtexcommercestable&an=apiexamplesThis endpoint allows the marketplace to map its sales channels with a seller's affiliate. The seller can have multiple sales channels associated with the same…

API details

Base URL
https://vtex.local
https://{accountName}.{environment}.com.br/api
Authentication
An API key in the X-VTEX-API-AppKey header
An API key in the X-VTEX-API-AppToken header
Operations
23 operations on 15 pathsGET 10PUT 6POST 4DELETE 2PATCH 1
Main resources
Seller Invite 7Seller Commissions 5Sellers 4Matched Offers 3Notification 2Sales Channel Mapping 2
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Marketplace API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Marketplace API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-VTEX-API-AppKey header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List Sellers” (GET /seller-register/pvt/sellers?accountName=apiexamples&environment=vtexcommercestable&from=0&to=100&keyword=keyword&integration=vtex-seller&group =Group&isActive=false&isBetterScope=false&isVtex=false&sc=1&sellerType=1&sort=id:asc), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Marketplace API?

The Marketplace API enables marketplaces and sellers hosted on VTEX to perform their collaborative operations. >⚠️ The marketplace must [create an appKey and… It is listed under Other and has 23 endpoints.

Who publishes the Marketplace API?

It is listed from VTEX's public API description (an OpenAPI document), not published by VTEX on Swastik Codes. Anyone who controls vtex.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Marketplace API?

Its description lists 2 base URLs: https://vtex.local, https://{accountName}.{environment}.com.br/api. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Marketplace API?

It accepts 2 methods: an API key in the X-VTEX-API-AppKey header; an API key in the X-VTEX-API-AppToken header.

How many endpoints does the Marketplace API have?

23 operations on 15 paths (10 GET, 6 PUT, 4 POST, 2 DELETE, 1 PATCH). The largest groups are Seller Invite, Seller Commissions, Sellers, Matched Offers.

Is forking the Marketplace API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.