VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/WhatsApp: fluxos do bot

Pedidos de mudança

Fila de pedidos dos sellers para mudar seus fluxos, e a rota que dá um fluxo próprio a um seller.

Num marketplace, o seller (lojista) não edita a estrutura do fluxo sozinho: ele pede a mudança e o administrador da loja decide. Estas rotas são o lado do administrador.

Listar pedidos de mudança

Sellers podem pedir mudanças na estrutura do fluxo que usam (por exemplo, uma etapa a mais). Esses pedidos chegam a esta fila para o administrador da loja analisar. A lista traz até 100 pedidos, os mais novos primeiro.

GET/api/v1/admin/whatsapp/flow-requestsAdmin

Lista os pedidos de mudança de fluxo dos sellers

Parâmetros de consulta

statusstringpadrão: pending
pendingapprovedrejectedappliedall
Filtra por estado. all traz todos. Omitido, traz só os pending.
vendor_iduuid
Filtra por seller.

Exemplo de requisição (Listar pedidos)

bash
curl "$BASE_URL/api/v1/admin/whatsapp/flow-requests?status=all" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Listar pedidos)

200Pedidos devolvidos
json
{
  "requests": [
    {
      "id": "1be48fc0-0376-453c-942d-4847d2c20a21",
      "vendor_id": "9d9d9d56-eb43-4719-889d-055632f7c7da",
      "flow_id": "00d2a290-8dd8-4583-8f43-271461e01dfd",
      "title": "Adicionar etapa de cupom",
      "description": "Perguntar se o cliente tem cupom antes de fechar o pedido.",
      "status": "pending",
      "created_by": "a1a25b87-5e32-4439-b3df-f98eb03b6434",
      "created_at": "2026-10-11T21:59:32.462039Z",
      "updated_at": "2026-10-11T21:59:32.462039Z"
    }
  ]
}

Campos da resposta

requestsarray

Pedidos de mudança.

iduuid
Identificador do pedido de mudança.
vendor_iduuid
Seller que pediu.
flow_iduuid
Fluxo a que o pedido se refere. Ausente quando não informado.
titlestring
Título do pedido.
descriptionstring
Detalhes do que o seller quer mudar.
statusstring
pendingapprovedrejectedapplied
Estado do pedido.
admin_notesstring
Observação do administrador. Ausente se não houver.
created_byuuid
Usuário que abriu o pedido.
reviewed_byuuid
Administrador que revisou. Ausente enquanto pendente.
reviewed_atstring
Quando foi revisado (RFC 3339). Ausente enquanto pendente.
created_atstring
Criação (RFC 3339, UTC).
updated_atstring
Última alteração (RFC 3339, UTC).

Erros (Listar pedidos)

StatusQuandoCorpo
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O módulo WhatsApp Commerce está desligado na loja, o usuário não é administrador ou não tem o privilégio exigido.{"error":"module_disabled","module":"whatsapp-commerce"} ou {"error":"insufficient privileges","required":"manage_settings"} ou {"error":"admin access required"}
500Falha ao consultar (inclusive vendor_id que não é UUID).{"error":"..."}
Quem cria os pedidos

O pedido é aberto pelo próprio seller, pelo painel do lojista. Não existe rota de administrador para criar um.

Revisar um pedido

Registra a decisão sobre um pedido: aprovado, rejeitado, aplicado (a mudança já foi feita) ou de volta a pendente. Grava quem revisou e quando.

POST/api/v1/admin/whatsapp/flow-requests/{id}/reviewAdmin

Registra a decisão sobre um pedido de mudança

Parâmetros de caminho

iduuidobrigatório
Id do pedido.

Corpo da requisição

statusstringobrigatório
approvedrejectedappliedpending
Nova decisão. Obrigatório.
admin_notesstring
Observação para o seller. Cada revisão substitui a anterior, inclusive apagando-a se omitida.

Exemplo de requisição (Revisar um pedido)

bash
curl -X POST "$BASE_URL/api/v1/admin/whatsapp/flow-requests/1be48fc0-0376-453c-942d-4847d2c20a21/review" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "approved",
    "admin_notes": "Vamos incluir na próxima revisão."
  }'

Resposta (Revisar um pedido)

