Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
catalogs
/
{phone}
Get products V2 (phone)
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/{phone} \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nextCursor": "<string>"
}
'

Overview

With this method you can get the products from a WhatsApp Business catalog of any number, whether your own or someone else’s. This version uses POST with pagination via body.

Attributes

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

Path

phone
string
required
WhatsApp Business phone number

Body

nextCursor
string
Pagination token to fetch more records

Request Body

{
  "nextCursor": "eyJwbHVnaW5fbmFtZSI6IldIQVRTQVBQX0NBVEFMT0ciLCJxdWVy..."
}

Response

200

{
  "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.

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