Added information about paging #15
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Mephisztoe
commented
Jun 5, 2019
| Get search results from a retailer based on a query term. Results include product id, title, image url, number of reviews, star rating, and price. | ||
| Get search results from a retailer based on a query term. Results include product id, title, image url, number of reviews, star rating, and price as well as how many results are shown of all available. | ||
|
|
||
| The api is optimized for fast responses so results are paged. That means that if there are lots of results returned by your query, the response will be paged. You can retrieve more results by executing the query again with an increased page number. For example, if querying the first page lists `showing.start` as 1 and `showing.end` as 48 with a total amount of results as `showing.of` = 30000, you can expect 625 pages in total (30000/48). However, keep in mind that query results are not being cached on our server, so executing a query again with another page number could return different results and will also be billed as each query causes new workload. That means your application should allow the showing object for changes with each query you execute. |
There was a problem hiding this comment.
At the moment, it is unclear to the user how many items will return, because there is no way of setting the pagesize. Since the total amount of available items can vary between several executions, the user has to keep an eye on the values of the showing object. This point needs to be stressed more.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.