Mensagem de Pedido

O tipo ORDER representa uma mensagem estruturada de pedido/compra. É primariamente recebido (inbound): quando um cliente seleciona produtos do catálogo do WhatsApp Business e envia o pedido, você recebe um webhook ORDER. Também pode ser enviado para confirmações de pedido, resumos de compra e notificações de e-commerce.

Payload

{
  "channelId": "uuid-do-canal",
  "content": {
    "type": "ORDER",
    "to": {
      "type": "WHATSAPP",
      "number": "5511999999999"
    },
    "orderId": "PED-2026-00789",
    "itemCount": 3,
    "totalAmount1000": 15990,
    "totalCurrencyCode": "BRL",
    "text": "Obrigado pela sua compra! Seu pedido esta sendo preparado.",
    "items": [
      {
        "name": "Camiseta Azul M",
        "quantity": 2,
        "price": 4990,
        "currency": "BRL",
        "imageUrl": "https://cdn.suaempresa.com/produtos/camiseta-azul.jpg"
      },
      {
        "name": "Calca Jeans 42",
        "quantity": 1,
        "price": 6010,
        "currency": "BRL",
        "imageUrl": "https://cdn.suaempresa.com/produtos/calca-jeans.jpg"
      }
    ]
  }
}

Campos

string

required

Deve ser "ORDER".

Address

required

Endereço do destinatário. Veja formatos de endereço.

string

Identificador do pedido. Exibido ao destinatário.

integer

Número total de itens no pedido.

long

Valor total do pedido em milésimos da unidade monetária. Veja a seção de valores abaixo.

string

Código da moeda no formato ISO 4217 (ex: BRL, USD, EUR).

string

Texto adicional da mensagem de pedido.

string

Imagem de preview do pedido em Base64 (JPEG).

array

Lista de itens do pedido.

Campos de cada item

string

Nome do produto/item.

integer

Quantidade do item.

long

Preço unitário do item em milésimos da unidade monetária.

string

Código da moeda do item (ex: BRL).

string

URL da imagem do produto.

Valores em Milésimos

Os campos de valor (totalAmount1000, price) usam milésimos como unidade. O valor é multiplicado por 1.000 (mil) em relação ao valor na unidade monetária.Para converter: valor monetário x 1.000 = valor no campo (ou campo / 1.000 = valor real).

Valor Real	Valor no Campo	Cálculo
R$ 15,99	`15990`	15,99 x 1.000
R$ 49,90	`49900`	49,90 x 1.000
R$ 1,00	`1000`	1,00 x 1.000
R$ 0,50	`500`	0,50 x 1.000
R$ 199,90	`199900`	199,90 x 1.000

Exemplos

Pedido completo

curl -X POST https://api-dev.messagefy.io/api/v1/message/SendMessage \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: sua-api-key-aqui" \
  -d '{
    "channelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "correlationId": "pedido-789",
    "content": {
      "type": "ORDER",
      "to": {
        "type": "WHATSAPP",
        "number": "5511999999999"
      },
      "orderId": "PED-2026-00789",
      "itemCount": 3,
      "totalAmount1000": 89800,
      "totalCurrencyCode": "BRL",
      "text": "Pedido confirmado! Previsao de entrega: 3 dias uteis.",
      "items": [
        {
          "name": "Tenis Esportivo 41",
          "quantity": 1,
          "price": 59900,
          "currency": "BRL",
          "imageUrl": "https://cdn.suaempresa.com/produtos/tenis-esportivo.jpg"
        },
        {
          "name": "Meia Esportiva (par)",
          "quantity": 2,
          "price": 14950,
          "currency": "BRL",
          "imageUrl": "https://cdn.suaempresa.com/produtos/meia-esportiva.jpg"
        }
      ]
    }
  }'

import requests

response = requests.post(
    "https://api-dev.messagefy.io/api/v1/message/SendMessage",
    headers={
        "Content-Type": "application/json",
        "X-API-KEY": "sua-api-key-aqui"
    },
    json={
        "channelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "correlationId": "pedido-789",
        "content": {
            "type": "ORDER",
            "to": {
                "type": "WHATSAPP",
                "number": "5511999999999"
            },
            "orderId": "PED-2026-00789",
            "itemCount": 3,
            "totalAmount1000": 89800,
            "totalCurrencyCode": "BRL",
            "text": "Pedido confirmado! Previsao de entrega: 3 dias uteis.",
            "items": [
                {
                    "name": "Tenis Esportivo 41",
                    "quantity": 1,
                    "price": 59900,
                    "currency": "BRL",
                    "imageUrl": "https://cdn.suaempresa.com/produtos/tenis-esportivo.jpg"
                },
                {
                    "name": "Meia Esportiva (par)",
                    "quantity": 2,
                    "price": 14950,
                    "currency": "BRL",
                    "imageUrl": "https://cdn.suaempresa.com/produtos/meia-esportiva.jpg"
                }
            ]
        }
    }
)
print(response.json())

const response = await fetch(
  "https://api-dev.messagefy.io/api/v1/message/SendMessage",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "X-API-KEY": "sua-api-key-aqui",
    },
    body: JSON.stringify({
      channelId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      correlationId: "pedido-789",
      content: {
        type: "ORDER",
        to: {
          type: "WHATSAPP",
          number: "5511999999999",
        },
        orderId: "PED-2026-00789",
        itemCount: 3,
        totalAmount1000: 89800,
        totalCurrencyCode: "BRL",
        text: "Pedido confirmado! Previsao de entrega: 3 dias uteis.",
        items: [
          {
            name: "Tenis Esportivo 41",
            quantity: 1,
            price: 59900,
            currency: "BRL",
            imageUrl:
              "https://cdn.suaempresa.com/produtos/tenis-esportivo.jpg",
          },
          {
            name: "Meia Esportiva (par)",
            quantity: 2,
            price: 14950,
            currency: "BRL",
            imageUrl:
              "https://cdn.suaempresa.com/produtos/meia-esportiva.jpg",
          },
        ],
      },
    }),
  }
);
const data = await response.json();
console.log(data);

