Docs
Management API
Checkout Settings

Checkout Settings

Get Checkout Settings

GET /checkouts/settings

Request

Get checkout settings

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required

    The MIME type of the response body.

example

Response

Body

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

example

Update Checkout Settings

PUT /checkouts/settings

Request

Update checkout settings

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • 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.

example

Response

Body

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

example

Did you find what you were looking for?