Get SKU suggestion by ID
This endpoint retrieves the data of a specific SKU sent by the seller, to the marketplace. Marketplaces or external matchers can call this endpoint when they want to check the information about a single SKU.
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 | Send marketplace suggestion |
| Channels | UI resources | Save suggestion rules |
| Suggestion | Suggestion resources | Main |
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
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.
A string that identifies the SKU in the marketplace. This is the ID that the marketplace will use for future references to this SKU, such as price and inventory notifications.
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