Pagination in requests to Yandex Market API for sellers

Some queries do not return the result in its entirety, but page by page. To get the full result, run several consecutive queries. — in each new request, pass a parameter with the next page of results.

Depending on which parameter needs to be passed, pagination can be of two types:

• with the page ID — parameter page_token;
• with the page number — parameter page.

If both types of pagination are available in the method, use page ID (page_token), not her number.

Pagination with the page ID

Examples of methods:

• POST v2/businesses/{businessId}/offer-cards
• POST v2/campaigns/{campaignId}/offer-prices
• GET v2/campaigns/{campaignId}/returns

To get the full result:

1. Make a request where:

   • Don't pass it on page_token.
   • If desired, send limit. Then this parameter will need to be passed in each subsequent request.

   The response will return the parameter paging.

2. If in paging the parameter returned nextPageToken so, there is the next page of the result. Repeat the request, where pass the value nextPageToken in the parameter page_token.

   Parameter Value nextPageToken

   This is not a page number, but a string that needs to be passed in the request.

   If there is no parameter, then the last page is returned. Make more requests no need.

3. Keep executing requests until it returns nextPageToken.

Pagination with the page number

Examples of methods:

• GET v2/campaigns
• GET v2/campaigns/{campaignId}/orders
• GET v2/regions/{regionId}/children

To get the full result:

1. Make a request where:

   • Don't pass it on page.
   • If desired, send pageSize. Then this parameter will need to be passed in each subsequent request.

   The response will return the parameter pager with the number of result pages pagesCount.

2. If in pagesCount more than one page returned, repeat the requests — in the parameter page send the page numbers (2, 3 and to the last one).