Estado del pedido

Last update: 4 days ago by Irais Aguirre

Resumen para integración
Endpoint: POST https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging
Token: de mensajería, en el encabezado Authorization: Bearer {{wa-msg-api-token}} (cómo generarlo)
Campos comunes: from, to (teléfono o BSUID) y type (detalle)
Valores de type en esta página: "interactive"
Respuesta: la misma para todos los mensajes (ver respuesta)

Mensaje interactivo de estado del pedido (order_status). Todos se envían con POST /v1/messaging; los encabezados (Encabezados), los campos comunes y la respuesta (Respuesta) están en Conexión HTTP.

Estado del pedido

Después de enviar los detalles del pedido, se puede notificar al comprador los cambios en el estado del pedido y del pago (por ejemplo, pago capturado o pedido enviado) usando el mismo reference_id. El campo type debe ser "interactive" y el contenido va en el objeto order_status con la acción "review_order".

Cuerpo

Campos de Estado del pedido:

Nombre	Descripción	Tipo	Requerimientos
from	Teléfono (con código de país) del que se enviará el mensaje.	String	Obligatorio
to	Teléfono del destinatario en formato E.164, sin el signo +. También acepta el BSUID del usuario, por ejemplo, US.13491208655302741918.	String	Obligatorio
type	Tipo de mensaje. Debe ser "interactive".	String	Obligatorio
order_status	Objeto que contiene el contenido del mensaje y el nuevo estado del pedido.	Objeto	Obligatorio

Objeto order status

Nombre	Descripción	Tipo	Requerimientos
body	Texto principal del mensaje.	String	Obligatorio
footer	Texto del pie del mensaje.	String	Opcional
action	Objeto que contiene la acción y sus parámetros.	Objeto	Obligatorio

Objeto action order status

Nombre	Descripción	Tipo	Requerimientos
name	Nombre de la acción. Debe ser "review_order".	String	Obligatorio
parameters	Objeto con la referencia y el nuevo estado del pedido.	Objeto	Obligatorio

Objeto parameters order status

Nombre	Descripción	Tipo	Requerimientos
reference_id	Identificador del pedido. Debe ser el mismo reference_id enviado en los detalles del pedido.	String	Obligatorio
order.status	Estado del pedido. Los valores pueden ser: pending processing partially_shipped shipped completed canceled	String	Obligatorio si se envía order
order.description	Descripción del estado del pedido.	String	Opcional Máximo 120 caracteres.
payment.status	Estado del pago. Los valores pueden ser: pending captured failed	String	Obligatorio si se envía payment
payment.timestamp	Fecha del pago en formato Unix timestamp.	Number	Opcional

Ejemplo

Ejemplo completo de Estado del pedido:

Petición HTTP con estado del pedido y del pago

curl -X POST 'https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging' \
-H 'Authorization: Bearer {{wa-msg-api-token}}' \
-H 'Content-Type: application/json' \
-d '{
    "from": "5511900000001",
    "to": "5511900000002",
    "type": "interactive",
    "order_status": {
        "body": "Seu pagamento foi confirmado e o pedido está sendo preparado.",
        "footer": "Obrigado pela sua compra",
        "action": {
            "name": "review_order",
            "parameters": {
                "reference_id": "link-br-full-001",
                "order": {
                    "status": "processing",
                    "description": "Pedido em preparação"
                },
                "payment": {
                    "status": "captured",
                    "timestamp": 1762300800
                }
            }
        }
    }
}'

Whatsapp — Anterior

Detalles del pedido y pago

Siguiente — Whatsapp

Plantillas de pago