Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
catalogs
/
collection-products
/
{phone}
List collection products
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection-products/{phone} \
  --header 'Client-Token: <api-key>'
{
  "products": [
    {}
  ]
}

​
Overview

This method is responsible for listing all products belonging to a specific collection in the WhatsApp Business catalog.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Path

​
phone
string
required
Phone number of the catalog owner

​
Query Parameters

​
collectionId
string
required
Collection ID
​
nextCursor
string
Cursor for result pagination

​
Response

​
200

​
products
array
List of products in the collection
[
  {
    "id": "6643149779134830",
    "name": "Nome do produto",
    "description": "Descrição do produto",
    "price": 9900,
    "currency": "BRL",
    "images": [
      {
        "url": "https://example.com/image.jpg"
      }
    ]
  }
]

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.