Get all SKU suggestions
This endpoint retrieves a list of all SKUs sent by the seller for the marketplace's approval. Marketplace operators should use this endpoint whenever they want to check the full list of received SKUs and their information.
Note that all the information sent by the seller will be in the [content] object. All remaining information in this endpoint's response is given by the Matcher.
Matcher rates received SKUs by correlating the data sent by sellers, to existing fields in the marketplace. The calculation of these scores determines whether the product has been:
Approved: Score equal to or greater than 80 points.
Pending: From 31 to 79 points.
Denied: From 0 to 30 points.
Note that if the autoApprove setting is enabled, the SKUs will be approved, regardless of the Score.
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 |
|---|---|---|
| Channels | UI resources | Save suggestion rules |
| Suggestion | Suggestion resources | Main access |
There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint.
To learn more about machine authentication at VTEX, see Authentication overview.
❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.
Path parameters
Name of the VTEX account. Used as part of the URL
Query parameters
This field allows you to customize your search. You can fill in this query param if you want to narrow down your search using the available filters on Received SKU modules.
This field allows users to filter SKU suggestions, by searching only the new suggestions that were just sent, and suggestions that have already been sent, but were updated. Possible values for this field include new and update.
A string that identifies the seller in the marketplace. This ID must be created by the marketplace and informed to the seller so it can call this endpoint.
Narrow down you search, filtering by status. Values allowed on this field include: accepted, pending and denied.
This field allows you to filter SKUs that have mapping or not. Insert true to filter SKUs that have mapping, or false to retrieve SKUs that aren't mapped.
Identifies the matching entity. It can be either VTEX's matcher, or an external matcher developed by partners, for example. The matcherId's value can be obtained through the Get SKU Suggestion by ID endpoint.
Define your pagination range, by adding the pagination starting value. Values should be bigger than 0, with a maximum of 50 records per page.
Define your pagination range, by adding the pagination ending value. Values should be bigger than 0, with a maximum of 50 records per page.
Headers
Describes the type of the content being sent.
HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
Response
OK