GiftCardDelete Endpoint

Overview

There might be the rare occasion that you need to delete a gift card from the store entirely.  This endpoint allows you to delete any unnecessary gift cards from 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 delete one.

GiftCardDelete

This REST API endpoint allows you to delete a gift card from 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/[ID]

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

HTTP Method

DELETE

Parameters

Parameter Description
id This is the unique ID of the gift card that you wish to delete.

Returns

If successful, this endpoint will return True in the ApiResponse.Content object.  Otherwise, you should have one or more errors returned.  If you receive a False response with no error, either the gift card ID doesn't exist, or the REST call was improperly formatted.

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 delete
var giftCardId = 1;

// call the API to delete the specified gift card
ApiResponse<bool> response = proxy.GiftCardDelete(giftCardId);
// 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 delete
    var giftCardId = 1;

    // call the API to delete the specified gift card
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/" + giftCardId + "?key=" + apiKey,
        type: 'DELETE',
        success: function (data) {
            // do something
        },
        error: function (jqXHR, textStatus) {
            // do something else
        }
    });

});
{
   "Errors":[

   ],
   "Content":true
}
Have more questions? Submit a request

Need More Help?

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