Skip to main content
GET
Get product recommendations

Authorizations

X-Api-Key
string
header
required

Company Level Authentication

Include your API key in the X-Api-Key header for every request:

Headers

snappy-account-id
string

Optional account identifier for swag validation/filtering.

Example:

"acc123456"

snappy-company-id
string

Optional company identifier for swag validation/filtering.

Example:

"cmp123456"

Path Parameters

productId
string
required

Stable identifier of the source product.

Pattern: ^[A-Za-z0-9]{8,}$
Example:

"655277e68e0719000d6c3fd5"

Query Parameters

location
string
required

ISO 3166-1 alpha-2 country code used to scope pricing and availability.

Pattern: ^[A-Z]{2}$
Example:

"US"

filter[price][gte]
number | null

Inclusive minimum price. Must be sent together with filter[price][lte].

Required range: x >= 0
Example:

10

filter[price][lte]
number | null

Inclusive maximum price. Must be sent together with filter[price][gte].

Required range: x >= 0
Example:

50

collectionId
string

Restrict recommendations to products belonging to the given collection.

Example:

"6527bb3567f414000c15d2c7"

page[limit]
integer | null
default:10

Maximum number of recommendations to return.

Required range: 0 <= x <= 20
Example:

10

include
enum<string>[]

Comma-separated related entities to expand in each recommended product.

Related entities to include.

Available options:
brand,
tags
Example:

Response

Recommended products.

Product recommendations response.

data
object[]
required

Recommended products, ordered by relevance. Empty when no qualifying recommendations are found.

Last modified on June 26, 2026