The Products API is a REST API that allows you to import your product data into Fresh Relevance for use in product recommendations and other SmartBlocks.

In order to call the API you must have:

Your Account ID

To find this, in Fresh Relevance, expand the User menu and copy the Account ID value. *
An API token

You must have an API token key for the type API Key with sufficient area access to meet your needs.

Learn more about creating and editing API access tokens.

Endpoints

The API is available at a region specific API endpoint, for example, https:/r1-api-freshrelevance.dotdigital.com/api.

OAS / Swagger

Download OAS / Swagger specification

Authorization

Calls to the API are authorized by ensuring that a HTTP Header of x-api-key is included with the value of your API token.

Scoping

To ensure we scope the calls to the correct account/website you must pass your Account/Website ID in the path of each call to the API in the website_id parameter.

Security

The API is served only by HTTPS using TLS 1.2 or higher for security.