Get matched offers list
Offers are seller's products and SKUs that were sent to the marketplace, and already have their price and inventory level configured.
This endpoint retrieves the available offers in a marketplace. It differs from the Get Suggestions endpoints, since it retrieves products that were already matched by the marketplace, and are currently in its catalog.
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
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
Number of rows included in the response. Each row corresponds to a single offer. The default amount of rows in the response is 1, and the maximum amount is 50. To have more than one offer listed in the response, please add the rows parameter with a number greater than 1.
Number corresponding to the row from which the offer list will begin, used for pagination. Filters the list of offers by retrieving the offers starting from the row defined. The default value is 0, if the param is not included in the call.
This filter query can be used to filter offers by the criteria described below. It should be filled in by following the format: fq={{criteriaName}}:{{criteriaValue}}.
-
productId: integer of the product ID
-
productName: string of the product's name
-
skuId: integer of the SKU ID
-
eanId: string of the EAN ID
-
refId: string of the Ref ID
-
categoryId: integer of the category ID
-
brandId: integer of the brand ID
-
sellerId: string of the seller ID
-
sc: integer of the sales channel's ID (trade policy in VTEX)
Ex: skuId:172
Ex: categoryId:13
Ex. productName:Product example-123
Headers
Type of the content being sent.
HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
Response
OK