GiftCardFindAllByPage Endpoint

Overview

You may have a performance wary routine or a paged user interface.  No matter the reason, this endpoint allows you to request a subset of gift cards in a paged fashion to fit these use cases and more.

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 several gift cards created so that you can successfully request one or more pages of results.

GiftCardFindAllByPage

This REST API endpoint allows you to request a specific page of gift cards based upon a page size you define.  This should help you with paged user interfaces as well as to adjust costly logic for custom applications. 

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/?key=[YOURKEY]&page=[PAGE]&pagesize=[PAGESIZE]

PAGE and PAGESIZE are described in the parameters below.

HTTP Method

GET

Parameters

Parameter Description
page This is an integer value and should reflect the page number of the result set that you want to have returned. For example, pass "1" for the first page of gift cards.
pagesize This number is also an integer and should be consistent for any group of requests using this endpoint to ensure consistent results.   For example, a page size of 5 will consistently return 5 results, but they will be different based upon which page number is requested.

Returns

If successful, this endpoint will return a populated list of 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);

// specify the page number to get
var page = 1;

// specify how many gift cards should be in each page
var pageSize = 3;

// call the API to find all gift cards in the store
ApiResponse<List<GiftCardDTO>> response = proxy.GiftCardFindAllByPage(page, pageSize);
// 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() {

    // specify the page number to get
    var page = 1;

    // specify how many gift cards should be in each page
    var pageSize = 3;

    // call the API to find all gift cards in the store
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "?key=" + apiKey + "&page=" + page + "&pageSize=" + pageSize,
        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
      }
   ]
}
Have more questions? Submit a request

Need More Help?

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