Product Catalog API · WhatsApp · 1SPOC API Reference

infoOverview

About this API

This API is used to fetch the products in the given catalog id.

MethodGET

Versionv3.0

Base URLhttps://partnersv1.pinbot.ai/v3

Content TypeNo request body

keySecurity

Authentication

Include your API credential in the request header. Keep credentials on the server and never expose them in client-side applications.

Locationheader

Field nameapikey

Example valueYOUR_WABA_API_KEY

routeParameters

Path Parameters

Substitute these placeholders in the endpoint URL before sending the request.

catalog-idstringRequiredResource identifier for catalog id.

tuneParameters

Query Parameters

Append these values to the URL query string. Omit optional parameters when they are not needed.

limitstringNot specifiedRequest value for limit.

fieldsstringNot specifiedRequest value for fields.

filterstringNot specifiedRequest value for filter.

summarystringNot specifiedRequest value for summary.

uploadInput

Request Details

check_circle

No Request Body

Provide identifiers in the path and any supported values in the query string.

smartphoneEmbedded Signup Sandbox

Test with simulated WABA credentials

Use the sample WABA ID and WABA number produced by the Embedded Signup simulation. Sending here never calls the real WhatsApp API.

9:41⌁

chevron_left

1SPOC Demobusiness account

videocamcall

lockMessages are end-to-end encrypted. This preview is simulated.

Today

Ready to preview: Product Catalog API.9:41

add_circle

Messagedescription

photo_cameramic

codeIntegration

Code Examples

Select your language and customize the request URL. Credential placeholders are intentionally preserved so secrets never appear in generated samples.

Request URL

shield_lockCredentials protectedAdd secrets only in your secure server environment.

downloadSDK

curl --request GET 'https://partnersv1.pinbot.ai/v3/{catalog-id}/products?limit=2&fields=%5B%22category%22%2C%22name%22%2C%22retailer_id%22%2C%22price%22%2C%22availability%22%2C%22description%22%2C%22country%22%2C%22brand%22%2C%22image_url%22%2C%22size%22%2C%22color%22%2C%22retailer_product_group_id%22%2C%22thumbnail_product_retailer_id%22%5D&filter=%7B%22name%22%3A%7B%22i_contains%22%3A%22productchangedname%22%7D%7D&summary=true' \
  --header 'apikey: <API_KEY>'

const response = await fetch('https://partnersv1.pinbot.ai/v3/{catalog-id}/products?limit=2&fields=%5B%22category%22%2C%22name%22%2C%22retailer_id%22%2C%22price%22%2C%22availability%22%2C%22description%22%2C%22country%22%2C%22brand%22%2C%22image_url%22%2C%22size%22%2C%22color%22%2C%22retailer_product_group_id%22%2C%22thumbnail_product_retailer_id%22%5D&filter=%7B%22name%22%3A%7B%22i_contains%22%3A%22productchangedname%22%7D%7D&summary=true', {
  method: 'GET',
  headers: {
    "apikey": "<API_KEY>"
  },
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);

const response = await fetch('https://partnersv1.pinbot.ai/v3/{catalog-id}/products?limit=2&fields=%5B%22category%22%2C%22name%22%2C%22retailer_id%22%2C%22price%22%2C%22availability%22%2C%22description%22%2C%22country%22%2C%22brand%22%2C%22image_url%22%2C%22size%22%2C%22color%22%2C%22retailer_product_group_id%22%2C%22thumbnail_product_retailer_id%22%5D&filter=%7B%22name%22%3A%7B%22i_contains%22%3A%22productchangedname%22%7D%7D&summary=true', {
  method: 'GET',
  headers: {
    "apikey": "<API_KEY>"
  },
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);

import json
import requests

url = 'https://partnersv1.pinbot.ai/v3/{catalog-id}/products?limit=2&fields=%5B%22category%22%2C%22name%22%2C%22retailer_id%22%2C%22price%22%2C%22availability%22%2C%22description%22%2C%22country%22%2C%22brand%22%2C%22image_url%22%2C%22size%22%2C%22color%22%2C%22retailer_product_group_id%22%2C%22thumbnail_product_retailer_id%22%5D&filter=%7B%22name%22%3A%7B%22i_contains%22%3A%22productchangedname%22%7D%7D&summary=true'
headers = {
  "apikey": "<API_KEY>"
}
response = requests.get(url, headers=headers)

response.raise_for_status()
print(response.json())

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var client = HttpClient.newHttpClient();
var request = HttpRequest.newBuilder(URI.create("https://partnersv1.pinbot.ai/v3/{catalog-id}/products?limit=2&fields=%5B%22category%22%2C%22name%22%2C%22retailer_id%22%2C%22price%22%2C%22availability%22%2C%22description%22%2C%22country%22%2C%22brand%22%2C%22image_url%22%2C%22size%22%2C%22color%22%2C%22retailer_product_group_id%22%2C%22thumbnail_product_retailer_id%22%5D&filter=%7B%22name%22%3A%7B%22i_contains%22%3A%22productchangedname%22%7D%7D&summary=true"))
    .header("apikey", "<API_KEY>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());

<?php
$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://partnersv1.pinbot.ai/v3/{catalog-id}/products?limit=2&fields=%5B%22category%22%2C%22name%22%2C%22retailer_id%22%2C%22price%22%2C%22availability%22%2C%22description%22%2C%22country%22%2C%22brand%22%2C%22image_url%22%2C%22size%22%2C%22color%22%2C%22retailer_product_group_id%22%2C%22thumbnail_product_retailer_id%22%5D&filter=%7B%22name%22%3A%7B%22i_contains%22%3A%22productchangedname%22%7D%7D&summary=true',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => ["apikey: <API_KEY>"],
]);
$response = curl_exec($curl);
if ($response === false) throw new Exception(curl_error($curl));
curl_close($curl);
echo $response;

using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("apikey", "<API_KEY>");
var response = await client.GetAsync("https://partnersv1.pinbot.ai/v3/{catalog-id}/products?limit=2&fields=%5B%22category%22%2C%22name%22%2C%22retailer_id%22%2C%22price%22%2C%22availability%22%2C%22description%22%2C%22country%22%2C%22brand%22%2C%22image_url%22%2C%22size%22%2C%22color%22%2C%22retailer_product_group_id%22%2C%22thumbnail_product_retailer_id%22%5D&filter=%7B%22name%22%3A%7B%22i_contains%22%3A%22productchangedname%22%7D%7D&summary=true");
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    request, err := http.NewRequest("GET", "https://partnersv1.pinbot.ai/v3/{catalog-id}/products?limit=2&fields=%5B%22category%22%2C%22name%22%2C%22retailer_id%22%2C%22price%22%2C%22availability%22%2C%22description%22%2C%22country%22%2C%22brand%22%2C%22image_url%22%2C%22size%22%2C%22color%22%2C%22retailer_product_group_id%22%2C%22thumbnail_product_retailer_id%22%5D&filter=%7B%22name%22%3A%7B%22i_contains%22%3A%22productchangedname%22%7D%7D&summary=true", nil)
    if err != nil { panic(err) }
    request.Header.Set("Accept", "application/json")
    request.Header.Set("apikey", "<API_KEY>")
    response, err := http.DefaultClient.Do(request)
    if err != nil { panic(err) }
    defer response.Body.Close()
    data, err := io.ReadAll(response.Body)
    if err != nil { panic(err) }
    if response.StatusCode >= 400 { panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data)) }
    fmt.Println(string(data))
}

