Checkouts
Get Checkout Settings
GET /stores/{store_hash}/v3/checkouts/settings
Request
Get checkout settings
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
example
Response
Body
dataobject
metaobject
Response metadata.
example
Update Checkout Settings
PUT /stores/{store_hash}/v3/checkouts/settings
Request
Update checkout settings
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
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 for
custom_checkout_script_url
andcustom_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 for
custom_checkout_script_url
andcustom_order_confirmation_script_url
.custom_checkout_supports_uco_settingsboolean
Boolean value that specifies whether this checkout supports Optimized One-Page Checkout settings.
example
Response
Body
dataobject
metaobject
Response metadata.