Enviar atualização de pagamento do pedido
Método#
/order-payment-update#
POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/order-payment-update
Header#
| Key | Value |
|---|---|
| Client-Token | TOKEN DE SEGURANÇA DA CONTA |
Conceituação#
Neste método você poderá enviar mensagens de atualização do pagamento dos pedidos enviados.
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 |
| messageId | string | Id do whatsapp da mensagem original do pedido |
| referenceId | string | Id de referência do pedido (retornado no webhook) |
| orderRequestId | string | Id de referência da requisição do pedido (retornado no webhook) |
| orderStatus | string | Status atual do pedido (pending, processing, shipped, completed, canceled) (retornado no webhook) |
| paymentStatus | string | Novo status do pagamento (pending, paid) |
| 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 |
|---|---|---|
| productId | string | Id do produto (retornado no webhook) |
| name | string | Nome do produto |
| value | number | Valor do produto |
| quantity | number | Quantidade |
| isCustomItem | boolean | Informa se é um produto customizado na hora do envio (retornado no webhook) |
Opcionais#
| Atributos | Tipo | Descrição |
|---|---|---|
| message | string | Texto da mensagem |
Object (order)
| Atributos | Tipo | Descrição |
|---|---|---|
| discount | number | Valor de desconto |
| tax | number | Valor de imposto |
| shipping | number | Valor de frete |
Request Body#
Atenção
É necessário enviar na requisição todos os dados previamente informados no envio do pedido, com a inclusão de alguns parâmetros adicionais obrigatórios, os quais são retornados no webhook
Dica
É possível notar que o produto com o atributo "isCustomItem" com o valor true, tem um id com o prefixo "custom-item". Isso ocorre quando ao enviar um pedido não é informado nenhum id de produto, ou seja, o whatsapp assume que é um produto customizado. Esse id é retornado no webhook e é um parâmetro obrigatório, juntamente com o "isCustomItem", para atualizações 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)