Search…
API Reference
Resources
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
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.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.reference
string
Optional
attributes.reference_origin
string
Optional
attributes.metadata
object
Optional
relationships.manual_tax_calculator
object
Required

Example

Request
Response
The following request creates a new tax rule:
1
curl -g -X POST \
2
'https://yourdomain.commercelayer.io/api/tax_rules' \
3
-H 'Accept: application/vnd.api+json' \
4
-H 'Authorization: Bearer your-access-token' \
5
-H 'Content-Type: application/vnd.api+json' \
6
-d '{
7
"data": {
8
"type": "tax_rules",
9
"attributes": {
10
"name": "Fixed 22%"
11
},
12
"relationships": {
13
"manual_tax_calculator": {
14
"data": {
15
"type": "manual_tax_calculators",
16
"id": "QWERtyUpBa"
17
}
18
}
19
}
20
}
21
}'
Copied!
On success, the API responds with a 201 Created status code, returning the created resource object:
1
{
2
"data": {
3
"id": "xYZkjABcde",
4
"type": "tax_rules",
5
"links": {
6
"self": "https://yourdomain.commercelayer.io/api/tax_rules/xYZkjABcde"
7
},
8
"attributes": {
9
"name": "Fixed 22%",
10
"tax_rate": 0.22,
11
"country_code_regex": "AT|BE|BG|CZ|DK|EE|DE|HU|LV|LT",
12
"not_country_code_regex": "AT|BE|BG|CZ|DK|EE|DE",
13
"state_code_regex": "A[KLRZ]|C[AOT]|D[CE]|FL",
14
"not_state_code_regex": "A[KLRZ]|C[AOT]",
15
"zip_code_regex": "(?i)(JE1|JE2|JE3|JE4|JE5)",
16
"not_zip_code_regex": "(?i)(JE1|JE2|JE3)",
17
"freight_taxable": false,
18
"payment_method_taxable": false,
19
"gift_card_taxable": false,
20
"adjustment_taxable": false,
21
"breakdown": {
22
"41": {
23
"tax_rate": 0.22
24
}
25
},
26
"created_at": "2018-01-01T12:00:00.000Z",
27
"updated_at": "2018-01-01T12:00:00.000Z",
28
"reference": "ANY-EXTERNAL-REFEFERNCE",
29
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
30
"metadata": {
31
"foo": "bar"
32
}
33
},
34
"relationships": {
35
"manual_tax_calculator": {
36
"links": {
37
"self": "https://yourdomain.commercelayer.io/api/tax_rules/xYZkjABcde/relationships/manual_tax_calculator",
38
"related": "https://yourdomain.commercelayer.io/api/tax_rules/xYZkjABcde/manual_tax_calculator"
39
}
40
}
41
},
42
"meta": {
43
"mode": "test"
44
}
45
}
46
}
Copied!
Last modified 2mo ago
Copy link