Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
catalogs
Get products
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs \
  --header 'Client-Token: <api-key>'
{
  "cartEnabled": true,
  "products": [
    {}
  ]
}

​
Overview

With this method you can get the products from a WhatsApp Business catalog.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Query Parameters

​
nextCursor
string
Pagination token to fetch more records

​
Response

​
200

​
cartEnabled
boolean
Shopping cart active status
​
products
array
Catalog product list
{
  "cartEnabled": true,
  "products": [
    {
      "availability": "in stock",
      "id": "999999999999999",
      "retailerId": null,
      "description": "Mouse description",
      "price": "100000",
      "salePrice": "90000",
      "currency": "BRL",
      "name": "Mouse",
      "quantity": null,
      "images": ["https://..."]
    }
  ]
}

​
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.

​
414 - URI Too Large

In some cases, sending the nextCursor can cause a 414 “URI Too Large” error. To solve this issue, we implemented a V2 for this API route that accepts POST requests so you can send the nextCursor in the request body. See the Get Products V2 route.

​
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”.