OCAPI pagination 23.1

The Open Commerce API uses paging whenever it accesses a collection of resource instances. Paging enables the API to return data in chunks, instead of returning a complete collection all at once. Each chunk, depending on its position, links to the previous chunk and to the next chunk. You can explicitly configure paging by providing values for the start and count parameters:

In the following example, a product search yields a collection of 99 total resource instances (shoes). The start property specifies that the requested chunk should start at position 10, and the count element specifies that the chunk should contain at most 5 resource instances. In the response, you can see the presence of the next and previous links; these links enable your application to navigate through the entire collection one chunk at a time.

GET /dw/shop/v23_1/product_search?q=shoes&start=10&count=5 HTTP/1.1
Host: example.com
Accept: application/json

HTTP/1.1 200 OK
Content-Length: 351
Content-Type: application/json; charset=UTF-8

  "_v" : "23.1",
    "name":"My Ultimate Shoe",
X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.