Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
catalogs
/
collection
/
add-product
Adicionar produtos à coleção
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection/add-product \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "collectionId": "<string>",
  "productIds": [
    {}
  ]
}
'
{
  "success": true,
  "collectionId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Este método é responsável por adicionar produtos a uma coleção existente no catálogo do WhatsApp Business.
Ao adicionar ou remover produtos de uma coleção, o ID da mesma é alterado pelo WhatsApp. Utilize o ID retornado para operações subsequentes.

​
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.

​
Obrigatórios

​
collectionId
string
obrigatório
ID da coleção
​
productIds
array
obrigatório
IDs dos produtos a serem adicionados

​
Request Body

{
  "collectionId": "658387616418640",
  "productIds": ["6643149779134830"]
}

​
Response

​
200

​
success
boolean
true caso tenha dado certo e false em caso de falha
​
collectionId
string
Novo ID da coleção após a alteração
{
  "success": true,
  "collectionId": "1798362193933497"
}

​
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”.