Backend API: Create a gift card

Create a new gift card.

Arguments

accountAccount

Expandable link to an account where the value was redeemed as account credit, if applicable.

account_idobjectId

ID of an account where the value was redeemed as account credit, if applicable.

amountcurrencyrequired

Initial gift card value. Minimum of 0.01.

amount_spentcurrencyauto

Amount of the gift card that has been spent on orders.

balancecurrencyauto

Remaining balance on the gift card.

bulk_descriptionstringauto

A brief description of the occasion for generating a batch of gift cards.

bundle_item_idobjectId

ID of the associated bundle item, if applicable.

codestring

Unique code to identify the gift card.

code_formattedstring

Formatted gift card code for display purposes.

code_patternstring

String pattern used to display the code in a human-friendly format.

currencystring

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

currency_ratefloat

Currency percentage used in calculating the fixed amount.

date_bulk_generateddateauto

If the gift card was generated in bulk, this will be the date it was generated.

date_expireddate

Date the gift card will expire and can no longer be spent or redeemed. Defaults to the time period defined in gift card settings.

debitsarray of Debits

Expandable list of debit transactions created when the gift card is spent.

disabledboolean

Indicates the gift card is disabled and can't be spent or redeemed further.

last4stringauto

Last four digits of the gift card code.

orderOrder

Expandable link to the order that originated the gift card, if applicable.

order_idobjectIdauto

ID of the order that originated the gift card, if applicable.

order_item_idobjectIdauto

ID of the order item that originated the gift card, if applicable.

product_idobjectIdauto

ID of the product that originated the gift card, if applicable.

redeemedbooleanauto

Indicates the gift card was fully redeemed for account credit to `account_id`.

send_emailstring

Email address of the gift card recipient, if applicable.

send_notestring

Customer note sent to the gift card recipient by email, if applicable.

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

await swell.post('/giftcards', {
  amount: 100
});

The gift card model

{
  "id": "60f199509111e70000000022",
  "amount": 100,
  "amount_spent": 25,
  "balance": 75,
  "code": "C9X9L7D9Q3MAXC3P",
  "code_formatted": "C9X9 L7D9 Q3MA XC3P",
  "code_pattern": "{XXXX} {XXXX} {XXXX} {XXXX}",
  "currency": "USD",
  "date_created": "2021-07-16T14:36:00.142Z",
  "date_updated": "2021-07-16T14:36:00.142Z",
  "last4": "XC3P",
  "redeemed": false,
  "send_email": "friend@example.com",
  "send_note": null
}