getCollectionProduct

Lists every product that belongs to one collection.

💡 Products come back in summary form. For variants, options, and the full record, call getProductItem with a product id.

Request

method is "getCollectionProduct".

Field	Type	Required	Description
`id`	String	Yes	The collection whose products you want.
`app_id`	String	Yes	The app the collection belongs to.
`reference`	String	Optional	Your id for this request. Echoed back in the response.

Preconditions

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

Response

getCollectionProductResponse

Field	Type	Returned	Description
`method`	String	Yes	`"getCollectionProductResponse"`
`products`	Array of Product	Yes	The products in the collection.
`reference`	String	Optional	Echoed from the request.

SDKs

SDK	Call	Callback
Java	`api.getCollectionProduct(collectionId, appId, reference);`	`onCollectionProduct(GetProductCollectionResponse collectionProduct)`
JavaScript	`api.getCollectionProduct(collectionId, appId, reference);`	`onCollectionProduct(collectionProduct)`
Python	`napi.get_collection_product(collection_id=collection_id, app_id=app_id, reference=reference)`	`on_collection_product(self, msg_ack)`

Example

Request

json
{
  "method": "getCollectionProduct",
  "id": "5121960361126208",
  "app_id": "90090684293000559",
  "reference": "123456789"
}

java
api.getCollectionProduct("5121960361126208", "90090684293000559", "123456789");

javascript
api.getCollectionProduct("5121960361126208", "90090684293000559", "123456789");

python
napi.get_collection_product(
    collection_id="5121960361126208",
    app_id="90090684293000559",
    reference="123456789",
)

Response

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

json
{
  "method": "getCollectionProductResponse",
  "reference": "123456789",
  "products": [
    {
      "id": 5121228327126172,
      "name": "Green T-shirt",
      "price": 50.0,
      "category": "product",
      "status": "A",
      "created_date": "2024-10-10 10:06:42",
      "app_id": 90090684293000559,
      "business_channel_id": 90090684293000559,
      "image": [
        {
          "url": "https://m1.nandbox.ca/v1/AUTH_.../90090684293000559_e3d97c03…jpg?temp_url_sig=…",
          "width": 245,
          "height": 275
        }
      ]
    },
    {
      "id": 5121232097126213,
      "name": "Red T-shirt",
      "price": 50.0,
      "category": "product",
      "status": "A",
      "created_date": "2025-04-02 12:33:25",
      "app_id": 90090684293000559,
      "business_channel_id": 90090684293000559,
      "image": [
        {
          "url": "https://m1.nandbox.ca/v1/AUTH_.../90090684293000559_d49bf44b…jpg?temp_url_sig=…",
          "width": 275,
          "height": 275
        }
      ]
    },
    {
      "id": 5121419845126176,
      "name": "Black T-shirt",
      "price": 50.0,
      "category": "product",
      "status": "A",
      "created_date": "2025-04-02 13:56:34",
      "app_id": 90090684293000559,
      "business_channel_id": 90090684293000559,
      "image": [
        {
          "url": "https://m1.nandbox.ca/v1/AUTH_.../90090684293000559_b7010f02…jpg?temp_url_sig=…",
          "width": 235,
          "height": 275
        }
      ]
    }
  ]
}