setDiscounts( )


Applies or unapplies discounts on a draft order.

Unapplied discounts are still part of the draft order, but do not affect balance. Existing discounts that are not passed in the request will keep their current state.

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage eCommerce - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
draftOrderIdstringRequired

Draft order ID.


discountsArray<IdAndApplied>Required

Discounts to set on the draft order.

Any existing discounts that are not passed will not change.

Returns
Return Type:Promise<SetDiscountsResponse>
Errors
404Not Found

There is 1 error with this status code.

409Already Exists

There is 1 error with this status code.

428Failed Precondition

There are 2 errors with this status code.

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

Did this help?