Get seller data by ID
Marketplace operators may call this endpoint to retrieve information about a specific seller by filtering by ID. It is also possible to filter results by sales channel (trade policy) through the sc query param.
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.
Request
- Base URLhttps://apiexamples.vtexcommercestable.com.br/api
- URLhttps://apiexamples.vtexcommercestable.com.br/api/seller-register/pvt/sellers/{sellerId}
- AuthAPI key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
Path parameters
Name of the VTEX account that belongs to the marketplace. The notification will be posted into this account.
Environment to use. Used as part of the URL.
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
Sales channel (or trade policy) associated to the seller account created.
Headers
HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
Type of the content being sent.
Response
OK
Changes
No recorded changes to this operation across all 52 revisions of this API.