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

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

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v2/tax_classes' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

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

[
{
"id": "1",
"name": "Non-Taxable Products",
"created_at": "1973-01-20T21:34:57.903+00:00",
"updated_at": "1990-12-30T00:29:23.515+00:00"
},
{
"id": "2",
"name": "Shipping",
"created_at": "1973-01-20T21:34:57.903+00:00",
"updated_at": "1990-12-30T00:29:23.515+00:00"
},
{
"id": "3",
"name": "Gift Wrapping",
"created_at": "1973-01-20T21:34:57.903+00:00",
"updated_at": "1990-12-30T00:29:23.515+00:00"
}
]

Get a Tax Class

GET /tax_classes/{id}

Request

Returns a single Tax Class.

Authentication

  • X-Auth-Token in header

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

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v2/tax_classes/[id]' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

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

{
"id": "1",
"name": "Shipping",
"created_at": "1973-01-20T21:34:57.903+00:00",
"updated_at": "1990-12-30T00:29:23.515+00:00"
}

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?
Delete a SubscriberGet All Tax Classes