Send a WhatsApp multi-product (cart) list message
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/whatsapp/catalog/send-list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"to": "<string>",
"catalog_id": "<string>",
"sections": [
{
"title": "<string>",
"product_retailer_ids": [
"<string>"
]
}
],
"body": "Browse our products",
"header": "<string>",
"footer": "<string>",
"waba_id": "<string>",
"phone_number_id": "<string>"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/whatsapp/catalog/send-list"
payload = {
"to": "<string>",
"catalog_id": "<string>",
"sections": [
{
"title": "<string>",
"product_retailer_ids": ["<string>"]
}
],
"body": "Browse our products",
"header": "<string>",
"footer": "<string>",
"waba_id": "<string>",
"phone_number_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
to: '<string>',
catalog_id: '<string>',
sections: [{title: '<string>', product_retailer_ids: ['<string>']}],
body: JSON.stringify('Browse our products'),
header: '<string>',
footer: '<string>',
waba_id: '<string>',
phone_number_id: '<string>'
})
};
fetch('https://api.orbit.devotel.io/api/v1/whatsapp/catalog/send-list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/whatsapp/catalog/send-list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'to' => '<string>',
'catalog_id' => '<string>',
'sections' => [
[
'title' => '<string>',
'product_retailer_ids' => [
'<string>'
]
]
],
'body' => 'Browse our products',
'header' => '<string>',
'footer' => '<string>',
'waba_id' => '<string>',
'phone_number_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/whatsapp/catalog/send-list"
payload := strings.NewReader("{\n \"to\": \"<string>\",\n \"catalog_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_retailer_ids\": [\n \"<string>\"\n ]\n }\n ],\n \"body\": \"Browse our products\",\n \"header\": \"<string>\",\n \"footer\": \"<string>\",\n \"waba_id\": \"<string>\",\n \"phone_number_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/whatsapp/catalog/send-list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"to\": \"<string>\",\n \"catalog_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_retailer_ids\": [\n \"<string>\"\n ]\n }\n ],\n \"body\": \"Browse our products\",\n \"header\": \"<string>\",\n \"footer\": \"<string>\",\n \"waba_id\": \"<string>\",\n \"phone_number_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/whatsapp/catalog/send-list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"to\": \"<string>\",\n \"catalog_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_retailer_ids\": [\n \"<string>\"\n ]\n }\n ],\n \"body\": \"Browse our products\",\n \"header\": \"<string>\",\n \"footer\": \"<string>\",\n \"waba_id\": \"<string>\",\n \"phone_number_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAPI Reference
Send a WhatsApp multi-product (cart) list message
Sends an interactive multi-product message presenting several catalog SKUs grouped into titled sections. The recipient adds items to their WhatsApp cart and checks out in-thread; the resulting order arrives on the inbound order webhook. Sibling of POST /api/v1/whatsapp/catalog/send (single product).
POST
/
api
/
v1
/
whatsapp
/
catalog
/
send-list
Send a WhatsApp multi-product (cart) list message
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/whatsapp/catalog/send-list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"to": "<string>",
"catalog_id": "<string>",
"sections": [
{
"title": "<string>",
"product_retailer_ids": [
"<string>"
]
}
],
"body": "Browse our products",
"header": "<string>",
"footer": "<string>",
"waba_id": "<string>",
"phone_number_id": "<string>"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/whatsapp/catalog/send-list"
payload = {
"to": "<string>",
"catalog_id": "<string>",
"sections": [
{
"title": "<string>",
"product_retailer_ids": ["<string>"]
}
],
"body": "Browse our products",
"header": "<string>",
"footer": "<string>",
"waba_id": "<string>",
"phone_number_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
to: '<string>',
catalog_id: '<string>',
sections: [{title: '<string>', product_retailer_ids: ['<string>']}],
body: JSON.stringify('Browse our products'),
header: '<string>',
footer: '<string>',
waba_id: '<string>',
phone_number_id: '<string>'
})
};
fetch('https://api.orbit.devotel.io/api/v1/whatsapp/catalog/send-list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/whatsapp/catalog/send-list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'to' => '<string>',
'catalog_id' => '<string>',
'sections' => [
[
'title' => '<string>',
'product_retailer_ids' => [
'<string>'
]
]
],
'body' => 'Browse our products',
'header' => '<string>',
'footer' => '<string>',
'waba_id' => '<string>',
'phone_number_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/whatsapp/catalog/send-list"
payload := strings.NewReader("{\n \"to\": \"<string>\",\n \"catalog_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_retailer_ids\": [\n \"<string>\"\n ]\n }\n ],\n \"body\": \"Browse our products\",\n \"header\": \"<string>\",\n \"footer\": \"<string>\",\n \"waba_id\": \"<string>\",\n \"phone_number_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/whatsapp/catalog/send-list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"to\": \"<string>\",\n \"catalog_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_retailer_ids\": [\n \"<string>\"\n ]\n }\n ],\n \"body\": \"Browse our products\",\n \"header\": \"<string>\",\n \"footer\": \"<string>\",\n \"waba_id\": \"<string>\",\n \"phone_number_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/whatsapp/catalog/send-list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"to\": \"<string>\",\n \"catalog_id\": \"<string>\",\n \"sections\": [\n {\n \"title\": \"<string>\",\n \"product_retailer_ids\": [\n \"<string>\"\n ]\n }\n ],\n \"body\": \"Browse our products\",\n \"header\": \"<string>\",\n \"footer\": \"<string>\",\n \"waba_id\": \"<string>\",\n \"phone_number_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
BearerApiKey
Dashboard JWT token from Clerk
Body
application/json
Recipient phone number in E.164 format.
Minimum string length:
1Meta product catalog ID the SKUs belong to.
Minimum string length:
1One or more titled product sections.
Minimum array length:
1Show child attributes
Show child attributes
Message body text.
Minimum string length:
1Optional header text (max 60 chars).
Maximum string length:
60Optional footer text (max 60 chars).
Maximum string length:
60Optional WABA selector for multi-WABA orgs. Defaults to the org's default connection when omitted.
Minimum string length:
1Optional sender phone number ID for multi-WABA orgs.
Minimum string length:
1Response
200
Default Response
⌘I