Make paginated requests to the REST Admin API

When you send a request to a REST endpoint that supports cursor-based pagination, the response body returns the first page of results. If applicable, then a response header returns links to the next page and the previous page of results. You can use the links in the response header to iterate through the pages of results.

Link headers use the following syntax:

The link header includes arelparameter that describes the relation of the linked page to the current page of results. The value can either bepreviousornext. If your initial request doesn't return enough records to generate an additional page of results, then the response won't have a link header.

The URL in the link header can include the following parameters:

You can use cursor-based pagination on mostREST Admin APIGET endpoints that retrieve a list of resources.

If the REST resource includes thelimitparameter on the GET endpoint, then you can use the endpoint to request paginated data. For example, the产品resource includes thelimitparameter on theGET endpoint that retrieves a list of products.

When you make a request to an endpoint that supports paginated results, you can set the number of results to return per page using thelimitparameter. If you don't specify alimit, then the endpoint will use itsdefault page limit. You can also set other parameters in this request to narrow down your results.

The following example request asks the product endpoint for all products that belong to a collection (id: 123), with alimitof 3 products per page of results:

The response header returns a link header that includes a URL for the next page of results. The response body returns the first page of results, which includes 3 products.

To get the next page of results, you can make a request to the URL stored in the link header of thelast response.

The response header includes a link to the previous page of results and a link to the next page. The response body includes the second page of results, which includes the next 3 products after the first page.

You can use the URLs in the link headers to iterate through each page of results. If you make a request to a page, and the response header only includes a link to the previous page, then you've reached the last page of results.

You can change thelimitin a link header URL to return a different number of results from a specified point. For example, the following example request asks the product endpoint for all products, with alimitparameter of 3:

If you change thelimitin the URL in the link header to 6 and make a request to that URL, then the response body returns the 6 products after the first page of results:

The@shopify/shopify-apilibraryprovides backend support for JavaScript and TypeScript apps to access the REST Admin API.

下面的代码检索产品的商店by fetching them in batches of 10 until all products have been retrieved. You can store thepageInfodata between requests using a session.

• A request that includes thepage_infoparameter can't include any other parameters except forlimitandfields(if it applies to the endpoint). If you want your results to be filtered by other parameters, then you need to include those parameters in the first request you make.
• The link header URLs are temporary and we don't recommend saving them to use later. Use link header URLs only while working with the request that generated them.
• Any request that sends thepageparameter will return an error.