Get Channel-Specific Checkout Settings | BigCommerce Developer Center

import requests
url = "https://api.bigcommerce.com/stores/store_hash/v3/checkouts/settings/channels/channelId"
headers = {"X-Auth-Token": "<apiKey>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "data": {
    "checkout_type": "string",
    "custom_checkout_script_url": "string",
    "custom_checkout_sri_hash": "string",
    "custom_checkout_supports_uco_settings": true,
    "custom_order_confirmation_script_url": "string",
    "custom_order_confirmation_sri_hash": "string",
    "guest_checkout_for_existing_accounts": "string",
    "guest_checkout_type": "string",
    "is_order_terms_and_conditions_enabled": true,
    "order_confirmation_contact_email": "string",
    "order_confirmation_use_custom_checkout_script": true,
    "order_terms_and_conditions_link": "string",
    "order_terms_and_conditions_textarea": "string",
    "order_terms_and_conditions_type": "string",
    "policy_consent": "string",
    "should_redirect_to_storefront_for_auth": true
  },
  "meta": {}
}

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

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.

### 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](/developer/docs/overview/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Path parameters

channelIdstringRequired

Response

Channel checkout settings retrieved successfully

dataobject

metaobject

Response metadata.

Errors

422

Unprocessable Entity Error