Our Price Analytics API is a RESTful service based on JSON format (or others) that provides you with market price and product data on your portfolio items. In order to receive data on one or more offers for products your system asks the API with a specific identifier (GTIN, ASIN, id, term, PZN, URL) as well as specific data source (e.g. amazon, google, idealo, etc.) and country code (de, us, etc.). Our service visits the website of the data source specified in the request, searches for the product offers and extracts the relevant information. Once this process is done, your system can download the data and use it for further processing.
The following steps apply when data is requested from Price Analytics API:
1.|Create a job
2.|Poll the job (every few minutes) untill results are prepared
There are several endpoints to create a job, based on the search parameter.
A job summarizes your request to collect data for one or more product offers. Each job carries a job_id and can be specified by the following parameters:
Available sources and countries:
All start search endpoints returns the job structure including the job_id. This is used in the polling step.
If there is an error in the input parameters e.g. incorrect source, or country an error message is returned.
{
"error": false,
"job_id": "5fa2660127a87648da89d17f"
}
{
"error": true,
"message": "missing parameter"
}
ORList of possible errors:
No matter what start search endpoint was used there is only one endpoint “Poll results”.
A job_id received from start search is used as an input to this endpoint.
Response is a JSON object.
If the job is not finished yet, the “status” field of response is “working”. So poll the endpoint again after a few minutes.
If the job is finished, “status” field is “finished” and “results” field is an arrays of results for each value submitted. The “content” of each results includes the data about the product (title, description, rating, price summary, etc.) and offers of various sellers if available. The content varies somewhat based on the input source.
{
"error": false,
"job"_id": "620e4e2974a29136b08a2c0a",
"status": "working",
"done": 0,
"all": 1
}
{
"job_id": "620e4e2974a29136b08a2c0a",
"status": "finished",
"results": [
{
"updated_at": "2022-02-17T13:32:22.985Z",
"query": {
"max_age": 1200,
"max_pages": 1,
"value": "0194252099537",
"key": "gtin",
"country": "de",
"topic": "search_and_offers",
"source": "amazon"
},
"content": {
"availability": true,
"description_text": "",
"bullet_text": "Als Teil der Bemühungen von Apple, seine Umweltziele zu erreichen, kommt das iPhone 11 ohne Netzteil und EarPods. Verwende bitte ein vorhandenes Apple Netzteil und vorhandene Kopfhörer oder kaufe dieses Zubehör separat.\n6,1\" Liquid Retina HD LCD Display (15,5cm Diagonale)\nWasser und Staubschutz (2 Meter für bis zu 30 Minuten, IP68)\n12MP Zwei-Kamera-System mit Ultraweitwinkel und Weitwinkelobjektiv, Nachtmodus, Porträtmodus und 4K Video bis zu 60 fps\n12MP True Depth Frontkamera mit Porträtmodus, 4K Video und Zeitlupe\nFace ID für sicheres Authentifizieren und Apple Pay\nA13 Bionic Chip mit Neural Engine der 3.Generation\nSchnelles Aufladen\nKabelloses Laden\n",
"on_amazon_since": null,
"is_available": true,
"no_shops": 1,
"buybox_owner_id": "A3JWKAKR8XB7XF",
"buybox_owner": "Amazon",
"buybox_price": 619.99,
"shipping": 0,
"currency": "EUR",
"parent_asin": "B08L6ZD883",
"name": "Apple iPhone 11 (128 GB) - Weiß",
"bsr": [],
"seller_type": "amazon",
"review_count": 514,
"review_rating": 96,
"brand": {
"brand_id": null,
"name": "Besuchen Sie den Apple-Store"
},
"category": {
"rank": null,
"node_id": null,
"name": "Apple"
},
"url": "https://www.amazon.de/dp/B08L6ZD883",
"asin": "B08L6ZD883",
"offers": [
{
"shop_review_count": 0,
"shop_review_rating": 0,
"marketplace_name": "amazon",
"shop_type": "standalone-shop",
"shop_url": "https://www.amazon.de",
"shop_name": "Amazon",
"shop_id": "",
"condition": "Neu",
"position": 1,
"currency": "EUR",
"shipping": 0,
"price": 619.99
},
{
"shop_review_count": 0,
"shop_review_rating": 0,
"marketplace_name": "amazon",
"shop_type": "standalone-shop",
"shop_url": "https://www.amazon.de",
"shop_name": "Amazon Warehouse",
"shop_id": "",
"condition": "Gebraucht - Wie neu",
"position": 2,
"currency": "EUR",
"shipping": 0,
"price": 603.67
}
],
"offers_count": 2,
"price_min": 603.67,
"price_max": 619.99,
"price_avg": 611.83
},
"success": true
}
]
}
{
"error": true,
"message": "job id incorrect or missing"
}
ORList of possible errors:
List of possible product level errors: