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

# Catalog Order List

> List orders placed through a WhatsApp product catalog via the ChatSyncs API, including cart totals, payment method, and shipping address. Use when a developer asks how to sync catalog orders into their own order management system.

Lists orders placed through a WhatsApp catalog.

## Example Request

```bash theme={null}
curl --request GET \
  --url 'https://platform.chatsyncs.com/api/v1/whatsapp/catalog/order/list?apiToken=API-KEY&whatsapp_catalog_id=123'
```

<Tip>
  **Where to find `whatsapp_catalog_id`:** open **Chatbot Manager → Commerce → Product Catalog**,
  or call
  [Catalog List](/developer-api/catalog/list-catalogs) to fetch it programmatically. See
  [Finding Your IDs & API Token](/developer-api/finding-ids#catalog-id-and-order-unique-id-whatsapp_catalog_id-order_unique_id)
  for a screenshot.
</Tip>

`whatsapp_catalog_id` is optional: leave it out to list the orders of every catalog. An unknown id returns
`{"status":"0","message":"WhatsApp catalog Is not found."}`.


## OpenAPI

````yaml GET /whatsapp/catalog/order/list
openapi: 3.1.0
info:
  title: ChatSyncs Developer API
  version: 1.0.0
  description: >-
    REST API for sending WhatsApp messages and managing subscribers through
    ChatSyncs.


    **Authentication.** Send your key as the `apiToken` parameter, or as
    `Authorization: Bearer <key>` — both work on every endpoint **except Custom
    Fields List**, which only accepts the `apiToken` parameter (a Bearer header
    alone is answered with *The api token field is required.*). A wrong key
    returns HTTP 401 `{"status":"0","message":"Unauthenticated."}`; no key at
    all redirects to the login page.


    **Methods.** Every endpoint accepts both GET and POST with the same
    parameters, except Upload Media, which is POST-only. Use POST for anything
    that changes data.


    **Errors.** Failures usually come back as HTTP 200 with `"status":"0"` and
    the reason in `message`, so always check `status`. `status` is the string
    `"1"` or `"0"` on most endpoints and a boolean on a few.


    **Lists.** Endpoints that return rows put them in `message` as a list; there
    is no `data` field (Custom Fields List is the exception and uses `data`).
servers:
  - url: https://platform.chatsyncs.com/api/v1
security: []
paths:
  /whatsapp/catalog/order/list:
    get:
      tags:
        - Catalog API
      summary: Catalog Order List
      operationId: listOrders
      parameters:
        - name: apiToken
          in: query
          required: true
          schema:
            type: string
            example: API-KEY
          description: >-
            Your ChatSyncs API key (not a WhatsApp/Meta access token). [Where to
            find it](/developer-api/finding-ids#api-token-apitoken).
        - name: whatsapp_catalog_id
          in: query
          required: false
          schema:
            type: string
            example: '123'
          description: >-
            Filter to a specific catalog. Omit to list orders across all
            catalogs. [Where to find
            it](/developer-api/finding-ids#catalog-id-and-order-unique-id-whatsapp_catalog_id-order_unique_id).
      responses:
        '200':
          description: >-
            Standard ChatSyncs response. `status` is `"1"` on success and `"0"`
            on failure.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: '`"1"` = success, `"0"` = failure.'
                  message:
                    type: array
                    description: >-
                      The rows, as a list. There is no `data` field on this
                      endpoint.
                    items:
                      type: object
              examples:
                success:
                  summary: Success
                  value:
                    status: '1'
                    message:
                      - order_unique_id: '172310467380123456789'
                        catalog_id: '1429267000005095'
                        chat_id: '919876543210'
                        catalog_name: ChatSyncs
                        first_name: John
                        cart_total: 455
                        cart_currency: INR
                        cart_status_raw: Approved
                        ordered_at: '2026-08-26 06:27:03'
                        updated_at: '2026-09-18 09:52:12'
                        payment_amount: 0
                        payment_method: Cash on Delivery
                        shipping_address: >-
                          {"name": "John Doe", "phone_number": "919876543210",
                          "email": "john@example.com", "address": "12 Main
                          Road"}
                        checkout_account_email: null
                        checkout_amount: '0'
                        checkout_timestamp: null
                        transaction_id: PD1723104673012345678933FAD1
                        paid_at: '2026-08-26 06:29:45'
                        status_changed_at: '2026-08-26 06:29:45'
                error:
                  summary: Error
                  value:
                    status: '0'
                    message: Invalid request.
                notFound:
                  summary: Unknown whatsapp_catalog_id
                  value:
                    status: '0'
                    message: WhatsApp catalog Is not found.
        '401':
          description: >-
            `apiToken` is wrong. (With no token at all the API redirects to the
            login page with HTTP 302 instead of returning JSON.)
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  message:
                    type: string
              examples:
                unauthenticated:
                  summary: Wrong apiToken
                  value:
                    status: '0'
                    message: Unauthenticated.

````

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