Skip to content

Commit 2697709

Browse files
Create file
1 parent 65d0a5b commit 2697709

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

docs/amazon_product.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# amazon\_product Documentation
2+
3+
## Brief Description
4+
5+
The `amazon_product` object is a JSON configuration used to extract data from an Amazon product page for a given ASIN (Amazon's Product ID).
6+
7+
## Usage
8+
9+
This object is typically used as part of an API request to retrieve detailed information about a specific Amazon product. It defines the structure for both the request and the expected response.
10+
11+
## Parameters
12+
13+
* `asin` (string, required): The Amazon Standard Identification Number (ASIN) of the product. Must be a 10-character alphanumeric string.
14+
15+
## Return Value
16+
17+
The `amazon_product` object doesn't return a value directly, but it defines the structure of the API response, which includes detailed product information.
18+
19+
## Examples
20+
21+
```javascript
22+
// Example API request
23+
fetch('https://api.webit.live/api/v1/realtime/ecommerce/amazon/product', {
24+
method: 'POST',
25+
headers: {
26+
'Authorization': 'Basic <TOKEN>',
27+
'Content-Type': 'application/json'
28+
},
29+
body: JSON.stringify({
30+
asin: 'B0C4ZZBD71'
31+
})
32+
})
33+
.then(response => response.json())
34+
.then(data => console.log(data));
35+
```
36+
37+
## Notes or Considerations
38+
39+
* The API requires authentication. Ensure you have a valid token before making requests.
40+
41+
* The response includes detailed product information such as price, availability, ratings, and product variations.
42+
43+
* The object supports multiple domains (e.g., "com", "co.uk"), allowing for region-specific product lookups.
44+
45+
* Be aware of Amazon's terms of service and usage policies when using this API to fetch product data.

0 commit comments

Comments
 (0)