WhatsApp

WhatsApp Commerce Settings API

The Commerce Settings API from WhatsApp — 1 operation(s) for commerce settings.

GitHub OpenAPI

Operations 2

GET /{Version}/{Phone-Number-ID}/whatsapp_commerce_settings Get commerce settings #
POST /{Version}/{Phone-Number-ID}/whatsapp_commerce_settings Set or update commerce settings #

Documentation

📖
Documentation
https://developers.facebook.com/documentation/business-messaging/whatsapp/overview

Specifications

⚙
OpenAPI
https://artifacts.apis.io/whatsapp/openapi/whatsapp-commerce-settings-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/meta/openapi

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-call-request-payload-schema.json
📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-whats-app-business-account-schema.json
📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-whats-app-business-profile-node-schema.json
📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-phone-number-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-call-permission-check-response-payload-schema.json
📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-whats-app-account-number-schema.json

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/WhatsApp/WhatsApp-Flows-Tools/main/postman/v1/whatsapp-cloud-api.postman_collection.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/whatsapp:whatsapp-commerce-settings-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

whatsapp-commerce-settings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Meta Graph API - Application Connected Client Businesses…
  version: v23.0
  description: 'API for retrieving connected client businesses associated with a Meta application.


    This endpoint allows applications to retrieve information about businesses that have

    established client connections through the application. This is essential for managing

    business relationships and understanding client business configurations.'
  contact:
    name: Meta Business Platform Team
    url: https://developers.facebook.com/support
  license:
    name: Meta Platform Terms
    url: https://developers.facebook.com/terms
  termsOfService: https://developers.facebook.com/terms
servers:
- url: https://graph.facebook.com
  description: Production Graph API server
- url: https://graph.facebook.com
- url: https://graph.facebook.com
  description: WhatsApp Business Cloud API
- url: https://graph.facebook.com
  description: Meta Graph API production server
