listCollections

Lists the product collections defined for your app, with optional filtering and pagination.

💡 Every filter is optional. Send just method and app_id to get the first page of everything.

Request

method is "listCollections".

Field	Type	Required	Description
`app_id`	String	Yes	The app whose collections you want.
`reference`	String	Optional	Your id for this request. Echoed back in the response.
`collection_id`	String	Optional	Return only this one collection.
`status`	String	Optional	`"A"` = active, `"N"` = non-active.
`category`	Array of String	Optional	Filter by category — e.g. `"product"`, `"event"`, `"booking"`.
`page_number`	Number	Optional	Page to retrieve, starting at `0`.
`page_size`	Number	Optional	Entries per page. Defaults to 50.

Preconditions

Requirement	Why
`"Manage Products"` permission	Needed to read product and collection data for the app.

Response

listCollectionsResponse

Field	Type	Returned	Description
`method`	String	Yes	`"listCollectionsResponse"`
`collections`	Array of Collection	Yes	The collections on this page.
`app_id`	String	Yes	Echoed from the request.
`page_number`	Number	Optional	The page this result represents.
`eop`	Boolean	Conditional	End of pages. `true` when there is nothing more to fetch. Defaults to `false`.
`reference`	String	Optional	Echoed from the request.

SDKs

SDK	Call	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("90090684293000559", "123456789");

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

python
napi.list_collection_item(app_id="90090684293000559", reference="123456789")

Response

Image URLs are signed and time-limited; they are shortened here for readability.

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