Cursor-Based Pagination

[richardklint]

With the latest API release, certain pagination calls are not working. See https://help.shopify.com/en/api/guides/paginated-rest-results

[tareqtms]

@richardklint
We don't have any specific functions to handle paginated results. What update do you want from us?

[richardklint]

This is just to track progress towards getting the new pagination working.

[KiloooNL]

This is just to track progress towards getting the new pagination working.

Pagination is quite easy, this works for me, it may help you:

<?php
$shopify = new PHPShopify\ShopifySDK;

// Shopify paginiation
$productsCount = $shopify->Product->count();
echo '<br>Total Shopify products in Shopify: ' . $productsCount;

$page = 1;   // First page
$limit = 25; // Limit of products per page
$getShopifyProducts = array(); // Create an array for Shopify products
                
// Work out how many pages there are
$totalPages = ceil($productsCount / $limit);
while ($page <= $totalPages) {
        echo '<br><b>Current page: ' . $page . ' / ' . $totalPages . '</b>';
        $params = array("limit" => $limit, "page" => $page);
        array_push($getShopifyProducts, $shopify->Product->get($params));

        // Go to the next page.
        $page++;
} 

// Now that we have all the products, print the array
print_r($getShopifyProducts);
?>

[zealnagar]

@KiloooNL you are right but after the Curson based pagination in 2019-07 and above they provide next and previous link in header when you pass limit query string parameter. So we need support to access CurlResponse class getHeader method statically. So we can iterate the pages and get relevant info based on the individual use case. @tareqtms

[shawnhind]

You can also use since_id based pagination which they still say is the most efficient (moreso than cursor-based) and has been available in the API for quite a long time.

The cursor pagination in this plugin would be a nice convenience thing to have though.

Using a since_id is the fastest solution and should be the first choice for pagination when order doesn’t matter.

This can also be implemented right now with no change needed to the library.

Ref:
https://www.shopify.com/partners/blog/relative-pagination

[tareqtms]

@zealnagar
Ok, will have a look before the next release.

[mailramk]

Hi,
When can we expect this enhancement implemented as the support for pagination is stopping from April 2020. This is the screenshot from the mail received from Shopify about this.

Thanks
Ram

[rick-li-dev]

Hi, this issue should be in top priority. If page filter is removed on April 1, 2020, this SDK will be useless. I am looking forward to hear there is a support for this soon.

Thanks
Rick

[shawnhind]

@rickcow take a look at my comment above in this thread. since_id pagination is still supported in this new API and has nothing to do with page filtering being removed. You can use this in this SDK in its current state very easily and isn't going away and is actually even more efficient than cursor based pagination.

Example to retrieve all Products:

$lastId = 1;
$products = [];

do {
    $results = $client->Product->get(['limit' => 250, 'since_id' => $lastId]);
    $products = array_merge($products, $results);
    $lastId = end($results)['id'];
} while (sizeof($results) > 0);

[Coennie]

@shawnhind agreed since_id works perfectly, for most cases... Unfortunately not all endpoinds support since_id. Take the inventoryLevel for instance, this does give the pagination headers, but does not take the since_id.

Regards Coen

[shawnhind]

@Coennie oh okay. Thanks, wasn't aware that this wasn't available for all endpoints, yeah in that case this would be necessary then. I only use the Page, Blog, Product, and ProductCollection endpoints which all have it so I just made an assumption that they all did.