v1
latestOpenAPI 3.1.02026-07-24173271.4 KBPath parameters
The unique identifier of the publishers site.
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 parameters
The barcode of the product to search, can be one of: UPC,EAN,GTIN,ISBN,ASIN.
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.
List of keywords to search in the product name, separated by space. For example: 'Dickies hat red' or 'iPhone X'.
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'.
Range of prices where the 'salePlace' of the returned products should belong. The range is defined in the form <min-price>-<max-price>, 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.
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.
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.
Sort results by EPC. If true the results will be sorted by EPC otherwise default sorting will be used.
Response
The product matching the given criteria.
Example response
[
{
"id": 2595306430,
"name": "Elizabeth Arden - '5Th Avenue' Eau De Parfum Spray",
"merchant": {
"id": 9262,
"name": "Debenhams",
"logo": "https://cdn.imgwzzmb.net/image/merchant/logo/cj/debenhams_88x31.png"
},
"deeplink": "https://redirect.viglink.com?u=CURCExYDFxwTQE9KB1RfQwNdABtUWFsbZjFQBlMBUVkGGAsRVFQ%3D&key=xxx&prodOvrd=PCR&opt=false&x=v1",
"image": "https://debenhams.scene7.com/is/image/Debenhams/123096900299?wid=800&hei=800&qlt=95",
"thumbnail": "https://debenhams.scene7.com/is/image/Debenhams/123096900299?wid=800&hei=800&qlt=95",
"currency": "GBP",
"salePrice": 30,
"retailPrice": 60,
"discountRate": 50,
"affiliatable": true,
"epc": 1.05
}
]