POST

Create Checkout From Template

Creates a new checkout based on the checkout template.

Before using this endpoint, you must have a checkout template available. Create a checkout template with Create Checkout Template.

The customer can be directed to the new checkout using the checkout's checkoutUrl.

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/ecom/v1/checkout-templates/{checkoutTemplateId}/create-checkout-from-template
Path Params
checkoutTemplateIdstringRequired

ID of the checkout template to use to create a checkout from.

Body Params
siteIdstringRequiredformat GUID

ID of the site associated with the checkout template.

Response Object
checkoutIdstringformat GUID

ID of the created checkout.

checkoutUrlstring

URL of the created checkout page.

purchaseFlowIdstringformat GUID

Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.

Create Checkout From Template
Request
cURL
Response
JSON
Errors
428Failed Precondition

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Event TriggersThis method triggers the following events:
Checkout Template Used
Did this help?