Pular para o conteúdo principal

Pegar Produtos

Método#

/catalogs#

GET https://api.z-api.io/instances/{{instanceId}}/token/{{instanceToken}}/catalogs

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Conceituação#

Nesse método você será capaz de pegar os produtos de um catálogo do whatsapp Business

Atributos#

Opcional#

AtributosTipoDescrição
nextCursorstringToken utilizado para paginação dos registros
414 URI Too Large

Em alguns casos o envio do nextCursor pode causar um erro 414 "URI Too Large". Para resolver esse problema implementamos uma V2 para essa rota da API que aceita requisições do tipo POST para que você possa enviar o nextCursor no corpo da requisição. Para saber como utilizar acesse a documentação da rota Get Products V2

Response#

200#

AtributosTipoDescrição
cartEnabledbooleanAtributo para saber se o carrinho está ativo
availabilitystringAtributo para saber a disponibilidade do produto
idstringId do produto
retailerIdbooleanID do varejista
descriptionstringDescricao do produto
pricestringPreço do produto
salePricestringPreço promocional
currencystringTipo da moeda
namestringNome do produto
quantitybooleanAtributo de quantidade de produto
imagesstringLink da imagem do produto

Exemplo

{
"cartEnabled": true,
"products": [
{
"availability": "in stock",
"id": "999999999999999",
"retailerId": null,
"description": "Descriçao do mouse",
"price": "100000",
"salePrice": "90000",
"currency": "BRL",
"name": "Mouse",
"quantity": null,
"images": ["https://"]
}
]
}

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#