Z-API WhatsApp icon

Z-API WhatsApp

Integration with Z-API (WhatsApp) organized by resources (messages, groups, chats, contacts, products, queue, instance, status, etc.).

Product → Get Products by Phone

AI-generated

Summary

Retrieves WhatsApp Business catalog products for a specific phone number, supporting pagination via a cursor token.

Inputs

  • catalogPhone (required) — Phone number that owns the WhatsApp Business catalog (country code + area code + number, digits only).
  • nextCursor — Pagination token returned in the previous call. Leave empty to fetch the first page.

Output shape

The API response object containing the list of products.

The response includes a 'nextCursor' field in the API response (or body) that must be passed as 'nextCursor' to fetch subsequent pages, if available.

Examples

Example 1: Fetch the first page of products for a catalog owned by phone 5511999999999

catalogPhone set to '5511999999999', nextCursor left empty

Example 2: Fetch the second page of products using the cursor from the previous response

catalogPhone set to '5511999999999', nextCursor set to the value returned in the previous 'nextCursor' field

Links

Discussion