All Products

get https://enterprise-sl-api.labelinsight.com/api/v4/{accessKey}/data/product

Query Parameters

Query Parameter	Type	Default	Restrictions
pageSize	Integer	20	Must be between 1 and 50.
cursor	String	* (Page 0)	Must be the cursor value defined in the previous request.

API Response

Field	Type	Description
content	List	A list of SmartLabel products, each matching the “API JSON Response” data structure.
cursor	String	The value of the cursor supplied, `null` if first page.
nextCursor	String	The value of the cursor to supply as a query parameter to fetch the next page.
isLastPage	Boolean	Indicates if iteration over the list of products is complete.
pageSize	Integer	Total number of products returned in the page.
totalElements	Integer	Total number of products in the organization.

How to iterate and fetch all products

Fetch the first page by submitting a GET request to https://enterprise-sl-api.labelinsight.com/api/v4/{organizationId}/data/product

Example Response:

  "content": [
        { <SmartLabel Product> },
            …,
        { <SmartLabel Product> }
  ],
  "cursor": null,
  "nextCursor": "1234567",
  "isLastPage": false,
  "pageSize": 20,
  "totalElements": 819
}

Fetch the next page by supplying the nextCursor field from the previous request as the cursor query parameter in the next request. For example, to fetch page 2: https://enterprise-sl-api.labelinsight.com/api/v4/{organizationId}/data/product?cursor=1234567
Continue making requests to the API using the cursor from the previous API response. The cursor will change in each response, so it must be maintained between requests.
Stop iterating once the isLastPage boolean is true in the API response.

Other Notes

Once the last page is reached, the nextCursor value will be null.
If the pageSize requested exactly matches the number of products returned in the last page, the subsequent request will return an empty list of products with isLastPage boolean set to true to terminate the iteration.