200Pedido revisado
json
{
  "id": "1be48fc0-0376-453c-942d-4847d2c20a21",
  "vendor_id": "9d9d9d56-eb43-4719-889d-055632f7c7da",
  "flow_id": "00d2a290-8dd8-4583-8f43-271461e01dfd",
  "title": "Adicionar etapa de cupom",
  "description": "Perguntar se o cliente tem cupom antes de fechar o pedido.",
  "status": "approved",
  "created_by": "a1a25b87-5e32-4439-b3df-f98eb03b6434",
  "created_at": "2026-10-11T21:59:32.462039Z",
  "updated_at": "2026-10-11T21:59:32.462039Z",
  "admin_notes": "Vamos incluir na próxima revisão.",
  "reviewed_by": "a1a25b87-5e32-4439-b3df-f98eb03b6434",
  "reviewed_at": "2026-10-11T22:10:00Z"
}

Campos da resposta

iduuid
Identificador do pedido de mudança.
vendor_iduuid
Seller que pediu.
flow_iduuid
Fluxo a que o pedido se refere. Ausente quando não informado.
titlestring
Título do pedido.
descriptionstring
Detalhes do que o seller quer mudar.
statusstring
pendingapprovedrejectedapplied
Estado do pedido.
admin_notesstring
Observação do administrador. Ausente se não houver.
created_byuuid
Usuário que abriu o pedido.
reviewed_byuuid
Administrador que revisou. Ausente enquanto pendente.
reviewed_atstring
Quando foi revisado (RFC 3339). Ausente enquanto pendente.
created_atstring
Criação (RFC 3339, UTC).
updated_atstring
Última alteração (RFC 3339, UTC).

Erros (Revisar um pedido)

StatusQuandoCorpo
400Corpo que não é JSON, status inválido, pedido inexistente ou id que não é UUID.{"error":"invalid status \"x\""} ou {"error":"sql: no rows in result set"}
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O módulo WhatsApp Commerce está desligado na loja, o usuário não é administrador ou não tem o privilégio exigido.{"error":"module_disabled","module":"whatsapp-commerce"} ou {"error":"insufficient privileges","required":"manage_settings"} ou {"error":"admin access required"}
Aprovar não altera o fluxo

A revisão só muda o estado do pedido. Quem aplica a mudança é você, editando o fluxo; depois marque o pedido como applied.

Garantir um fluxo próprio para um seller

Se o seller ainda não tem um fluxo seu, instala nele o pacote "Varejo B2C completo" (um conjunto pronto de fluxos). Se já tem um fluxo ativo próprio, devolve o id dele sem criar nada. Útil logo depois de conectar o número do seller.

POST/api/v1/admin/whatsapp/vendors/{vendor_id}/ensure-flowAdmin

Garante que o seller tenha um fluxo próprio

Parâmetros de caminho

vendor_iduuidobrigatório
Id do seller.

Exemplo de requisição (Garantir fluxo do seller)

bash
curl -X POST "$BASE_URL/api/v1/admin/whatsapp/vendors/9d9d9d56-eb43-4719-889d-055632f7c7da/ensure-flow" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Garantir fluxo do seller)

200Fluxo do seller
json
{
  "flow_id": "fa4b0c91-2883-43c6-94ef-86e5b540a2aa",
  "vendor_id": "9d9d9d56-eb43-4719-889d-055632f7c7da"
}

Campos da resposta

flow_iduuid
O fluxo do seller (existente ou recém-criado).
vendor_iduuid
O seller.

Erros (Garantir fluxo do seller)

StatusQuandoCorpo
400vendor_id que não é UUID, módulo desligado ou falha ao instalar.{"error":"..."}
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O módulo WhatsApp Commerce está desligado na loja, o usuário não é administrador ou não tem o privilégio exigido.{"error":"module_disabled","module":"whatsapp-commerce"} ou {"error":"insufficient privileges","required":"manage_settings"} ou {"error":"admin access required"}
Não duplica depois da primeira vez

O pacote instalado é um fluxo ativo do seller. Chamadas seguintes encontram esse fluxo e só devolvem o id. Se o fluxo próprio for desativado ou apagado, uma nova chamada instala outro.

Veja também

  • Pacotes de experiência
  • Criar e alterar fluxos
Anterior
Sessões de fluxo
Próxima
Pacotes de experiência
Nesta página
  • Listar pedidos de mudança
  • Exemplo de requisição (Listar pedidos)
  • Resposta (Listar pedidos)
  • Erros (Listar pedidos)
  • Revisar um pedido
  • Exemplo de requisição (Revisar um pedido)
  • Resposta (Revisar um pedido)
  • Erros (Revisar um pedido)
  • Garantir um fluxo próprio para um seller
  • Exemplo de requisição (Garantir fluxo do seller)
  • Resposta (Garantir fluxo do seller)
  • Erros (Garantir fluxo do seller)
  • Veja também