Marketplace API 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.
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.
GET Get autoApprove Status in Account Settings
PUT Activate autoApprove in Marketplace's Account
GET Get Account's Approval Settings
PUT Save Account's Approval Settings
GET Get Seller's Approval Settings
PUT Save Seller's Approval Settings
PUT Activate 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.
GET Get Matched Offer's Data by SKU ID
GET Get Matched Offer's Data by Product ID
Seller Invite
Invite sellers to join their marketplace.
POST Invite Seller Lead
GET List Seller Lead
GET Get Seller Lead's Data by Id
DELETE Delete Seller Lead
Seller Commissions
Set commissions for different categories of sellers their marketplace.
PUT Upsert Seller Commissions in Bulk
GET List Seller Commissions by Seller ID
PUT Upsert Seller Commissions by Category ID
DELETE Remove Seller Commissions by Category ID
GET Get Seller Commissions by Category ID
Sellers
Configure the accounts of sellers who have already accepted the invitation to join their marketplace.
GET List Sellers
PATCH Update Seller by Seller ID
Sales Channel Mapping
Map your sales channels with a seller affiliate.