GiftCardFindAll Endpoint

Overview

This endpoint allows you to find all of the gift cards that are in your store.  This allows you to list them and parse them for any number of reasons or purposes.

Requirements

The following pre-requisites will be necessary to accomplish the goals of this article:

  • General understanding of REST and API’s
  • Understanding of C# and/or JavaScript
  • Visual Studio 2012 or newer

Getting Started

You should already have a project open and ready to accept code to allow you to use this REST API endpoint.  You should also have one or more gift cards created so that you can successfully find them.

GiftCardsFindAll

This REST API endpoint allows you to find all of the gift cards in your store. 

Example URL

This is what the REST endpoint will look like if you are calling it using JavaScript.  See our REST API URL documentation for more information.

http://example.com/DesktopModules/Hotcakes/API/rest/v1/giftcards

HTTP Method

GET

Parameters

There are no parameters for this endpoint.

Returns

If successful, this endpoint will return a populated list of the GiftCardDTO object in JSON format.  Otherwise, you should have one or more errors returned.  

Example Code

The following code will allow you to successfully call this endpoint, provided that you have enabled it.

Project References

  • Hotcakes.CommerceDTO

Import Namespaces

  • Hotcakes.CommerceDTO.v1
  • Hotcakes.CommerceDTO.v1.Catalog
  • Hotcakes.CommerceDTO.v1.Client

 

string url = "http://example.com";
string key = "YOUR-API-KEY";

Api proxy = new Api(url, key);

// call the API to find all gift cards in the store
ApiResponse<List<GiftCardDTO>> response = proxy.GiftCardFindAll();
// your domain name
var url = "http://example.com"; 
// the path where the API is
var apiPath = "/DesktopModules/Hotcakes/API/rest/v1/";  
// endpoint as shown in the documentation
var endPoint = "giftcards";  
// get this from the store admin
var apiKey = "YOUR-API-KEY";

$(document).ready(function() {

    // call the API to find all gift cards in the store
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "?key=" + apiKey,
        type: 'GET',
        success: function (data) {
            // do something
        },
        error: function (jqXHR, textStatus) {
           // do something else
        }
    });

});
{
   "Errors":[

   ],
   "Content":[
      {
         "GiftCardId":1,
         "StoreId":1,
         "LineItemId":null,
         "CardNumber":"GC1234567890",
         "Amount":100.0000000000,
         "UsedAmount":0.0000000000,
         "IssueDateUtc":"\/Date(1412410476190)\/",
         "ExpirationDateUtc":"\/Date(1475568875937)\/",
         "RecipientEmail":"info@hotcakescommerce.com",
         "RecipientName":"John Dough",
         "GiftMessage":null,
         "Enabled":true
      },
      {
         "GiftCardId":4,
         "StoreId":1,
         "LineItemId":null,
         "CardNumber":"GC0123456789",
         "Amount":100.0000000000,
         "UsedAmount":0.0000000000,
         "IssueDateUtc":"\/Date(1412412616397)\/",
         "ExpirationDateUtc":"\/Date(1475571016177)\/",
         "RecipientEmail":"info@hotcakescommerce.com",
         "RecipientName":"John Dough",
         "GiftMessage":null,
         "Enabled":true
      },
      {
         "GiftCardId":5,
         "StoreId":1,
         "LineItemId":null,
         "CardNumber":"SCA8C09AS7C87A97",
         "Amount":100.0000000000,
         "UsedAmount":0.0000000000,
         "IssueDateUtc":"\/Date(1412412895627)\/",
         "ExpirationDateUtc":"\/Date(1475571295407)\/",
         "RecipientEmail":"info@hotcakescommerce.com",
         "RecipientName":"John Dough",
         "GiftMessage":null,
         "Enabled":true
      },
      {
         "GiftCardId":6,
         "StoreId":1,
         "LineItemId":null,
         "CardNumber":"3XM077873701327010",
         "Amount":100.0000000000,
         "UsedAmount":0.0000000000,
         "IssueDateUtc":"\/Date(1412412912260)\/",
         "ExpirationDateUtc":"\/Date(1475571312063)\/",
         "RecipientEmail":"info@hotcakescommerce.com",
         "RecipientName":"John Dough",
         "GiftMessage":null,
         "Enabled":true
      },
      {
         "GiftCardId":7,
         "StoreId":1,
         "LineItemId":null,
         "CardNumber":"D5R435ZD4GZRRHZNJ54J534",
         "Amount":100.0000000000,
         "UsedAmount":0.0000000000,
         "IssueDateUtc":"\/Date(1412412924340)\/",
         "ExpirationDateUtc":"\/Date(1475571324120)\/",
         "RecipientEmail":"info@hotcakescommerce.com",
         "RecipientName":"John Dough",
         "GiftMessage":null,
         "Enabled":true
      }
   ]
}
Have more questions? Submit a request

Need More Help?

Do you need more assistance with this article? Please review your support options.