Backend API

Fields

idobjectIdauto

The unique identifier for the purchase link.

namestringrequired

Human-friendly name of the purchase link.

itemsarray of object

List of line items describing the products ordered.

activebooleanauto

The active status of the purchase link is automatically set to off and must be toggled on to activate, share, and use.

coupon_idobjectId

ID of the coupon applied to purchase link items.

couponcoupon

Expandable link to the coupon applied to purchase link items.

discountsarray of object

Discounts applied to purchase link items.

sub_totalcurrency

The subtotal of all of the items in a purchase link.

item_discountcurrency

Total discount applied to line items.

discount_totalcurrency

Total discount amount.

grand_totalcurrencyauto

Grand total including items, shipping, and taxes.

metadataobject

Arbitrary data, typically set in a checkout flow to store custom values. See Frontend API for more details.

The purchase link model
{
  "active": true,
  "name": "Mythic Dawn Commentaries Collection",
  "items": [
    {
      "product_id": "628ba6011869c10019b41f70",
      "quantity": 1,
      "price": 60,
      "id": "628ba7241869c10019b41f7d",
      "orig_price": 60,
      "delivery": "shipment",
      "shipment_weight": 0,
      "price_total": 60,
      "discount_total": 0,
      "discount_each": 0
    },
    {
      "product_id": "628ba67a1869c10019b41f76",
      "quantity": 1,
      "price": 60,
      "id": "628ba728499bba0019b1a9c2",
      "orig_price": 60,
      "delivery": "shipment",
      "shipment_weight": 0,
      "price_total": 60,
      "discount_total": 0,
      "discount_each": 0
    },
    {
      "product_id": "628ba6b7499bba0019b1a9b2",
      "quantity": 1,
      "price": 60,
      "id": "628ba72b499bba0019b1a9c5",
      "orig_price": 60,
      "delivery": "shipment",
      "shipment_weight": 0,
      "price_total": 60,
      "discount_total": 0,
      "discount_each": 0
    },
    {
      "product_id": "628ba701499bba0019b1a9bb",
      "quantity": 1,
      "price": 60,
      "id": "628ba72d499bba0019b1a9c8",
      "orig_price": 60,
      "delivery": "shipment",
      "shipment_weight": 0,
      "price_total": 60,
      "discount_total": 0,
      "discount_each": 0
    }
  ],
  "shipment_delivery": true,
  "currency": "USD",
  "sub_total": 240,
  "item_discount": 0,
  "discount_total": 0,
  "grand_total": 240,
  "date_created": "2022-05-23T15:24:20.977Z",
  "date_updated": "2022-05-23T15:24:32.137Z",
  "id": "5wFVZQzV"
}

Create a purchase link.

Arguments

namestringrequired

Human-friendly name of the purchase link.

itemsarray of object

List of line items describing the products ordered.

activeboolean

Indicates the cart has been updated by a customer within the last 3 hours.

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

await swell.post('/purchaselinks', {
	name: 'Purchase link example',
	active: true,
	items: [
    {
      product_id: '626034d4e7b741001968292d',
      quantity: 1,
    }
  ],
  });
Response
{
  "active": true,
  "name": "Purchase link example",
  "items": [
    {
      "product_id": "626034d4e7b741001968292d",
      "quantity": 1,
      "price": 5,
      "price_total": 5,
      "discount_total": 0,
      "discount_each": 0,
      "id": "62681502ea4c3f00138da5ea"
    }
  ],
  "currency": "USD",
  "sub_total": 5,
  "item_discount": 0,
  "discount_total": 0,
  "grand_total": 5,
  "date_created": "2022-04-26T15:51:30.324Z",
  "date_updated": "2022-04-26T15:52:33.949Z",
  "id": "DEEFRebs"
}

Retrieve a purchase link.

Arguments

idobjectIdrequired

The id of the cart to retrieve.

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

await swell.get('/purchaselinks/{id}');
Response
{
  "active": true,
  "name": "Purchase link example",
  "items": [
    {
      "product_id": "626034d4e7b741001968292d",
      "quantity": 1,
      "price": 5,
      "price_total": 5,
      "discount_total": 0,
      "discount_each": 0,
      "id": "62681502ea4c3f00138da5ea"
    }
  ],
  "currency": "USD",
  "sub_total": 5,
  "item_discount": 0,
  "discount_total": 0,
  "grand_total": 5,
  "date_created": "2022-04-26T15:51:30.324Z",
  "date_updated": "2022-04-26T15:52:33.949Z",
  "id": "DEEFRebs"
}

Update a purchase link.

Arguments

idobjectIdrequired

Unique identifier for the cart.

nameobjectId

Human-friendly name of the purchase link.

activeboolean

The active status of the purchase link is automatically set to off and must be toggled on to activate, share, and use.

itemsarray of object

List of line items describing the products ordered.

coupon_codestring

Coupon code applied to the cart. See coupons for details.

promotion_idsarray of child_scalar

List of promotion IDs applied to the cart.

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

await swell.put('/purchaselinks/{id}', {
  active: 'true',
});
Response
{
  "active": true,
  "name": "Purchase link example",
  "items": [
    {
      "product_id": "626034d4e7b741001968292d",
      "quantity": 1,
      "price": 5,
      "price_total": 5,
      "discount_total": 0,
      "discount_each": 0,
      "id": "62681502ea4c3f00138da5ea"
    }
  ],
  "currency": "USD",
  "sub_total": 5,
  "item_discount": 0,
  "discount_total": 0,
  "grand_total": 5,
  "date_created": "2022-04-26T15:51:30.324Z",
  "date_updated": "2022-04-26T15:52:33.949Z",
  "id": "DEEFRebs"
}

List all purchase links.

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/purchaselinks
const swell = require('swell-node').init('store-id', 'secret-key');

await swell.get('/purchaselinks/');
Response
{
  "count": 39,
  "results": [
    {
      "active": true,
      "name": "Purchase link example",
      "items": [
        {
          "product_id": "626034d4e7b741001968292d",
          "options": [
            {
              "id": "626034de60bd1a69a444f233",
              "name": "Size20-04",
              "value": "s",
              "value_id": "626034ee60bd1a69a444f234",
              "variant": true
            }
          ],
          "quantity": 1,
          "price": 5,
          "price_total": 5,
          "discount_total": 0,
          "discount_each": 0,
          "id": "62681502ea4c3f00138da5ea"
        }
      ],
      "currency": "USD",
      "sub_total": 5,
      "item_discount": 0,
      "discount_total": 0,
      "grand_total": 5,
      "date_created": "2022-04-26T15:51:30.324Z",
      "date_updated": "2022-04-26T15:52:33.949Z",
      "id": "DEEFRebs"
    },
    {
      "active": true,
      "name": "Test items",
      "items": [
        {
          "product_id": "625daa41e6e0e30019c4a084",
          "quantity": 1,
          "price": 100,
          "id": "625daa53e6e0e30019c4a2a3",
          "orig_price": 100,
          "delivery": "shipment",
          "shipment_weight": 0,
          "price_total": 100,
          "discount_total": 50,
          "discount_each": 50,
          "discounts": [
            {
              "id": "coupon-0",
              "amount": 50
            }
          ]
        }
      ],
      "shipment_delivery": true,
      "currency": "USD",
      "sub_total": 100,
      "item_discount": 50,
      "discount_total": 50,
      "grand_total": 50,
      "date_created": "2022-04-18T17:51:34.937Z",
      "date_updated": "2022-04-18T18:13:40.581Z",
      "coupon_code": "SIMPLETEST",
      "promotion_ids": [
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        "625da6a2e6e0e30019c471dd"
      ],
      "coupon_id": "625da691e6e0e30019c46fea",
      "discounts": [
        {
          "type": "coupon",
          "rule": {
            "value_fixed": 50,
            "type": "total",
            "value_type": "fixed"
          },
          "amount": 50,
          "id": "coupon-0"
        }
      ],
      "shipment_discount": null,
      "id": "vASbh0zY"
    },
    {
      "name": "NEW PURCHASE LINK",
      "items": [
        {
          "purchase_option": {
            "plan_id": "6256eb710c7aaf0012dd1731",
            "billing_schedule": {
              "interval": "weekly",
              "interval_count": 1,
              "trial_days": 0,
              "limit": null
            },
            "type": "subscription",
            "plan_name": "Weekly"
          },
          "quantity": 1,
          "price": 65,
          "product_id": "6256eb710c7aaf0012dd1722",
          "id": "62599ad09a57a6001a8ca827",
          "orig_price": 65,
          "shipment_weight": 0,
          "price_total": 65,
          "discount_total": 0,
          "discount_each": 0
        }
      ],
      "subscription_delivery": true,
      "currency": "USD",
      "sub_total": 65,
      "item_discount": 0,
      "discount_total": 0,
      "grand_total": 65,
      "date_created": "2022-04-15T16:18:24.644Z",
      "active": true,
      "date_updated": "2022-04-15T16:31:35.254Z",
      "id": "midpIahm"
    },
		. . .
  ],
  "page": 1,
  "pages": {
    "1": {
      "start": 1,
      "end": 15
    },
    "2": {
      "start": 16,
      "end": 30
    },
    "3": {
      "start": 31,
      "end": 39
    }
  }
}

Delete a purchase link.

Arguments

idobjectIdrequired

The id for the purchase link to delete.

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

await swell.delete('/purchaselinks/{id}', {
});
Response
{
  "active": true,
  "name": "Purchase link example",
  "items": [
    {
      "product_id": "626034d4e7b741001968292d",
      "quantity": 1,
      "price": 5,
      "price_total": 5,
      "discount_total": 0,
      "discount_each": 0,
      "id": "62681502ea4c3f00138da5ea"
    }
  ],
  "currency": "USD",
  "sub_total": 5,
  "item_discount": 0,
  "discount_total": 0,
  "grand_total": 5,
  "date_created": "2022-04-26T15:51:30.324Z",
  "date_updated": "2022-04-26T15:52:33.949Z",
  "id": "DEEFRebs"
}