v1

latestOpenAPI 3.1.02026-07-24173271.4 KB

Get Product Recommendations

post/ai-orchestration/products

Query parameters

apiKeystring required

Your Sovrn Commerce API key. Found in the Sovrn Platform under Site Settings or via the Campaigns API.

marketstring

Market in the format currency_language (e.g., usd_en). Inferred from IP if not provided.

cuidstring

Custom tracking ID for associating recommendations with a specific user, session, or page.

priceRangestring

Price filter using "min-max" format, e.g., "20-50" or "*-25".

includeMerchantsstring

Comma separated list of merchant IDs to include. Only one of includeMerchants or excludeMerchants may be used.

excludeMerchantsstring

Comma separated list of merchant IDs to exclude. Only one of includeMerchants or excludeMerchants may be used.

numProductsinteger

Number of products to return. Default: 4, Max: 50.

pageUrlstring required

The URL or key of the content you want recommendations for. See the 'Caching' section above for more information.

Request body

titlestring

Short descriptive title for the content (optional).

contentstring required

The material you want to generate recommendations from. This can be full HTML from a page, plain text from an article, or even a short description of a product, user, or scenario.

Response

A list of recommended products.

idinteger

namestring

imageURLstring

thumbnailURLstring

currencystring

salePricenumber

retailPricenumber

discountRatenumber

inStockboolean

affiliatableboolean

deepLinkstring