Backend API
Update an existing coupon using the ID that was returned when created.
Arguments
Unique identifier for the coupon.
Indicates the coupon is currently active. Note: this is not affected by date_valid and date_expired.
Date the coupon is considered expired and no longer available for use. When defined, the coupon will not be valid after this date.
A short descriptive name of the coupon.
Expandable list of codes used to identify the coupon.
Three-letter ISO currency code in uppercase. Defaults to base currency.
Date the coupon is first available for use. When defined, the coupon will not be valid until after this date and before `date_expired`.
A brief description of the coupon, as it may be displayed to customers.
ID of the discount group the coupon belongs to, if applicable, as defined in discount settings. Used to ensure only one set of discount rules can apply across a number of coupons and promotions.
List of discount rules to apply.
Type of discount to apply. Can be total, product, category, or shipment.
Possible enum values:
Type of discount amount to calculate. Can be fixed or percent.
Possible enum values:
Fixed discount applied when value_type=fixed.
Percentage discount applied when value_type=percent.
Minimum order total required for the rule to apply.
The maximum amount of a discount that can be redeemed.
The minimum amount of a discount that can be redeemed.
Minimum product quantity required for the rule to apply, applicable for category and product discounts.
Maximum product quantity for which the rule will apply, applicable for category and product discounts.
ID of the product to discount, if applicable.
ID of the variant to discount, if applicable.
Quantity of the product to add to cart, if applicable.
ID of the shipping service to discount, if applicable.
Expandable link to the discounted product, if applicable.
Expandable link to the discounted variant, if applicable.
Expandable link to the discounted category, if applicable.
Expandable link to categories excluded from the promotion, if applicable.
List of items that need to be purchased before the promotion becomes eligible.
ID of the product that is tied to the promotion eligibility, if applicable.
Expandable link to the promotion-eligible product, if applicable.
ID of the category that is tied to the promotion eligibility, if applicable.
Expandable link to the promotion-eligible category, if applicable.
List of items eligible for promotion after designated products have been purchased.
ID of the product to discount, if applicable.
Expandable link to the discounted product, if applicable.
ID of the discounted category, if applicable.
Expandable link to the discounted category, if applicable.
List of customer account groups allowed to use the coupon.
Maximum number of times the coupon can be used by each customer account.
Maximum number of invoices the promotion may be applied to for a subscription.
Maximum number of times each coupon code can be applied. Mainly used with multiple codes.
Maximum number of times the coupon can be applied across all customers.
Indicates the coupon is identified by multiple coupon codes.
Number of times the coupon has been used.
const { swell } = require('swell-node');
swell.init('store-id', 'secret-key');
await swell.put('/coupons/{id}', {
id: '60f199509111e70000000015',
limit_uses: 300,
active: true
});
Response
{
"id": "60f199509111e70000000015",
"name": "10% Off Winter Jacket Sale",
"active": true,
"codes": [
{
"code": "WINTER10"
}
],
"currency": "USD",
"date_created": "2021-07-16T14:36:00.100Z",
"date_expired": "2018-03-01T00:00:00.000Z",
"date_updated": "2021-07-16T14:36:00.100Z",
"date_valid": "2018-11-01T00:00:00.000Z",
"description": "Save 10% on all Winter Jackets for a limited time only.",
"discount_group": null,
"discounts": [
{
"type": "category",
"category_id": "5a97242bc65396a875c2d381",
"value_type": "percent",
"value_fixed": 10
}
],
"limit_account_uses": 3,
"limit_code_uses": 10,
"limit_uses": 300,
"multi_codes": false,
"use_count": 184
}