Docs
Management API
Checkouts
Checkout Settings

Checkout Settings

Get Checkout Settings

GET /checkouts/settings

Request

Get checkout settings

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/checkouts/settings' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

example

{
"data": {
"custom_checkout_script_url": "https://example.com/custom-checkout-script.js",
"order_confirmation_use_custom_checkout_script": false,
"custom_order_confirmation_script_url": "https://example.com/custom-order-confirmation-script.js",
"custom_checkout_supports_uco_settings": false,
"custom_checkout_sri_hash": "sha256-1234567890",
"order_confirmation_sri_hash": "sha256-0987654321"
},
"meta": {}
}

Update Checkout Settings

PUT /checkouts/settings

Request

Update checkout settings

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

object | application/json

  • custom_checkout_script_url    string

    Custom checkout script URL to replace our default checkout. To reset a store to optimized one-page checkout, pass an empty string for custom_checkout_script_url and custom_order_confirmation_script_url.

  • order_confirmation_use_custom_checkout_script    boolean

    When order_confirmation_use_custom_checkout_script=true, the default custom_order_confirmation_script_url defaults to an empty string.

  • custom_order_confirmation_script_url    string

    Custom order confirmation script URL to replace the default order confirmation. To reset a store to optimized one-page checkout, pass an empty string for custom_checkout_script_url and custom_order_confirmation_script_url.

  • custom_checkout_supports_uco_settings    boolean

    Boolean value that specifies whether this checkout supports Optimized One-Page Checkout settings.

  • custom_checkout_sri_hash    string

    The Subresource Integrity (SRI) hash for the custom checkout script URL.

  • custom_order_confirmation_sri_hash    string

    The Subresource Integrity (SRI) hash for the custom order confirmation script URL.

example

{
"custom_checkout_script_url": "string",
"order_confirmation_use_custom_checkout_script": true,
"custom_order_confirmation_script_url": "string",
"custom_checkout_supports_uco_settings": true,
"custom_checkout_sri_hash": "string",
"custom_order_confirmation_sri_hash": "string"
}

Response

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

example

{
"data": {
"custom_checkout_script_url": "https://example.com/custom-checkout-script.js",
"order_confirmation_use_custom_checkout_script": false,
"custom_order_confirmation_script_url": "https://example.com/custom-order-confirmation-script.js",
"custom_checkout_supports_uco_settings": false,
"custom_checkout_sri_hash": "sha256-1234567890",
"order_confirmation_sri_hash": "sha256-0987654321"
},
"meta": {}
}
Did you find what you were looking for?
Create an OrderGet Checkout Settings