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

# Add, change or remove products

> Up to 5,000 product changes per call. LazyApp queues them and sends them through Meta's Catalog Batch API in chunks; the response is the queued batch. Poll `GET /v1/catalog/batches/{batch}` for the result and the rows Meta refused. See [Manage products](/sending/catalog-inventory).

Needs Meta's `catalog_management` permission for LazyApp; until Meta approves it the call returns `403` with `code: meta_approval_pending`.

**Required scope:** `catalog:write`



## OpenAPI

````yaml /api-reference/openapi.json post /v1/catalog/items
openapi: 3.1.0
info:
  title: LazyApp API
  version: v1
  description: >-
    One WhatsApp API for developers, SaaS platforms and businesses.


    Every endpoint is Bearer-authenticated with a LazyApp API key, returns JSON,
    and is scoped to the workspace and mode (`live` or `test`) the key belongs
    to.


    Live keys need the Pro plan. A live key on a workspace below Pro gets `402`
    with `code: plan_limit_reached` on every request. Test keys work on every
    plan, so you can build against the test number before you upgrade.


    LazyApp adds 0% to Meta's message rates. Meta bills each message to the
    business's own Meta payment method; your LazyApp plan is billed separately.
  contact:
    name: LazyApp support
    url: https://lazyapp.in
servers:
  - url: https://lazyapp.in
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Messages
    description: Send and schedule WhatsApp messages.
  - name: Contacts
    description: The people you message, and their identifiers.
  - name: Conversations
    description: Threads and their message history.
  - name: Calls
    description: WhatsApp call history for the workspace.
  - name: Templates
    description: Create, submit and sync message templates.
  - name: Media
    description: Upload, retrieve and delete media.
  - name: Broadcasts
    description: Template sends to many contacts at once.
  - name: Events
    description: Say what happened; LazyApp picks the template.
  - name: Flows
    description: WhatsApp Flows and their responses.
  - name: Webhooks
    description: Register endpoints and inspect deliveries.
  - name: Workflows
    description: Automations and their executions.
  - name: Verify
    description: One-time passcodes over WhatsApp.
  - name: Capabilities
    description: What each connected number supports.
  - name: Catalog
    description: Proxy Meta Commerce catalog products for a connection.
  - name: Platform
    description: Manage customers if you run a platform on LazyApp.
  - name: Meta-compatible proxy
    description: Drop-in endpoints for existing Cloud API integrations.
  - name: Connections
    description: >-
      Your WhatsApp numbers and the account behind them: health, limits,
      registration, display name, blue tick, QR codes, conversation starters,
      opt-in links, business profile and blocked users.
  - name: Billing
    description: >-
      Meta's message rates, which LazyApp passes on with 0% added, and the
      billing facts behind them.
  - name: Analytics
    description: Workspace messaging aggregates.
  - name: Groups
    description: WhatsApp group chats on a connection Meta has enabled.
  - name: Funding
    description: Local funding status and recorded WhatsApp charges.
  - name: Connections
    description: 'WhatsApp connections: block users, business profile, insights.'
  - name: Payments
    description: >-
      WhatsApp payments in India: ask for payment, follow it, update the order
      and refund.
