updateCheckoutTemplate( )

Updates a checkout template.

If the info in a checkout template is updated, only new checkouts created from this template will include the updated items. Checkouts previously created from this template before the update will not be affected.

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 updateCheckoutTemplate(
  _id: string,
  checkoutTemplate: UpdateCheckoutTemplate,
): Promise<CheckoutTemplate>;
Method Parameters
_idstringRequired

Checkout template ID.

checkoutTemplateUpdateCheckoutTemplateRequired

Checkout template info to update.

Returns
Return Type:Promise<CheckoutTemplate>
JavaScript
import { checkoutTemplates } from "@wix/ecom";

async function updateCheckoutTemplate(id, checkoutTemplate) {
  const response = await checkoutTemplates.updateCheckoutTemplate(
    id,
    checkoutTemplate,
  );
}
Errors
400Invalid Argument

There are 4 errors with this status code.

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

Did this help?