Criar coleção
curl --request POST \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"productIds": [
{}
]
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection"
payload = {
"name": "<string>",
"productIds": [{}]
}
headers = {
"Client-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', productIds: [{}]})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection', 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.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection",
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([
'name' => '<string>',
'productIds' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Client-Token: <api-key>",
"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.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"productIds\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Client-Token", "<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://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"productIds\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"productIds\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"collectionId": "<string>"
}WhatsApp Business
Criar coleção
Cria uma nova coleção no catálogo do WhatsApp Business
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
catalogs
/
collection
Criar coleção
curl --request POST \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"productIds": [
{}
]
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection"
payload = {
"name": "<string>",
"productIds": [{}]
}
headers = {
"Client-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', productIds: [{}]})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection', 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.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection",
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([
'name' => '<string>',
'productIds' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Client-Token: <api-key>",
"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.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"productIds\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Client-Token", "<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://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"productIds\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"productIds\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"collectionId": "<string>"
}Conceituação
Este método é responsável por criar uma nova coleção no catálogo do WhatsApp Business, permitindo agrupar produtos de forma organizada.Atributos
Header
ID da sua instância. Disponível no painel Z-API em Instâncias.
Token da sua instância Z-API.
Obrigatórios
Nome da coleção
IDs dos produtos
Request Body
{
"name": "Nome da coleção",
"productIds": ["121212121212", "232323232323"]
}
Response
200
ID da coleção criada
{
"collectionId": "123456789123"
}
405
Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.415
Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.⌘I