Get matched offers' data by product ID
Offers are seller products and SKUs that were sent to the marketplace, and already have their price and inventory level configured.
This endpoint retrieves the available offers for a speciic Product ID in the marketplace's catalog. It differs from the Get Suggestions endpoints, since it retrieves products that were already matched by the marketplace operator, and are currently active in its catalog.
The call returns a list of offers for that ID, that contain the following data:
-
Seller that sells the SKU
-
Correspondent SKU ID
-
SKU's price value
-
Inventory level
-
Sales channel (or trade policy) that it is available at.
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.
A string that identifies the seller's product. This is the ID that the marketplace will use for all references to this product, such as price and inventory notifications.
Headers
Type of the content being sent.
HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
Response
OK