Suggestions
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.
Manage Suggestions
Send or delete SKU suggestions from the seller to marketplace.
DELETE Delete SKU Suggestion
Get Versions
Search and filter all versions of suggestions, using specific criteria.
GET Get all versions
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.
Endpoints
Get suggestions
| Summary | Method | Path |
|---|---|---|
| Get all SKU suggestions | GET | /suggestions |
| Get SKU suggestion by ID | GET | /suggestions/{sellerId}/{sellerSkuId} |
Manage suggestions
| Summary | Method | Path |
|---|---|---|
| Send SKU suggestion | PUT | /suggestions/{sellerId}/{sellerSkuId} |
| Delete SKU suggestion | DELETE | /suggestions/{sellerId}/{sellerSkuId} |
Get versions
| Summary | Method | Path |
|---|---|---|
| Get all versions | GET | /suggestions/{sellerId}/{sellerskuid}/versions |
| Get version by ID | GET | /suggestions/{sellerId}/{sellerskuid}/versions/{version} |
SKU approval settings
| Summary | Method | Path |
|---|---|---|
| Get autoApprove status in account settings | GET | /suggestions/configuration/autoapproval/toggle |
| Activate autoApprove in marketplace's account | PUT | /suggestions/configuration/autoapproval/toggle |
| Get account's approval settings | GET | /suggestions/configuration |
| Save account's approval settings | PUT | /suggestions/configuration |
| Get account's matcher settings | GET | /suggestions/configuration/account/config |
| Get seller's approval settings | GET | /suggestions/configuration/seller/{sellerId} |
| Save seller's approval settings | PUT | /suggestions/configuration/seller/{sellerId} |
| Activate autoApprove setting for a seller | PUT | /suggestions/configuration/autoapproval/toggle/seller/{sellerId} |
Match received SKUs
| Summary | Method | Path |
|---|---|---|
| Match received SKUs individually | PUT | /suggestions/{sellerId}/{sellerskuid}/versions/{version}/matches/{matchid} |
| Match multiple received SKUs | PUT | /suggestions/matches/action/{actionName} |
Multiple product specification mapping
| Summary | Method | Path |
|---|---|---|
| Map seller specifications to marketplace catalog | PUT | /suggestions/configuration/{sellerID}/specifications |