Pedido simples sem itens detalhados

{
  "channelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "content": {
    "type": "ORDER",
    "to": {
      "type": "WHATSAPP",
      "number": "5511999999999"
    },
    "orderId": "PED-2026-00456",
    "itemCount": 5,
    "totalAmount1000": 245000,
    "totalCurrencyCode": "BRL",
    "text": "Resumo do seu pedido: 5 itens no total de R$ 245,00. Aguardando pagamento."
  }
}

Use o campo correlationId no Package para vincular o pedido ao seu sistema interno. Isso facilita o rastreamento quando você receber webhooks de status da mensagem.

Resposta

{
  "packageId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Recebimento

Quando um cliente monta um pedido a partir do catálogo do WhatsApp Business e o envia, você recebe um webhook com content.type igual a ORDER. O content traz os mesmos campos do envio (orderId, itemCount, totalAmount1000, totalCurrencyCode, text, thumbnail, items[]), acrescido do envelope comum de mensagem recebida (from, to, messageId, etc.).

string

Identificador único do pedido no WhatsApp.

integer

Quantidade total de itens no pedido.

long

Valor total do pedido em milésimos. Divida por 1.000 para obter o valor real (ex: 13500 = R$ 135,00).

string

Código da moeda (ex: BRL, USD).

string

Mensagem opcional enviada pelo cliente junto ao pedido. Pode vir vazia.

string

Thumbnail do pedido em Base64 (JPEG).

array

Lista de produtos do pedido.

string

Nome do produto.

integer

Quantidade solicitada.

long

Preço unitário em milésimos. Divida por 1.000 para obter o valor real (ex: 8500 = R$ 8,50).

string

Código da moeda do item (ex: BRL).

string

URL da imagem do produto no StorageFy. Veja a nota abaixo sobre disponibilidade.

Address

Endereço de quem enviou o pedido. Veja formatos de endereço.

string

Identificador da mensagem no WhatsApp.

Os demais campos do envelope (packageId, channelId, correlationId, timestamp, providerMetadata) e os campos comuns de mensagem (isFromMe, isGroupMessage, isForwarded, isStatusMessage, isHistoryMessage, isBroadcast, isAnnounceGroup, isCommunityNotices, isNewsletter, quotedMessage, metaReferralAds) estão descritos em Recebendo Mensagens.

Exemplo de payload recebido

{
  "packageId": "019d3bff-efb4-7566-9901-cfb29dde3ed5",
  "channelId": "019d3bfd-d884-71d4-b162-218d70dee00f",
  "correlationId": null,
  "content": {
    "type": "ORDER",
    "orderId": "1895184554485465",
    "itemCount": 3,
    "totalAmount1000": 13500,
    "totalCurrencyCode": "BRL",
    "text": "",
    "thumbnail": "/9j/4AAQSkZJRgABAQAA...",
    "items": [
      {
        "name": "Garrafa de agua",
        "quantity": 2,
        "price": 2500,
        "currency": "BRL",
        "imageUrl": "https://storage-dev.messagefy.io/api/v1/files/download-external/abc123"
      },
      {
        "name": "Refrigerante",
        "quantity": 1,
        "price": 8500,
        "currency": "BRL",
        "imageUrl": "https://storage-dev.messagefy.io/api/v1/files/download-external/def456"
      }
    ],
    "from": {
      "type": "WHATSAPP",
      "jid": "554298002650@s.whatsapp.net",
      "lid": "28209462644963@lid",
      "number": "554298002650",
      "name": "Cliente"
    },
    "to": {
      "type": "WHATSAPP",
      "jid": "554288706357@s.whatsapp.net",
      "number": "554288706357",
      "name": "Minha Loja"
    },
    "messageId": "3A8BEC9A4AF0FC7264AE",
    "isFromMe": false,
    "isGroupMessage": false,
    "isForwarded": false,
    "isStatusMessage": false,
    "deliveryStrategy": 0,
    "priority": 0,
    "timestamp": "2026-03-29T23:48:42+00:00"
  },
  "timestamp": "2026-03-29T23:48:42.0366555+00:00",
  "providerMetadata": null
}

Imagens dos produtos: as URLs em items[].imageUrl são presigned URLs do StorageFy. Quando o pedido chega, as imagens ainda podem estar em processamento. Um evento DOWNLOAD_AVAILABLE é enviado para cada imagem assim que ela fica pronta — o campo externalDownloadUrl do DOWNLOAD_AVAILABLE corresponde ao imageUrl do item.

Início

Contas

API Keys

Canais

WhatsApp Oficial

Tipos de Mensagem

Operações de Mensagem

Sessão e Conexão

Consultas

Interação

Mensagem de Pedido

Mensagem de Pedido

Payload

Campos

Campos de cada item

Valores em Milésimos

Exemplos

Pedido completo

Pedido simples sem itens detalhados

Resposta

Recebimento

Exemplo de payload recebido

​Mensagem de Pedido

​Payload

​Campos

​Campos de cada item

​Valores em Milésimos

​Exemplos

​Pedido completo

​Pedido simples sem itens detalhados

​Resposta

​Recebimento

​Exemplo de payload recebido

Mensagem de Pedido

Payload

Campos

Campos de cada item

Valores em Milésimos

Exemplos

Pedido completo

Pedido simples sem itens detalhados

Resposta

Recebimento

Exemplo de payload recebido