Sign in

v50

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

List seller leads

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:

  • id

  • createdAt

  • status

  • isConnected

  • sellerEmail

  • sellerName

  • salesChannel

  • email

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 AdministrationView Seller

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

RoleResource
Seller managerView 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.

get/seller-register/pvt/seller-leads

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.

Query parameters

offsetinteger required

This field determines the limit used to retrieve the list of sellers. The response includes objects starting from the value inputted here.

limitinteger required

This field determines the limit used to retrieve the list of sellers. The response includes objects until the value inputted here.

isConnectedstring required

Query param that enables results to be filter by whether the seller lead is already connected to the marketplace or not.

searchstring required

Custom search field, that filters sellers invited by specific marketplace operator's email.

statusstring required

Seller Lead's status. Includes accepted, connected or invited.

orderBystring required

Query param determining how data will be ordered in the response, ordering by name or ID in descending our ascending order. Includes the following values:

namesort = desc/asc

idsort = desc/asc

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