Update Checkout Settings
Updates the store-level checkout settings. Settings you omit remain unchanged.
To install a custom checkout, send checkout_type: custom with a non-empty custom_checkout_script_url. To return to Optimized One-Page Checkout, send an empty string for custom_checkout_script_url and custom_order_confirmation_script_url. Sending a non-empty script URL while checkout_type is optimized returns a 422.
When is_order_terms_and_conditions_enabled is true, include order_terms_and_conditions_type and the matching order_terms_and_conditions_link or order_terms_and_conditions_textarea.
Authentication
OAuth scopes
Authentication header
Further reading
For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.
For more about BigCommerce OAuth scopes, see our Guide to API Accounts.
For a list of API status codes, see API Status Codes.
Path parameters
Headers
The MIME type of the response body.
Request
The checkout type. optimized uses Optimized One-Page Checkout. custom loads the script at custom_checkout_script_url, which must be set when the type is custom. Setting a non-empty custom_checkout_script_url while the type is optimized returns a 422.
How guest shoppers can check out. guest_checkout allows guest checkout. guest_checkout_account allows guest checkout and creates a customer account when the order completes. no_guest_checkout requires shoppers to sign in.
How checkout treats a guest whose email matches an existing customer account. allow_guest lets them continue as a guest. require_login makes them sign in. encourage_login prompts them to sign in but lets them continue as a guest. When guest_checkout_type is no_guest_checkout, the channel-level value is set to require_login.
Custom checkout script URL to replace the default checkout. Accepts an https URL or a webdav: path to a file uploaded with WebDAV. To reset a store to Optimized One-Page Checkout, pass an empty string for custom_checkout_script_url and custom_order_confirmation_script_url.
How checkout collects privacy policy consent. none does not show a privacy policy. standard shows the privacy policy. express requires the shopper to actively consent before placing the order.
Whether the order confirmation page loads the same script as the custom checkout. When true, custom_order_confirmation_script_url defaults to an empty string.
Custom order confirmation script URL to replace the default order confirmation page. Accepts an https URL or a webdav: path. To reset a store to Optimized One-Page Checkout, pass an empty string for custom_checkout_script_url and custom_order_confirmation_script_url.
Whether shoppers must accept order terms and conditions before placing an order. When true, order_terms_and_conditions_type is required, and the matching order_terms_and_conditions_link or order_terms_and_conditions_textarea must not be empty.
How the terms and conditions display at checkout. link links to the page at order_terms_and_conditions_link. textarea shows the text in order_terms_and_conditions_textarea. Returns an empty string when terms and conditions are not configured.
The URL of the terms and conditions page. Used when order_terms_and_conditions_type is link.
The terms and conditions text shown at checkout. Used when order_terms_and_conditions_type is textarea.
Whether the custom checkout supports Optimized One-Page Checkout settings from the control panel.
Whether the custom checkout receives the checkout’s initial state when it loads, instead of fetching it after load. Takes effect only when initial-state hydration for custom checkouts is enabled for the store.
Whether checkout redirects shoppers to the storefront to sign in, so a headless storefront keeps the customer session in sync. Set to true for Catalyst and other headless storefronts that manage customer authentication.
The Subresource Integrity (SRI) hash for the custom checkout script. Accepts a sha256-, sha384-, or sha512- hash, or an empty string to remove the hash.
The Subresource Integrity (SRI) hash for the custom order confirmation script. Accepts a sha256-, sha384-, or sha512- hash, or an empty string to remove the hash.
URL of a CSS file that overrides the Optimized One-Page Checkout styles. Accepts an https URL or a webdav: path that ends in .css. Pass an empty string to remove the override.
The Subresource Integrity (SRI) hash for the stylesheet at checkout_style_override. Accepts a sha256-, sha384-, or sha512- hash, or an empty string when no hash is set.
Response
The store-level checkout settings.