Paging Mechanism​

Introduction​

The SHOPLINE REST Admin API implements a pagination query based on cursors. The interface that supports the paging query has public input and output parameters, and supports both since_id mode (mainly used for the first page) and page_info mode (not the first page).

SHOPLINE's REST Admin API may return a link field in the response header to represent the possible next and previous pages when performing pagination queries. You need to parse from this field to obtain the URL to obtain page turning data.

This pagination rule works for all versions of the REST Admin API.

Parameter descriptions​

• page_info
  • represents the unique ID of a certain page.
  • Obtained in the link response header.
• limit
  • The number limit per page.
  • Default 50, up to 1000.
• fields
  • The fields to be queried.
  • The default is all fields, and multiple first-level fields are separated by English ,

How to paginate​

Suppose we need to retrieve items in a SHOPLINE store, query 10 items per page, and query the second page:

1. Construct the following request: request:admin/openapi/{version}/products/products.json?limit=10
2. Get the link field from the response

Note that if there is no link field, it means that you have requested all the data without pagination.

• When there is only the next page, the return structure is as follows:

<https://{handle}.myshopline.com/admin/openapi/{version}/products/products.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next"

• When there is a previous page and a next page, the return structure is as follows:

<https://{handle}.myshopline.com/admin/openapi/{version}/products/products.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc2NjAxNzI1MjczOTI4MDEwOTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next"

<https://{handle}.myshopline.com/admin/openapi/{version}/products/products.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc2NjAxNzI1MjczOTI4MDEwOTI3ODgiLCJkaXJlY3Rpb24iOiJwcmV2IiwibGltaXQiOjF9>; rel="previous"

If necessary, in Java you can extract page_info by <([^>]+)>; rel="([^"]+)" regular expression

rel Explained​

• next represents the ID of the next page
• previous represents the ID of the previous page

When you need the next page, you can directly get the URL of the next page from the link.

For example, in the above example, you need to access the data on the next page, and parse it directly from the data below:

<https://{handle}.myshopline.com/admin/openapi/{version}/products/products.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc2NjAxNzI1MjczOTI4MDEwOTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next", 

<https://{handle}.myshopline.com/admin/openapi/{version}/products/products.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc2NjAxNzI1MjczOTI4MDEwOTI3ODgiLCJkaXJlY3Rpb24iOiJwcmV2IiwibGltaXQiOjF9>; rel="previous"

The parsed URL is as follows

https://{handle}.myshopline.com/admin/openapi/{version}/products/products.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc2NjAxNzI1MjczOTI4MDEwOTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9

Now you can initiate a request for the next page through the URL above.

Note that when your URL contains the page_info parameter, the URL itself except the limit and fields fields, any other filter fields will be ignored

Detailed parameter description​

Since_id Mode (mainly used for the first page)​

Input parameter：

Output parameter：

page_info Mode (Not the first page)​

Input parameter：

Output parameter：