BigCommerce · Schema

Checkouts settings request

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
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
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
custom_checkout_supports_uco_settings boolean Boolean value that specifies whether this checkout supports Optimized One-Page Checkout settings.
View JSON Schema on GitHub

JSON Schema

bigcommerce-checkoutssettingsrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CheckoutsSettingsRequest",
  "title": "Checkouts settings request",
  "type": "object",
  "properties": {
    "custom_checkout_script_url": {
      "type": "string",
      "description": "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": {
      "type": "boolean",
      "description": "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": {
      "type": "string",
      "description": "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": {
      "type": "boolean",
      "description": "Boolean value that specifies whether this checkout supports Optimized One-Page Checkout settings."
    }
  },
  "description": ""
}