OrderTransactionsUpdate Endpoint

Overview

It wouldn't be unusual to need to update an existing transaction, but you should be careful when you do.  This endpoint allows you to update any specific transaction 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 transactions created so that you can successfully find one to update.

OrderTransactionsUpdate

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

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/ordertransactions/[BVIN]

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

HTTP Method

POST

Parameters

Parameter Description
bvin This is the unique ID of the transaction that you wish to update
data You will need to pass an updated JSON version of the OrderTransactionDTO object in your post request

Returns

If successful, this endpoint will return a populated OrderTransactionDTO 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.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 look for
// (uses a built-in method to convert a string to GUID)
var transactionId = DataTypeHelper.BvinToGuid("BFB52845-8DB7-4336-9635-2574EF7A78DA");

// call the API to find the transaction
var transaction = proxy.OrderTransactionsFind(transactionId).Content;

// update one or more properties
transaction.PurchaseOrderNumber = "Z1MIO2P2";

// call the API to update the transaction
ApiResponse<OrderTransactionDTO> response = proxy.OrderTransactionsUpdate(transaction);
// 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 = "BFB52845-8DB7-4336-9635-2574EF7A78DA";

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

});

function UpdateTransaction(transaction) {

    // update one or more properties
    transaction.PurchaseOrderNumber = "Z1MIO2P2";

    // update the dates to be safe for update
    transaction.TimeStampUtc = ParseDateForSave(transaction.TimeStampUtc);
            
    // call the API to update the transaction
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/" + transaction.Id + "?key=" + apiKey,
        type: 'POST',
        success: function (data) {
            // do something
        },
        error: function (jqXHR, textStatus) {
            // do something else
        }
    });

}

function ParseDateForSave(dateValue) {
    // create a new date object in UTC format
    var newDate = new Date(parseInt(dateValue.substr(6)));

    // return the UTC version of the date
    return newDate.toISOString();
}
{
   "Errors":[

   ],
   "Content":{
      "Id":"29d7b321-2c5b-4fa6-ab68-40b33740c594",
      "StoreId":1,
      "OrderId":"",
      "OrderNumber":"",
      "TimeStampUtc":"\/Date(1406775097503)\/",
      "Action":0,
      "Amount":0,
      "CreditCard":{
         "CardNumber":"",
         "CardIsEncrypted":false,
         "ExpirationMonth":1,
         "ExpirationYear":2014,
         "CardHolderName":""
      },
      "Success":false,
      "Voided":false,
      "RefNum1":"",
      "RefNum2":"",
      "LinkedToTransaction":"",
      "Messages":"",
      "CheckNumber":"",
      "PurchaseOrderNumber":"",
      "GiftCardNumber":"",
      "CompanyAccountNumber":""
   }
}
Have more questions? Submit a request

Need More Help?

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