Help Center
API DocsVisit our website
English(en)
English(en)
  • Welcome to YCloud Docs
  • 🆙Update Log
  • 🚀Quick Start
    • Create a WhatsApp Business API Account
    • Send Verification Code via WhatsApp
    • Send Utility Messages via WhatsApp
    • Acquire More Customers (CTWA)
    • Marketing via WhatsApp
    • Customer Support via WhatsApp
  • ✅WhatsApp Basics
    • WhatsApp Business Account (WABA)
    • WhatsApp Account Structure
    • Phone Numbers
    • Messages
    • Message Templates
      • Authentication Message Templates
        • Copy Verification Code Authentication Template
        • One-Click Autofill Authentication Template
        • Zero-Click Authentication Template
      • Catalog Template
      • Carousel Template
      • Coupon Code Template
      • Location Request Template
      • Limited-Time Offer Template
      • Multi-Product Message Template
    • WhatsApp Flows
      • Create WhatsApp Flows
      • Send WhatsApp Flows
      • Analyse WhatsApp Flows
    • Business Verification
    • Green Tick Verification
    • Compliance Information
      • Opt-in to Subscribe to WhatsApp
      • Opt-out of Unsubscribing from WhatsApp
  • 💡WhatsApp Accounts Management
    • Create a WhatsApp API Account
      • Create WABA via Embedded Sign-up
      • Add Numbers
      • Number Migration
    • Template Management
      • Create Template
        • Create WhatsApp Flows Template
        • Create WhatsApp Pay Template
        • AI generates marketing templates
      • Copy Template
      • Template Data Statistics
    • Phone Number Management
      • Phone Number Nickname Settings
      • Phone Number Profile Settings
      • Conversation Assignment Rules
      • Automation
      • Bot Reception Settings
      • Chat Links
    • Account Disabling and Handling
    • Data Analysis
  • 📫Inbox
    • Inbox Introduction
    • Quick start with Inbox
    • Admin Guide
    • Agent/Sale Guide
    • Initiate New Chat
    • Company Canned Response
    • Conversation Tags
    • Conversation Logs
    • Message Translation
    • Inbox Data Analysis
    • Inbox Mobile Client
    • Best Practices
      • How Sales Teams Use Inbox
      • How Service Teams Use Inbox
  • 📘Contact
    • Contact Management
    • Create/Import Contacts
    • Contact Grouping
    • Bulk Operations
    • Unsubscribe List
    • Contact Settings
      • Contact Attribute Settings
      • Contact Tag Settings
      • Contact Event
    • Owner Assignment Settings (Agent/Sales Assignment)
  • 🎯Campaign
    • Create a WhatsApp Marketing Campaign
    • Track Button Clicks
    • Analyze Campaign Data
  • 🧩Journey
    • Journey Introduction
    • Create a Journey
    • Components and Features Introduction
      • Trigger
      • Send Template
      • Message Status Rule
      • Add Tag
      • Wait
    • Journey Best Practice
  • 🤖Chatbot
    • What is Chatbot
    • Create a Chatbot
    • Create a Flow
    • Chatbot Components
      • Trigger
      • Ask a Question
      • Send Messages
      • Agent Takeover
      • Unsubscribe
      • Branch
      • Send Shopify orders
    • Chatbot AI
    • Analyse Chatbot Data
    • Best Practices
      • Automatically Add Customers to Unsubscribe List
  • 📢CTWA (Click to WhatsApp Ad)
    • CTWA Introduction
    • Connect Facebook Ad Account
    • Create Click to WhatsApp Ad (CTWA)
    • Receive CTWA Visitors
    • CTWA Analysis
    • Conversion API (CAPI)
  • 🛒Shop
    • Shop Overview
    • Install Shop
    • Shipping Settings
    • Payment Settings
    • Product
    • Order
  • 💰WhatsApp pay
    • Overview
    • Link Your Payment Account
    • Send order detail & checkout button tmessage
    • Update order status
  • 🔌Integrations
    • Channels
      • Global SMS
        • Getting Started
        • SMS Basic Principles
        • SMS Features
          • API Interface
          • SMPP
          • Mass Messaging
          • Sender ID
      • Verify
        • Getting Started
        • Verification Features
          • Verification Message Templates
          • Security Settings
          • Verification Analysis
          • Custom OTP
        • Best Practices for Verification
          • Best Practices
          • Verification Channel Selection
          • Verification via WhatsApp
          • Preventing Fraud and Invalid Registrations
      • Email
        • Getting Started
        • Basic Principles
        • Email Features
          • Domain Configuration
          • Sending Emails via API
          • Monitoring and Optimization
        • Best Practices for Email
          • Separate Marketing Subdomain
          • Warm-up Sending
    • Coupons
      • Coupon Tool Usage
    • E-commerce
      • Shopify
        • Checkout abandon
        • COD order confirmation
        • Order canceled/fulfilled
        • Shopify Best Practice
    • MM Lite API
    • Freshdesk
  • ⚙️Account Management
    • Enterprise Account Information
    • Users and Teams
    • Personal Preferences Settings
    • Security and Privacy
  • 💰Pricing and Billing
    • WhatsApp Conversation Billing Rules
    • Amount Freezing and Unfreezing
    • Billing and Recharge
    • Low Balance Alert
    • Subscription Expiration and 15-day Buffer Period
  • 👐Partnership
    • Partner Documentation
  • 🆘Support
    • YCloud Support Team
    • Meta Support
    • Frequently Asked Questions
Powered by GitBook
On this page
  • Before updating the order status
  • Order status enumeration value
  • How to notify customers about changes in order status?
  • Create order status update template
  • Send Order status updates message

Was this helpful?

  1. WhatsApp pay

Update order status

PreviousSend order detail & checkout button tmessageNextChannels

Last updated 5 months ago

Was this helpful?

Before updating the order status

Before updating the order status, make sure the order has been paid. YCloud will push you the paid status via this .

You will receive updates when the status of the user-initiated transaction changes. It occurs when the payment status changes to captured (when the payment is successfully completed), or pending (when the user attempts but has yet to receive a successful transaction signal).

Sample:

{
  "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"
        }
      }
    ]
  }
}

Order status enumeration value

Value
Description

pending

User has not successfully paid yet

processing

User payment authorized, merchant/partner is fulfilling the order, performing service, etc.

partially-shipped

A portion of the products in the order have been shipped by the merchant

shipped

All the products in the order have been shipped by the merchant

completed

The order is completed and no further action is expected from the user or the partner/merchant

canceled

The partner/merchant would like to cancel the order_details message for the order/invoice. The status update will fail if there is already a successful or pending payment for this order_details message

How to notify customers about changes in order status?

You can notify customers by sending an Order Status Updates template when an order is comfirmed or shipped.

e.g. When an order has been shipped, you can send an Order Status Updates template to the customer, informing them about the updated status.

Create order status update template

The prerequisite is that you have linked your payment account.

  1. Create via api

  1. Create on YCloud

Send Order status updates message

example:

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>"
              }
            }
          }
        ]
      }
    ]
  }
}'

api doc:

create example:

Visit

api:

💰
webhook
https://docs.ycloud.com/reference/whatsapp_template-create
https://docs.ycloud.com/reference/whatsapp-template-creation-examples#order-status-template
https://www.ycloud.com/console/#/app/dashboard/template
https://docs.ycloud.com/reference/whatsapp_message-send-directly