updateCheckoutSettings( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates the sites' checkout settings.

The updateCheckoutSettings() function returns a Promise that resolves to the newly updated checkout settings.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Stores - all permissions
Manage Restaurants - all permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
checkoutSettingsCheckoutSettingsRequired

Checkout settings to update.

optionsUpdateCheckoutSettingsOptions
Returns
Return Type:Promise<UpdateCheckoutSettingsResponse>
Was this helpful?
Yes
No