Catalog Messages

1. Catalog Template Message

A catalog template is a WhatsApp message that shows off your products. It has a product photo, some text you write about it, plus a fixed title and subtitle from WhatsApp. It also has a "View catalog" button — when tapped, your full product catalog opens right inside WhatsApp, so customers can browse without leaving the chat.

Create Template Sample

{
  "name": "<TEMPLATE_NAME>",
  "language": "<LANGUAGE_CODE>",
  "category": "MARKETING",
  "components": [
    {
      "type": "BODY",
      "text": "Now shop for your favorite products right here on WhatsApp! Get Rs {{1}} off on all orders above {{2}}Rs! Valid for your first {{3}} orders placed on WhatsApp!",
      "example": {
        "body_text": [
          [
            "100",
            "400",
            "3"
          ]
        ]
      }
    },
    {
      "type": "FOOTER",
      "text": "Best grocery deals on WhatsApp!"
    },
    {
      "type": "BUTTONS",
      "buttons": [
        {
          "type": "CATALOG",
          "text": "View catalog"
        }
      ]
    }
  ]
}

Template Message Sample

{
  "to": "<USER_PHONE_NUMBER>",
  "type": "template",
  "template": {
    "name": "<TEMPLATE_NAME>",
    "language": {
      "code": "<LANGUAGE_CODE>"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "100"
          },
          {
            "type": "text",
            "text": "400"
          },
          {
            "type": "text",
            "text": "3"
          }
        ]
      },
      {
        "type": "button",
        "sub_type": "CATALOG",
        "index": 0,
        "parameters": [
          {
            "type": "action",
            "action": {
              "thumbnail_product_retailer_id": "<PRODUCT_RETAILER_ID>"
            }
          }
        ]
      }
    ]
  }
}

Interactive Message Sample

{
  "to": "<USER_PHONE_NUMBER>",
  "type": "interactive",
  "interactive": {
    "type": "catalog_message",
    "body": {
      "text": "Hello! Thanks for your interest. Ordering is easy. Just visit our catalog and add items to purchase."
    },
    "action": {
      "name": "catalog_message",
      "parameters": {
        "thumbnail_product_retailer_id": "<PRODUCT_RETAILER_ID>"
      }
    },
    "footer": {
      "text": "Best grocery deals on WhatsApp!"
    }
  }
}

2. Single Product Template Message

SPM (Single Product Message) templates let you show one product from your online catalog in a WhatsApp message, complete with a picture, product name, price, and your own custom text. Users can tap a button to view the product, then add or remove it from their WhatsApp cart. When they place an order, you get notified automatically, and the user gets a confirmation with an option to view their order details.

Create Template Sample

{
  "name": "<TEAMPLTE_NAME>",
  "language": "<LANGUAGE_CODE>",
  "category": "marketing",
  "parameter_format": "named",
  "components": [
    {
      "type": "header",
      "format": "product"
    },
    {
      "type": "body",
      "text": "Use code {{code}} to get {{percent}} off our newest succulent!",
      "example": {
        "body_text_named_params": [
          {
            "param_name": "code",
            "example": "15OFF"
          },
          {
            "param_name": "percent",
            "example": "15%"
          }
        ]
      }
    },
    {
      "type": "footer",
      "text": "Offer ends September 22, 2024"
    },
    {
      "type": "buttons",
      "buttons": [
        {
          "type": "spm",
          "text": "View"
        }
      ]
    }
  ]
}

Template Message Sample

{
  "to": "<USER_PHONE_NUMBER>",
  "type": "template",
  "template": {
    "name": "<TEMPLATE_NAME>",
    "language": {
      "code": "<LANGUAGE_CODE>"
    },
    "components": [
      {
        "type": "header",
        "parameters": [
          {
            "type": "product",
            "product": {
              "product_retailer_id": "<PRODUCT_RETAILER_ID>",
              "catalog_id": "<CATALOG_ID>"
            }
          }
        ]
      },
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "parameter_name": "code",
            "text": "25OFF"
          },
          {
            "type": "text",
            "parameter_name": "percent",
            "text": "25%"
          }
        ]
      }
    ]
  }
}

Interactive Message Sample

