Backend API

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.

Fields

idobjectId

Unique identifier for the coupon.

namestringrequired

A short descriptive name of the coupon.

activeboolean

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

codesarray of Codes

Expandable list of codes used to identify the coupon.

currencystring

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

date_createddate

Date and time the coupon was created.

date_expireddate

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

date_updateddate

Date and time the coupon was last updated.

date_validdate

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

descriptionstring

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

discount_groupstring

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.

discountsarray of object

List of discount rules to apply.

limit_code_usesint

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

limit_usesint

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

limit_account_usesint

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

limit_account_groupsarray of account_groups

List of customer account groups allowed to use the coupon.

multi_codesboolean

Indicates the coupon is identified by multiple coupon codes.

ordersOrder

Expandable list of orders that have applied the coupon.

subscriptionsSubscription

Expandable list of subscriptions that have applied the coupon.

use_countint

Number of times the coupon has been used.

usesarray of Uses

Expandable list of coupon code usage records.

generationsarray of Generations

List of coupon generations.

active_generationsCoupon generation

List of coupon generations that are active.

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 new coupon.

Arguments

namestringrequired

A short descriptive name of the coupon.

descriptionstring

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

activeboolean

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

date_expireddate

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

discountsarray of objectrequired

List of discount rules to apply.

codesarray of Codesrequired

Expandable list of codes used to identify the coupon.

multi_codesboolean

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 an existing coupon using the ID that was returned when created.

Arguments

idobjectIdrequired

The ID of the coupon to retrieve.

expandstring

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.

fieldsstring

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.

includestring

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 an existing coupon using the ID that was returned when created.

Arguments

idobjectIdrequired

Unique identifier for the coupon.

activeboolean

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

date_expireddate

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

namestring

A short descriptive name of the coupon.

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
}

Return a list of coupons.

Arguments

expandstring

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.

fieldsstring

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.
includeobject

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

See including for more details.

limitint

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

pageint

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

searchstring

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.

sortstring

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.

whereobject

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 permanently.

Arguments

idobjectIdrequired

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
}