vértice
Produto Preços Painel
Mensagens

Enviar pedido detalhado

Protocolo nativo pela sessão conectada, sem serviço externo.

API key Escopo write
Exemplo de requisição
curl -X POST "https://seu-dominio/instances/:id/messages/order-details" \
  -H "x-api-key: $VERTICE_API_KEY" \
  -H "content-type: application/json" \
  -d '{"to":"5511999999999","text":"Pedido","referenceId":"pedido-1","currency":"BRL","items":[{"id":"sku-1","name":"Produto","amount100":2300,"quantity":1}]}'
POST /instances/{id}/messages/order-details
API key
Entenda

Conceituação

Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64. Valores amount100/tax100/shipping100/discount100 são inteiros em centavos; totais calculados com precisão. Não confirma pagamento.

A operação exige que a instância esteja conectada ao WhatsApp. Caso o socket esteja desconectado, a API responde 409 not_connected.

Corpo JSON. Os campos abaixo são exemplos; campos marcados como obrigatórios precisam ser enviados.
Contrato

Atributos

Header

x-api-key string obrigatório

API key do workspace (vtc_live_...). Também aceita Authorization: Bearer.

content-type string obrigatório

application/json.

Path

id string obrigatório

ID da instância.

Body

to string opcional

Telefone com DDI e DDD, ou JID de grupo terminando em @g.us.

text string opcional

Corpo da mensagem. Respeite o limite de 65.536 caracteres.

referenceId string opcional

Campo referenceId do corpo JSON.

currency string opcional

Campo currency do corpo JSON.

items array<object> opcional

Campo items do corpo JSON.

Payload

Request Body

{
  "to": "5511999999999",
  "text": "Pedido",
  "referenceId": "pedido-1",
  "currency": "BRL",
  "items": [
    {
      "id": "sku-1",
      "name": "Produto",
      "amount100": 2300,
      "quantity": 1
    }
  ]
}
Contrato

Resposta

200
{
  "data": {
    "ok": true
  }
}

Respostas de sucesso são envelopadas em data.

Erros comuns

400 Corpo, query ou parâmetro inválido. A resposta traz error.code e error.message.
401 Credencial ausente, inválida ou sessão expirada.
403 Escopo insuficiente, IP não autorizado ou workspace suspenso.
404 Recurso não encontrado ou pertence a outro workspace.
409 Instância não conectada ou conflito de estado.