Get featured collection products
Use this endpoint to retrieve the featured products of a collection for a budget range. Featured products are a Snappy-curated selection of the most popular items in the collection that fit the budget. We recommend displaying them at the top of your collection page, above the full product list from GET /v3/collections/{collectionId}/products.
Required parameters:
collectionIdpath parameter - the collection to retrieve featured products from.filter[price][gte]- inclusive minimum budget (0 or more).filter[price][lte]- inclusive maximum budget. Must be greater than or equal tofilter[price][gte].
Optional parameters:
location- ISO 3166-1 alpha-2 country code (defaultUS).include- related entities to include, comma-separated. One or more ofbrand,tags.fields- computed fields, comma-separated. One or more ofselectedOrFirstAvailableVariant,priceRange,variantsCount.seed- any string. The same seed returns the same selection for the same collection, budget, and location - for example, pass a recipient ID so each recipient sees a stable set of featured products.Snappy-Account-Idheader - optional account scoping.
Please note:
- The response is not paginated. All featured products are returned in a single
dataarray. - Each product has the same shape as in
GET /v3/collections/{collectionId}/products, plusselectedOrFirstAvailableVariantwhen requested throughfields. - Returns
400when the price range is missing or invalid (e.g.filter[price][gte]greater thanfilter[price][lte]). - Returns
404if the collection does not exist.
Permissions
- Requires:
products:read
Authorizations
Company Level Authentication
Include your API key in the X-Api-Key header for every request:
Headers
Must be provided to retrieve swag products.
1"acc123456"
Path Parameters
Collection identifier.
^[A-Za-z0-9]{8,}$"abcdef12"
Query Parameters
Inclusive minimum budget for featured products.
x >= 070
Inclusive maximum budget for featured products.
x >= 0100
ISO 3166-1 alpha-2 country code.
^[A-Z]{2}$"US"
Related entities to include.
Related entities to include.
brand, tags Computed or expanded product fields.
Computed or expanded fields for featured collection products.
selectedOrFirstAvailableVariant, priceRange, variantsCount Seed used to produce deterministic featured product selection.
"recipient-123"
Response
Featured products selected for the requested budget.
Featured products selected for the requested budget.