Send order details template message

Updated: Jun 30, 2026

Overview

Order details message template is a template with interactive components that extends the call-to-action button to support sending order details, letting you display itemized orders, totals, and payment options that templates with only text components cannot.

Once you create and approve your order details message templates, you can use the approved template to send the template message with order or bill information to prompt customers to make a payment.

Before sending an order details template message, create a template with an "order details" call-to-action button. See Create Message Templates for Your WhatsApp Business account⁠ for more information on prerequisites and how to create a template.

Creating an order details template on WhatsApp Manager

To create an order details template, you need a business portfolio with a WhatsApp Business account.

In WhatsApp Manager > Account tools:

• Click Create template.
• Select Utility or Marketing category to see the Order details template format option.
• Select Order details template format, and click Next
• Enter the desired template name and supported locale
  • Depending on the number of locales selected there will be an equal number of template variants and you fill in the template details in the respective locale.
• Fill in template components such as Header, Body, and optional footer text.
  • For the Header, you can choose one of three media types: Text, Image or Document. Choose Document if you want to send PDF files in the header of this template.
• Click submit.
• Once submitted, templates will be categorized as per the guidelines and undergo the approval process.
• The system approves or rejects the template after verifying its components.
  • If you believe the assigned category is not consistent with the template category guidelines, confirm there are no common issues that leads to rejections and if you are looking for further clarification you may request a review of the template via Business Support⁠
• Once approved template status will be changed to ACTIVE
  • A template's status can change automatically from ACTIVE to PAUSED or DISABLED based on customer feedback and engagement. Monitor status changes and take appropriate action whenever such a change occurs.

Creating an order details template using template creation APIs

To create a template through API and understand the general syntax, required categories and components please refer to templates API. All the guidelines outlined above in creating templates apply through API as well.

Order details template can be categorized as "Utility" or "Marketing" template and apart from 'name' and 'language' of choice, the template has general template components such as HEADER, BODY, FOOTER, and a fixed BUTTON with "ORDER_DETAILS" type.

The category must be UTILITY or MARKETING, and the header format must be TEXT, IMAGE, or DOCUMENT.

Endpoint

POST /{WHATSAPP_BUSINESS_ACCOUNT_ID}/message_templates

Request body

{  
  "name": "<TEMPLATE_NAME>",  
  "language": "<LANGUAGE_CODE>",  
  "category": "<CATEGORY>",  
  "display_format": "ORDER_DETAILS",  
  "components": [  
    {  
      "type": "HEADER",  
      "format": "<FORMAT>",  
      "text": "<HEADER_TEXT>"  
    },  
    {  
      "type": "BODY",  
      "text": "<BODY_TEXT>"  
    },  
    {  
      "type": "FOOTER",  
      "text": "<FOOTER_TEXT>"  
    },  
    {  
      "type": "BUTTONS",  
      "buttons": [  
        {  
          "type": "ORDER_DETAILS",  
          "text": "<COPY_PIX_CODE>"  
        }  
      ]  
    }  
  ]  
}

Sending order details template message

Order details template message allows the businesses to send invoice (order_details) message as predefined order details call-to-action button component parameters. The order details template message supports businesses to send all payment integration (such as Dynamic Pix code, Payment Links, Boleto, and so on) integration as button parameters.

To send an order details template message, make a POST call to /PHONE_NUMBER_ID/messages endpoint and attach a message object with type=template. Then, add a template object with a predefined order details call-to-action button.

The following image shows an example of an order details template message rendered in WhatsApp, with itemized products, payment options, and call-to-action buttons.

You can optionally include a PDF file as an attachment in the header component of the template message. To do so, you use type=document in the parameter object of the header component object, as described in the Components document.

For example, the following sample describes how to send Copy Pix code in order details template message parameters to prompt the consumer to make a payment.

Endpoint

POST /{PHONE_NUMBER_ID}/messages

Request body

{  
  "messaging_product": "whatsapp",  
  "recipient_type": "individual",  
  "to": "<PHONE_NUMBER>",  
  "type": "template",  
  "template": {  
    "name": "<TEMPLATE_NAME>",  
    "language": {  
      "policy": "deterministic",  
      "code": "<LANGUAGE_AND_LOCALE_CODE>"  
    },  
    "components": [  
      {  
        "type": "button",  
        "sub_type": "order_details",  
        "index": 0,  
        "parameters": [  
          {  
            "type": "action",  
            "action": {  
              "order_details": {  
                "reference_id": "<UNIQUE_REFERENCE_ID>",  
                "type": "digital-goods",  
                "payment_type": "br",  
                "payment_settings": [  
                  {  
                    "type": "pix_dynamic_code",  
                    "pix_dynamic_code": {  
                      "code": "00020101021226700014br.gov.bcb.pix2548pix.example.com...",  
                      "merchant_name": "Account holder name",  
                      "key": "39580525000189",  
                      "key_type": "CNPJ"  
                    }  
                  }  
                ],  
                "currency": "BRL",  
                "total_amount": {  
                  "value": 50000,  
                  "offset": 100  
                },  
                "order": {  
                  "status": "pending",  
                  "tax": {  
                    "value": 0,  
                    "offset": 100,  
                    "description": "optional text"  
                  },  
                  "items": [  
                    {  
                      "retailer_id": "1234567",  
                      "name": "Cake",  
                      "amount": {  
                        "value": 50000,  
                        "offset": 100  
                      },  
                      "quantity": 1  
                    }  
                  ],  
                  "subtotal": {  
                    "value": 50000,  
                    "offset": 100  
                  }  
                }  
              }  
            }  
          }  
        ]  
      }  
    ]  
  }  
}

Once the order details template message is delivered, a successful response includes an object with an identifier prefixed with wamid. Use the ID listed after wamid to track your message status.

{  
    "messaging_product": "whatsapp",  
    "contacts": [  
        {  
            "input": "<PHONE_NUMBER>",  
            "wa_id": "<WHATSAPP_ID>"  
        }  
    ],  
    "messages": [  
        {  
            "id": "wamid.ID"  
        }  
    ]  
}

Post order details template message flow

After the order details template message delivery the rest of the payment flow is the same as "Sending invoice in customer session window" and depends on the chosen payment integration order details parameters.