getCheckoutTemplate( )

Retrieves a checkout template.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
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";

async function getCheckoutTemplate(checkoutTemplateId) {
  const response =
    await checkoutTemplates.getCheckoutTemplate(checkoutTemplateId);
}
Errors

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

Did this help?