Seller Invite

Invite seller lead

Changed on Jul 31, 2024

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.

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

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:

Product	Category	Resource
Seller Register	Seller Administration	View Seller

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

Role	Resource
Seller manager	View 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.

post/seller-register/pvt/seller-leads

Request

Base URL
https://apiexamples.vtexcommercestable.com.br/api
URL
https://apiexamples.vtexcommercestable.com.br/api/seller-register/pvt/seller-leads
Auth
API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken

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.

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.

Request body

sellerEmailstring required

Seller's contact email.

sellerNamestring required

Seller's store's name.

sellerAccountNamestring required

Name of the seller's account, part of the url of their VTEX Admin.

salesChannelstring required

Sales channel (trade policy) associated to the seller account created.

emailstring required

The email address associated with the seller. It should be in a valid email format.

sellerTypeinteger required

Type of seller, which can be:

1: Regular seller

2: White label seller.

accountIdstring required

Marketplace's account ID.

documentstring required

Company's legal document number.

hasAcceptedLegalTermsboolean required

Indicates if the seller has accepted the platform's legal terms and conditions.

Example request

{
  "sellerEmail": "selleremail@email.com",
  "sellerName": "Seller Name",
  "sellerAccountName": "seller123",
  "salesChannel": "1",
  "email": "email@email.com",
  "sellerType": 1,
  "accountId": "5fb38ace-d95e-45ad-970d-ee97cce9fbcd",
  "document": "12345671000",
  "hasAcceptedLegalTerms": true,
  "address": {
    "postalcode": "12345678",
    "complement": "Appartment 1234",
    "street": "VTEX street",
    "number": "25",
    "neighborhood": "VTEX quarter",
    "state": "RJ",
    "city": "Rio de Janeiro"
  },
  "accountable": {
    "name": "Jane Smith",
    "email": "email@email.com",
    "phone": "1234567890"
  }
}

Response

sellerIdstring

ID of the created seller.

createdAtstring

Creation date of the seller.

updatedAtstring

Date of the last update of the seller.

Changes

Jul 31, 2024bf4c1957ca4a Revision changes
- info
  the request property default value 5fb38ace-d95e-45ad-970d-ee97cce9fbcd was removed
- info
  the request property default value Rio de Janeiro was removed
- info
  the request property default value Appartment 1234 was removed
- info
  the request property default value 12345671000 was removed
- info
  the request property default value email@email.com was removed
- info
  the request property default value true was removed
- info
  the request property default value Jane Smith was removed
- info
  the request property default value VTEX quarter was removed
- info
  the request property default value 25 was removed
- info
  the request property default value 1234567890 was removed
- info
  the request property default value 12345678 was removed
- info
  the request property default value 1 was removed
- info
  the request property default value seller123 was removed
- info
  the request property default value selleremail@email.com was removed
- info
  the request property default value Seller Name was removed
- info
  the request property default value 1 was removed
- info
  the request property default value RJ was removed
- info
  the request property default value VTEX street was removed
Jul 31, 2024bf4c1957ca4a Revision changes
- info
  the request property default value 5fb38ace-d95e-45ad-970d-ee97cce9fbcd was removed
- info
  the request property default value Rio de Janeiro was removed
- info
  the request property default value Appartment 1234 was removed
- info
  the request property default value 12345671000 was removed
- info
  the request property default value email@email.com was removed
- info
  the request property default value true was removed
- info
  the request property default value Jane Smith was removed
- info
  the request property default value VTEX quarter was removed
- info
  the request property default value 25 was removed
- info
  the request property default value 1234567890 was removed
- info
  the request property default value 12345678 was removed
- info
  the request property default value 1 was removed
- info
  the request property default value seller123 was removed
- info
  the request property default value selleremail@email.com was removed
- info
  the request property default value Seller Name was removed
- info
  the request property default value 1 was removed
- info
  the request property default value RJ was removed
- info
  the request property default value VTEX street was removed

Operation history (4 revisions)