vértice
Produto Preços Painel
WhatsApp Business

WhatsApp Business

Perfil comercial, catálogo, produtos, coleções, etiquetas e pedidos do WhatsApp Business.

Referência

22 endpoints

GET /instances/:id/business/profile →

Perfil business

Retorna o perfil comercial do número conectado.

API key · Escopo read
PATCH /instances/:id/business/profile →

Atualizar perfil business

Atualiza descrição, e-mail, sites, endereço e horário comercial.

API key · Escopo write
PUT /instances/:id/business/cover-photo →

Atualizar foto de capa business

Atualiza foto de capa business.

API key · Escopo write
DELETE /instances/:id/business/cover-photo/:photoId →

Remover foto de capa business

Remove foto de capa business.

API key · Escopo write
GET /instances/:id/business/catalog →

Catálogo de produtos

Lista produtos do catálogo do WhatsApp Business.

API key · Escopo read
GET /instances/:id/business/catalog/:jid →

Catálogo de outro número

Catálogo de outro número.

API key · Escopo read
GET /instances/:id/business/products →

Listar produtos

Lista produtos.

API key · Escopo read
GET /instances/:id/business/products/:productId →

Detalhe do produto

Retorna um produto específico do catálogo.

API key · Escopo read
POST /instances/:id/business/products →

Criar produto

Cria um produto com imagens, preço, moeda e descrição.

API key · Escopo write
PATCH /instances/:id/business/products/:productId →

Atualizar produto

Atualiza os dados de um produto.

API key · Escopo write
DELETE /instances/:id/business/products/:productId →

Deleta produto

Remove um produto do catálogo.

API key · Escopo write
GET /instances/:id/business/collections →

Listar coleções

Lista as coleções do catálogo.

API key · Escopo read
GET /instances/:id/business/labels →

Listar etiquetas

Lista as etiquetas business persistidas no Vértice.

API key · Escopo read
POST /instances/:id/business/labels →

Criar etiqueta

Cria uma etiqueta e a replica no app state do WhatsApp.

API key · Escopo write
PATCH /instances/:id/business/labels/:labelId →

Editar etiqueta

Edita nome/cor da etiqueta.

API key · Escopo write
DELETE /instances/:id/business/labels/:labelId →

Deleta etiqueta

Remove a etiqueta e suas associações.

API key · Escopo write
POST /instances/:id/business/quick-replies →

Criar/editar resposta rápida

Cria/edita resposta rápida.

API key · Escopo write
DELETE /instances/:id/business/quick-replies/:shortcut →

Remover resposta rápida

Remove resposta rápida.

API key · Escopo write
GET /instances/:id/business/orders/:orderId →

Detalhe de pedido

Retorna os detalhes de um pedido a partir de orderId e token.

API key · Escopo read
GET /instances/:id/business/collections/:collectionId/products →

Produtos de coleção no resultado do provedor

Limitado à página de coleções/produtos retornada pelo provedor. Não é uma varredura completa de todas as páginas.

API key · Escopo read
GET /instances/:id/business/quick-replies →

Respostas rápidas geridas pela API

Retorna meta.coverage=managed_by_api; não importa todas as respostas criadas no celular.

API key · Escopo read
GET /instances/:id/business/labels/:labelId/chats →

Listar conversas por etiqueta

Consulta isolada por instância e etiqueta; limit inteiro de 1 a 1000.

API key · Escopo read