listCollections

Use this method to retrieve a list of product collections within the app.

Field	Type	Required	Description
`method`	String	✅ Yes	Must be `"listCollections"`
`app_id`	String	✅ Yes	Unique identifier for the App requesting the collections.
`reference`	String	Optional	Unique identifier for the request. Will be echoed in the response.
`page_number`	Number	Optional	The page number to retrieve. Starts from `0`.
`page_size`	Number	Optional	Number of items per page. Default is `50`.
`collection_id`	String	Optional	Filter by collection_id to retrive exact collection.
`status`	String	Optional	Filter by collection status:`"A"` = Active, `"N"` = Non-active
`category`	Array of String	Optional	Filter collections by category (e.g., `"product"`, `"event"`, `"booking"`).

Preconditions for API Functionality

The following table outlines the preconditions that must be met for the API to function correctly. Failure to meet these conditions may result in errors or unexpected behavior.

Condition	Description
API must have `"Manage Products"` permission	The API needs `"Manage Products"` permission to manage products within the app.

Response:

listCollectionsResponse

✅ On success, the listCollectionsResponse method is returned with an echo of the chat object.

Field	Type	Returned	Description
`method`	String	Yes	`"listCollectionsResponse` `"`
`app_id`	String	Yes	Unique identifier for App.
`collections`	Array of Collections	Yes	Collection Object.
`page_number`	Number	Optional	The page number to retrieve in pagination. Returns the next page of results.
`eop`	Boolean	Conditional	End of page: Indicates that the last page has been reached. Returns `true` when there are no more pages to retrieve. Default is `false`
`reference`	String	Optional	Unique identifier echoed from the request.

SDK Mapping — `listCollectionItem`

SDK	Request Method	Response Callback
Java	`api.listCollectionItem(appId, reference);`	`listCollectionItemResponse(ListCollectionItemResponse collections)`
JavaScript	`api.listCollectionItem(appId, reference);`	`listCollectionItemResponse(collections)`
Python	`napi.list_collection_item(app_id=app_id, reference=reference)`	`on_collection_item(self, msg_ack)`

Example

Request

json

{
  "method": "listCollections",
  "app_id": "90090684293000559",
  "reference": "123456789"
}

java
api.listCollectionItem(Long.valueOf("90090684293000559"), null);

javascript
api.listCollectionItem("90091783822039252","123456789");

python
napi.list_collection_item(app_id=90090684298937728,reference=None)

Response

json
{
    "page_number": 1,
    "method": "listCollectionsResponse",
    "app_id": "90090684293000559",
    "business_channel_id": "90090684293000559",
    "collections": [
        {
           "id": "5121960361126208",
            "name": "New Collection",
            "description": "Collection Description",
            "image": [
                {
                    "width": 720,
                    "url": "https:\/\/m1.nandbox.ca\/v1\/AUTH_137b624a8e434c4e88e9be30fa5e7bed\/g\/null073734a35fbf6f2374c2cfe1080a2c3eb28a64f8c75fc7ba0ef6d7b7fe3520af.jpg?temp_url_sig=3d864d3723b85e6ebce8c99231419781818ebbc1&temp_url_expires=2059203944",
                    "height": 340
                }
            ],
            "status": "A",
            "category": "product",
            "date": "2025-03-26 04:05:57",
            "version": "ctAZhT"               
        }
    ],
    "eop": true,
    "reference": "123456789",

}