Get Channel-Specific Checkout Settings

GET

https://api.bigcommerce.com/stores/:store_hash/v3/checkouts/settings/channels/:channelId

GET

/stores/:store_hash/v3/checkouts/settings/channels/:channelId

curl https://api.bigcommerce.com/stores/store_hash/v3/checkouts/settings/channels/1 \
     -H "X-Auth-Token: <apiKey>"

{
  "data": {
    "checkout_type": null,
    "guest_checkout_type": "no_guest_checkout",
    "guest_checkout_for_existing_accounts": "require_login",
    "custom_checkout_script_url": null,
    "policy_consent": "express",
    "order_confirmation_contact_email": null,
    "order_confirmation_use_custom_checkout_script": null,
    "custom_order_confirmation_script_url": null,
    "is_order_terms_and_conditions_enabled": null,
    "order_terms_and_conditions_type": null,
    "order_terms_and_conditions_link": null,
    "order_terms_and_conditions_textarea": null,
    "custom_checkout_supports_uco_settings": null,
    "custom_checkout_supports_data_hydration": null,
    "should_redirect_to_storefront_for_auth": true,
    "support_b2b_settings": null,
    "custom_checkout_sri_hash": null,
    "custom_order_confirmation_sri_hash": null
  },
  "meta": {}
}

Returns the checkout settings for a given channel (storefront) by channelId.

Each field is null when the channel has no override for it. In that case, the store-level value from Get Checkout Settings applies.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Checkouts	modify	`store_checkouts`
Checkouts	read-only	`store_checkouts_read_only`
Checkout Content	modify	`store_checkout_content`
Checkout Content	read-only	`store_checkout_content_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

channelIdintegerRequired

The ID of the channel.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Response

Channel checkout settings retrieved successfully

dataobjectOptional

Checkout settings that override the store-level settings for one channel. Every field is nullable. A null value means the channel has no override and uses the store-level value. Channel settings do not include checkout_style_override, checkout_style_override_sri_hash, or enhanced_checkout_experience.

metaobjectOptional

Response metadata.

Errors

422

Unprocessable Entity Error