v50

latestOpenAPI 3.0.0raw.githubusercontent.com2025-08-282624202.6 KB
Seller Invite

Create seller from lead

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

Permissions

Any user or API key must have at least one of the appropriate License Manager resources 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:

ProductCategoryResource
Seller RegisterSeller AdministrationSave Seller

You can create a custom role with that resource or use one of the following predefined roles:

RoleResource
Seller managerSave Seller

❗ Assigning a predefined role to users or application keys usually grants permission to multiple License Manager resources. 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.

put/seller-register/pvt/seller-leads/{sellerLeadId}/seller

Path parameters

accountNamestring required
Example:apiexamples

Name of the VTEX account that belongs to the marketplace. The notification will be posted into this account.

environmentstring required

Environment to use. Used as part of the URL.

sellerIdstring required
Example:seller123

A string that identifies the seller in the marketplace. This ID must be created by the marketplace and informed to the seller before the integration is built.

Query parameters

isActiveboolean

Enables to filter sellers that are active (true) or unactive (false) in the marketplace.

Headers

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Content-Typestring required

Type of the content being sent.

Response

OK