Backend API
Promotions are a way to offer customers a discount without a coupon code, by automatically applying discounts to their cart. A promotion can have several discounts and exceptions. For example, a promotion discount can apply to a whole order, to particular categories, to individual products, or to shipping methods. A promotion can be limited to a maximum number of uses, by specific customer groups, and more.
Fields
Unique identifier for the promotion.
A short descriptive name of the promo.
Indicates the promo is currently active. Note: this is not affected by date_start and date_end.
Three-letter ISO currency code in uppercase. Defaults to the store's base currency.
Date and time the promotion was created.
Date the promo ends and is no longer available. When defined, the promo will not be applied after this date.
Date the promo is first available. When defined, the promo will not be valid until after this date and before date_end.
Date and time the promotion was last updated.
A brief description of the promo, as it may be displayed to customers.
ID of the discount group the promo 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.
Items required to be purchased in order to receive the promotion.
Unique identifier for the category.
Expandable link to the category.
Unique identifier for the product.
Expandable link to the product.
Expandable link to the discounted category, if applicable.
ID of the category to discount, if applicable.
Maximum redeemable discount amount for the coupon.
Expandable list of excluded categories, if applicable.
List of category IDs to exclude from discount, applicable to category discounts when several categories overlap.
Eligible discounted items available once promotion's buy_items requirements are met.
Unique identifier for the category.
Expandable link to the category.
Unique identifier for the product.
Expandable link to the product.
Indicates whether the get_items promotion requirements have been met.
Minimum product price required for the rule to apply, applicable for category and product discounts.
Expandable link to the discounted product, if applicable.
ID of the product to discount, if applicable.
Maximum product quantity for which the rule will apply, applicable for category and product discounts.
Minimum product quantity required for the rule to apply, applicable for category and product discounts.
ID of the shipping service to discount, if applicable.
Minimum order total required for the rule to apply.
Type of discount to apply. Can be total, product, category or shipment.
Possible enum values:
Fixed discount applied when value_type=fixed.
Percentage discount applied when value_type=percent.
ID of the variant to discount, if applicable.
Type of discount amount to calculate. Can be fixed or percent.
Possible enum values:
Purchase option the discount applies to.
Possible enum values:
ID of the subscription plan the discount applies to, when purchase_option is subscription_plan.
Expandable link to the discounted variant, if applicable.
List of exclusions considered when the promo is applied.
ID of the category to exclude from the promo.
Expandable link to the category excluded from the promo.
ID of the product to exclude from the promo.
Expandable link to the product excluded from the promo.
Type of exclusion. Can be product or category.
Possible enum values:
List of customer account for which the promo will apply.
Maximum number of times the promo will be applied by each customer account.
Maximum number of times the promo will be applied across all customers.
Expandable list of orders that have applied the promo.
Expandable list of subscriptions that have applied the promo.
Number of times the promo has been applied.
Expandable list of promotion use records.
The promotion model
{
"id": "60f199509111e7000000006b",
"name": "15% Off Store Wide Sale",
"active": true,
"currency": "USD",
"date_created": "2021-07-16T14:36:00.386Z",
"date_end": "2018-03-01T00:00:00.000Z",
"date_start": "2018-11-01T00:00:00.000Z",
"date_updated": "2021-07-16T14:36:00.386Z",
"description": "Save 15% store wide for a limited time only.",
"discounts": [
{
"type": "total",
"value_type": "percent",
"value_fixed": 15
}
],
"limit_account_uses": 3,
"limit_uses": 300,
"use_count": 142
}Create a new promotion.
Arguments
A short descriptive name of the promo.
A brief description of the promo, as it may be displayed to customers.
Indicates the promo is currently active. Note: this is not affected by date_start and date_end.
Date the promo is first available. When defined, the promo will not be valid until after this date and before date_end.
Date the promo ends and is no longer available. When defined, the promo will not be applied after this date.
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.
ID of the shipping service to discount, if applicable.
ID of the category to discount, if applicable.
List of category IDs to exclude from discount, applicable to category discounts when several categories overlap.
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 list of excluded categories, if applicable.
Items required to be purchased in order to receive the promotion.
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 promotion'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 whether the get_items promotion requirements have been met.
Number of times the promo has been applied.
Maximum number of times the promo will be applied across all customers.
Maximum number of times the promo will be applied by each customer account.
List of customer account for which the promo will apply.
ID of the discount group the promo 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 exclusions considered when the promo is applied.
The type of exclusion for the promotion. Can be either product or category.
Possible enum values:
ID of the product to exclude from the discount, if applicable.
ID of the category to exclude from the discount, if applicable.
Expandable link to the excluded product, if applicable.
Expandable link to the excluded category, if applicable.
Expandable list of promo usage records.
Expandable list of orders that have applied the promo.
Expandable list of subscriptions that have applied the promo.
Three-letter ISO currency code in uppercase. Defaults to the store's base currency.
const { swell } = require('swell-node');
swell.init('store-id', 'secret-key');
await swell.post('/promotions', {
discounts: [
{
type: 'total',
value_type: 'percent',
value_fixed: 15
}
],
name: '15% Off Store Wide Sale',
active: true,
date_end: '2018-03-01T00:00:00.000Z',
date_start: '2018-11-01T00:00:00.000Z',
description: 'Save 15% store wide for a limited time only.'
});
Response
{
"id": "60f199509111e7000000006b",
"name": "15% Off Store Wide Sale",
"active": true,
"currency": "USD",
"date_created": "2021-07-16T14:36:00.386Z",
"date_end": "2018-03-01T00:00:00.000Z",
"date_start": "2018-11-01T00:00:00.000Z",
"date_updated": "2021-07-16T14:36:00.386Z",
"description": "Save 15% store wide for a limited time only.",
"discounts": [
{
"type": "total",
"value_type": "percent",
"value_fixed": 15
}
],
"limit_account_uses": 3,
"limit_uses": 300,
"use_count": 142
}Retrieve an existing promotion using the ID that was returned when created.
Arguments
The ID of the promotion to retrieve.
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.
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 one or more arbitrary queries in the response, possibly related to the main query.
See including for more details.
const { swell } = require('swell-node');
swell.init('store-id', 'secret-key');
await swell.get('/promotions/{id}', {
id: '60f199509111e70000000071'
});
Response
{
"id": "60f199509111e70000000071",
"name": "15% Off Store Wide Sale",
"active": true,
"currency": "USD",
"date_created": "2021-07-16T14:36:00.386Z",
"date_end": "2018-03-01T00:00:00.000Z",
"date_start": "2018-11-01T00:00:00.000Z",
"date_updated": "2021-07-16T14:36:00.386Z",
"description": "Save 15% store wide for a limited time only.",
"discounts": [
{
"type": "total",
"value_type": "percent",
"value_fixed": 15
}
],
"limit_account_uses": 3,
"limit_uses": 300,
"use_count": 142
}Update an existing promotion using the ID that was returned when created.
Arguments
Unique identifier for the promotion.
Indicates the promo is currently active. Note: this is not affected by date_start and date_end.
Date the promo ends and is no longer available. When defined, the promo will not be applied after this date.
A short descriptive name of the promo.
Three-letter ISO currency code in uppercase. Defaults to the store's base currency.
Date the promo is first available. When defined, the promo will not be valid until after this date and before date_end.
A brief description of the promo, as it may be displayed to customers.
ID of the discount group the promo 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 mimimum 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.
ID of the shipping service to discount, if applicable.
ID of the category to discount, if applicable.
List of category IDs to exclude from discount, applicable to category discounts when several categories overlap.
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 list of excluded categories, 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 exclusions considered when the promo is applied.
The type of exclusion for the promotion. Can be either product or category.
Possible enum values:
ID of the product to exclude from the discount, if applicable.
ID of the category to exclude from the discount, if applicable.
Expandable link to the excluded product, if applicable.
Expandable link to the excluded category, if applicable.
Number of times the promo has been applied.
Maximum number of times the promo will be applied across all customers.
Maximum number of times the promo will be applied by each customer account.
List of customer account for which the promo will apply.
const { swell } = require('swell-node');
swell.init('store-id', 'secret-key');
await swell.put('/promotions/{id}', {
id: '60f199509111e7000000006b',
limit_uses: 300,
active: true
});
Response
{
"id": "60f199509111e7000000006b",
"name": "15% Off Store Wide Sale",
"active": true,
"currency": "USD",
"date_created": "2021-07-16T14:36:00.386Z",
"date_end": "2018-03-01T00:00:00.000Z",
"date_start": "2018-11-01T00:00:00.000Z",
"date_updated": "2021-07-16T14:36:00.386Z",
"description": "Save 15% store wide for a limited time only.",
"discounts": [
{
"type": "total",
"value_type": "percent",
"value_fixed": 15
}
],
"limit_account_uses": 3,
"limit_uses": 300,
"use_count": 142
}Return a list of promotions.
Arguments
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.
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 one or more arbitrary queries in the response which are potentially related to the main query.
See including for more details.
Limit the number of records returned, ranging between 1 and 1000. Defaults to 15.
The page number of results to return given the specified or default limit.
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.
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.
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.
const { swell } = require('swell-node');
swell.init('store-id', 'secret-key');
await swell.get('/promotions', {
where: {
active: true
},
limit: 25,
page: 1
});
Response
{
"count": 51,
"results": [
{
"id": "60f199509111e7000000006b",
"name": "15% Off Store Wide Sale",
"active": true,
"currency": "USD",
"date_created": "2021-07-16T14:36:00.386Z",
"date_end": "2018-03-01T00:00:00.000Z",
"date_start": "2018-11-01T00:00:00.000Z",
"date_updated": "2021-07-16T14:36:00.386Z",
"description": "Save 15% store wide for a limited time only.",
"discounts": [
{
"type": "total",
"value_type": "percent",
"value_fixed": 15
}
],
"limit_account_uses": 3,
"limit_uses": 300,
"use_count": 142
},
{...},
{...}
],
"page": 1,
"pages": {
"1": {
"start": 1,
"end": 25
},
"2": {
"start": 26,
"end": 50
},
"2": {
"start": 51,
"end": 51
}
}
}Delete a promotion permanently.
Arguments
The id of the promotion to delete.
const { swell } = require('swell-node');
swell.init('store-id', 'secret-key');
await swell.delete('/promotions/{id}', {
id: '60f199509111e70000000077'
});
Response
{
"id": "60f199509111e70000000077",
"name": "15% Off Store Wide Sale",
"active": true,
"currency": "USD",
"date_created": "2021-07-16T14:36:00.386Z",
"date_end": "2018-03-01T00:00:00.000Z",
"date_start": "2018-11-01T00:00:00.000Z",
"date_updated": "2021-07-16T14:36:00.386Z",
"description": "Save 15% store wide for a limited time only.",
"discounts": [
{
"type": "total",
"value_type": "percent",
"value_fixed": 15
}
],
"limit_account_uses": 3,
"limit_uses": 300,
"use_count": 142
}