woocommerce-rest-api-docs/source/includes/v3/_tax-classes.md

Tax - Classes

This section lists all API endpoints that can be used to create, edit or otherwise manipulate tax classes.

Taxes Properties

Attribute	Type	Description
slug	string	Tax class slug read-only
name	string	Tax class name

Create a Tax Class

This API helps you to create a new tax class.

HTTP Request

POST

/wc-api/v3/taxes/classes

curl -X POST https://example.com/wc-api/v3/taxes/classes \
    -u consumer_key:consumer_secret \
    -H "Content-Type: application/json" \
    -d '{
  "tax_class": {
    "name": "Zero Rate"
  }
}'

var data = {
  tax_class: {
    name: 'Zero Rate'
  }
};

WooCommerce.post('taxes/classes', data, function(err, data, res) {
  console.log(res);
});

<?php
$data = [
    'tax_class' => [
        'name' => 'Zero Rate'
    ]
];

print_r($woocommerce->post('taxes/classes', $data));
?>

data = {
    "tax_class": {
        "name": "Zero Rate"
    }
}

print(wcapi.post("taxes/classes", data).json())

data = {
  tax_class: {
    name: "Zero Rate"
  }
}

woocommerce.post("taxes/classes", data).parsed_response

JSON response example:

{
  "tax_class": {
    "slug": "zero-rate",
    "name": "Zero Rate"
  }
}

Endpoint introduced since WooCommerce 2.5.

View List of Tax Classes

This API helps you to view all the tax classes.

HTTP Request

GET

/wc-api/v3/taxes/classes

curl https://example.com/wc-api/v3/taxes/classes \
	-u consumer_key:consumer_secret

WooCommerce.get('taxes/classes', function(err, data, res) {
  console.log(res);
});

<?php print_r($woocommerce->get('taxes/classes')); ?>

print(wcapi.get("taxes/classes").json())

woocommerce.get("taxes/classes").parsed_response

JSON response example:

{
  "tax_classes": [
    {
      "slug": "standard",
      "name": "Standard Rate"
    },
    {
      "slug": "reduced-rate",
      "name": "Reduced Rate"
    },
    {
      "slug": "zero-rate",
      "name": "Zero Rate"
    }
  ]
}

Endpoint introduced since WooCommerce 2.5.

Delete a Tax Class

This API helps you delete a tax class.

This also will delete all tax rates from the selected class.

HTTP Request

DELETE

/wc-api/v3/taxes/classes/<slug>

curl -X DELETE https://example.com/wc-api/v3/taxes/classes/zero-rate \
	-u consumer_key:consumer_secret

WooCommerce.delete('taxes/classes/zero-rate', function(err, data, res) {
  console.log(res);
});

<?php print_r($woocommerce->delete('taxes/classes/zero-rate')); ?>

print(wcapi.delete("taxes/classes/zero-rate").json())

woocommerce.delete("taxes/classes/zero-rate").parsed_response

JSON response example:

{
  "message": "Deleted tax_class"
}

Endpoint introduced since WooCommerce 2.5.

View Tax Rate Count

This API lets you retrieve a count of all tax rates.

HTTP Request

GET

/wc-api/v3/taxes/classes/count

curl https://example.com/wc-api/v3/taxes/classes/count \
	-u consumer_key:consumer_secret

WooCommerce.get('taxes/classes/count', function(err, data, res) {
  console.log(res);
});

<?php print_r($woocommerce->get('taxes/classes/count')); ?>

print(wcapi.get("taxes/classes/count").json())

woocommerce.get("taxes/classes/count").parsed_response

JSON response example:

{
  "count": 3
}

Endpoint introduced since WooCommerce 2.5.