Pular para o conteúdo principal

Enviar atualização de status do pedido

Método#

/order-status-update#

POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/order-status-update

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Conceituação#

Neste método você poderá enviar mensagens de atualização de status dos pedidos enviados.

image


Importante

Este método está disponível apenas para contas Business do whatsapp.


Atributos#

Obrigatórios#

AtributosTipoDescrição
phonestringTelefone do destinatário no formato DDI DDD NÚMERO Ex: 551199999999. IMPORTANTE Envie somente números, sem formatação ou máscara
messageIdstringId do whatsapp da mensagem original do pedido
referenceIdstringId de referência do pedido (retornado no webhook)
orderRequestIdstringId de referência da requisição do pedido (retornado no webhook)
orderStatusstringNovo status do pedido (pending, processing, shipped, completed, canceled)
paymentStatusstringStatus atual do pagamento (pending, paid) (retornado no webhook)
orderobjectInformações do pedido a ser enviado

Object (order)

AtributosTipoDescrição
currencystringCódigo da moeda
productsarray objectInformações dos produtos relacionados ao pedido

Object (products)

AtributosTipoDescrição
productIdstringId do produto (retornado no webhook)
namestringNome do produto
valuenumberValor do produto
quantitynumberQuantidade
isCustomItembooleanInforma se é um produto customizado na hora do envio (retornado no webhook)

Opcionais#

AtributosTipoDescrição
messagestringTexto da mensagem

Object (order)

AtributosTipoDescrição
discountnumberValor de desconto
taxnumberValor de imposto
shippingnumberValor 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

{
"phone": "554499999999",
"messageId": "3EB0F91BBA791BB0A787FC",
"message": "Mensagem de texto da atualização do pedido",
"referenceId": "4N8FCTW1WM6",
"orderRequestId": "4N8FCTW22W4",
"orderStatus": "processing",
"paymentStatus": "pending",
"order": {
"currency": "BRL",
"discount": 10,
"tax": 10,
"shipping": 5,
"products": [
{
"value": 150,
"quantity": 2,
"name": "order 1",
"isCustomItem": true,
"productId": "custom-item-4N8FCTW23N7"
},
{
"productId": "23940797548900636",
"value": 150,
"quantity": 2,
"name": "order 2",
"isCustomItem": false
}
]
}
}
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#

AtributosTipoDescrição
zaapIdstringid no z-api
messageIdstringid no whatsapp
idstringAdicionado para compatibilidade com zapier, ele tem o mesmo valor do messageId

Exemplo

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

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)

Webhook


Code#