updateDiscountRule( )

Updates a discount rule's properties.

The updateDiscountRule() function returns a Promise that resolves when the specified discount rule's properties are updated.

Each time the discount rule is updated, revision increments by 1. The existing revision must be included when updating the discount rule. This ensures you're working with the latest discount rule information, and it prevents unintended overwrites.

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 updateDiscountRule(
  _id: string,
  discountRule: UpdateDiscountRule,
): Promise<DiscountRule>;
Method Parameters
_idstringRequired

Discount rule ID.

discountRuleUpdateDiscountRuleRequired

Discount rule info.

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

async function updateDiscountRule(id, discountRule, options) {
  const response = await discountRules.updateDiscountRule(
    id,
    discountRule,
    options,
  );
}
Errors

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

Did this help?