Add products to collection
curl --request POST \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection/add-product \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"collectionId": "<string>",
"productIds": [
{}
]
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection/add-product"
payload = {
"collectionId": "<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({collectionId: '<string>', productIds: [{}]})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection/add-product', 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/add-product",
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([
'collectionId' => '<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/add-product"
payload := strings.NewReader("{\n \"collectionId\": \"<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/add-product")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"collectionId\": \"<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/add-product")
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 \"collectionId\": \"<string>\",\n \"productIds\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"collectionId": "<string>"
}WhatsApp Business
Add products to collection
Adds products to an existing collection in the WhatsApp Business catalog
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
catalogs
/
collection
/
add-product
Add products to collection
curl --request POST \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection/add-product \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"collectionId": "<string>",
"productIds": [
{}
]
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection/add-product"
payload = {
"collectionId": "<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({collectionId: '<string>', productIds: [{}]})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection/add-product', 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/add-product",
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([
'collectionId' => '<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/add-product"
payload := strings.NewReader("{\n \"collectionId\": \"<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/add-product")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"collectionId\": \"<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/add-product")
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 \"collectionId\": \"<string>\",\n \"productIds\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"collectionId": "<string>"
}Overview
This method is responsible for adding products to an existing collection in the WhatsApp Business catalog.When adding or removing products from a collection, its ID is changed by WhatsApp. Use the returned ID for subsequent operations.
Attributes
Header
string
required
Your instance ID. Available in the Z-API panel under Instances.
string
required
Your Z-API instance token.
Required
string
required
Collection ID
array
required
IDs of the products to be added
Request Body
{
"collectionId": "658387616418640",
"productIds": ["6643149779134830"]
}
Response
200
boolean
true if successful, false if it failedstring
New collection ID after the change
{
"success": true,
"collectionId": "1798362193933497"
}
405
Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.415
If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.⌘I