> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ycloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Atualizar status do pedido

## Antes de atualizar o status do pedido

Antes de atualizar o status do pedido, **certifique-se de que o pedido foi pago**. A YCloud enviará o status de pago a você por meio deste [webhook](/pt/api-reference/webhooks/test-webhooks). 

Você receberá atualizações quando o status da transação iniciada pelo usuário for alterado. Isso ocorre quando o status do pagamento muda para `captured` (quando o pagamento é concluído com sucesso) ou `pending` (quando o usuário tenta, mas ainda não recebeu um sinal de transação bem-sucedida).

Exemplo:

```
{
  "id": "evt_eEkn26qar3nOB8md",
  "type": "whatsapp.payment.updated",
  "apiVersion": "v2",
  "createTime": "2024-10-10T07:08:00.000Z",
  "whatsappPayment": {
    "wabaId": "WABA-ID",
    "referenceId": "<reference-id>",
    "status": "captured | pending",
    "transactions": [
      {
        "id": "<transaction-id>",
        "type": "billdesk | payu | razorpay | zaakpay",
        "status": "pending | success | failed",
        "createdTimestamp": 1728544066000,
        "updatedTimestamp": 1728544066000,
        "amount": {
          "value": 21000,
          "offset": 100
        },
        "currency": "INR",
        "methodType": "upi | card | wallet | netbanking",
        "error": {
          "code": "error-code",
          "reason": "error-reason"
        }
      }
    ]
  }
}
```

## Valores de enumeração do status do pedido

| Valor | Descrição |
| - | - |
| `pending` | O usuário ainda não pagou com sucesso |
| `processing` | Pagamento do usuário autorizado, o comerciante/parceiro está atendendo ao pedido, prestando o serviço, etc. |
| `partially-shipped` | Uma parte dos produtos do pedido foi enviada pelo comerciante |
| `shipped` | Todos os produtos do pedido foram enviados pelo comerciante |
| `completed` | O pedido foi concluído e nenhuma ação adicional é esperada do usuário ou do parceiro/comerciante |
| `canceled` | O parceiro/comerciante gostaria de cancelar a mensagem `order_details` para o pedido/fatura. A atualização do status falhará se já houver um pagamento `successful` ou `pending` para esta mensagem `order_details` |

<img src="https://mintcdn.com/lchnan/WD-ixrYVrqB7b7aQ/product-assets/3be4b91634-image-596.webp?fit=max&auto=format&n=WD-ixrYVrqB7b7aQ&q=85&s=a91122cebfd41c2afbedd93da2cf01f3" alt="Captura de tela do produto YCloud" width="765" height="307" data-path="product-assets/3be4b91634-image-596.webp" />

## Como notificar os clientes sobre alterações no status do pedido?

Você pode notificar os clientes enviando um modelo de Atualizações de Status do Pedido quando um pedido for confirmado ou enviado.

Por exemplo: quando um pedido for enviado, você pode enviar um modelo de **Order Status Updates** ao cliente, informando-o sobre o status atualizado.

### Criar modelo de atualização de status do pedido

<Info>
  O pré-requisito é que você tenha vinculado sua conta de pagamento.
</Info>

1. Criar via API

Referência da API: [Criar um modelo](/api-reference/whatsapp-templates/create-a-template)

Exemplo de criação: [Criar um modelo](/api-reference/whatsapp-templates/create-a-template)

2. Criar na YCloud

Acesse [https://www.ycloud.com/console/#/app/dashboard/template](https://www.ycloud.com/console/#/app/dashboard/template)

<img src="https://mintcdn.com/lchnan/6CxA7mK2t7klNAOL/product-assets/9b7f2f2c98-image-597.webp?fit=max&auto=format&n=6CxA7mK2t7klNAOL&q=85&s=69883deedf4517a575e99109af6fa9d9" alt="Captura de tela do produto YCloud" width="1592" height="827" data-path="product-assets/9b7f2f2c98-image-597.webp" />

### Enviar mensagem de atualizações de status do pedido

Referência da API: [Enviar uma mensagem diretamente](/api-reference/whatsapp-messages/send-a-message-directly)

Exemplo:

```
curl 'https://api.ycloud.com/v2/whatsapp/messages/sendDirectly' \
-H 'Content-Type: application/json' \
-H 'X-API-Key: {{YOUR-API-KEY}}' \
-d '{
  "from": "{{BUSINESS-PHONE-NUMBER}}",
  "to": "{{CUSTOMER-PHONE-NUMBER}}",
  "type": "template",
  "template": {
    "name": "order_status_template",
    "language": {
      "policy": "deterministic",
      "code": "en_US"
    },
    "components": [
      {
        "type": "order_status",
        "parameters": [
          {
            "type": "order_status",
            "order_status": {
              "reference_id": "<reference_id_value>",
              "order": {
                "status": "processing | partially_shipped | shipped | completed | canceled",
                "description": "<OPTIONAL_DESCRIPTION>"
              }
            }
          }
        ]
      }
    ]
  }
}'
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.