Pular para o conteúdo principal

Adicionar produtos à coleção

Método#

/catalogs/collection/add-product#

POST https://api.z-api.io/instances/{{instanceId}}/token/{{instanceToken}}/catalogs/collection/add-product

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Conceituação#

Utilizando esse método você será capaz de adicionar produtos à uma coleção do seu catálogo.

Atenção

Ao adicionar ou remover produtos de uma coleção, o id da mesma é alterado pelo whatsapp. Isso quer dizer que, ao cadastrar um produto na coleção e tentar fazer qualquer outra operação utilizando o id "antigo" resultará em um não funcionamento da rota. Lembre-se então de utilizar o id retornado por essa mesma rota, o qual já é o id atualizado para as operações seguintes.


Atributos#

Obrigatórios#

AtributosTipoDescrição
collectionIdstringId da coleção
productIdsarray stringIds dos produtos que farão parte da coleção

Request Body#

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

Response#

200#

AtributosTipoDescrição
successbooleantrue caso tenha dado certo e false em caso de falha
collectionIdstringId atualizado da coleção

Exemplo

{
"success": true,
"collectionId": "1798362193933497"
}

405#

Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no inicio 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"


Code#