OrderTransactionsDelete Endpoint


Sometimes, a transaction should just not exist.  This endpoint allows you to delete any unnecessary transactions from your store.


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 orders with transactions created so that you can successfully delete one.


This REST API endpoint allows you to delete a transaction 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.


BVIN is the transaction ID as described in the parameters below.

HTTP Method



Parameter Description
bvin This is the unique ID of the order transaction that you wish to delete


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 order transaction 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.Client
  • Hotcakes.CommerceDTO.v1.Orders


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

Api proxy = new Api(url, key);

// specify the transaction to delete
// (uses a built-in method to convert a string to GUID)
var transactionId = DataTypeHelper.BvinToGuid("F588C8FE-21C3-406B-B38B-25D098EA5295");

// call the API to delete the transaction
ApiResponse<bool> response = proxy.OrderTransactionsDelete(transactionId);
// 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 = "ordertransactions";  
// get this from the store admin
var apiKey = "YOUR-API-KEY";

$(document).ready(function() {

    // specify the transaction to delete
    var transactionId = "F588C8FE-21C3-406B-B38B-25D098EA5295";

    // call the API to delete the transaction
        dataType: "json",
        url: url + apiPath + endPoint + "/" + transactionId + "?key=" + apiKey,
        type: 'DELETE',
        success: function (data) {
            // do something
        error: function (jqXHR, textStatus) {
            // do something else


Have more questions? Submit a request

Need More Help?

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