OrderTransactionsCreate Endpoint

Overview

Nearly every single store needs transactions to process their orders.  This endpoint allows you to create as many transactions as you need for the orders in your store.  Overall, this is a great place to start for integration with other systems.

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 transaction to have before you create it.

OrderTransactionsCreate

This REST API endpoint allows you to create a transaction for an order in 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/ordertransactions

HTTP Method

POST

Parameters

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

Returns

If successful, this endpoint will return a OrderTransactionDTO 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.Client
  • Hotcakes.CommerceDTO.v1.Orders

 

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

Api proxy = new Api(url, key);

// create a new transaction object with relevant information
var transaction = new OrderTransactionDTO
{
    OrderId = "c0ee144f-045e-4928-8258-7ac7c7e84030",
    OrderNumber = "5",
    LinkedToTransaction = "DF4BE34C-C56E-4269-9650-B691DB930575",
    Action = OrderTransactionActionDTO.PurchaseOrderAccepted,
    Amount = 59.87m,
    PurchaseOrderNumber = "12345",
    RefNum1 = "ACB123XYZ",
    Messages = "Successfull accepted the PO for this transaction",
    Success = true
};

// call the API to create the transaction
ApiResponse<OrderTransactionDTO> response = proxy.OrderTransactionsCreate(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() {

    // create a new transaction object with relevant information
    var transaction = {
        "OrderId": "c0ee144f-045e-4928-8258-7ac7c7e84030",
        "OrderNumber": "5",
        "LinkedToTransaction": "DF4BE34C-C56E-4269-9650-B691DB930575",
        "Action": 402,
        "Amount": 59.87,
        "PurchaseOrderNumber": "12345",
        "RefNum1": "ACB123XYZ",
        "Messages": "Successfull accepted the PO for this transaction",
        "Success": true
    };

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

});
{
   "Errors":[

   ],
   "Content":{
      "Id":"5f02091b-a4a0-4ac5-b599-8e7757bc6909",
      "StoreId":1,
      "OrderId":"c0ee144f-045e-4928-8258-7ac7c7e84030",
      "OrderNumber":"5",
      "TimeStampUtc":"\/Date(1406752600136)\/",
      "Action":402,
      "Amount":59.87,
      "CreditCard":{
         "CardNumber":"",
         "CardIsEncrypted":false,
         "ExpirationMonth":1,
         "ExpirationYear":2000,
         "CardHolderName":""
      },
      "Success":true,
      "Voided":false,
      "RefNum1":"ACB123XYZ",
      "RefNum2":"",
      "LinkedToTransaction":"DF4BE34C-C56E-4269-9650-B691DB930575",
      "Messages":"Successfull accepted the PO for this transaction",
      "CheckNumber":"",
      "PurchaseOrderNumber":"12345",
      "GiftCardNumber":"",
      "CompanyAccountNumber":""
   }
}
Have more questions? Submit a request

Need More Help?

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