Enviar pedido
Método#
/send-order#
POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/send-order
Header#
| Key | Value |
|---|---|
| Client-Token | TOKEN DE SEGURANÇA DA CONTA |
Conceituação#
Neste método você poderá enviar mensagens de pedidos, contendo produtos do seu catálogo ou customizados no momento do envio.
Importante
Este método está disponível apenas para contas Business do whatsapp.
Atributos#
Obrigatórios#
| Atributos | Tipo | Descrição |
|---|---|---|
| phone | string | Telefone do destinatário no formato DDI DDD NÚMERO Ex: 551199999999. IMPORTANTE Envie somente números, sem formatação ou máscara |
| order | object | Informações do pedido a ser enviado |
Object (order)
| Atributos | Tipo | Descrição |
|---|---|---|
| currency | string | Código da moeda |
| products | array object | Informações dos produtos relacionados ao pedido |
Object (products)
| Atributos | Tipo | Descrição |
|---|---|---|
| name | string | Nome do produto |
| value | number | Valor do produto |
| quantity | number | Quantidade |
Opcionais#
Object (order)
| Atributos | Tipo | Descrição |
|---|---|---|
| discount | number | Valor de desconto |
| tax | number | Valor de imposto |
| shipping | number | Valor de frete |
Object (products)
| Atributos | Tipo | Descrição |
|---|---|---|
| productId | string | Id do produto do catálogo |
Request Body#
Incluindo parâmetros opcionais#
Apenas parâmetros obrigatórios#
Dica
Ao enviar um produto na lista "products" sem o atributo "productId", isso é caracterizado como um produto "customizado". Ele recebe um id para ser utilizado no contexto desse pedido, o qual é retornado no webhook de ReceivedCallback e deve ser utilizado para as atualizações de status do pedido.
Response#
200#
| Atributos | Tipo | Descrição |
|---|---|---|
| zaapId | string | id no z-api |
| messageId | string | id no whatsapp |
| id | string | Adicionado para compatibilidade com zapier, ele tem o mesmo valor do messageId |
Exemplo
405#
Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no inicio 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"
Webhook Response#
Link para a response do webhook (ao receber)