REST API Endpoints for Taxes

Overview

Taxes will be required of most stores, regardless of where and what you sell.  If your store uses a manual tax table or schedule, this area of the API allows you to manage how that is done.

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

Getting Started

If you haven’t already done so, you should probably have a development environment ready to development against, complete with Hotcakes installed and configured.

REST API Endpoints for Taxes

There are a handful of REST API endpoints that allow you to display or manage various aspects of taxes.  Those endpoints are detailed below.

Endpoint Return Type Description
TaxesCreate TaxDTO Create a tax zone for a tax schedule to calculate taxes for a matching order.
TaxesDelete Boolean Deleted the tax zone from the store permanently.
TaxesFind TaxDTO Find a specific tax zone using the ID of the tax zone.
TaxesFindAll List of TaxDTO Allows you to find all taxes in the store for all tax zones.
TaxesUpdate TaxDTO Updates the tax record wtih the information specified.

 

Have more questions? Submit a request

Need More Help?

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