> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pilotstatus.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Fetch product catalog

> Fetches the product catalog for a business WhatsApp number.



## OpenAPI

````yaml openapi.evolution-v2.json POST /business/getCatalog/{instance}
openapi: 3.1.0
info:
  title: Evolution V2 Layer
  version: 1.0.0
  description: >-
    Pilot Status API Layer — Evolution V2. Base URL
    `https://pilotstatus.com.br/api/layer/evolution-v2`. Authenticate with the
    `apikey` header (your Pilot Status `ps_` key). Instance/session endpoints
    are NOT available through the layer.
servers:
  - url: https://pilotstatus.com.br/api/layer/evolution-v2
security:
  - apiKey: []
tags:
  - name: Call & Business
  - name: Chat
  - name: Group
  - name: Label
  - name: Message
  - name: Profile
  - name: Settings & Proxy
  - name: Storage (S3)
  - name: Template
paths:
  /business/getCatalog/{instance}:
    post:
      tags:
        - Call & Business
      summary: Fetch product catalog
      description: Fetches the product catalog for a business WhatsApp number.
      operationId: post__business_getCatalog_instance
      parameters:
        - name: instance
          in: path
          required: true
          schema:
            type: string
          description: The number's display name in the Pilot Status dashboard.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                number:
                  type: string
                  description: >-
                    Business phone number whose catalog to fetch; defaults to
                    the instance's own number.
                  example: '5511999999999'
                limit:
                  type: number
                  description: Maximum number of products to return.
                  example: 50
      responses:
        '200':
          description: Success — provider-native response body.
          content:
            application/json:
              schema:
                type: object
                description: Product catalog fetched from a WhatsApp Business account.
                properties:
                  wuid:
                    type: string
                    description: Resolved WhatsApp JID of the queried business number.
                  numberExists:
                    type: boolean
                    description: Whether the queried number exists on WhatsApp.
                  isBusiness:
                    type: boolean
                    description: Whether the number is a WhatsApp Business account.
                  catalogLength:
                    type: integer
                    description: Total number of products returned in the catalog array.
                  catalog:
                    type: array
                    description: List of catalog products.
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Product id.
                        name:
                          type: string
                          description: Product name.
                        description:
                          type: string
                          description: Product description.
                        price:
                          type: integer
                          description: Price in the smallest currency unit (e.g. cents).
                        currency:
                          type: string
                          description: ISO 4217 currency code.
                        retailerId:
                          type: string
                          description: Retailer-defined SKU / content id for the product.
                        url:
                          type: string
                          description: Product landing URL.
                        isHidden:
                          type: boolean
                          description: Whether the product is hidden from the storefront.
                        availability:
                          type: string
                          description: >-
                            Stock availability, e.g. 'in stock', 'limited
                            availability', 'out of stock'.
                        imageUrls:
                          type: object
                          description: Map of image size key to image URL.
                          additionalProperties:
                            type: string
                        reviewStatus:
                          type: object
                          description: Map of review dimension to review status.
                          additionalProperties:
                            type: string
                required:
                  - wuid
                  - numberExists
                  - isBusiness
                  - catalogLength
                  - catalog
              example:
                wuid: 5511999999999@s.whatsapp.net
                numberExists: true
                isBusiness: true
                catalogLength: 2
                catalog:
                  - id: '6104474702914109'
                    name: Camiseta Pilot Status
                    description: Camiseta 100% algodão, edição limitada.
                    price: 7990
                    currency: BRL
                    retailerId: SKU-TSHIRT-001
                    url: https://loja.exemplo.com.br/camiseta
                    isHidden: false
                    availability: in stock
                    imageUrls:
                      requested_image_size: https://mmg.whatsapp.net/v/t45.5328-4/prod1_thumb.jpg
                      original_image_url: https://mmg.whatsapp.net/v/t45.5328-4/prod1_full.jpg
                    reviewStatus:
                      whatsapp: APPROVED
                  - id: '6104474702914110'
                    name: Caneca Pilot Status
                    description: Caneca de cerâmica 350ml.
                    price: 3490
                    currency: BRL
                    retailerId: SKU-MUG-002
                    url: https://loja.exemplo.com.br/caneca
                    isHidden: false
                    availability: in stock
                    imageUrls:
                      requested_image_size: https://mmg.whatsapp.net/v/t45.5328-4/prod2_thumb.jpg
                    reviewStatus:
                      whatsapp: APPROVED
        default:
          description: Error — provider or layer error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                  response:
                    type: object
              example:
                status: 400
                error: Bad Request
                message: Invalid payload
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apikey
      description: >-
        Your Pilot Status API key (ps_...). Evolution GO also accepts
        `Authorization: Bearer <key>`.

````