List and Paginate Products in a Convo Catalogue

Use this endpoint to retrieve all products within a specific catalogue. Results are paginated and can be filtered by product status.

Endpoint

GET https://connect.api-wa.co/project-apis/v1/project/{project_id}/get-catalog-products

Authentication

X-API-WA-Project-API-Pwd: YOUR_API_PASSWORD

Path Parameters

string

required

Your Convo project ID.

Query Parameters

string

required

The ID of the catalogue whose products you want to retrieve. You can obtain catalogue IDs from the List Catalogues endpoint.

boolean

Filter products by their active status. Pass true to return only active products, or false to return only inactive products. Omit to return all products regardless of status.

integer

Number of products to return per page. Defaults to 20.

integer

Number of records to skip for offset-based pagination. Defaults to 0.

Request Example

curl "https://connect.api-wa.co/project-apis/v1/project/YOUR_PROJECT_ID/get-catalog-products?catalogId=738763614338341&limit=20&skip=0" \
  -H "X-API-WA-Project-API-Pwd: YOUR_API_PASSWORD"

Response

Returns a catalogueProducts array containing product objects for the specified catalogue.

array

Array of product objects. Each object contains:

Show Product Object

string

Internal database ID of the product record in Convo.

string

The Meta product ID as registered in the catalogue.

string

The display name of the product.

string

The product price in the smallest currency unit (e.g., "89900" = ₹899.00).

string

The ISO 4217 currency code for the price (e.g., "INR", "USD").

string

The product description text.

string

URL of the product’s image.

string

Your unique product SKU or identifier.

string

Inventory availability status (e.g., "in stock", "out of stock").

string

Product condition (e.g., "new", "refurbished", "used").

boolean

Whether the product is currently active (true) or inactive (false).

string

ISO 8601 timestamp of when the product record was last updated.

Example Response

{
  "catalogueProducts": [
    {
      "_id": "64b3e1a2c4f1a234560d2e5a",
      "productId": "4812039481203",
      "productName": "Classic Leather Watch",
      "price": "89900",
      "currency": "INR",
      "description": "Elegant leather-strap watch with a stainless steel case. Water-resistant to 50m.",
      "imageUrl": "https://example.com/images/classic-leather-watch.jpg",
      "retailerId": "WATCH-CLW-001",
      "availability": "in stock",
      "condition": "new",
      "status": true,
      "updatedAt": "2024-01-07T10:30:00.000Z"
    },
    {
      "_id": "64b3e1a2c4f1a234560d2e6b",
      "productId": "4812039481204",
      "productName": "Sport Chronograph",
      "price": "54900",
      "currency": "INR",
      "description": "Professional sport watch with tachymeter bezel and co-axial movement.",
      "imageUrl": "https://example.com/images/sport-chronograph.jpg",
      "retailerId": "WATCH-SCH-001",
      "availability": "in stock",
      "condition": "new",
      "status": true,
      "updatedAt": "2024-01-06T08:15:00.000Z"
    }
  ]
}

Overview

Business & Project

Messages

Contacts

Templates

Campaigns

Webhooks

Catalogue

Media

List and Paginate Products in a Convo Catalogue

Endpoint

Authentication

Path Parameters

Query Parameters

Request Example

Response

Example Response

​Endpoint

​Authentication

​Path Parameters

​Query Parameters

​Request Example

​Response

​Example Response

Endpoint

Authentication

Path Parameters

Query Parameters

Request Example

Response

Example Response