GiftCardCreate Endpoint

Overview

If your store is going to use gift cards, you'll be able to use this endpoint to create as many gift cards as you need.

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 some kind of idea what attributes that you want your gift card to have before you create it.

GiftCardCreate

This REST API endpoint allows you to create a gift card for 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

POST

Parameters

This method only requires that you pass an instance of the GiftCardDTO object to the endpoint.

Returns

If successful, this endpoint will return a GiftCardDTO object in JSON format.  Otherwise, you will 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);

// create a new gift card object with minimal information
var giftCard = new GiftCardDTO()
{
    CardNumber = "GC1234567890",
    Amount = 100m,
    ExpirationDateUtc = DateTime.UtcNow.AddYears(2),
    RecipientName = "John Dough",
    RecipientEmail = "info@hotcakescommerce.com",
    Enabled = true
};

// call the API to create the giftcard
ApiResponse<GiftCardDTO> response = proxy.GiftCardCreate(giftCard);
// 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 gift card expiration date
    var expirationDate = new Date("10/1/2016");

    // create a new gift card object with minimal information
    var giftCard = {
        "CardNumber": "GC1234567890",
        "Amount": 100,
        "ExpirationDateUtc": expirationDate.toISOString(),
        "RecipientName": "John Dough",
        "RecipientEmail": "info@hotcakescommerce.com",
        "Enabled": true
    };

    // call the API to create the giftcard
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "?key=" + apiKey,
        data: JSON.stringify(giftCard),
        type: 'POST',
        success: function (data) {
            // do something
        },
        error: function(jqXHR, textStatus) {
            // do something else
        }
    });

});
{
   "Errors":[

   ],
   "Content":{
      "GiftCardId":0,
      "StoreId":1,
      "LineItemId":null,
      "CardNumber":"GC1234567890",
      "Amount":100,
      "UsedAmount":0,
      "IssueDateUtc":"\/Date(1412385295938)\/",
      "ExpirationDateUtc":"\/Date(1475543695408)\/",
      "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.