Backend API
Create a new coupon.
Arguments
A short descriptive name of the coupon.
Indicates the coupon is currently active. Note: this is not affected by `date_valid` and `date_expired`.
Expandable list of codes used to identify the coupon.
Date the coupon is considered expired and no longer available for use. When defined, the coupon will not be valid after this date.
A brief description of the coupon, as it may be displayed to customers.
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.
Unique identifier for the category.
List of category IDs excluded by the coupon.
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.
Items required to be purchased in order to receive the coupon.
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.
Eligible discounted items available once a coupon's buy_items requirements are met.
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.
Indicates the coupon is identified by multiple coupon codes.
List of coupon generations that are active.
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`.
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 coupon generations.
List of customer account groups allowed to use the coupon.
List of account segments for which the coupon is avaialble.
Maximum number of times the coupon can be used by each customer account.
Maximum number of times each coupon code can be applied. Mainly used with multiple codes.
Maximum number of invoices the promotion may be applied to for a subscription.
Maximum number of times the coupon can be applied across all customers.
Expandable list of orders that have applied the coupon.
Expandable list of subscriptions that have applied the coupon.
Number of times the coupon has been used.
Expandable list of coupon code usage records.
const { swell } = require('swell-node');
swell.init('store-id', 'secret-key');
await swell.post('/coupons', {
codes: [
{
code: 'WINTER10'
}
],
discounts: [
{
type: 'category',
category_id: '5a97242bc65396a875c2d381',
value_type: 'percent',
value_fixed: 10
}
],
name: '10% Off Winter Jacket Sale',
active: true,
date_expired: '2018-03-01T00:00:00.000Z',
description: 'Save 10% on all Winter Jackets for a limited time only.',
multi_codes: false
});
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
}