Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
catalogs
/
collection-products
/
{phone}
Listar produtos de uma coleção
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection-products/{phone} \
  --header 'Client-Token: <api-key>'
{
  "products": [
    {}
  ]
}

​
Conceituação

Este método é responsável por listar todos os produtos pertencentes a uma coleção específica do catálogo do WhatsApp Business.

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Path

​
phone
string
obrigatório
Telefone do dono do catálogo

​
Query Parameters

​
collectionId
string
obrigatório
ID da coleção
​
nextCursor
string
Cursor para paginação dos resultados

​
Response

​
200

​
products
array
Lista de produtos da coleção
[
  {
    "id": "6643149779134830",
    "name": "Nome do produto",
    "description": "Descrição do produto",
    "price": 9900,
    "currency": "BRL",
    "images": [
      {
        "url": "https://example.com/image.jpg"
      }
    ]
  }
]

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.