Evolution V2
Fetch collections
Fetches the catalog collections for a business WhatsApp number.
POST
/
business
/
getCollections
/
{instance}
Fetch collections
curl --request POST \
--url https://pilotstatus.com.br/api/layer/evolution-v2/business/getCollections/{instance} \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"number": "5511999999999",
"limit": 20
}
'import requests
url = "https://pilotstatus.com.br/api/layer/evolution-v2/business/getCollections/{instance}"
payload = {
"number": "5511999999999",
"limit": 20
}
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({number: '5511999999999', limit: 20})
};
fetch('https://pilotstatus.com.br/api/layer/evolution-v2/business/getCollections/{instance}', 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://pilotstatus.com.br/api/layer/evolution-v2/business/getCollections/{instance}",
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([
'number' => '5511999999999',
'limit' => 20
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <api-key>"
],
]);
$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://pilotstatus.com.br/api/layer/evolution-v2/business/getCollections/{instance}"
payload := strings.NewReader("{\n \"number\": \"5511999999999\",\n \"limit\": 20\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apikey", "<api-key>")
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://pilotstatus.com.br/api/layer/evolution-v2/business/getCollections/{instance}")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"number\": \"5511999999999\",\n \"limit\": 20\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/api/layer/evolution-v2/business/getCollections/{instance}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"number\": \"5511999999999\",\n \"limit\": 20\n}"
response = http.request(request)
puts response.read_body{
"wuid": "5511999999999@s.whatsapp.net",
"name": "Loja Exemplo",
"numberExists": true,
"isBusiness": true,
"collectionsLength": 1,
"collections": [
{
"id": "434823429384756",
"name": "Lançamentos",
"status": "APPROVED",
"products": [
{
"id": "6104474702914109",
"name": "Camiseta Pilot Status",
"description": "Camiseta 100% algodão, edição limitada.",
"price": 7990,
"currency": "BRL",
"retailerId": "SKU-TSHIRT-001",
"url": "https://loja.exemplo.com.br/camiseta",
"isHidden": false,
"availability": "in stock",
"imageUrls": {
"requested_image_size": "https://mmg.whatsapp.net/v/t45.5328-4/prod1_thumb.jpg"
},
"reviewStatus": {
"whatsapp": "APPROVED"
}
}
]
}
]
}{
"status": 400,
"error": "Bad Request",
"message": "Invalid payload"
}Authorizations
Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.
Path Parameters
The number's display name in the Pilot Status dashboard.
Body
application/json
Response
Success — provider-native response body.
Product collections fetched from a WhatsApp Business account.
Resolved WhatsApp JID of the queried business number.
Whether the queried number exists on WhatsApp.
Whether the number is a WhatsApp Business account.
Number of collections returned in the collections array.
List of catalog collections.
Show child attributes
Show child attributes
Display name associated with the queried number, if available.
Was this page helpful?
⌘I
Fetch collections
curl --request POST \
--url https://pilotstatus.com.br/api/layer/evolution-v2/business/getCollections/{instance} \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"number": "5511999999999",
"limit": 20
}
'import requests
url = "https://pilotstatus.com.br/api/layer/evolution-v2/business/getCollections/{instance}"
payload = {
"number": "5511999999999",
"limit": 20
}
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({number: '5511999999999', limit: 20})
};
fetch('https://pilotstatus.com.br/api/layer/evolution-v2/business/getCollections/{instance}', 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://pilotstatus.com.br/api/layer/evolution-v2/business/getCollections/{instance}",
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([
'number' => '5511999999999',
'limit' => 20
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <api-key>"
],
]);
$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://pilotstatus.com.br/api/layer/evolution-v2/business/getCollections/{instance}"
payload := strings.NewReader("{\n \"number\": \"5511999999999\",\n \"limit\": 20\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apikey", "<api-key>")
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://pilotstatus.com.br/api/layer/evolution-v2/business/getCollections/{instance}")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"number\": \"5511999999999\",\n \"limit\": 20\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/api/layer/evolution-v2/business/getCollections/{instance}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"number\": \"5511999999999\",\n \"limit\": 20\n}"
response = http.request(request)
puts response.read_body{
"wuid": "5511999999999@s.whatsapp.net",
"name": "Loja Exemplo",
"numberExists": true,
"isBusiness": true,
"collectionsLength": 1,
"collections": [
{
"id": "434823429384756",
"name": "Lançamentos",
"status": "APPROVED",
"products": [
{
"id": "6104474702914109",
"name": "Camiseta Pilot Status",
"description": "Camiseta 100% algodão, edição limitada.",
"price": 7990,
"currency": "BRL",
"retailerId": "SKU-TSHIRT-001",
"url": "https://loja.exemplo.com.br/camiseta",
"isHidden": false,
"availability": "in stock",
"imageUrls": {
"requested_image_size": "https://mmg.whatsapp.net/v/t45.5328-4/prod1_thumb.jpg"
},
"reviewStatus": {
"whatsapp": "APPROVED"
}
}
]
}
]
}{
"status": 400,
"error": "Bad Request",
"message": "Invalid payload"
}