downloadOutput

Response

A successful request returns the documented response payload. Delivery and asynchronous events may arrive separately through configured webhooks.

{
"data": [
{
"category": "Shirt",
"name": "product changed name",
"retailer_id": "group1",
"price": "₹10.00",
"availability": "in stock",
"description": "product description",
"brand": "Pinnacle",
"image_url":
"https:
4-english-oven-bread-pav.jpg",
"retailer_product_group_id": "1",
"id": "catalog-id"
},
{
"category": "Shirt",
"name": "product changed name 3",
"retailer_id": "group3",
"price": "₹10.00",
"availability": "in stock",
"description": "product description",
"brand": "Pinnacle",

"image_url":
"https:
4-english-oven-bread-pav.jpg",
"retailer_product_group_id": "1",
"id": "catalog-id"
}
],
"paging": {
"cursors": {
"before": "eyJvZAmZAzZAXQiOjB9",
"after": "eyJvZAmZAzZAXQiOjF9"
},
"next":
"https:
%22i_contains%22%3A%22product%20changed%20name%22%7D%7D&summary=tr
ue&fields=%5B%22category%22%2C%22name%22%2C%22retailer_id%22%2C%22pr
ice%22%2C%22availability%22%2C%22description%22%2C%22country%22%2C%22
brand%22%2C%22image_url%22%2C%22size%22%2C%22color%22%2C%20%22ret
ailer_product_group_id%22%2C%22thumbnail_product_retailer_id%22%5D&limit=2&af
ter=eyJvZAmZAzZAXQiOjF9",
"previous":
"https:
%22i_contains%22%3A%22product%20changed%20name%22%7D%7D&summary=tr
ue&fields=%5B%22category%22%2C%22name%22%2C%22retailer_id%22%2C%22pr
ice%22%2C%22availability%22%2C%22description%22%2C%22country%22%2C%22
brand%22%2C%22image_url%22%2C%22size%22%2C%22color%22%2C%20%22ret
ailer_product_group_id%22%2C%22thumbnail_product_retailer_id%22%5D&limit=2&b
efore=eyJvZAmZAzZAXQiOjB9"
},
"summary": {
"total_count": 11
}
}

{
  "type": "object",
  "properties": {
    "raw_example": {
      "type": "string"
    }
  }
}

ruleHTTP Responses

Status Codes

200The request was successful.

400Bad request or invalid parameters.

401API key is missing or invalid.

403The request is not authorized for this resource.

404The requested resource was not found.

500The server encountered an error.