tags:
- name: Commerce Settings
paths:
  /{Version}/{Phone-Number-ID}/whatsapp_commerce_settings:
    parameters:
    - $ref: '#/components/parameters/UserAgent'
    - $ref: '#/components/parameters/Authorization'
    - name: Version
      in: path
      required: true
      schema:
        type: string
    - name: Phone-Number-ID
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Commerce Settings
      summary: Get commerce settings
      description: '- Guide: Sell Products & Services (Cloud API)

        - Guide: Sell Products & Services (On-Premises API)

        - Endpoint reference: WhatsApp Business Phone Number > WhatsApp Commerce Settings'
      operationId: getCommerceSettings
      responses:
        '200':
          description: Example response
          headers:
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: '*'
            Alt-Svc:
              schema:
                type: string
                example: h3=":443"; ma=86400
            Cache-Control:
              schema:
                type: string
                example: private, no-cache, no-store, must-revalidate
            Connection:
              schema:
                type: string
                example: keep-alive
            Content-Length:
              schema:
                type: string
                example: '84'
            Date:
              schema:
                type: string
                example: Fri, 07 Apr 2023 20:02:54 GMT
            ETag:
              schema:
                type: string
                example: '"be665e167cf848b6b62159f1d6828c494dc47008"'
            Expires:
              schema:
                type: string
                example: Sat, 01 Jan 2000 00:00:00 GMT
            Pragma:
              schema:
                type: string
                example: no-cache
            Strict-Transport-Security:
              schema:
                type: string
                example: max-age=15552000; preload
            Vary:
              schema:
                type: string
                example: Origin
            X-FB-Debug:
              schema:
                type: string
                example: N/Bc7wjn7wzoGQzxpah+q29b3kn3Cu3Q5Vexydxna3Nq00SaWCkxw7wXuyFyLggvngmTAGNe60aQ2TTFzvT2hQ==
            facebook-api-version:
              schema:
                type: string
                example: v16.0
            x-business-use-case-usage:
              schema:
                type: string
                example: '{"102290129340398":[{"type":"whatsapp_business_management","call_count":1,"total_cputime":1,"total_time":1,"estimated_time_to_regain_access":0}]}'
            x-fb-request-id:
              schema:
                type: string
                example: ATqienUCgZnGDTAHjSt_s1u
            x-fb-rev:
              schema:
                type: string
                example: '1007268877'
            x-fb-rlafr:
              schema:
                type: string
                example: '0'
            x-fb-trace-id:
              schema:
                type: string
                example: BZ2vk4sqqeh
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: '527759822865714'
                        is_cart_enabled:
                          type: boolean
                          example: true
                        is_catalog_visible:
                          type: boolean
                          example: true
                    example:
                    - id: '527759822865714'
                      is_cart_enabled: true
                      is_catalog_visible: true
              examples:
                Example response:
                  value:
                    data:
                    - id: '527759822865714'
                      is_cart_enabled: true
                      is_catalog_visible: true
      security:
      - bearerAuth: []
    post:
      tags:
      - Commerce Settings
      summary: Set or update commerce settings
      description: '- Guide: Sell Products & Services (Cloud API)

        - Guide: Sell Products & Services (On-Premises API)

        - Endpoint reference: WhatsApp Business Phone Number > WhatsApp Commerce Settings'
      operationId: setOrUpdateCommerceSettings
      parameters:
      - $ref: '#/components/parameters/UserAgent'
      - $ref: '#/components/parameters/Authorization'
      - name: is_cart_enabled
        in: query
        schema:
          type: string
          example: 'true'
      - name: is_catalog_visible
        in: query
        schema:
          type: string
          example: 'true'
      responses:
        '200':
          description: Example response
          headers:
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: '*'
            Alt-Svc:
              schema:
                type: string
                example: h3=":443"; ma=86400
            Cache-Control:
              schema:
                type: string
                example: private, no-cache, no-store, must-revalidate
            Connection:
              schema:
                type: string
                example: keep-alive
            Content-Length:
              schema:
                type: string
                example: '16'
            Date:
              schema:
                type: string
                example: Fri, 07 Apr 2023 20:01:14 GMT
            Expires:
              schema:
                type: string
                example: Sat, 01 Jan 2000 00:00:00 GMT
            Pragma:
              schema:
                type: string
                example: no-cache
            Strict-Transport-Security:
              schema:
                type: string
                example: max-age=15552000; preload
            Vary:
              schema:
                type: string
                example: Origin
            X-FB-Debug:
              schema:
                type: string
                example: 03bVIwTYJnh6qJe3sqWWNGapvvRoU/yKE+3nC45djcuaeV41y+6Z4SgWhK/SRB+WUUBEKWInR4hxFzHnKZ1+7Q==
            cross-origin-resource-policy:
              schema:
                type: string
                example: cross-origin
            facebook-api-version:
              schema:
                type: string
                example: v16.0
            x-app-usage:
              schema:
                type: string
                example: '{"call_count":0,"total_cputime":0,"total_time":0}'
            x-fb-request-id:
              schema:
                type: string
                example: AB0EvD-U5WkosUqnPBMwXhB
            x-fb-rev:
              schema:
                type: string
                example: '1007268877'
            x-fb-rlafr:
              schema:
                type: string
                example: '0'
            x-fb-trace-id:
              schema:
                type: string
                example: A5pEgwxfemZ
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
              examples:
                Example response:
                  value:
                    success: true
      security:
      - bearerAuth: []
components:
  parameters:
    Authorization:
      name: Authorization
      in: header
      description: 'Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token.

        '
      required: true
      schema:
        type: string
        pattern: ^Bearer\s+[A-Za-z0-9\-_.]+.*$
        example: Bearer EAABwzLixnjYBOzYmNMJJGfHq9DgNh...
    UserAgent:
      name: User-Agent
      in: header
      description: The user agent string identifying the client software making the request.
      required: false
      schema:
        type: string
        default: Meta-Business-Messaging-OpenAPI/1.0.0;spec=2025-10-21
        pattern: ^[a-zA-Z0-9\-_]+\/[0-9]+\.[0-9]+\.[0-9]+(;[a-zA-Z0-9\-=\.]+)?(\s+[a-zA-Z0-9\-_]+\/[0-9\-\.]+)?$
        example: Meta-Business-Messaging-OpenAPI/1.0.0;spec=2025-10-21
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'System user access token with whatsapp_business_management permission. Format: Bearer YOUR_SYSTEM_USER_ACCESS_TOKEN

        '