{
  "to": "<USER_PHONE_NUMBER>",
  "type": "interactive",
  "interactive": {
    "type": "product",
    "body": {
      "text": "BODY_TEXT"
    },
    "footer": {
      "text": "FOOTER_TEXT"
    },
    "action": {
      "catalog_id": "<CATALOG_ID>",
      "product_retailer_id": "<PRODUCT_RETAILER_ID>"
    }
  }
}

3. Multi Product Template Message

Multi-Product Message templates are marketing templates that display up to 30 products from your ecommerce catalog, organized in up to 10 sections, in a single message.

An MPM template message with its header image, header text, body text, and View items button, alongside the item list view organized into sections.

WhatsApp users can browse products and sections within the message, view product details, and add, or remove, products from their cart. They then submit the cart to place an order, and WhatsApp sends you each order via a webhook.

Create Template Sample

{
  "name": "<TEMPLATE_NAME>",
  "language": "<LANGUAGE_CODE>",
  "category": "MARKETING",
  "components": [
    {
      "type": "HEADER",
      "format": "TEXT",
      "text": "Forget something, {{1}}?",
      "example": {
        "header_text": [
          "Pablo"
        ]
      }
    },
    {
      "type": "BODY",
      "text": "Looks like you left these items in your cart, still interested? Use code {{1}} to get 10% off!",
      "example": {
        "body_text": [
          [
            "10OFF"
          ]
        ]
      }
    },
    {
      "type":"BUTTONS",
      "buttons": [
        {
          "type": "MPM",
          "text": "View items"
        }
      ]
    }
  ]
}

Template Message Sample

{
  "to": "<USER_PHONE_NUMBER>",
  "type": "template",
  "template": {
    "name": "<TEMPLATE_NAME>",
    "language": {
      "code": "<LANGUAGE_CODE>"
    },
    "components": [
      {
        "type": "header",
        "parameters": [
          {
            "type": "text",
            "text": "Pablo"
          }
        ]
      },
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "10OFF"
          }
        ]
      },
      {
        "type": "button",
        "sub_type": "mpm",
        "index": 0,
        "parameters": [
          {
            "type": "action",
            "action": {
              "thumbnail_product_retailer_id": "<PRODUCT_RETAILER_ID>",
              "sections": [
                {
                  "title": "Popular Bundles",
                  "product_items": [
                    {
                      "product_retailer_id": "<PRODUCT_RETAILER_ID>"
                    },
                    {
                      "product_retailer_id": "<PRODUCT_RETAILER_ID>"
                    }
                  ]
                },
                {
                  "title": "Premium Packages",
                  "product_items": [
                    {
                      "product_retailer_id": "<PRODUCT_RETAILER_ID>"
                    }
                  ]
                }
              ]
            }
          }
        ]
      }
    ]
  }
}

Interactive Message Sample

{
    "to": "<USER_PHONE_NUMBER>",
    "type": "interactive",
    "interactive": {
        "type": "product_list",
        "header": {
            "type": "text",
            "text": "HEADER_CONTENT"
        },
        "body": {
            "text": "BODY_CONTENT"
        },
        "footer": {
            "text": "FOOTER_CONTENT"
        },
        "action": {
            "catalog_id": "<CATALOG_ID>",
            "sections": [
                {
                    "title": "SECTION_TITLE",
                    "product_items": [
                        {
                            "product_retailer_id": "<PRODUCT_RETAILER_ID>"
                        },
                        {
                            "product_retailer_id": "<PRODUCT_RETAILER_ID>"
                        }
                    ]
                },
                {
                    "title": "SECTION_TITLE",
                    "product_items": [
                        {
                            "product_retailer_id": "<PRODUCT_RETAILER_ID>"
                        },
                        {
                            "product_retailer_id": "<PRODUCT_RETAILER_ID>"
                        }
                    ]
                }
            ]
        }
    }
}

4. Product Card Carousel Template Message

Product card carousel templates let you send a text message along with up to 10 scrollable product cards. When a WhatsApp user taps "View" on any card, they can see more product details, add it to their cart, and complete an order — all without ever leaving WhatsApp.

Coupon Code Template Preview

Product Cards

Carousel templates support up to 10 product cards, composed of message body text, a product image, product title, product price, and a single View button or URL button. All cards defined on a template must have the same components.

