Skip to content

Commit 6ef0d18

Browse files
Create file
1 parent 2697709 commit 6ef0d18

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

docs/amazonSearch.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# amazonSearch Documentation
2+
3+
## Brief Description
4+
5+
amazonSearch is a JSON object that defines the structure and parameters for making Amazon product search queries.
6+
7+
## Usage
8+
9+
To use amazonSearch, you need to send a POST request to the specified endpoint with the required parameters. The object provides the URL structure, query parameters, and parsing options for Amazon product searches.
10+
11+
## Parameters
12+
13+
* `query` (string, required): The search term to look up on Amazon.
14+
15+
## Return Value
16+
17+
The amazonSearch object doesn't return a value directly. Instead, it defines the structure for an API request that will return search results from Amazon.
18+
19+
## Examples
20+
21+
```javascript
22+
// Example POST request using the amazonSearch structure
23+
fetch('https://api.webit.live/api/v1/realtime/ecommerce/amazon/search', {
24+
method: 'POST',
25+
headers: {
26+
'Authorization': 'Basic <TOKEN>',
27+
'Content-Type': 'application/json'
28+
},
29+
body: JSON.stringify({
30+
query: 'ironflask'
31+
})
32+
})
33+
.then(response => response.json())
34+
.then(data => console.log(data))
35+
.catch(error => console.error('Error:', error));
36+
```
37+
38+
## Notes or Considerations
39+
40+
* You need a valid authorization token to make requests.
41+
42+
* The search is performed on Amazon's US site by default, but other domains like UK are supported.
43+
44+
* The response includes detailed product information such as ASIN, price, rating, and product name.
45+
46+
* Be aware of Amazon's terms of service and usage limits when using this API.

0 commit comments

Comments
 (0)