Our Ebay data 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, id, term, URL) and country code (de, us, etc.). Our service visits ebay, 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 Ebay data 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 ebay 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": "620fa624d84dd161f61630ed",
"status": "working",
"done": 0,
"all": 2
}
{
"job_id": "620fa624d84dd161f61630ed",
"status": "finished",
"results": [{
"query": {
"max_age": 1200,
"max_pages": 1,
"value": "0194252099537",
"key": "gtin",
"topic": "search",
"country": "de",
"source": "ebay",
},
"updated_at": "2022-02-18T13:59:46.593Z",
"content": {
"offers": [{
"shipping": 0,
"currency": "EUR",
"price": 649.9,
"review_count": 1,
"review_rating": "N/A",
"name": "Apple iPhone 11 iOS Smartphone 64GB - 256GB LTE - 12MP Kamera - vom Händler",
"id": "185055288807",
"url": "https://www.ebay.de/itm/185055288807?epid=20044258427&hash=item2b16279de7%3Ag%3A44oAAOSwUjthuwx2&LH_BIN=1&LH_ItemCondition=3"
},
{
"shipping": 0,
"currency": "EUR",
"price": 807.6,
"review_count": "N/A",
"review_rating": "N/A",
"name": "Apple iPhone 11 4G smartphone dual-SIM 128 GB LCD display 6.1"
1792 x MHDJ3ZD / A ",
"id": "294802790777",
"url": "https://www.ebay.de/itm/294802790777?epid=4045155144&_trkparms=ispr%3D1&hash=item44a39d9979%3Ag%3AVd4AAOSwcTdiAmAd&amdata=enc%3AAQAGAAACoPYe5NmHp%252B2JMhMi7yxGiTJkPrKr5t53CooMSQt2orsS%252Fwocn770hnih0B3mVHNZ5FtUGO7RXwGe6mC4Gjno%252F2Mxeu2tCWCMx0ndZwNitx%252FuYS%252FXbBc2k4nC%252FI04hsWEvANLccwvCfdz%252F8iNcfSl239BBlORgc9diUpInGZKzXPFmfPz2ziEsJyNhBg4KKSj2vIEzzUA3QU0C%252BUDEeM0nDmxHK1wE5snVwCLrkxUegmwLOJYLDjkFupI1Aev10iTyYyBGL%252F%252BxzpVw0C97IuicjKgfd%252B1de3YS6a2VIE4lCCIPmDxI1rovUnaxwFiPoz24yF7q%252FCosUwMJwy08ouDlQ20M9oxuemb623zNm6zrS%252FmivXlAUioHZGZdMcp%252FdR6TmeJqMHNwwkYPRSpTQmkSDMGMteZM8ODFSkIt1UeM9wKyb5t%252FgHgR%252BbFAxpQPf7R%252Bq1wGR2Fh%252FO6Zfx90P4yI3um7k3FkHz6VV4fRS1sR92zQ734yTrEwU9zANlBN%252FA5v6SC1CFoiukDzIETpovoPaFXBTQTq8HdcHjgeMnG5isaUAOBux%252B8zc30jYLf5fuqKGsFNJOdR4rVsop9KsJIUEP2jabAHuwkwsOedKUVOtPnY8sa%252BJ%252FmAD%252BkYuUa85Enx%252Fa1vsVEGKaTglMoNUOtgBcAyQnAwFMZn4NPAzT%252BarVYs17Mf3KK6tI%252BanZgmjJTSXaG4cX7A67IxHKzgT%252FWd2XUFn%252FQ5zRP2zbvYBRwofUN%252FrFrCd6YC5QNyT4BastOxiJOPnQnbF7%252FE4lLfa2u0h9ek58US4xgWtNHm5C6j10rp3v9QaKJzbM5F5k5tcx9rzyvZXM2jbQPvuJt%252Fpam2kbGADVy%252Fv2qbKVZyGsv7ICIRwX1wLPFLD2AfB%252BbazOyVw%253D%253D%7Cclp%3A2334524%7Ctkp%3ABFBMlvuM0uFf&LH_BIN=1&LH_ItemCondition=3"
}
]
},
"success": true
},
{
"query": {
"max_age": 1200,
"max_pages": 1,
"value": "0194252014233",
"key": "gtin",
"topic": "search",
"country": "de",
"source": "ebay",
},
"updated_at": "2022-02-18T13:59:51.722Z",
"content": {
"offers": [{
"shipping": 0,
"currency": "EUR",
"price": 568,
"review_count": 2,
"review_rating": "N/A",
"name": "Apple iPhone i12 Mini 64GB Blau Blue ( 2020 ) OVP Händler versiegelt NEU",
"id": "224837964473",
"url": "https://www.ebay.de/itm/224837964473?epid=7041718885&hash=item34596312b9%3Ag%3AMYcAAOSwemRfhvt%7E&LH_BIN=1&LH_ItemCondition=3"
},
{
"shipping": 14,
"currency": "EUR",
"price": 635,
"review_count": 2,
"review_rating": "N/A",
"name": "Apple iPhone 12 mini 5G 64GB blau Brandneu -originale Verpackung versiegelt",
"id": "125124374831",
"url": "https://www.ebay.de/itm/125124374831?epid=7041718885&hash=item1d21fe712f%3Ag%3AmfcAAOSwX05h9XGT&LH_BIN=1&LH_ItemCondition=3"
},
{
"shipping": 18.9,
"currency": "EUR",
"price": 599.9,
"review_count": 2,
"review_rating": "N/A",
"name": "Apple iPhone 12 mini blau 64Gb Händler NEUWERTIG inkl. MWSt.",
"id": "384687639119",
"url": "https://www.ebay.de/itm/384687639119?epid=7041718885&hash=item59912b8a4f%3Ag%3AV2UAAOSwIO1h6AjY&LH_BIN=1&LH_ItemCondition=3"
},
{
"shipping": 13,
"currency": "EUR",
"price": 904,
"review_count": 2,
"review_rating": "N/A",
"name": "^ Apple iPhone 12 mini 64GB Blue (MGE13ZD/A)",
"id": "294771934422",
"url": "https://www.ebay.de/itm/294771934422?epid=13042300325&hash=item44a1c6c4d6%3Ag%3A53EAAOSwkY5h8a7f&LH_BIN=1&LH_ItemCondition=3"
},
{
"shipping": 0,
"currency": "EUR",
"price": 679.99,
"review_count": 2,
"review_rating": "N/A",
"name": "NEU Apple iPhone 12 - 64GB - Blau (Ohne Simlock) A2403",
"id": "393892625756",
"url": "https://www.ebay.de/itm/393892625756?epid=7041718885&hash=item5bb5d47d5c%3Ag%3AM7wAAOSwUaJh7DuC&LH_BIN=1&LH_ItemCondition=3"
},
{
"shipping": 0,
"currency": "EUR",
"price": 589,
"review_count": 2,
"review_rating": "N/A",
"name": "Brandneu - Apple iPhone 12 mini - 64GB - Blau - OVP und versiegelt - Fabrikneu",
"id": "255381481685",
"url": "https://www.ebay.de/itm/255381481685?epid=7041718885&hash=item3b75ec28d5%3Ag%3AgDIAAOSwZCFiBo-p&LH_BIN=1&LH_ItemCondition=3"
},
{
"shipping": 0,
"currency": "EUR",
"price": 519,
"review_count": 2,
"review_rating": "N/A",
"name": "Apple iPhone 12 mini 64GB iOS Smartphone Blau Blue IP68 - Deutsche Ware!",
"id": "333971068891",
"url": "https://www.ebay.de/itm/333971068891?epid=13042300325&hash=item4dc23a17db%3Ag%3AdcEAAOSwnRZggYyl&LH_BIN=1&LH_ItemCondition=3"
},
{
"shipping": 0,
"currency": "EUR",
"price": 696,
"review_count": 2,
"review_rating": "N/A",
"name": "Smartphone Original APPLE iPhone 12 Mini 4GB/64GB 5G Blau Handy",
"id": "233921020785",
"url": "https://www.ebay.de/itm/233921020785?epid=13042300325&hash=item3676c78371%3Ag%3ANBgAAOSwmFFgQ0AD&LH_BIN=1&LH_ItemCondition=3"
},
{
"shipping": 0,
"currency": "EUR",
"price": 751.9,
"review_count": 2,
"review_rating": "N/A",
"name": "Apple iPhone 12 mini (64GB) blau",
"id": "165301261774",
"url": "https://www.ebay.de/itm/165301261774?epid=7041718885&hash=item267cb915ce%3Ag%3AHEQAAOSwTsJhLMF3&LH_BIN=1&LH_ItemCondition=3"
},
{
"shipping": 0,
"currency": "EUR",
"price": 609,
"review_count": 2,
"review_rating": "N/A",
"name": "Apple iPhone 12 mini 64GB Blau NEU & OVP - Differenzbesteuert",
"id": "185278173614",
"url": "https://www.ebay.de/itm/185278173614?epid=7041718885&hash=item2b237091ae%3Ag%3AlTAAAOSwjzZh-Wuc&LH_BIN=1&LH_ItemCondition=3"
},
{
"shipping": 0,
"currency": "EUR",
"price": 843.9,
"review_count": 2,
"review_rating": "N/A",
"name": "Apple iPhone 12 mini (64GB) blau",
"id": "284624323553",
"url": "https://www.ebay.de/itm/284624323553?epid=13042300325&hash=item4244ee83e1%3Ag%3AkaYAAOSwWfZgGQ3h&LH_BIN=1&LH_ItemCondition=3"
}
]
},
"success": true
}
]
}
{
"error": true,
"message": "job id incorrect or missing"
}
ORList of possible errors:
List of possible product level errors: