TaxSchedulesUpdate Endpoint

Overview

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

TaxSchedulesUpdate

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

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

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

HTTP Method

POST

Parameters

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

Returns

If successful, this endpoint will return a populated TaxScheduleDTO 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 a tax schedule to update
var taxScheduleId = 1;

// call the API to get the tax schedule to update
ApiResponse<TaxScheduleDTO> taxSchedule = proxy.TaxSchedulesFind(taxScheduleId);

// update one or more properties of the tax schedule
taxSchedule.Content.Name = "Fall Tax Schedule";

// call the API to update the tax schedule
ApiResponse<TaxScheduleDTO> response = proxy.TaxSchedulesUpdate(taxSchedule.Content);
// 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 = "taxschedules";  
// get this from the store admin
var apiKey = "YOUR-API-KEY";

$(document).ready(function() {

    // specify a tax schedule to update
    var taxScheduleId = 1;

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

});

function UpdateTaxSchedule(taxSchedule) {

    // update one or more properties of the tax schedule
    taxSchedule.Name = "Fall Tax Schedule";

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

}
{
   "Errors":[

   ],
   "Content":{
      "Id":1,
      "StoreId":1,
      "Name":"Fall Tax Schedule",
      "DefaultRate":0,
      "DefaultShippingRate":0
   }
}
Have more questions? Submit a request

Need More Help?

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