iWAREHOUSE - Gift Card API

The purpose of the Gift Card API is to either CREATE or READ a Gift Card resource. If you are going to use the Gift Card API as part of your website for ecommerce then you are still responsibility for the digital delivery. The API does not create emails or return barcodes. Its purpose it to create the record to say the card is valid and for the value. Making the call to the API should only be done once you have payment.

Gift Cards Assume the following:

• Gift Cards will be sold from the Website
  • On a successful sale (ie payment) the website should hit our gift card API and get a code returned.
  • That code should be emailed to the customer
  • The API does not set denominations, that is up to the website if they want to enforce this.
• Gift Cards are treated like a form of payment.
  • Can be used as part payment.
  • Can used multiple cards on the same order.
• The Code will need to be
  • generated as a random non-sequential code so that people can’t guess a valid code.
  • Ability to printed/scanned as a barcode and or typed into the POS/OLO

Example URL to create a new card:
https://ZZZ.iposwarehouse.com/core/sales/cards/gift/gift_api.asp?log=XXX&pwd=YYY&qty=100&expiresyears=3

Returns:

{
    "CardKey": 5,
    "CardCode": "GCQ22X9HE1",
    "CardActive": true,
    "SiteKey": 0,
    "CustomerKey": 0,
    "ProductKey": 0,
    "CardOpeningDteTme": "4/03/2019",
    "CardOpeningBalance": 100,
    "CardOpeningBalanceManual": 0,
    "CardBalanceDteTme": "",
    "CardBalance": 100,
    "CardExpiryDate": "4/03/2022",
    "CardNotes": ""
}

The API can also be used to read the balance of an existing card:
https://ZZZ.iposwarehouse.com/core/sales/cards/gift/gift_api.asp?log=XXX&pwd=YYY&card=GCQ22X9HE1

Returns:

{
    "CardKey": 5,
    "CardCode": "GCQ22X9HE1",
    "CardActive": true,
    "SiteKey": 0,
    "CustomerKey": 0,
    "ProductKey": 0,
    "CardOpeningDteTme": "4/03/2019",
    "CardOpeningBalance": 100,
    "CardOpeningBalanceManual": 0,
    "CardBalanceDteTme": "",
    "CardBalance": 100,
    "CardExpiryDate": "4/03/2022",
    "CardNotes": ""
}

• The API creates one gift card at a time
• The Code
• has a prefix (in this case GC) but the prefix could be anything. (Allows the POS to recognise a card using the prefix)
• is checked against the database before being returned so it us unique (not used before)
  • is always UPPER CASE
  • can be converted to a Barcode using a Barcode Font in an email or HTML page. (this is not the job of the API).
• There are many fields returned, most of which you don’t need, the important fields are CardCode, CardBalance, and CardExpiryDate
• Substitute XXX and YYY for your login details.
• We suggest using POSTMAN to prove that the API works and you can use this to troubleshoot your code.
• We suggest you log every call and response to the API so that we can compare logs if needed.
• Be aware that JSON is case sensitive

Other expiry options are expiresdays=X, expiresmonths=X, expiresyears=X, expires=date