Fetch Product Collections

GET 
/products/collections

Internal API to fetch the Product Collections

Request

Version stringrequired

API Version

Available optionsv3

limit number

The maximum number of items to be included in a single page of results

Default value:10

offset number

The starting index of the page, indicating the position from which the results should be retrieved.

Default value:0

altId stringrequired

Location Id

altType stringrequired

The type of alt. For now it is only LOCATION

Available optionslocation

collectionIds string

Ids of the collections separated by comma(,) for search purposes

name string

Query to search collection based on names

application/json

Successful response

application/json

Schema

Schema

dataarray[]required

Array of Collections

totalnumberrequired

The total count of the collections present, which is useful to calculate the pagination

Example (auto)

{
  "data": [
    null
  ],
  "total": 0
}