Graph API Version

Commerce Merchant Settings

Reading

Commerce Merchant Settings object

Example

Graph API Explorer
GET /v7.0/{commerce-merchant-settings-id} 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(
    '/{commerce-merchant-settings-id}',
    '{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(
    "/{commerce-merchant-settings-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{commerce-merchant-settings-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{commerce-merchant-settings-id}"
                                      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

FieldDescription
id
numeric string

ID of the Commerce Merchant Settings

braintree_merchant_id
string

The Braintree Merchant ID (for BigCommerce)

checkout_message
string

Checkout Message of Commerce Merchant Settings

contact_email
string

Contact email of Commerce Merchant Settings

disable_checkout_urls
bool

Ignore checkout_urls for offsite links forthis merchant, if they exist on products.

display_name
string

Business display name

facebook_channel
CommerceFacebookChannel

Facebook channel settings

has_discount_code
bool

Whether or not this merchant has discount code

instagram_channel
CommerceInstagramChannel

Instagram channel settings

merchant_alert_email
string

Place to send alert emails for the merchant

merchant_page

Profile of the merchant selling products

merchant_status
enum

Current status of the merchant

onsite_commerce_merchant
CommerceMerchantSettingsOnsiteCommerceMerchant

Commerce Merchant Settings Info for the new commerce platform API

payment_provider
enum

Payment Provider for Commerce Merchant Settings

privacy_url_by_locale
list<KeyValue:string,string>

Map from locale to merchant privacy policy url. The locale follows the format of concatenating ISO language and country code with an underscore. For instance, en_US represents U.S. English.

review_rejection_messages
list<string>

Descriptive rejection messages corresponding to the given rejection reasons, if applicable

review_rejection_reasons
list<enum>

Reasons the merchant was rejected on review (for onboarding requests or performance metrics), if applicable

review_status
enum

The internal review status of the merchant

supported_card_types
list<enum>

Credit card types supported by the merchant

terms
string

Terms of Commerce Merchant Settings

terms_url_by_locale
list<KeyValue:string,string>

Map from locale to merchant terms url. The locale follows the format of concatenating ISO language and country code with an underscore. For instance, en_US represents U.S. English.

Edges

EdgeDescription

App ID that is authorized to manage this shop

Product catalogs attached to this merchant

Order Returns for this Merchant

Onboarding status for this merchant

Tax settings including information about fulfillment locations

Validation Rules

ErrorDescription
100Invalid parameter
200Permissions error

Creating

You can't perform this operation on this endpoint.

Updating

You can update a CommerceMerchantSettings by making a POST request to /{commerce_merchant_settings_id}.

Parameters

ParameterDescription
contact_email
string

Contact email for the storefront

merchant_alert_email
string

Place to send alert emails for the merchant

merchant_status
enum {ENABLED, EXTERNALLY_DISABLED}

Current status of the merchant

onsite_commerce_merchant
Object

onsite_commerce_merchant

merchant_page_id
numeric string or integer

merchant_business_info
JSON object

merchant_fulfillment
JSON object

marketplace_approval_requested
boolean

merchant_status
enum {ENABLED, EXTERNALLY_DISABLED}

override_existing_merchant_settings
boolean

sandboxed
boolean

terms
string

Terms and conditions for the storefront (full text or a URL)

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
}

Validation Rules

ErrorDescription
100Invalid parameter
200Permissions error

Deleting

You can't perform this operation on this endpoint.