View Buttons

Tapping the button opens the product details, showing info pulled straight from your catalog. From there, the user can add the product to their cart and place an order. Once they submit the cart, a webhook fires to notify you of the order, and the user sees an order confirmation message in the chat. They can also tap "View details" anytime afterward to check what they ordered.

Create Template Sample

{
  "name": "<TEMPLATE_NAME",
  "language": "<LANGUAGE_CODE>",
  "category": "marketing",
  "components": [
    {
      "type": "body",
      "text": "Rare succulents for sale! {{1}}, add these unique plants to your collection. All three of these rare succulents are available for purchase on our website, and they come with a 100% satisfaction guarantee. Whether you're a seasoned succulent enthusiast or just starting your plant collection, these rare succulents are sure to impress. Shop now and add some unique and beautiful plants to your collection!",
      "example": {
        "body_text": "Pablo"
      }
    },
    {
      "type": "carousel",
      "cards": [
        {
          "components": [
            {
              "type": "header",
              "format": "product"
            },
            {
              "type": "buttons",
              "buttons": [
                {
                  "type": "spm",
                  "text": "View"
                }
              ]
            }
          ]
        },
        {
          "components": [
            {
              "type": "header",
              "format": "product"
            },
            {
              "type": "buttons",
              "buttons": [
                {
                  "type": "spm",
                  "text": "View"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Teamplate Message Sample

{
  "to": "<USER_PHONE_NUMBER>",
  "type": "template",
  "template": {
    "name": "<TEMPLATE_NAME>",
    "language": {
      "code": "<LANGUAGE_CODE>"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "Pablo"
          }
        ]
      },
      {
        "type": "carousel",
        "cards": [
          {
            "card_index": 0,
            "components": [
              {
                "type": "header",
                "parameters": [
                  {
                    "type": "product",
                    "product": {
                      "product_retailer_id": "<PRODUCT_RETAILER_ID>",
                      "catalog_id": "<CATALOG_ID>"
                    }
                  }
                ]
              }
            ]
          },
          {
            "card_index": 1,
            "components": [
              {
                "type": "header",
                "parameters": [
                  {
                    "type": "product",
                    "product": {
                      "product_retailer_id": "<PRODUCT_RETAILER_ID>",
                      "catalog_id": "<CATALOG_ID>"
                    }
                  }
                ]
              }
            ]
          },
          {
            "card_index": 2,
            "components": [
              {
                "type": "header",
                "parameters": [
                  {
                    "type": "product",
                    "product": {
                      "product_retailer_id": "<PRODUCT_RETAILER_ID>",
                      "catalog_id": "<CATALOG_ID>"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Interactive Message Sample

{
  "to": "<USER_PHONE_NUMBER>",
  "type": "interactive",
  "interactive": {
    "type": "carousel",
    "body": {
      "text": "Check out our featured products!"
    },
    "action": {
      "cards": [
        {
          "card_index": 0,
          "type": "product",
          "action": {
            "product_retailer_id": "<PRODUCT_RETAILER_ID>",
            "catalog_id": "<CATALOG_ID>"
          }
        },
        {
          "card_index": 1,
          "type": "product",
          "action": {
            "product_retailer_id": "<PRODUCT_RETAILER_ID>",
            "catalog_id": "<CATALOG_ID>"
          }
        }
      ]
    }
  }
}

1. Catalog Template Message#

Create Template Sample#

Template Message Sample#

Interactive Message Sample#

2. Single Product Template Message#

Create Template Sample#

Template Message Sample#

Interactive Message Sample#

3. Multi Product Template Message#

Create Template Sample#

Template Message Sample#

Interactive Message Sample#

4. Product Card Carousel Template Message#

Product Cards#

View Buttons#

Create Template Sample#

Teamplate Message Sample#

Interactive Message Sample#

1. Catalog Template Message

Create Template Sample

Template Message Sample

Interactive Message Sample

2. Single Product Template Message

Create Template Sample

Template Message Sample

Interactive Message Sample

3. Multi Product Template Message

Create Template Sample

Template Message Sample

Interactive Message Sample

4. Product Card Carousel Template Message

Product Cards

View Buttons

Create Template Sample

Teamplate Message Sample

Interactive Message Sample