# Product Card Carousel Templates {% hint style="info" %} Product Card Carousel Templates are only available while using Cloud API. {% endhint %} Product Card Carousel templates allow you to send a single text message (1), accompanied by a set of up to 10 carousel cards (2) in a horizontally scrollable view. From January 2024, in addition to the mobile device experience, users can now view Carousel messages seamlessly on the WhatsApp Web Client.
#### SPM (View Button) You can add the SPM button to your Product Card Carousel Template and users can tap it to see details about the product, and can add or remove the product from the WhatsApp shopping cart. See more details in [Single-Product Message Templates (View Button) ](https://docs.360dialog.com/partner/messaging/template-messages/single-product-message-templates)

Example Product Card Carrousel with View Button

#### URL Buttons Instead of **View** buttons you may wish to use **URL** buttons. When a WhatsApp user taps a URL button to buy a product, the URL is loaded in the device's default web browser, taking the user out of the WhatsApp client experience. This can be useful if, for example, you wish to load the product in your checkout page where users can add promo codes and find related products.

Example Product Card Carrousel with URL Button

#### Carousel Cards Carousel templates support up to 10 carousel cards. Cards must have a media header (image or video) and can optionally include body text and up to 2 [quick reply buttons, phone number buttons, or URL buttons](https://docs.360dialog.com/partner/messaging/template-messages/..#buttons-1) or[ SPM buttons](https://docs.360dialog.com/partner/messaging/template-messages/single-product-message-templates) (button types can be mixed). The media header format and buttons must be the same across all cards that make up a carousel template. Media assets will be cropped to a wide ratio based on the customer's device. #### Catalogs To use product card carousel templates, you must have an ecommerce[ product catalog](https://docs.360dialog.com/partner/messaging/commerce-and-payments/products-and-catalogs), with inventory, connected to your WhatsApp Business Account. #### Webhooks If you send a carousel template composed of product cards that use a **View** button, when a customer adds one or more products to their cart and submits an order, you will receive a webhook that [describes the order](https://docs.360dialog.com/partner/onboarding/webhook-events-and-setup/webhook-events-partner-and-messaging-api#order-messages). With URL button flows, since order placement happens outside of the WhatsApp, webhooks [describing the order](https://docs.360dialog.com/partner/onboarding/webhook-events-and-setup/webhook-events-partner-and-messaging-api#order-messages) are not triggered. ### Creating Product Card Carousel Templates Use the create template [endpoint](https://app.gitbook.com/s/-M4sMxKjL6eJRvZn6jeG-887967055/messaging-api/api-reference/templates#post-v1-configs-templates) to create the Product Card Carousel Template. **Headers** | Name | Type | Description | | ------------ | ------ | ----------- | | D360-API-KEY | string | | Once your template is approved, you can send it in a template message. #### Post Body It is only necessary to define two product cards upon template creation. An approved template with two product cards can be used to send up to 10 cards in a template message. ```json { "name": "", "language": "", "category": "marketing", "components": [ { "type": "body", "text": "", "example": { "body_text": [ [ "", "" ] ] } }, { "type": "carousel", "cards": [ /* First product card */ { "components": [ { "type": "header", "format": "product" }, /* Supports 1 button only, can be either an SPM button or URL button */ { "type": "buttons", "buttons": [ /* SPM button */ { "type": "spm", "text": "View" } /* URL button */ { "type": "url", "text": "", "url": "", "example": [ "" ] } ] } ] }, /* Second product card would follow, using same structure as first card. It is only necessary to define two cards. */ ] } ] } ``` #### Properties
PlaceholderDescriptionExample Value

<MESSAGE_BODY_TEXT>

String

Required.

Message bubble text string. Supports variables.

Maximum 1024 characters.

Summer is here, and we've got the freshest produce around! Use code {{1}} to get {{2}} off your next order.

<MESSAGE_BODY_TEXT_VARIABLE_EXAMPLE>

String

Required if the message body text string uses variables.

Message body text example variable string(s).

