Create a tax rule

How to create a tax rule via API

To create a new tax rule, send a POST request to the /api/tax_rules endpoint, passing the resource arguments in the request body.

Request

POST https://yourdomain.commercelayer.io/api/tax_rules

Arguments

Body Parameter	Type	Required
type	string	Required
attributes.name	string	Required
attributes.tax_rate	float	Optional, default is 0.0
attributes.freight_taxable	boolean	Optional, default is 'false'
attributes.payment_method_taxable	boolean	Optional, default is 'false'
attributes.gift_card_taxable	boolean	Optional, default is 'false'
attributes.adjustment_taxable	boolean	Optional, default is 'false'
attributes.country_code_regex	string	Optional
attributes.not_country_code_regex	string	Optional
attributes.state_code_regex	string	Optional
attributes.not_state_code_regex	string	Optional
attributes.zip_code_regex	string	Optional
attributes.not_zip_code_regex	string	Optional
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional
relationships.manual_tax_calculator	object	Required

Example

Request

The following request creates a new tax rule:

curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/tax_rules' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "tax_rules",
    "attributes": {
      "name": "Fixed 22%"
    },
    "relationships": {
      "manual_tax_calculator": {
        "data": {
          "type": "manual_tax_calculators",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'

Response