Checkout Settings
Get Checkout Settings
GET https://api.bigcommerce.com/stores/{store_hash}/v3/checkouts/settingsRequest
Get checkout settings
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
example
Response
Body
object | application/json
dataobject
example
Update Checkout Settings
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/checkouts/settingsRequest
Update checkout settings
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Body
object | application/json
custom_checkout_script_urlstring
Custom checkout script URL to replace our default checkout. To reset a store to optimized one-page checkout, pass an empty string forcustom_checkout_script_urlandcustom_order_confirmation_script_url.order_confirmation_use_custom_checkout_scriptboolean
When order_confirmation_use_custom_checkout_script=true, the default custom_order_confirmation_script_url defaults to an empty string.custom_order_confirmation_script_urlstring
Custom order confirmation script URL to replace the default order confirmation. To reset a store to optimized one-page checkout, pass an empty string forcustom_checkout_script_urlandcustom_order_confirmation_script_url.custom_checkout_supports_uco_settingsboolean
Boolean value that specifies whether this checkout supports Optimized One-Page Checkout settings.custom_checkout_sri_hashstring
The Subresource Integrity (SRI) hash for the custom checkout script URL.custom_order_confirmation_sri_hashstring
The Subresource Integrity (SRI) hash for the custom order confirmation script URL.
example
Response
Body
object | application/json
dataobject
example
Did you find what you were looking for?