Docs
Management API
Tax classes

Tax Classes

Manage tax calculations applied to sales. Tax classes are used to apply different tax rates for specific types of products and orders. This API is read only. Classes must be set using the Control Panel (opens in a new tab).

Get All Tax Classes

GET /tax_classes

Request

Returns a list of all Tax Classes in a store.

Default sorting is by tax-class id, from lowest to highest.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required

    The MIME type of the response body.

  • page in query - number

    Optional filter param. Number of pages.

  • limit in query - number

    Optional filter param. Number of items per page

example

Response

Body

array | application/json
  • id
    string

    The unique numerical ID of the tax class. A read-only value which is automatically assigned and increments sequentially.

    Example: 1

  • name
    string

    The name of the tax class.

    Example: Shipping

  • created_at
    string

    Date and time of the tax class' creation. Read-Only.

    Example: 2018-05-07T20:14:17+00:00

  • updated_at
    string

    Date and time when the tax class was last updated. Read-Only.

    Example: 2018-05-07T20:14:17+00:00

example

Get a Tax Class

GET /tax_classes/{id}

Request

Returns a single Tax Class.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required

    The MIME type of the response body.

  • id in path - integer
    required

    ID of the tax class.

example

Response

Body

object | application/json
  • id
    string

    The unique numerical ID of the tax class. A read-only value which is automatically assigned and increments sequentially.

    Example: 1

  • name
    string

    The name of the tax class.

    Example: Shipping

  • created_at
    string

    Date and time of the tax class' creation. Read-Only.

    Example: 2018-05-07T20:14:17+00:00

  • updated_at
    string

    Date and time when the tax class was last updated. Read-Only.

    Example: 2018-05-07T20:14:17+00:00

example

Did you find what you were looking for?