GiftCardUpdate Endpoint

Overview

It wouldn't be unusual to need to update an existing gift card.  This endpoint allows you to update any specific gift card in your store.

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 one to update.

GiftCardUpdate

This REST API endpoint allows you to update a gift card in your store. This requires that you also have a gift card to update, which would mean that you should also call the GiftCardFind endpoint to get an existing gift card.

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/[ID]

ID is the gift card ID as described in the parameters below.

HTTP Method

POST

Parameters

Parameter Description
id This is the unique ID of the gift card that you wish to update
data You will need to pass an updated JSON version of the GiftCardDTO object in your post request

Returns

If successful, this endpoint will return a populated 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 gift card to look for
var giftCardId = 7;

// call the API to find the giftcard
var giftCard = proxy.GiftCardFind(giftCardId).Content;

// update one or more of the gift card properties
giftCard.RecipientEmail = "jdough@mydomain.com";

// call the API to update the giftcard
ApiResponse<GiftCardDTO> response = proxy.GiftCardUpdate(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 to look for
    var giftCardId = 7;

    // call the API to find the giftcard
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/" + giftCardId + "?key=" + apiKey,
        type: 'GET',
        success: function (data) {
            // update the gift card in another method
            UpdateGiftCard(data.Content);
        },
        error: function (jqXHR, textStatus) {
            // do something
        }
    });

});

function UpdateGiftCard(giftCard) {
            
    // update one or more of the gift card properties
    giftCard.RecipientEmail = "jdough@mydomain.com";

    // parse the dates to be JSON-friendly to prevent errors
    giftCard.IssueDateUtc = ParseDateForSave(giftCard.IssueDateUtc);
    giftCard.ExpirationDateUtc = ParseDateForSave(giftCard.ExpirationDateUtc);

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

}
{
   "Errors":[

   ],
   "Content":{
      "GiftCardId":7,
      "StoreId":1,
      "LineItemId":null,
      "CardNumber":"D5R435ZD4GZRRHZNJ54J534",
      "Amount":100.0000000000,
      "UsedAmount":0.0000000000,
      "IssueDateUtc":"\/Date(1412438124340)\/",
      "ExpirationDateUtc":"\/Date(1475596524120)\/",
      "RecipientEmail":"jdough@mydomain.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.