Backend API
Gift card debits keep a record of transactions for which a gift card is used for payment in order to ensure that a gift card balance is updated with each use. These debit collections are stored on the gift card entry and associated each transaction to the parent gift card and payment entries.
Fields
Unique identifier for the gift card debit.
The id of the parent gift card.
Link to the parent gift card.
Date the debit is created.
Date the debit was last updated.
Amount of the debit transaction.
The id of the related payment.
Link to the associated payment.
The id for the associated refund, if applicable.
Link to the associated refund, if applicable.
Three-letter ISO currency code in uppercase. Defaults to your store's base currency.
The gift card debit model
{
"parent_id": "5fd21b2b53c2be21778d1f7e",
"payment_id": "5fd21b5353c2be21778d3293",
"amount": 35,
"currency": "USD",
"date_created": "2020-12-10T12:57:55.651Z",
"id": "5fd21b5353c2be21778d337d"
}Create a new gift card debit.
Arguments
The ID of the gift card debit.
Initial gift card debit value. Minimum of 0.01.
ID of the parent gift card.
Three-letter ISO currency code in uppercase. Defaults to the store's base currency.
Date and time the gift card debit was created.
Date and time the gift card debit was last updated.
Expandable link to the payment.
Unique identifier for the refund.
const { swell } = require('swell-node');
swell.init('store-id', 'secret-key');
await swell.post('/giftcards:debits', {
parent_id: 5fd21b2b53c2be21778d1f7e,
amount: 10.99,
currency: 'USD'
});The gift card debit model
{
"parent_id": "5fd21b2b53c2be21778d1f7e",
"payment_id": "5fd21b5353c2be21778d3293",
"amount": 35,
"currency": "USD",
"date_created": "2020-12-10T12:57:55.651Z",
"id": "5fd21b5353c2be21778d337d"
}Retrieve an existing gift card debit using the ID that was returned when created.
Arguments
ID of the gift card debit to be retrieved.
const { swell } = require('swell-node');
swell.init('store-id', 'secret-key');
await swell.get('/giftcards:debits/{id}', {
});The gift card debit model
{
"parent_id": "5fd21b2b53c2be21778d1f7e",
"payment_id": "5fd21b5353c2be21778d3293",
"amount": 35,
"currency": "USD",
"date_created": "2020-12-10T12:57:55.651Z",
"id": "5fd21b5353c2be21778d337d"
}Update an existing gift card debit using the ID that was returned when created.
Arguments
Unique identifier for the gift card debit.
const { swell } = require('swell-node');
swell.init('store-id', 'secret-key');
await swell.put('/giftcards:debits/{id}', {
id: '62ced9a991f00e001279a07e',
currency: 'JPY'
});The gift card debit model
{
"parent_id": "5fd21b2b53c2be21778d1f7e",
"payment_id": "5fd21b5353c2be21778d3293",
"amount": 35,
"currency": "USD",
"date_created": "2020-12-10T12:57:55.651Z",
"id": "5fd21b5353c2be21778d337d"
}Return a list of gift card debits.
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('/giftcards:debits', {
});The gift card debit model
{
"parent_id": "5fd21b2b53c2be21778d1f7e",
"payment_id": "5fd21b5353c2be21778d3293",
"amount": 35,
"currency": "USD",
"date_created": "2020-12-10T12:57:55.651Z",
"id": "5fd21b5353c2be21778d337d"
}Delete a gift card debit permanently.
Arguments
The ID of the gift card debit to delete.
const { swell } = require('swell-node');
swell.init('store-id', 'secret-key');
await swell.delete('/giftcards:debits/{id}', {
});The gift card debit model
{
"parent_id": "5fd21b2b53c2be21778d1f7e",
"payment_id": "5fd21b5353c2be21778d3293",
"amount": 35,
"currency": "USD",
"date_created": "2020-12-10T12:57:55.651Z",
"id": "5fd21b5353c2be21778d337d"
}