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 will need these extra pieces of information:

• Website ID
  • To get your website ID from your Fresh Relevance account, expand the User menu and copy the Account ID e.g xx123yyy
  • 
• API Token
  • You will need an API token key for the type API Key with sufficient area access to meet your needs. You can find out more about creating and editing API access tokens here.

End points

The API is available at this end point: https://api.freshrelevance.com

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 as discussed above.

Scoping

To ensure we scope the calls to the correct account/website you will need to pass your 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.