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 and redirects to the new checkout page.
Before using this function, you must have a checkout template available. Create a checkout template with createCheckoutTemplate()
.
To build a URL that uses this function, follow this format:
https://www.wixapis.com/ecom/v1/checkout-templates/{checkoutTemplateId}/create-and-redirect-to-checkout?siteId={siteId}
To create a checkout but not automatically redirect to the checkout page, use createCheckoutFromTemplate()
.
function createAndRedirectToCheckout(
checkoutTemplateId: string,
siteId: string,
): Promise<RawHttpResponse>;
ID of the checkout template to use to create a checkout.
ID of the site associated with the checkout template.
import { checkoutTemplates } from "wix-ecom-backend";
async function createAndRedirectToCheckout(checkoutTemplateId, siteId) {
try {
const result = await checkoutTemplates.createAndRedirectToCheckout(
checkoutTemplateId,
siteId,
);
return result;
} catch (error) {
console.error(error);
// Handle the error
}
}
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.