API Reference

Price Comparisons

get
https://comparisons.sovrn.com/api/affiliate/v3.5/sites//compare/prices//by/accuracy
Path Params
string
required

The unique identifier of the publishers site.

string
required

The market where to perform the search. Read the market section for the list of supported markets. For example: 'usd_en' for the US market.

Query Params
string

The barcode of the product to search, can be one of: UPC,EAN,GTIN,ISBN,ASIN.

string

The link of the product web page in a merchant's site. Note: the link must be plain, if you provide a tracked link the service may not work.

string

List of keywords to search in the product name, separated by space. For example: 'Dickies hat red' or 'iPhone X'.

string

List of keywords to exclude from the search, separated by space. Any result matching any of the provided keywords will be stripped out from the results. For example: 'Dickies hat red' or 'iPhone 10'.

string

Range of prices where the 'salePlace' of the returned products should belong. The range is defined in the form -, for example 20-30 or 19.9-26.8. The star can be used to avoid to limit one side of the range, for example -20 equals to 0-20 and 20- will take all results with a sale price >= 20 Note: using *-* is the same as not defining any filter.

integer

Limits the number of results, for example if limit=3 the service will return up to 3 products. The products in the response will be those from the best performing merchants according to our merchant-ranking system.

string

Custom source ID to be used for tracking purposes. This will be the sovrn CUID. Can contain only letters, digits, and the following punctuation characters: '-','_','.','~'. Cannot be longer than 32 characters.

boolean

Sort results by EPC. If true the results will be sorted by EPC otherwise default sorting will be used.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*
Updated 3 months ago