Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-order
Enviar pedido
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/send-order \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "order": {
    "currency": "<string>",
    "products": [
      {
        "name": "<string>",
        "value": 123,
        "quantity": 123,
        "productId": "<string>"
      }
    ],
    "discount": 123,
    "tax": 123,
    "shipping": 123
  }
}
'

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Neste método você poderá enviar mensagens de pedidos, contendo produtos do seu catálogo ou customizados no momento do envio. Esta mensagem é a mesma que é enviada quando você clica no botão “Aceitar pedido” ou “Enviar cobrança”.
Disponível apenas para contas business do WhatsApp. Produtos sem productId são tratados como itens customizados.

​
Exemplo no WhatsApp

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Obrigatórios

​
phone
string
obrigatório
Telefone do destinatário no formato DDI DDD NÚMERO. Ex: 551199999999
​
order
object
obrigatório
Dados do pedido

​
Opcionais

​
paymentSettings
object
Configurações de pagamento

​
Request Body

Com produtos do catálogo e pagamento: 
{
  "phone": "554499999999",
  "order": {
    "currency": "BRL",
    "discount": 10,
    "tax": 10,
    "shipping": 5,
    "products": [
      {
        "productId": "23940797548900636",
        "name": "Nome do produto",
        "value": 10,
        "quantity": 2
      }
    ]
  },
  "paymentSettings": {
    "pix": {
      "key": "Chave PIX",
      "keyType": "cpf",
      "name": "Nome da chave"
    },
    "card": {
      "enabled": true
    }
  }
}
Apenas campos obrigatórios (produto customizado): 
{
  "phone": "554499999999",
  "order": {
    "currency": "BRL",
    "products": [
      {
        "name": "Nome do produto",
        "value": 150,
        "quantity": 1
      }
    ]
  }
}

​
Response

​
200

{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.