Ler um produto

GET/v1/instances/{id}/catalog/products/{product_id}desde M12token da instância ou admin

Quando usar

Ler um produto

Autenticação

Aceita o token da instância (só a própria instância) ou o token admin. Um token de outra instância recebe 403 forbidden (ou 404 not_found em webhooks de outra instância).

Parâmetros

Caminho

Nome	Tipo	Descrição
idobrigatório	string	Id da instância (inst_...).
product_idobrigatório	string

Query

Nome	Tipo	Descrição
jid	string	Número da empresa; padrão, o próprio número.

Exemplo

cURL

curl -s "$LITEZAP_URL/v1/instances/$ID/catalog/products/$PRODUCT_ID" \
  -H "Authorization: Bearer $LITEZAP_TOKEN"

Node.js

const res = await fetch("http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/catalog/products/product_id", {
  headers: { Authorization: `Bearer ${process.env.LITEZAP_TOKEN}` },
});
console.log(res.status, res.status === 204 ? "" : await res.json());

Python

import os
import requests

r = requests.get(
    "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/catalog/products/product_id",
    headers={"Authorization": f"Bearer {os.environ['LITEZAP_TOKEN']}"},
    timeout=150,
)
print(r.status_code, r.json() if r.content else "")

Go

package main

import (
  "fmt"
  "io"
  "net/http"
  "os"
)

func main() {
  req, _ := http.NewRequest("GET", "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/catalog/products/product_id", nil)
  req.Header.Set("Authorization", "Bearer "+os.Getenv("LITEZAP_TOKEN"))
  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()
  out, _ := io.ReadAll(resp.Body)
  fmt.Println(resp.Status, string(out))
}

PHP

<?php
require 'vendor/autoload.php'; // composer require guzzlehttp/guzzle

$client = new GuzzleHttp\Client(['base_uri' => 'http://localhost:8787']);
$res = $client->request('GET', '/v1/instances/inst_7f3a9c2e5b1d4086/catalog/products/product_id', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('LITEZAP_TOKEN')],
    'http_errors' => false,
]);
echo $res->getStatusCode(), ' ', $res->getBody(), PHP_EOL;

Nos exemplos, LITEZAP_URL é a URL base (ex.: http://localhost:8787) e o token vem deLITEZAP_TOKEN (instância) ou LITEZAP_ADMIN_TOKEN.

Resposta

200 O produto.

Campos de CatalogProduct

id	string
name	string
description	string
price	number	price_amount_1000 / 1000.
price_amount_1000	integer	Milésimos da moeda (R$ 12,50 = 12500).
currency	string
price_text	string	Só BRL: "R$ 59,90".
sale_price	number
sale_price_amount_1000	integer
retailer_id	string
url	string
hidden	boolean
availability	string	in_stock, out_of_stock…
review_status	string	approved, pending, rejected…
image_count	integer
image_url	string	Link da CDN do WhatsApp (assinado, expira).
image_path	string	Caminho da API para baixar a primeira foto.

Erros

Código	HTTP	Retentável	O que fazer
validation_failed	400	não	Corrija o corpo ou os parâmetros; a message diz o campo.
unauthorized	401	não	Envie Authorization: Bearer <token> válido.
catalog_not_found	404	não
upstream_changed	502	não

Todo erro usa o envelope {"error":{"code","message","retryable"}}. Tabela completa em Erros.

Equivalente na Z-API: Obter produto. Veja Migrar da Z-API.

Outras operações de Catálogo e pedidos: Ler o catálogo · Ler as coleções · Baixar a foto de um produto · Pedidos recebidos · Detalhes de um pedido