The VTEX Marketplace API manages the relationships and operations between VTEX marketplaces and their sellers. It supports seller onboarding, offer management, seller portal access, and the coordination of catalog and order flows between marketplace operators and their sellers.
openapi: 3.0.0
info:
title: VTex Marketplace API
description: "The **Marketplace API** enables marketplaces and sellers hosted on VTEX to perform their collaborative operations. \r\n\r\n>⚠️ The marketplace must [create an appKey and appToken](https://developers.vtex.com/docs/guides/getting-started-authentication) for each non-VTEX seller that will use this API.\r\n\r\n## Index\r\n\r\n### Notification\r\n\r\nEndpoints used by sellers to notify marketplaces that the price or inventory language has changed for one of their SKUs.\r\n\r\n`POST` [Notify marketplace of price update](https://developers.vtex.com/docs/api-reference/marketplace-apis#post-/notificator/-sellerId-/changenotification/-skuId-/price)\r\n\r\n`POST` [Notify marketplace of inventory update](https://developers.vtex.com/docs/api-reference/marketplace-apis#post-/notificator/-sellerId-/changenotification/-skuId-/inventory)\r\n\r\n\r\n### Suggestions\r\n\r\n#### Get Suggestions\r\n\r\nSearch and filter all suggestions using specific criteria.\r\n\r\n`GET` [Get all SKU Suggestions](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions)\r\n\r\n`GET` [Get SKU Suggestion by ID](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/-sellerId-/-sellerSkuId-)\r\n\r\n\r\n#### Manage Suggestions\r\n\r\nSend or delete SKU suggestions from the seller to marketplace.\r\n\r\n`PUT` [Send SKU Suggestion](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/-sellerId-/-sellerSkuId-)\r\n\r\n`DELETE` [Delete SKU Suggestion](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#delete-/suggestions/-sellerId-/-sellerSkuId-)\r\n\r\n\r\n#### Get Versions\r\n\r\nSearch and filter all versions of suggestions, using specific criteria.\r\n\r\n`GET` [Get all versions](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/-sellerId-/-sellerskuid-/versions)\r\n\r\n`GET` [Get version by ID](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/-sellerId-/-sellerskuid-/versions/-version-)\r\n\r\n\r\n#### Match Received SKUs\r\n\r\nMatch SKU suggestions received in the marketplace.\r\n\r\n`PUT` [Match Received SKUs individually](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/-sellerId-/-sellerskuid-/versions/-version-/matches/-matchid-)\r\n\r\n`PUT` [Match Multiple Received SKUs](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/matches/action/-actionName-)\r\n\r\n\r\n#### SKU Approval Settings\r\n\r\nAllows marketplaces to configure rules for automatically and manually approving SKUs received from sellers.\r\n\r\n`GET`[Get autoApprove Status in Account Settings](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/configuration/autoapproval/toggle) \r\n\r\n`PUT`[Activate autoApprove in Marketplace's Account](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/configuration/autoapproval/toggle) \r\n\r\n`GET`[Get Account's Approval Settings](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/configuration)\r\n\r\n`PUT`[Save Account's Approval Settings](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/configuration)\r\n\r\n`GET`[Get Seller's Approval Settings](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/configuration/seller/-sellerId-)\r\n\r\n`PUT`[Save Seller's Approval Settings](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/configuration/seller/-sellerId-)\r\n\r\n`PUT`[Activate autoApprove Setting for a Seller](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/configuration/autoapproval/toggle/seller/-sellerId-) \r\n\r\n\r\n### Matched Offers\r\n\r\nOffers are seller products and SKUs that were sent to the marketplace, and already have
their price and inventory level configured.\r\n\r\n`GET`[Get Matched Offers List](https://developers.vtex.com/docs/api-reference/marketplace-apis#get-/offer-manager/pvt/offers)\r\n\r\n`GET`[Get Matched Offer's Data by SKU ID](https://developers.vtex.com/docs/api-reference/marketplace-apis#get-/offer-manager/pvt/product/-productId-/sku/-skuId-) \r\n\r\n`GET`[Get Matched Offer's Data by Product ID](https://developers.vtex.com/docs/api-reference/marketplace-apis#get-/offer-manager/pvt/product/-productId-)\r\n"
version: '1.0'
servers:
- url: https://{accountName}.{environment}.com.br/api
description: VTEX Server URL.
variables:
accountName:
description: Name of the VTEX account. Used as part of the URL.
default: apiexamples
environment:
description: Environment to use. Used as part of the URL.
enum:
- vtexcommercestable
default: vtexcommercestable
paths:
/notificator/{sellerId}/changenotification/{skuId}/price:
post:
tags:
- Notification
summary: VTex Notify marketplace of price update
description: "This endpoint is used by *sellers* to notify marketplaces that the price has changed for one of their SKUs. \n\nThere is no request body in this call, indicating the new price value, for instance. It only notifies a specific marketplace (`accountName`) that a seller (`sellerId`) has changed the price of an SKU (`skuId`). \n\n*Marketplaces* will then call the [fulfillment endpoint](https://developers.vtex.com/vtex-rest-api/reference/fulfillment-simulation) provided in the seller registration form to get the updated price information.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
operationId: PriceNotification
parameters:
- $ref: '#/components/parameters/accept'
- $ref: '#/components/parameters/accountName'
- $ref: '#/components/parameters/contentType'
- $ref: '#/components/parameters/environment'
- $ref: '#/components/parameters/sellerId'
- $ref: '#/components/parameters/skuId'
responses:
'202':
description: Accepted
deprecated: false
/notificator/{sellerId}/changenotification/{skuId}/inventory:
post:
tags:
- Notification
summary: VTex Notify marketplace of inventory update
description: "This endpoint is used by *sellers* to notify marketplaces that the inventory level has changed for one of their SKUs. \n\nThere is no request body in this call, indicating the new inventory level, for instance. It only notifies a specific marketplace (`accountName`) that a seller (`sellerId`) has changed the inventory level of an SKU (`skuId`). \n\n*Marketplaces* will then call the [fulfillment endpoint](https://developers.vtex.com/vtex-rest-api/reference/fulfillment-simulation) provided in the seller registration form to get the updated inventory information.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
operationId: InventoryNotification
parameters:
- $ref: '#/components/parameters/accountName'
- $ref: '#/components/parameters/environment'
- $ref: '#/components/parameters/accept'
- $ref: '#/components/parameters/contentType'
- $ref: '#/components/parameters/sellerId'
- $ref: '#/components/parameters/skuId'
responses:
'202':
description: Accepted
deprecated: false
/offer-manager/pvt/offers:
get:
tags:
- Matched Offers
summary: VTex Get Matched Offers List
description: "Offers are seller's products and SKUs that were sent to the marketplace, and already have their price and inventory level configured. \n\n This endpoint retrieves the available offers in a marketplace. It differs from the Get Suggestions endpoints, since it retrieves products that were already matched by the marketplace, and are currently in its catalog. \n\nIt is possible to filter the search through the following parameters: \n\n- rows \n- sort \n\n- start \n\n- fq\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
operationId: Getofferslist
parameters:
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/rows'
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/fq'
- $ref: '#/components/parameters/accountName'
- $ref: '#/components/parameters/contentType'
- $ref: '#/components/parameters/environment'
- $ref: '#/components/parameters/accept'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/responseGetMatchedOffersList'
example:
- LastModified: '2021-05-06T21:37:24.262529'
ProductId: '941947'
CategoryId: 1563
BrandId: 2004291
ProductName: Produto Teste 04 - Preto - 40
Skus:
- SkuId: '1070268'
EanId:
RefId:
NameComplete: Produto Teste 04 - Preto - 40 Cor:Preto
Name: Cor:Preto
IsActive: true
MainImage:
ImageId: '53878805'
ImageLabel:
ImageTag: <img src="~/arquivos/ids/53878805-#width#-#height#/image-8b4364782e664d76a6ebc8702008e478.jpg" width="#width#" height="#height#" alt="image-8b4364782e664d76a6ebc8702008e478" id="" />
ImagePath: ~/arquivos/ids/53878805-#width#-#height#/image-8b4364782e664d76a6ebc8702008e478.jpg
IsMain: true
IsZoomSize: true
ImageText: image-8b4364782e664d76a6ebc8702008e478
LastModified: '2021-04-06T03:01:30.747'
Offers:
- SellerId: '1'
SellerSkuId: '1070268'
OffersPerSalesChannel:
- SaleChannel: 1
Price: 0
ListPrice: 0
PriceWithoutDiscount: 0
AvailableQuantity: 0
AvailableSalesChannels:
- SellerId: madesacms
SellerSkuId: '3298'
OffersPerSalesChannel:
- SaleChannel: 0
Price: 1200
ListPrice: 1200
PriceWithoutDiscount: 1200
AvailableQuantity: 10000000
AvailableSalesChannels:
deprecated: false
/offer-manager/pvt/product/{productId}/sku/{skuId}:
get:
tags:
- Matched Offers
summary: VTex Get Matched Offer's Data by SKU ID
description: |-
Offers are seller products and SKUs that were sent to the marketplace, and already have their price and inventory level configured.
This endpoint retrieves the available offers for a speciic SKU ID in the marketplace's catalog. It differs from the Get Suggestions endpoints, since it retrieves products that were already matched by the marketplace operator, and are currently active in its catalog.
The call returns a list of offers for that ID, that contain the following data:
- Seller that sells the SKU
- Correspondent SKU ID
- SKU's price value
- Inventory level
- Sales channel (or [trade policy](https://help.vtex.com/en/tutorial/como-funciona-uma-politica-comercial--6Xef8PZiFm40kg2STrMkMV#master-data)) that it is available at.
operationId: GetSKUoffers
parameters:
- $ref: '#/components/parameters/accountName'
- $ref: '#/components/parameters/environment'
- $ref: '#/components/parameters/contentType'
- $ref: '#/components/parameters/accept'
- $ref: '#/components/parameters/productId'
- $ref: '#/components/parameters/skuId'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/responseGetMatchedOffersDataBySKU'
example:
- productId: '1561208'
skuId: '1559161'
nameComplete: Blusa Cardigan Manga Longa Vestem - Feminina - CINZA G
mainImage:
imagePath: ~/arquivos/ids/8567753-#width#-#height#/image-05b40d3167b5b7ed42285124f6862f12.jpg
sellersOffers:
- sellerId: '1'
sellerSkuId: '1559161'
salesChannelOffer:
- salesChannelId: '1'
salesChannelName: Principal
price: 49.99
listPrice: 59.99
priceWithoutDiscount: 49.99
availableQuantity: 8
- salesChannelId: '2'
salesChannelName: Online Store
price: 47.99
listPrice: 59.99
priceWithoutDiscount: 47.99
availableQuantity: 12
deprecated: false
/offer-manager/pvt/product/{productId}:
get:
tags:
- Matched Offers
summary: VTex Get Matched Offer's Data by Product ID
description: "Offers are seller products and SKUs that were sent to the marketplace, and already have their price and inventory level configured. \n\nThis endpoint retrieves the available offers for a speciic Product ID in the marketplace's catalog. It differs from the Get Suggestions endpoints, since it retrieves products that were already matched by the marketplace operator, and are currently active in its catalog. \n\nThe call returns a list of offers for that ID, that contain the following data: \n\n- Seller that sells the SKU \n\n- Correspondent SKU ID \n\n- SKU's price value \n\n- Inventory level \n\n- Sales channel (or [trade policy](https://help.vtex.com/en/tutorial/como-funciona-uma-politica-comercial--6Xef8PZiFm40kg2STrMkMV#master-data)) that it is available at.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
operationId: GetProductoffers
parameters:
- $ref: '#/components/parameters/accountName'
- $ref: '#/components/parameters/environment'
- $ref: '#/components/parameters/contentType'
- $ref: '#/components/parameters/accept'
- $ref: '#/components/parameters/productId'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/responseGetMatchedOffersDataByProductId'
example:
- productId: '1561208'
skuId: '1559161'
nameComplete: Blusa Cardigan Manga Longa Vestem - Feminina - CINZA G
mainImage:
imagePath: ~/arquivos/ids/8567753-#width#-#height#/image-05b40d3167b5b7ed42285124f6862f12.jpg
sellersOffers:
- sellerId: '1'
sellerSkuId: '1559161'
salesChannelOffer:
salesChannelId: '1'
salesChannelName: Principal
price: 0
listPrice: 0
priceWithoutDiscount: 0
availableQuantity: 0
- productId: '1561208'
skuId: '1559163'
nameComplete: Blusa Cardigan Manga Longa Vestem - Feminina - CINZA PP
mainImage:
imagePath: ~/arquivos/ids/8567753-#width#-#height#/image-05b40d3167b5b7ed42285124f6862f12.jpg
sellersOffers:
- sellerId: '1'
sellerSkuId: '1559161'
salesChannelOffer:
salesChannelId: '1'
salesChannelName: Principal
price: 0
listPrice: 0
priceWithoutDiscount: 0
availableQuantity: 0
deprecated: false
/seller-register/pvt/seller-leads:
post:
tags:
- Seller Invite
summary: VTex Invite Seller Lead
description: "This 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 their store. The invitation's link in the email is unique per user, and available for only seven days for the seller to click and begin activating their store. \n\nThe email template is completely customizable. All email templates that VTEX sends to seller leads can be found and edited in the marketplace's VTEX Admin, on the Message Center section.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Seller Register | Seller Administration | **Save Seller** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Create new sellers and edit data from all sellers linked to Marketplace account from the sellers management page. | Save Seller |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)."
operationId: CreateSellerLead
parameters:
- $ref: '#/components/parameters/accountName'
- $ref: '#/components/parameters/environment'
- $ref: '#/components/parameters/accept'
- $ref: '#/components/parameters/contentType'
requestBody:
description: This request requires detailed information about the seller, including their email, name, account name, sales channel, and other related details. Data should be in JSON format and follow the schema specified in 'CreateSellerLeadRequest'. A sample valid payload is provided for reference, including details such as address, contact information, and acceptance of legal terms.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSellerLeadRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/responseCreateSellerLead'
example:
sellerId: '7890123456'
createdAt: '2023-01-01T12:34:56Z'
updatedAt: '2023-01-01T12:34:56Z'
deprecated: false
get:
tags:
- Seller Invite
summary: VTex List Seller Leads
operationId: ListSellerLeads
description: "This 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 query fields to the request. Each seller listed includes the following information: \n\n- `id` \n\n- `createdAt` \n\n- `status` \n\n- `isConnected` \n\n- `sellerEmail` \n\n- `sellerName` \n\n- `salesChannel` \n\n- `email`\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Seller Register | Seller Administration | **View Seller** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| View all sellers linked to the Marketplace account described on the sellers management page, including recovering seller data, either from the sellers listing, or a specific seller. | View Seller |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)."
parameters:
- $ref: '#/components/parameters/accountName'
- $ref: '#/components/parameters/environment'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/isConnected'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/status'
- $ref: '#/components/parameters/orderBy'
- $ref: '#/components/parameters/accept'
- $ref: '#/components/parameters/contentType'
responses:
'200':
description: OK
headers: {}
deprecated: false
/seller-register/pvt/seller-leads/{sellerLeadId}:
put:
tags:
- Seller Invite
summary: VTex Accept Seller Lead
operationId: AcceptSellerLead
description: |-
This endpoint is triggered by the seller onboarding wizard, once the seller confirms their invitation. It can be used by marketplace operators to manually accept seller leads, and carry on with their onboarding process.
Note that there's no specific API call that allows status changes. The operations only allow the seller lead to move forward:
From `invite` > to `Accept` > closing on `Create Seller`.
If you want to change the status, you can start the process again, by deleting that lead through the *Delete Seller Lead* endpoint, and resending the invite through the *Resend Seller Lead's Invite* endpoint.
parameters:
- $ref: '#/components/parameters/accountName'
- $ref: '#/components/parameters/environment'
- $ref: '#/components/parameters/sellerId'
- $ref: '#/components/parameters/contentType'
requestBody:
description: This request requires information about the seller who is accepting the lead, including their email, name, account name, sales channel, and other relevant details.
content:
application/json:
schema:
$ref: '#/components/schemas/AcceptSellerLeadRequest'
required: true
responses:
'200':
description: OK
headers: {}
deprecated: false
get:
tags:
- Seller Invite
summary: VTex Get Seller Lead's Data by Id
operationId: RetrieveSellerLead
description: |-
Marketplace operators may call this endpoint to retrieve information about a specific seller invited to the Seller Portal, by searching through their `Seller Lead Id`. To know the chosen seller's `sellerLeadId`, marketplace operators can count on the *List Sellers* endpoint's response as well. Each seller listed includes the following information:
- `id`
- `createdAt`
- `status`
- `isConnected`
- `sellerEmail`
- `sellerName`
- `salesChannel`
- `email`
parameters:
- $ref: '#/components/parameters/accountName'
- $ref: '#/components/parameters/environment'
- $ref: '#/components/parameters/sellerId'
- $ref: '#/components/parameters/accept'
- $ref: '#/components/parameters/contentType'
responses:
'200':
description: OK
headers: {}
deprecated: false
delete:
tags:
- Seller Invite
summary: VTex Delete Seller Lead
description: This endpoint permanently deletes a seller previously invited to the marketplace, if the seller has not already accepted the invitation.
operationId: RemoveSellerLead
parameters:
- $ref: '#/components/parameters/accountName'
- $ref: '#/components/parameters/environment'
- $ref: '#/components/parameters/sellerLeadId'
- $ref: '#/components/parameters/accept'
- $ref: '#/components/parameters/contentType'
responses:
'200':
description: OK
headers: {}
deprecated: false
/seller-register/pvt/seller-leads/{sellerLeadId}/seller:
put:
tags:
- Seller Invite
summary: VTex Create Seller From Lead
operationId: CreateSellerFromSellerLead
description: |-
This endpoint is used by marketplace operators to create seller accounts. The request will only accept Seller Leads whose status is `accepted`. If they are already `connected` or `invited`, the call will not be fulfilled.
The creation of the account at VTEX is done by an internal Billing service. There is no seller account and marketplace affiliation if you do not go through this step.
Note that there's no specific API call that allows status changes. The operations only allow the seller lead to move forward:
From `invite` > to `Accept` > closing on `Create Seller`.
If you want to change the status, you can start the process again, by deleting that lead through the *Delete Seller Lead* endpoint, and resending the invite through the *Resend Seller Lead's Invite* endpoint.
parameters:
- $ref: '#/components/parameters/accountName'
- $ref: '#/components/parameters/environment'
- $ref: '#/components/parameters/isActive'
- $ref: '#/components/parameters/sellerId'
- $ref: '#/components/parameters/accept'
- $ref: '#/components/parameters/contentType'
responses:
'200':
description: OK
headers: {}
deprecated: false
/seller-register/pvt/seller-leads/{sellerLeadId}/status:
put:
tags:
- Seller Invite
summary: VTex Resend Seller Lead Invite
description: This endpoint allows marketplace operators to resend an invitation to a seller lead, previously invited to join their marketplace. The request will only accept Seller Leads whose status is `invited`. If they are already `connected` or `accepted`, the call will not be fulfilled.
operationId: ResendSellerLeadRequest
parameters:
- $ref: '#/components/parameters/accountName'
- $ref: '#/components/parameters/environment'
- $ref: '#/components/parameters/sellerId'
- $ref: '#/components/parameters/accept'
- $ref: '#/components/parameters/contentType'
requestBody:
description: This request requires information specifying the action to be taken, such as the status to be resent.
content:
application/json:
schema:
$ref: '#/components/schemas/ResendSellerLeadRequestRequest'
required: true
responses:
'200':
description: OK
headers: {}
deprecated: false
/seller-register/pvt/sellers/{sellerId}/commissions:
get:
tags:
- Seller Commissions
summary: VTex List Seller Commissions by seller ID
description: "This endpoint retrieves all comissions configured for a specific seller. It is not necessary to send a request body.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** | **Role** |\r\n|---|---|---|---|\r\n| Seller Register | Seller adminstration | View Seller | View all sellers linked to the Marketplace account described on the sellers management page, including recovering seller data, either from the sellers listing, or a specific seller. |\r\n| Seller Register | Seller administration | Save Seller | Create new sellers and edit data from all sellers linked to Marketplace account f
# --- truncated at 32 KB (104 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vtex/refs/heads/main/openapi/vtex-marketplace-openapi-original.yml