Response

Response Body

{
"url": "https://example.com/product/iphone-13",
"title": "Iphone 13",
"price": "Β£1,321.33",
"img_url": "https://example.com/images/iphone.png",
"avg_star": "4,6",
"review_count": "218",
"sku": "SKU123456",
"gtin": "GTIN123456",
"availability": "in_stock"
}
If everything goes well you will receive a JSON response formatted as above. Below section explains the details of the each key.
Key
Type
Default
Values
Description
url
string
​
​
The URL of the product page you provided.
title
string
"n/a"
​
Title of the product.
price
string
"n/a"
​
Price or price-range* of the product.
img_url
string
"n/a"
​
Main image of the product.
avg_star
string
"n/a"
​
Average rating of the product.
review_count
string
"0"
​
Total review count of the product.
sku
string
"n/a"
​
Stock Keeping Unit number of the product.
gtin
string
"n/a"
​
Global Trade Item Number of the product.
availability
string
"n/a"
["in_stock", "out_of_stock"]
Stock status of the product.
Price value will be the same text you see on the product page. There is no standard since there are lots of eCommerce website that uses different display format. For example, price value can be in one of these formats:
  • $12,3
  • USD 12,3
*For products that have different pricing strategies for their variants, most of the eCommerce stores show price ranges. So you may receive a price value something like this:
  • $12,3 - $14,5
Some eCommerce websites show localized prices or different prices for each country. ecom2json arranges the geo origins of the requests according to the target website. For example, ecom2json sends requests from Germany to fetch product info from Amazon.de.

Response Status Codes

Code
Description
Action
200
Successful API Call
​
400
Invalid request parameter
Check the response body for detail.
403
Insufficient balance
You can upgrade your package.
404
Target website is not found
Check the url you passed.
406
Target website is not supported
Ensure that target URL is in the supported websites.
429
Concurrency limit exceeded
You can upgrade your package.
500
Couldn't scrape the website
Check the response body. Retrying may help to solve the issue.
You will be charged only for requests that respond with HTTP 200 status code.

Response Headers

In addition to standard HTTP response headers, ecom2json sends a few extra headers to give you some information.
Name
Type
Description
e2j-left-request-count
int
Your up-to-date API Call balance after the request.
Copy link
On this page
Response Body
Response Status Codes
Response Headers