Documentation

 

Response

Results

results: {
"http://fancy.com/things/784232188592784899" : { ... }
   ...
},

Valid URLs retrieved by API.

Failures


"failures": {
    "http://no.com": "We do not appear to support URLs from that domain",
    "bad.url": "Invalid url",
    "http://www.shop.com/unknown-path": "Unable to process the URL provided"
}

URLs which were not found in by the API. This is typically a result of a retailer not recognised in our database. It can also be caused by a typo in the domain of a known retailer or a url without the protocol prefixed.

Pending


pending_urls: [
  "http://fancy.com/things/784232188592784899",
   ...
],

URLs not yet found in our DB but from a supported retailers. These URLs have been added to a queue for indexing, after a short wait re-querying for them should return results.


Errors

Missing required key

"error": {
    "urls": "missing-required-key"
}

Number of urls provided must be between 1 and 100

"error": {
    "urls": ", is not up-to-100-comma-separated-urls"
}

The urls field must be a commas separated list of between 1 and 100 urls.


Error parsing urls param

"error": {
    "urls": ", is not up-to-100-comma-separated-urls"
}

Dissallowed keys

"error": {
    "keywords": "disallowed-key",	
    "sr": "disallowed-key",
    "qid": "disallowed-key"
}

Commonly this error arises from urls with any '&' characters present in the url. Input URLs should be encoded before submitting