logo
Powered by Redocly

Gift Cards

Add, edit, and delete anything related to gift cards.

Giftcard

giftcard_id
string

The unique, redeemable ID and should be 12 characters.

amount
number

The amount available on the giftcard.

message
string

The redeem message to the customer

{
  • "giftcard_id": "string",
  • "amount": 0,
  • "message": "string"
}

Gets a list of gift cards

This allows you to get a list of gift cards

SecuritybearerAuth or basicAuth
Request
query Parameters
page
integer <int64>

Page number starting at 1

perpage
integer <int64>

Number of items per page

sortby
string

Sort results by term

sortdir
string

Sort results ASC or DESC

search
string

Filter gift cards by a search term

Responses
200

Successful operation

400

Unauthorized

get/giftcards
Request samples 
Response samples 
application/json
[
  • {
    }
]
Add a Gift Card
This allows you to add a new gift card


SecuritybearerAuth 
Request 
Request Body schema: application/json
required
Submit any or all elements to add a new gift card.


giftcard_id
required
string
The unique, redeemable ID and should be 12 characters.


 
amount
number
The amount available on the giftcard.


 
message
string
The redeem message to the customer


 
Responses 
200
Successful operation


400
Unauthorized


post/giftcards
Request samples 
application/json
{
  • "giftcard_id": "string",
  • "amount": 0,
  • "message": "string"
}
Response samples 
application/json
{
  • "giftcard_id": "string",
  • "amount": 0,
  • "message": "string"
}
Gets a gift card by ID
This allows you to get a gift card from your store by ID


SecuritybearerAuth or basicAuth 
Request 
path Parameters
giftcard_id
required
string^[0-9A-Z]+$
Giftcard ID


 
Responses 
200
Successful operation


400
Unauthorized


get/giftcards/{giftcard_id}
Request samples 
Response samples 
application/json
{
  • "giftcard_id": "string",
  • "amount": 0,
  • "message": "string"
}
Updates a gift card by code
This allows you to update a gift card


SecuritybearerAuth 
Request 
path Parameters
giftcard_id
required
string^[0-9A-Z]+$
Giftcard ID


 
Request Body schema: application/json
required
Submit any or all elements to update the gift card.


giftcard_id
string
The unique, redeemable ID and should be 12 characters.


 
amount
number
The amount available on the giftcard.


 
debit
number
The amount to deduct (subtract) from the gift card.


 
credit
number
The amount credit (add) to the gift card.


 
message
string
The redeem message to the customer


 
Responses 
200
Successful operation


400
Unauthorized


patch/giftcards/{giftcard_id}
Request samples 
application/json
{
  • "giftcard_id": "string",
  • "amount": 0,
  • "debit": 0,
  • "credit": 0,
  • "message": "string"
}
Response samples 
application/json
{
  • "giftcard_id": "string",
  • "amount": 0,
  • "message": "string"
}
Deletes a giftcard by ID
This allows you to delete a gift card from your store


SecuritybearerAuth 
Request 
path Parameters
giftcard_id
required
string^[0-9A-Z]+$
Giftcard ID


 
Responses 
200
Successful operation


400
Unauthorized


delete/giftcards/{giftcard_id}
Request samples 
Response samples 
application/json
{
  • "giftcard_id": "string",
  • "amount": 0,
  • "message": "string"
}
➔ Next to Manufacturers