API OPTIONS EXPLAINED
There are two main types of API operations we offer for gathering data.
Option 1 allows you to search our database containing well over 100 million products and growing. This is ideal for retrieving instant results or for seeking products using keywords or brand names. The downside to this is that we may not have every product you're searching for in our database and the inconstant data like pricing and sales rank would be from the last time the product was updated in our system - not real time. You can learn more technical info for this API option in our docs under Search Synccentric.
Option 2 allows you to feed products to the Synccentric system (your account/campaign) and search the identifiers across Amazon pulling real time results. While this option does not return an instant response and requires a search process, it does collect accurate up to date information and is not restricted to finding products solely in our database. This option is outlined in our docs under the Search Amazon section.
------
API OPTION 1 [FLOW]
Step 1 - Search with your Identifiers, Keyword, or Brand Name
Send up to 10 identifiers of the same type in a single request or search by keyword (or brand name) using the '/products/search' endpoint:
GET https://app.synccentric.com/api/v3/products/search
This operation is straight forward and you can view more technical details in our docs. If you're needing real-time data that changes often like pricing or sales rank, you'll want to skip this API and jump to API Option 2 below. If the data you need is more static, this is the best option to call first. For data that is not found in our database, we recommend queuing those missing products and then importing them using API Option 2 explained in the section below.
------
API OPTION 2 [FLOW]
Step 1 - Import Your Identifiers
Submit one or many identifiers as an array to your Synccentric account using the endpoint '/products'.
POST https://app.synccentric.com/api/v3/products
You're allowed to send up to 1000 identifiers per request. A premium plan user with a storage limit of 5000 could loop this request 5x to import a total of 5000 identifiers.
{
"campaign_id": 1,
"identifiers": [
{
"identifier": "B00YECW5VM",
"type": "asin"
}
]
}
Step 2 - Initiate the Search
After you submit your identifiers to a campaign, start the search by calling the endpoint '/product_search'.
POST https://app.synccentric.com/api/v3/product_search
There are several parameters you can apply to this request which are explained in the api.
Step 3 - Poll the Status
The search time will vary depending on many different factors like identifier search type and settings. You can poll the '/status' endpoint to retrieve the progress of the search and other attributes as shown in the example response below:
{
"type": "status",
"attributes": {
"errorItems": 0,
"totalItems": 1,
"convertedItems": 1,
"percentage": 100,
"jobsCount": 0,
"listingsReturned": 3,
"cancelJob": false,
"currentJobType": "product_search"
}
}
Step 4 - Export the Results
Once the 'status' response indicates the search is complete, you can export the results by GET '/products':
GET https://app.synccentric.com/api/v3/products
View the API docs to see which parameters are available for the export request. By default, the results will return in the request, using pagination if necessary. Another option is generating a json or csv file which can be downloaded and parsed once it is ready. For the latter option, you'll pass the parameters 'downloadable' and 'downloadable_type'. This generated a file and provides you with the downloadable link. We recommend this option for large exports.
For requesting single identifiers, simply include the id in the request URL:
https://app.synccentric.com/api/v3/products/{id}The id would be the identifier that you imported to your campaign.
Step 5 - Update Results or Delete and Import Next Batch
Depending on your use case, you may want to either update the data of the same identifiers in your campaign, or delete the data in your campaign so you can import and search your next batch of different identifiers. To re-search your data, you'll just repeat the steps starting at Step 2. To delete and import new data, you'll want to make a DELETE request:
DEL https://app.synccentric.com/api/v3/products/
This will return a response indicating your products have been deleted from your campaign. You can now repeat starting from Step 1.
If you need to delete only a specific identifier, just include the id within the delete request:
DEL https://app.synccentric.com/api/v3/products/{id}