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.
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 |