Backend API: Retrieve a coupon

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');
swell.init('store-id', 'secret-key');

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

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
}