Coupon

Update coupon

Requires the stores.coupons.update permission.

put/stores/{storeId}/coupons/{couponId}

Request

Base URL
https://api.komerza.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/komerza/apis/komerza-api/docs/stores/:storeId/coupons/:couponId/put.ts
A function with typed inputs. Its response is checked against the schema.

storeIdstring uuid required

The ID of the store that the coupon belongs to

couponIdstring uuid required

The ID of the coupon to update

codestring required

The case-insensitive code the customer will enter to redeem the coupon.

maximumUsesinteger required

The maximum number of times the coupon may be used. Set to –1 for unlimited uses.

percentageDecreasenumber double nullable

The percentage to subtract from the order total when the coupon is applied.

amountDecreasenumber double nullable

A fixed amount to subtract from the order total when the coupon is applied.

isEnabledboolean required

Whether the coupon is active and may be used at checkout.

variantIdsstring[] nullable

The list of variant IDs this coupon applies to; null or empty for all variants.

The object was successfully updated.

successboolean required

Indicates whether the operation or response was successful.

messagestring nullable

A descriptive message providing additional context or information about the response.

codestring nullable

The error code (if there was an error) to use when referencing the error

No recorded changes to this operation across all 1 revision of this API.