List sellers
This endpoint lists all sellers. The results can be filtered by trade policies 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.
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.
Query parameters
The start number of pagination, being 0 the default value.
The end number of pagination, being 100 the default value.
Search sellers by a keyword in sellerId or sellerName.
Filters sellers by the name of who made the integration, if VTEX or an external hub. The possible values for VTEX integrations are: vtex-sellerportal, vtex-seller and vtex-franchise.
Groups are defined by keywords that group sellers into categories defined by the marketplace.
Enables to filter sellers that are active (true) or unactive (false) in the marketplace.
The flag isBetterScope is used by the VTEX Checkout to simulate shopping carts, products, and shipping only in sellers with the field set as true, avoiding performance issues. When used as a query param, isBetterScope filters sellers that have the flag set as true or false.
When set as true, the list returned will be of sellers who have a VTEX store configured. When set as false, the list will be of sellers who do not have a VTEX store configured.
Sales channel (or trade policy) associated to the seller account created.
Filters sellers by their type, which can be regular seller (1) or whitelabel seller (2).
Criteria used to sort the list of offers. For sorting values in ascending order, use asc, while for descending order, use desc. To fill in the field, insert the sorting criteria, followed by 'asc', or 'desc', separated by a comma. You can sort by the following criteria:
-
price: sorts offers by price. Ascending goes from lowest to highest price, while Descending goes from highest to lowest price.
-
name: sorts offers by productName, in alphabetical order. Ascending goes from A to Z, while Descending goes from Z to A.
-
availability: availability in the sales channel (sc). The default value is 1.
Ex. sort=availability,desc
Ex. sort=name,asc
Ex. price,desc
Headers
HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
Type of the content being sent.
Response
OK