TaxesUpdate Endpoint

Overview

It wouldn't be unusual to need to update an existing tax.  This endpoint allows you to update any specific tax 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 taxes created so that you can successfully find one to update.

TaxesUpdate

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

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

ID is the tax ID as described in the parameters below.

HTTP Method

POST

Parameters

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

Returns

If successful, this endpoint will return a populated TaxDTO 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.Taxes

 

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

Api proxy = new Api(url, key);

// specify the ID of the tax to update
var taxId = 3;

// find the tax to update using the ID
var tax = proxy.TaxesFind(taxId).Content;

// update one or more properties
tax.Rate = 0.9m;

// call the API to update the tax
ApiResponse<TaxDTO> response = proxy.TaxesUpdate(tax);
// 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 = "taxes";  
// get this from the store admin
var apiKey = "YOUR-API-KEY";

$(document).ready(function() {

    // specify the ID of the tax to update
    var taxId = 3;

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

});

function UpdateTax(tax) {

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

}
{
   "Errors":[

   ],
   "Content":{
      "Id":3,
      "StoreId":1,
      "CountryIsoAlpha3":"USA",
      "RegionAbbreviation":"CA",
      "PostalCode":"94103",
      "TaxScheduleId":1,
      "Rate":0.9,
      "ShippingRate":0,
      "ApplyToShipping":false
   }
}
Have more questions? Submit a request

Need More Help?

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