Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
catalogs
Pegar produtos
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs \
  --header 'Client-Token: <api-key>'
{
  "cartEnabled": true,
  "products": [
    {}
  ]
}

Conceituação

Nesse método você será capaz de pegar os produtos de um 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.

Query Parameters

nextCursor
string
Token de paginação para buscar mais registros

Response

200

cartEnabled
boolean
Status do carrinho de compras ativo
products
array
Lista de produtos do catálogo
{
  "cartEnabled": true,
  "products": [
    {
      "availability": "in stock",
      "id": "999999999999999",
      "retailerId": null,
      "description": "Descrição do mouse",
      "price": "100000",
      "salePrice": "90000",
      "currency": "BRL",
      "name": "Mouse",
      "quantity": null,
      "images": ["https://..."]
    }
  ]
}

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.

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. Consulte a rota Pegar Produtos V2.

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