Catalog Order List

GET

catalog

order

list

Catalog Order List

curl --request GET \
  --url https://platform.chatsyncs.com/api/v1/whatsapp/catalog/order/list

const options = {method: 'GET'};

fetch('https://platform.chatsyncs.com/api/v1/whatsapp/catalog/order/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://platform.chatsyncs.com/api/v1/whatsapp/catalog/order/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://platform.chatsyncs.com/api/v1/whatsapp/catalog/order/list"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://platform.chatsyncs.com/api/v1/whatsapp/catalog/order/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "status": "1",
  "message": [
    {
      "order_unique_id": "172310467380123456789",
      "catalog_id": "1429267000005095",
      "chat_id": "919876543210",
      "catalog_name": "ChatSyncs",
      "first_name": "John",
      "cart_total": 455,
      "cart_currency": "INR",
      "cart_status_raw": "Approved",
      "ordered_at": "2026-08-26 06:27:03",
      "updated_at": "2026-09-18 09:52:12",
      "payment_amount": 0,
      "payment_method": "Cash on Delivery",
      "shipping_address": "{\"name\": \"John Doe\", \"phone_number\": \"919876543210\", \"email\": \"john@example.com\", \"address\": \"12 Main Road\"}",
      "checkout_account_email": null,
      "checkout_amount": "0",
      "checkout_timestamp": null,
      "transaction_id": "PD1723104673012345678933FAD1",
      "paid_at": "2026-08-26 06:29:45",
      "status_changed_at": "2026-08-26 06:29:45"
    }
  ]
}

Lists orders placed through a WhatsApp catalog.

Example Request

curl --request GET \
  --url 'https://platform.chatsyncs.com/api/v1/whatsapp/catalog/order/list?apiToken=API-KEY&whatsapp_catalog_id=123'

Where to find whatsapp_catalog_id: open Chatbot Manager → Commerce → Product Catalog, or call Catalog List to fetch it programmatically. See Finding Your IDs & API Token for a screenshot.

whatsapp_catalog_id is optional: leave it out to list the orders of every catalog. An unknown id returns {"status":"0","message":"WhatsApp catalog Is not found."}.

Query Parameters

apiToken

string

required

Your ChatSyncs API key (not a WhatsApp/Meta access token). Where to find it.

Example:

"API-KEY"

whatsapp_catalog_id

string

Filter to a specific catalog. Omit to list orders across all catalogs. Where to find it.

Example:

"123"

Response

Standard ChatSyncs response. status is "1" on success and "0" on failure.

status

string

"1" = success, "0" = failure.

message

object[]

The rows, as a list. There is no data field on this endpoint.

Catalog Order List

curl --request GET \
  --url https://platform.chatsyncs.com/api/v1/whatsapp/catalog/order/list

const options = {method: 'GET'};

fetch('https://platform.chatsyncs.com/api/v1/whatsapp/catalog/order/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://platform.chatsyncs.com/api/v1/whatsapp/catalog/order/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://platform.chatsyncs.com/api/v1/whatsapp/catalog/order/list"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://platform.chatsyncs.com/api/v1/whatsapp/catalog/order/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "status": "1",
  "message": [
    {
      "order_unique_id": "172310467380123456789",
      "catalog_id": "1429267000005095",
      "chat_id": "919876543210",
      "catalog_name": "ChatSyncs",
      "first_name": "John",
      "cart_total": 455,
      "cart_currency": "INR",
      "cart_status_raw": "Approved",
      "ordered_at": "2026-08-26 06:27:03",
      "updated_at": "2026-09-18 09:52:12",
      "payment_amount": 0,
      "payment_method": "Cash on Delivery",
      "shipping_address": "{\"name\": \"John Doe\", \"phone_number\": \"919876543210\", \"email\": \"john@example.com\", \"address\": \"12 Main Road\"}",
      "checkout_account_email": null,
      "checkout_amount": "0",
      "checkout_timestamp": null,
      "transaction_id": "PD1723104673012345678933FAD1",
      "paid_at": "2026-08-26 06:29:45",
      "status_changed_at": "2026-08-26 06:29:45"
    }
  ]
}

Get Started

WhatsApp API

Subscriber API

Label API

Catalog API

User API

Catalog Order List

Example Request

Query Parameters

Response

​Example Request

Query Parameters

Response

Example Request