Skip to content
This repository was archived by the owner on Aug 19, 2025. It is now read-only.

Added information about paging#15

Open
Mephisztoe wants to merge 1 commit intozincio:masterfrom
Mephisztoe:paging-doc
Open

Added information about paging#15
Mephisztoe wants to merge 1 commit intozincio:masterfrom
Mephisztoe:paging-doc

Conversation

@Mephisztoe
Copy link
Copy Markdown

No description provided.

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.
Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant