Coupons

Coupons are a way to offer customers a discount with a coupon code. A coupon can have several discounts and exceptions. For example, a coupon discount can apply to a whole order, to particular categories, to individual products, or to shipping methods. A coupon can be limited to a maximum number of uses, by specific customer groups, by expiration date, and more.

The coupon model

Fields

id

objectId

Unique identifier for the coupon.

name

stringrequired

A short descriptive name of the coupon.

active

boolean

Indicates the coupon is currently active. Note: this is not affected by `date_valid` and `date_expired`.

active_generations

Coupon generation

List of coupon generations that are active.

codes

array of Codes

Expandable list of codes used to identify the coupon.

currency

string

Three-letter ISO currency code in uppercase. Defaults to the store's base currency.

date_created

date

Date and time the coupon was created.

date_expired

date

Date the coupon is considered expired and no longer available for use. When defined, the coupon will not be valid after this date.

date_updated

date

Date and time the coupon was last updated.

date_valid

date

Date the coupon is first available for use. When defined, the coupon will not be valid until after this date and before date_expired.

description

string

A brief description of the coupon, as it may be displayed to customers.

discount_group

string

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.

discounts

array of object

List of discount rules to apply.

.type

enum

Type of discount to apply. Can be total, product, category, or shipment.

Possible enum values:

totalshipmentproductcategorybuy_get

.value_type

enumrequired

Type of value to calculate discount amount. Can be fixed or percent.

Possible enum values:

fixedpercent

.category_id

objectId

ID of the category to discount, if applicable.

.category

.exclude_category_ids

array of child_scalarrequired

List of category IDs to exclude from discount, applicable to category discounts when several categories overlap.

.exclude_categories

exclude_categoriesrequired

Expandable list of excluded categories, if applicable.

.price_min

currency

Minimum product price required for the rule to apply, applicable for category and product discounts.

.product_id

objectId

ID of the product to discount, if applicable.

.product

product

Expandable link to the discounted product, if applicable.

.quantity_add

int

Quantity of the product to add to cart, if applicable.

.quantity_max

int

Maximum product quantity required for the rule to apply, applicable for category and product discounts.

.quantity_min

int

Minimum product quantity required for the rule to apply, applicable for category and product discounts.

.shipment_service

stringrequired

ID of the shipping service to discount, if applicable.

.total_min

currency

Minimum order total required for the rule to apply.

.value_fixed

currency

Fixed discount applied when value_type=fixed.

.value_percent

float

Percentage discount applied when value_type=percent.

.variant_id

objectId

ID of the variant to discount, if applicable.

.variant

variantrequired

Expandable link to the discounted variant, if applicable.

.buy_items

array of object

Items required to be purchased in order to receive the coupon.

.get_items

array of object

Eligible discounted items available once a coupon's buy_items requirements are met.

.get_total

boolean

Indicates whether the get_items promotion requirements have been met.

.discount_max

currency

Maximum redeemable discount amount for the coupon.

generations

array of Generations

List of coupon generations.

limit_code_uses

int

Maximum number of times each coupon code can be applied. Mainly used with multiple codes.

limit_uses

int

Maximum number of times the coupon can be applied across all customers.

limit_account_uses

int

Maximum number of times the coupon can be used by each customer account.

limit_account_groups

array of account_groups

List of customer account groups allowed to use the coupon.

limit_subscription_uses

int

Maximum number of invoices the promotion may be applied to for a subscription.

multi_codes

boolean

Indicates the coupon is identified by multiple coupon codes.

orders

Order

Expandable list of orders that have applied the coupon.

subscriptions

Subscription

Expandable list of subscriptions that have applied the coupon.

use_count

int

Number of times the coupon has been used.

uses

array of Uses

Expandable list of coupon code usage records.

The coupon model

{
  "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
}

Create a coupon

Create a new coupon. If you wish to generate your own unique ID for the record, it must use BSON ObjectID format for compatibility.

Arguments

name

stringrequired

A short descriptive name of the coupon.

active

boolean

Indicates the coupon is currently active. Note: this is not affected by `date_valid` and `date_expired`.

codes

array of Codesrequired

Expandable list of codes used to identify the coupon.

date_expired

date

Date the coupon is considered expired and no longer available for use. When defined, the coupon will not be valid after this date.

description

string

A brief description of the coupon, as it may be displayed to customers.

discounts

array of objectrequired

List of discount rules to apply.

.type

enum

Type of discount to apply. Can be total, product, category, or shipment.

Possible enum values:

totalshipmentproductcategorybuy_get

.value_type

enumrequired

Type of discount amount to calculate. Can be fixed or percent.

Possible enum values:

fixedpercent

.value_fixed

currency

Fixed discount applied when value_type=fixed.

.value_percent

float

Percentage discount applied when value_type=percent.

.total_min

currency

Minimum order total required for the rule to apply.

.discount_max

currency

The maximum amount of a discount that can be redeemed.

.price_min

currency

The minimum amount of a discount that can be redeemed.

.quantity_min

int

Minimum product quantity required for the rule to apply, applicable for category and product discounts.

.quantity_max

int

Maximum product quantity for which the rule will apply, applicable for category and product discounts.

.product_id

objectId

ID of the product to discount, if applicable.

.variant_id

objectId

ID of the variant to discount, if applicable.

.quantity_add

int

Quantity of the product to add to cart, if applicable.

.shipment_service

string

ID of the shipping service to discount, if applicable.

.category_id

objectId

Unique identifier for the category.

.exclude_category_ids

array of child_scalar

List of category IDs excluded by the coupon.

.product

product

Expandable link to the discounted product, if applicable.

.variant

variant

Expandable link to the discounted variant, if applicable.

.category

.exclude_categories

exclude_categories

Expandable link to categories excluded from the promotion, if applicable.

.buy_items

array of object

Items required to be purchased in order to receive the coupon.

.get_items

array of object

Eligible discounted items available once a coupon's buy_items requirements are met.

.get_total

boolean

multi_codes

boolean

Indicates the coupon is identified by multiple coupon codes.

POST/coupons

const swell = require('swell-node').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
}

Retrieve a coupon

Retrieve an existing coupon using the ID that was returned when created.

Arguments

id

objectIdrequired

The ID of the coupon to retrieve.

expand

string

Expanding link fields and child collections is performed using the expand argument.

For example, expand=account would return a related customer account if one exists.

When the field represents a collection, you can specify the query limit.

For example, expand=variants:10 would return up to 10 records of the variants collection.

See expanding for more details.

fields

string

Return only the specified fields in the result. For example fields=name,slug would return only the fields name and slug in the response. Supports nested object and array fields using dot-notation, for example, items.product_id. The category id is always returned.

include

string

Include one or more arbitrary queries in the response, possibly related to the main query.

See including for more details.

GET/coupons/:id

const swell = require('swell-node').init('store-id', 'secret-key');

await swell.get('/coupons/{id}', {
  id: '60f199509111e70000000018'
});

Response

{
  "id": "60f199509111e7000000001b",
  "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
}

Update a coupon

Update an existing coupon using the ID that was returned when created.

Arguments

id

objectIdrequired

Unique identifier for the coupon.

active

boolean

Indicates the coupon is currently active. Note: this is not affected by date_valid and date_expired.

date_expired

date

Date the coupon is considered expired and no longer available for use. When defined, the coupon will not be valid after this date.

name

string

A short descriptive name of the coupon.

codes

array of Codesrequired

Expandable list of codes used to identify the coupon.

currency

string

Three-letter ISO currency code in uppercase. Defaults to base currency.

date_valid

date

Date the coupon is first available for use. When defined, the coupon will not be valid until after this date and before `date_expired`.

description

string

A brief description of the coupon, as it may be displayed to customers.

discount_group

string

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.

discounts

array of objectrequired

List of discount rules to apply.

.type

enum

Type of discount to apply. Can be total, product, category, or shipment.

Possible enum values:

totalshipmentproductcategorybuy_get

.value_type

enumrequired

Type of discount amount to calculate. Can be fixed or percent.

Possible enum values:

fixedpercent

