Skip to main content

​
WhatsApp Cloud API - Commerce Settings API

Copy for LLM View as Markdown Version v23.0 Configure WhatsApp Business commerce settings including catalog visibility and shopping cart enablement. Retrieve and update commerce configurations for business phone numbers.

​
Base URL

| https://graph.facebook.com |

​
Endpoints

| GET | ///whatsapp_commerce_settings | | POST | ///whatsapp_commerce_settings |

​
GET ///whatsapp_commerce_settings

Guide: Sell Products & Services (Cloud API) Guide: Sell Products & Services (On-Premises API) Endpoint reference: WhatsApp Business Phone Number > WhatsApp Commerce Settings

​
Request Syntax

GET///whatsapp_commerce_settings Select language cURLJavaScriptPython 
curl --request GET \
  --url 'https://graph.facebook.com/{Version}/{Phone-Number-ID}/whatsapp_commerce_settings' \
  --header 'Authorization: Bearer <Token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
Select status code 200 
{
  "Example response": {
    "value": {
      "data": [\
        {\
          "id": "527759822865714",\
          "is_cart_enabled": true,\
          "is_catalog_visible": true\
        }\
      ]
    }
  }
}
Header Parameters
User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters
Versionstring·required Phone-Number-IDstring·required Responses
Guide: Sell Products & Services (Cloud API) Guide: Sell Products & Services (On-Premises API) Endpoint reference: WhatsApp Business Phone Number > WhatsApp Commerce Settings 200 Example response Content Type: application/json Schema: object Show child attributes
dataarray of object Show child attributes
data[]object Show child attributes
idstring
is_cart_enabledboolean
is_catalog_visibleboolean Select language cURLJavaScriptPython 
curl --request GET \
  --url 'https://graph.facebook.com/{Version}/{Phone-Number-ID}/whatsapp_commerce_settings' \
  --header 'Authorization: Bearer <Token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
Select status code 200 
{
  "Example response": {
    "value": {
      "data": [\
        {\
          "id": "527759822865714",\
          "is_cart_enabled": true,\
          "is_catalog_visible": true\
        }\
      ]
    }
  }
}

​
POST ///whatsapp_commerce_settings

Guide: Sell Products & Services (Cloud API) Guide: Sell Products & Services (On-Premises API) Endpoint reference: WhatsApp Business Phone Number > WhatsApp Commerce Settings

​
Request Syntax

POST///whatsapp_commerce_settings Select language cURLJavaScriptPython 
curl --request POST \
  --url 'https://graph.facebook.com/{Version}/{Phone-Number-ID}/whatsapp_commerce_settings' \
  --header 'Authorization: Bearer <Token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
Select status code 200 
{
  "Example response": {
    "value": {
      "success": true
    }
  }
}
Header Parameters
User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters
Versionstring·required Phone-Number-IDstring·required Query Parameters
is_cart_enabledstring is_catalog_visiblestring Responses
Guide: Sell Products & Services (Cloud API) Guide: Sell Products & Services (On-Premises API) Endpoint reference: WhatsApp Business Phone Number > WhatsApp Commerce Settings 200 Example response Content Type: application/json Schema: object Show child attributes
successboolean Select language cURLJavaScriptPython 
curl --request POST \
  --url 'https://graph.facebook.com/{Version}/{Phone-Number-ID}/whatsapp_commerce_settings' \
  --header 'Authorization: Bearer <Token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
Select status code 200 
{
  "Example response": {
    "value": {
      "success": true
    }
  }
}

​
Authentication

| Scheme | Type | Location | | bearerAuth | HTTP Bearer | Header: Authorization |

​
Usage Examples

bearerAuth: Include Authorization: Bearer your-token-here in request headers

​
Global Authentication Requirements

All endpoints require: bearerAuth Did you find this page helpful? Thumbs up icon Thumbs down icon