CollectionsVersion: v3
Fetch Product Collections
GET/products/collections
Internal API to fetch the Product Collections
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
Scope:
products/ collection. readonlyAuth methods:
OAuthPrivate IntegrationToken type:
Sub-Account TokenRequest
Headers
Versionstringrequired
API Version
Available options
v3Query Parameters
limitnumber
The maximum number of items to be included in a single page of results
Default:
10Example:
20offsetnumber
The starting index of the page, indicating the position from which the results should be retrieved.
Default:
0Example:
0altIdstringrequired
Location Id
Example:
6578278e879ad2646715ba9caltTypestringrequired
The type of alt. For now it is only LOCATION
Available options
locationExample:
LOCATIONcollectionIdsstring
Ids of the collections separated by comma(,) for search purposes
Example:
65d71377c326ea78e1c47df5,65d71377c326ea78e1c47d34namestring
Query to search collection based on names
Example:
Best SellersResponse
Successful response
dataarray[]required
Array of Collections
totalnumberrequired
The total count of the collections present, which is useful to calculate the pagination