getCheckoutTemplate( )


Developer Preview

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

Retrieves a checkout template.

Authentication

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

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
function getCheckoutTemplate(
  checkoutTemplateId: string,
): Promise<CheckoutTemplate>;
Method Parameters
checkoutTemplateIdstringRequired

ID of the checkout template to retrieve.

Returns
Return Type:Promise<CheckoutTemplate>
JavaScript
import { checkoutTemplates } from "wix-ecom-backend"; async function getCheckoutTemplate(checkoutTemplateId) { try { const result = await checkoutTemplates.getCheckoutTemplate(checkoutTemplateId); return result; } catch (error) { console.error(error); // Handle the error } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?