This describes the API available on
https://api.testfreaks.com/ which requires authentication
and can be used to access and edit product, orders, reviews, questions & answers,
and your settings.
|Products||Sync and access your product catalog|
|Review Summaries||Get the number of reviews etc for each product or product family|
|Reviews||Access all your reviews, including non-published reviews and data|
|Seller Reviews||Access all your seller reviews, including non-published reviews and data|
|Orders||Sync and access your order data|
|Client Configurations||Access your client ids and configuration|
See separate authentication page.
A client configuration separates data in the application, such as the product catalog, orders, and the collected reviews.
The separation might be between different markets, for example countries, or even between languages
within a country. A separate
-staging client configuration is commonly used during setup and
The client configuration also contain settings. Examples include the locale to use, the number of days to wait before sending order review emails to customers, and whether seller reviews are being collected.
All API endpoints require a
client_id to identify the client configuration to use.
The only exception is the Client Configuration API. It can be used to list all available client configurations and their individual settings.
APIs can return
.errors array with a list of errors if something failed.
APIs returning lists of objects will contain a
.links.next entry with a link to the next page,
if there are more objects available. The link will set the
after parameter to allow pagination
that’s safe even when objects are inserted or deleted. You should not rely on
for anything else, or save it for more than 24 hours.
If the API returns these headers, rate limiting applies in accordance with RateLimit Header Fields for HTTP. If not, you’re expected to limit requests to reasonable volumes.
|HTTP header name||Description|
||containing the requests quota in the time window|
||containing the remaining requests quota in the current window|
||containing the time remaining in the current window, specified in seconds|