Marketplace API
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
Sellers
| Summary | Method | Path |
|---|---|---|
| Configure seller account | POST | /seller-register/pvt/sellers |
| List sellers | GET | /seller-register/pvt/sellers |
| Update seller by seller ID | PATCH | /seller-register/pvt/sellers/{sellerId} |
| Get seller data by ID | GET | /seller-register/pvt/sellers/{sellerId} |
Seller Invite
| Summary | Method | Path |
|---|---|---|
| Invite seller lead | POST | /seller-register/pvt/seller-leads |
| List seller leads | GET | /seller-register/pvt/seller-leads |
| Accept seller lead | PUT | /seller-register/pvt/seller-leads/{sellerLeadId} |
| Get seller lead's data by ID | GET | /seller-register/pvt/seller-leads/{sellerLeadId} |
| Delete seller lead | DELETE | /seller-register/pvt/seller-leads/{sellerLeadId} |
| Create seller from lead | PUT | /seller-register/pvt/seller-leads/{sellerLeadId}/seller |
| Resend seller lead invite | PUT | /seller-register/pvt/seller-leads/{sellerLeadId}/status |
Seller Commissions
| Summary | Method | Path |
|---|---|---|
| List seller commissions by seller ID | GET | /seller-register/pvt/sellers/{sellerId}/commissions |
| Upsert seller commissions in bulk | PUT | /seller-register/pvt/sellers/{sellerId}/commissions |
| Remove seller commissions by category ID | DELETE | /seller-register/pvt/sellers/{sellerId}/commissions/{categoryId} |
| Get seller commissions by category ID | GET | /seller-register/pvt/sellers/{sellerId}/commissions/{categoryId} |
Affiliates
| Summary | Method | Path |
|---|---|---|
| List affiliates | GET | /fulfillment/pvt/affiliates |
| Get affiliate by ID | GET | /fulfillment/pvt/affiliates/{affiliateId} |
| Update affiliate by ID | PUT | /fulfillment/pvt/affiliates/{affiliateId} |
| Delete affiliate by ID | DELETE | /fulfillment/pvt/affiliates/{affiliateId} |
Notification
| Summary | Method | Path |
|---|---|---|
| Notify marketplace of price update | POST | /notificator/{sellerId}/changenotification/{skuId}/price |
| Notify marketplace of inventory update | POST | /notificator/{sellerId}/changenotification/{skuId}/inventory |
Matched Offers
| Summary | Method | Path |
|---|---|---|
| Get matched offers list | GET | /offer-manager/pvt/offers |
| Get matched offers' data by SKU ID | GET | /offer-manager/pvt/product/{productId}/sku/{skuId} |
| Get matched offers' data by product ID | GET | /offer-manager/pvt/product/{productId} |
Sales Channel Mapping
| Summary | Method | Path |
|---|---|---|
| Upsert sales channel mapping | PUT | /seller-register/pvt/sellers/{sellerId}/sales-channel/mapping |
| Get sales channel mapping data | GET | /seller-register/pvt/sellers/{sellerId}/sales-channel/mapping |