.value_fixed

currency

Fixed discount applied when value_type=fixed.

.value_percent

float

Percentage discount applied when value_type=percent.

.total_min

currency

Minimum order total required for the rule to apply.

.discount_max

currency

The maximum amount of a discount that can be redeemed.

.price_min

currency

The minimum amount of a discount that can be redeemed.

.quantity_min

int

Minimum product quantity required for the rule to apply, applicable for category and product discounts.

.quantity_max

int

Maximum product quantity for which the rule will apply, applicable for category and product discounts.

.product_id

objectId

ID of the product to discount, if applicable.

.variant_id

objectId

ID of the variant to discount, if applicable.

.quantity_add

int

Quantity of the product to add to cart, if applicable.

.shipment_service

string

ID of the shipping service to discount, if applicable.

.category_id

objectId

.exclude_category_ids

array of child_scalar

.product

product

Expandable link to the discounted product, if applicable.

.variant

variant

Expandable link to the discounted variant, if applicable.

.category

.exclude_categories

exclude_categories

Expandable link to categories excluded from the promotion, if applicable.

.buy_items

array of object

List of items that need to be purchased before the promotion becomes eligible.

.get_items

array of object

List of items eligible for promotion after designated products have been purchased.

.get_total

boolean

limit_account_groups

array of child_scalar

List of customer account groups allowed to use the coupon.

limit_account_uses

int

Maximum number of times the coupon can be used by each customer account.

limit_subscription_uses

int

Maximum number of invoices the promotion may be applied to for a subscription.

limit_code_uses

int

Maximum number of times each coupon code can be applied. Mainly used with multiple codes.

limit_uses

int

Maximum number of times the coupon can be applied across all customers.

multi_codes

boolean

Indicates the coupon is identified by multiple coupon codes.

use_count

int

Number of times the coupon has been used.

PUT/coupons/:id

const swell = require('swell-node').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
}

List all coupons

Return a list of coupons.

Arguments

expand

string

Expand link fields and child collections by using the expand argument.

For example, expand=account would return a related customer account if one exists.

When the field represents a collection, you can specify the query limit.

For example, expand=variants:10 would return up to 10 records of the variants collection.

See expanding for more details.

fields

string

Returns only the specified fields in the result.

For example fields=name,slug would return only the fields name and slug in the response.

Supports nested object and array fields using dot-notation.

For example, items.product_id. The product id is always returned.

include

object

Include one or more arbitrary queries in the response which are potentially related to the main query.

See including for more details.

limit

int

Limit the number of records returned, ranging between 1 and 1000. Defaults to 15.

page

int

The page number of results to return given the specified or default limit.

search

string

A text search is performed using the search argument. Searchable fields are defined by the model.

For example, search=red would return records containing the word "red" anywhere in the defined text fields.

See searching for more details.

sort

string

Expression to sort results by using a format similar to a SQL sort statement.

For example, sort=name asc would return records sorted by name ascending.

See sorting for more details.

where

object

An object with criteria to filter the result.

For example, active=true would return records containing a field active with the value true.

It's also possible to use query operators, for example, $eq, $ne, $gt, and more.

See querying for more details.

GET/coupons

const swell = require('swell-node').init('store-id', 'secret-key');

await swell.get('/coupons', {
  where: {
    active: true
  },
  limit: 25,
  page: 1
});

Response

{
  "count": 51,
  "results": [
    {
      "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
    },
    {...},
    {...}
  ],
  "page": 1,
  "pages": {
    "1": {
      "start": 1,
      "end": 25
    },
    "2": {
      "start": 26,
      "end": 50
    },
    "2": {
      "start": 51,
      "end": 51
    }
  }
}

Delete a coupon

Delete a coupon permanently.

Arguments

id

objectIdrequired

The ID of the coupon to delete.

DELETE/coupons/:id

const swell = require('swell-node').init('store-id', 'secret-key');

await swell.delete('/coupons/{id}', {
  id: '60f199509111e7000000001e'
});

Response

{
  "id": "60f199509111e70000000021",
  "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
}

← Back: Invoices Next: Coupon codes →