This guide aims to show a complete process of searching Amazon via API for real-time data. Sections are divided by each step namely: import, search, export, and delete. Each section also provides curl examples for reference.

Import

To start, you need to import identifiers to your campaign for us to search/map them. Pass an identifiers parameter containing an array of identifiers each containing the type and the identifier. The limit to how many identifiers you can upload in a single request is 1000.

curl "https://app.synccentric.com/api/v3/products" \
  -H "Authorization: Bearer your-api-token" \
  -d "identifiers[0][identifier]=B00YECW5VM" \
  -d "identifiers[0][type]=asin" \
  -d "identifiers[1][identifier]=B00USV83JQ" \
  -d "identifiers[1][type]=asin" \
  -XPOST

This curl request will upload 2 ASIN type identifiers to your campaign. Now that your campaign is populated with identifiers to search/map, we can move on to the next step.

Search

Now that you have products imported into your campaign, you can run a search and let Synccentric map the data for your identifiers. Send a post request to the api/v3/product_search endpoint start your search.

curl "https://app.synccentric.com/api/v3/product_search" \
-H "Authorization: Bearer your-api-token" \
-d "campaign_id=<your-campaign-id>" \
-XPOST

If successful, this should return the following response :

{"type": "product_search", "attributes": { "status": "Success" }}

You can check the progress of your search by polling the search status endpoint, the response should contain a percentage value of the search progress.

curl "https://app.synccentric.com/api/v3/product_search/status" \
-H "Authorization: Bearer your-api-token" \
-d "campaign_id=<your-campaign-id>" \
-G

When the percentage from the poll result reaches 100, you can proceed with exporting the mapped results.

Export

There are multiple ways of exporting but in this guide, we'll show 2 modes of exporting via API namely by paginating through the results, or by export file.

export by pagination

This process allows for easier traversing through the results by using the page and per_page parameters. This endpoint has a throttle of 60 requests/minute.

curl "https://app.synccentric.com/api/v3/products?page=2&per_page=20" \
    -H "Authorization: Bearer your-api-token" \
    -d "campaign_id=<your-campaign-id>" \
    -G

2. export by file

This process is better for performance as you can process the entirety of your results in a single file without the overhead of making multiple export requests.

curl "https://app.synccentric.com/api/v3/products?page=2&per_page=20" \
    -H "Authorization: Bearer your-api-token" \
    -d "campaign_id=<your-campaign-id>" \
    -d "downloadable=1" \
    -d "downloadable_type=csv" \
    -G

On Success, this endpoint will return a downloadable_url property in the response which acts as the polling endpoint, then downloads the export file once ready.

Delete (optional)

If you want to import another set of identifiers to search, you can delete the products on your campaign to make space.

curl "https://app.synccentric.com/api/v3/products/" \
-H "Authorization: Bearer your-api-token" \
-d "campaign_id=<your-campaign-id>" \
-XDELETE