paths:
  /v1/catalog/items:
    post:
      tags:
        - Catalog
      summary: Add, change or remove products
      description: >-
        Up to 5,000 product changes per call. LazyApp queues them and sends them
        through Meta's Catalog Batch API in chunks; the response is the queued
        batch. Poll `GET /v1/catalog/batches/{batch}` for the result and the
        rows Meta refused. See [Manage products](/sending/catalog-inventory).


        Needs Meta's `catalog_management` permission for LazyApp; until Meta
        approves it the call returns `403` with `code: meta_approval_pending`.


        **Required scope:** `catalog:write`
      parameters:
        - name: Idempotency-Key
          in: header
          description: >-
            Optional. Makes this write safe to retry: the same key replays the
            first response instead of acting twice.
          schema:
            type: string
            maxLength: 255
        - name: connection_uuid
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: phone_number_id
          in: query
          required: false
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - items
              properties:
                connection_uuid:
                  type: string
                  format: uuid
                phone_number_id:
                  type: string
                items:
                  type: array
                  minItems: 1
                  maxItems: 5000
                  items:
                    $ref: '#/components/schemas/CatalogItemInput'
            example:
              items:
                - sku: TSHIRT-RED-M
                  title: Red cotton T-shirt (M)
                  price: 49900
                  currency: INR
                  quantity: 25
                  image_url: https://acme.example/images/red-tee.jpg
                - action: update
                  sku: MUG-01
                  quantity: 0
                - action: delete
                  sku: OLD-ITEM-7
      responses:
        '202':
          description: Queued.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogBatch'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          $ref: '#/components/responses/PlanLimitReached'
        '403':
          description: >-
            The key lacks `catalog:write` or is restricted from this number, or
            Meta has not approved catalog changes yet (`meta_approval_pending`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaApprovalPending'
        '422':
          description: Validation failed, no connection, or the connection has no catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '429':
          description: Rate limit exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    CatalogItemInput:
      type: object
      required:
        - sku
      properties:
        action:
          type: string
          enum:
            - upsert
            - update
            - delete
          default: upsert
          description: >-
            `upsert` adds the product or replaces it when the code exists, and
            needs `title`, `price` and `image_url`. `update` changes only the
            fields you send. `delete` removes the product by `sku`.
        sku:
          type: string
          maxLength: 100
          description: Your product code (Meta's retailer id). No spaces or commas.
          examples:
            - TSHIRT-RED-M
        title:
          type: string
          maxLength: 200
        description:
          type:
            - string
            - 'null'
          maxLength: 9999
          description: Defaults to the title for a new product.
        price:
          type: integer
          minimum: 0
          description: Minor units (paise, cents). `49900` with `INR` is ₹499.00.
          examples:
            - 49900
        currency:
          type:
            - string
            - 'null'
          minLength: 3
          maxLength: 3
          default: INR
        availability:
          type:
            - string
            - 'null'
          enum:
            - in_stock
            - out_of_stock
            - null
        quantity:
          type:
            - integer
            - 'null'
          minimum: 0
          maximum: 1000000
          description: How many can be sold. `0` also marks the product out of stock.
        image_url:
          type: string
          format: uri
          description: A public `https://` image, at least 500 × 500 pixels.
        link:
          type:
            - string
            - 'null'
          format: uri
          description: >-
            Product page. Defaults to a chat link with your number for a new
            product.
        brand:
          type:
            - string
            - 'null'
          maxLength: 100
          description: Defaults to your business name for a new product.
        condition:
          type:
            - string
            - 'null'
          enum:
            - new
            - refurbished
            - used
            - null
          default: new
    CatalogBatch:
      type: object
      description: One change to the catalog, sent to Meta in the background.
      properties:
        id:
          type: string
          format: uuid
        catalog_id:
          type: string
        source:
          type: string
          enum:
            - console
            - csv
            - api
        status:
          type: string
          enum:
            - queued
            - processing
            - finished
            - finished_with_errors
            - failed
        status_label:
          type: string
          examples:
            - Done, some rows need fixing
        filename:
          type:
            - string
            - 'null'
        total_rows:
          type: integer
        skipped_rows:
          type: integer
          description: Rows refused before reaching Meta.
        error_count:
          type: integer
        errors:
          type: array
          items:
            type: object
            properties:
              line:
                type:
                  - integer
                  - 'null'
                description: Position of the item in `items` (1-based), or the CSV row.
              sku:
                type:
                  - string
                  - 'null'
              message:
                type: string
                description: What to fix, in plain words.
        failure_message:
          type:
            - string
            - 'null'
        created_at:
          type:
            - string
            - 'null'
          format: date-time
        finished_at:
          type:
            - string
            - 'null'
          format: date-time
    Error:
      type: object
      properties:
        message:
          type: string
          description: Human-readable description of what went wrong.
        code:
          type: string
          description: >-
            Stable machine-readable reason, when the failure is one a client can
            branch on.
      required:
        - message
    MetaApprovalPending:
      type: object
      required:
        - message
        - code
        - permission
      properties:
        message:
          type: string
        code:
          type: string
          enum:
            - meta_approval_pending
        permission:
          type: string
          enum:
            - catalog_management
            - ads_read
    ValidationError:
      type: object
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Field name to list of failures.
      required:
        - message
  responses:
    PlanLimitReached:
      description: >-
        The workspace's plan does not allow this. A live key on a workspace
        below Pro gets this on every request, because the live API is a Pro
        feature. Upgrade in **Billing** to use live keys. Test keys are never
        limited, on any plan.


        `code` is always `plan_limit_reached`. Show `message` to the person: it
        names the plan to move to.


        Other plan limits use the same code in the console, but the API reports
        them differently today: a broadcast larger than the month's remaining
        Live broadcast sends is refused with `422` and the reason in `message`,
        and connecting a number beyond the plan's number capacity fails
        validation (`422`) on `phone_number_id`.
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: >-
                  A sentence you can show to the person. Says which plan to move
                  to.
              code:
                type: string
                enum:
                  - plan_limit_reached
            required:
              - message
              - code
          example:
            message: >-
              The API is on the Pro plan. Upgrade in Billing to use live keys.
              Test keys keep working.
            code: plan_limit_reached
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `sk_live_...` or `sk_test_...`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.