createCheckoutFromTemplate( )
Developer Preview
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Creates a new checkout based on the checkout template.
Before using this function, you must have a checkout template available. Create a checkout template with createCheckoutTemplate().
The customer can be directed to the new checkout using the checkout's checkoutUrl.
Permission Scopes
For app development, you must have one of the following permission scopes:Manage Stores - all permissions
Manage eCommerce - all permissions
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
checkoutTemplateIdstringRequired
ID of the checkout template to use to create a checkout from.
siteIdstringRequired
ID of the site associated with the checkout template.
Returns
Return Type:Promise<CreateCheckoutFromTemplateResponse>
Was this helpful?
Yes
No