Graph API Version

    Whats App Business Phone Number Whatsapp Commerce Settings

    Get, set, or update a WhatsApp business phone number's commerce settings. See Commerce Settings.

    Reading

    Get a business phone number's WhatsApp Commerce Settings. Returns empty if commerce settings have not been set.

    Requirements

    Additional Requirements

    Example

    Graph API Explorer
    GET /v19.0/{whats-app-business-phone-number-id}/whatsapp_commerce_settings HTTP/1.1
    Host: graph.facebook.com
    /* PHP SDK v5.0.0 */
    /* make the API call */
    try {
      // Returns a `Facebook\FacebookResponse` object
      $response = $fb->get(
        '/{whats-app-business-phone-number-id}/whatsapp_commerce_settings',
        '{access-token}'
      );
    } catch(Facebook\Exceptions\FacebookResponseException $e) {
      echo 'Graph returned an error: ' . $e->getMessage();
      exit;
    } catch(Facebook\Exceptions\FacebookSDKException $e) {
      echo 'Facebook SDK returned an error: ' . $e->getMessage();
      exit;
    }
    $graphNode = $response->getGraphNode();
    /* handle the result */
    /* make the API call */
    FB.api(
        "/{whats-app-business-phone-number-id}/whatsapp_commerce_settings",
        function (response) {
          if (response && !response.error) {
            /* handle the result */
          }
        }
    );
    /* make the API call */
    new GraphRequest(
        AccessToken.getCurrentAccessToken(),
        "/{whats-app-business-phone-number-id}/whatsapp_commerce_settings",
        null,
        HttpMethod.GET,
        new GraphRequest.Callback() {
            public void onCompleted(GraphResponse response) {
                /* handle the result */
            }
        }
    ).executeAsync();
    /* make the API call */
    FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                                   initWithGraphPath:@"/{whats-app-business-phone-number-id}/whatsapp_commerce_settings"
                                          parameters:params
                                          HTTPMethod:@"GET"];
    [request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                          id result,
                                          NSError *error) {
        // Handle the result
    }];
    If you want to learn how to use the Graph API, read our Using Graph API guide.

    Parameters

    This endpoint doesn't have any parameters.

    Fields

    Reading from this edge will return a JSON formatted result:

    { "data": [], "paging": {} }

    data

    A list of WhatsAppCommerceSettings nodes.

    paging

    For more details about pagination, see the Graph API guide.

    Error Codes

    ErrorDescription
    100Invalid parameter
    104Incorrect signature

    Creating

    You can't perform this operation on this endpoint.

    Updating

    You can't perform this operation on this endpoint.

    Deleting

    You can't perform this operation on this endpoint.