Number of strings must match the number of variable placeholders in the message body text string.

If message body text uses a single variable, body_text value can be a string, otherwise it must be an array containing an array of strings.

"15OFF","15%"

<TEMPLATE_LANGUAGE>

Enum

Required.

Template language and locale code.

en_US

<TEMPLATE_NAME>

String

Required.

Template name.

Maximum 512 characters.

summer_carousel_promo_2023

<URL_BUTTON_LABEL_TEXT>

String

Required if using a URL button.

URL button label text.

25 characters maximum.

Buy now

<URL_BUTTON_URL>

String

Required if using a URL button.

URL of website that loads in the device's default mobile web browser when the URL button is tapped by the app user.

Supports 1 variable, appended to the end of the URL string.

Maximum 2000 characters.

https://www.luckyshrub.com/shop?promo={{1}}

<URL_BUTTON_VAR_EXAMPLE>

String

Required if using a URL button.

URL of website. Supports 1 variable.

If using a variable, add sample variable property to the end of the URL string. The URL loads in the device's default mobile web browser when the customer taps the URL button.

Maximum 2000 characters.

https://www.luckyshrub.com/shop?promo=summer_lemons_2023
#### **Example Request** ```json { "name": "template_name", "language": "en", "category": "MARKETING", "components": [{ "type": "BODY", "text": "Rare succulents for sale! {{1}}, add these unique 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" } ] } ] }, { "components": [{ "type": "HEADER", "format": "PRODUCT" }, { "type": "buttons", "buttons": [ { "type": "spm", "text": "View" } ] } ] } ] } ] } ``` #### Example Response ```json { "category": "MARKETING", "components": [ //Array of Components ], "external_id": "11987839xxxxxxxx", "id": "dDJN6HNxxxxxxxxxxxxxWT", "language": "en", "name": "template_name", "namespace": "ed620b19_xxxx_xxxx_xxxx_670f20036e2b", "rejected_reason": null, "status": "submitted" } ``` ## Sending Product Card Carousel Templates Once your carousel template is approved, you can use the Cloud API to send it in a Product Card Carousel Template Message. `POST` `https://waba-v2.360dialog.io/messages` #### Request Body | Name | Type | Description | | ------------------ | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | | messaging\_product | string |

Required only for Cloud API.
Messaging service used for the request. Use "whatsapp".

| | recipient\_type | string | individual | | to | string | Recipient phone number | | type | string | template | | name | string | Template name | | language | string | Template language | | code | string | Language code | | components | Your template components array |

Required.

Assemble your payload similar to the structure of the template you created.

| {% hint style="warning" %} It is only possible to send Templates with an Active status. A message template's status can change automatically from **Active** to **Paused** or **Disabled** based on feedback from customers. For this reason, we recommend that you [monitor status changes](#monitoring-status-changes) to take appropriate actions whenever a message template that you rely upon becomes, or is in danger of becoming, paused or disabled. {% endhint %} #### Example with SPM View Button ```json { "messaging_product": "whatsapp", "recipient_type": "individual", "to": "phone_number", "type": "template", "template": { "name": "template_name", "language": { "code": "en" }, "components": [ { "type": "body", "parameters": [ { "type": "text", "text": "Pablo" } ] }, { "type": "carousel", "cards": [ { "card_index": 0, "components": [ { "type": "header", "parameters": [ { "type": "product", "product": { "product_retailer_id": "osb5529j3w", "catalog_id": "419472613037220" } } ] } ] }, { "card_index": 1, "components": [ { "type": "header", "parameters": [ { "type": "product", "product": { "product_retailer_id": "huhn", "catalog_id": "419472613037220" } } ] } ] }, { "card_index": 2, "components": [ { "type": "header", "parameters": [ { "type": "product", "product": { "product_retailer_id": "best_product_ever", "catalog_id": "419472613037220" } } ] } ] } ] } ] } } ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.360dialog.com/partner/messaging/template-messages/product-card-carousel-templates.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.