List all tax rules
How to fetch a collection of tax rules via API
To fetch a collection of tax rules, send a GET request to the /api/tax_rules endpoint.
Request
GET https://yourdomain.commercelayer.io/api/tax_rules
Example
The following request fetches a collection of tax rules:
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/tax_rules/' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token'On success, the API responds with a 200 OK status code, returning a paginated collection of resource objects:
{
"data": [
{
"id": "XAyRWNUzyN",
"type": "tax_rules",
"links": {
"self": "https://yourdomain.commercelayer.io/api/tax_rules/XAyRWNUzyN"
},
"attributes": {
"name": "Fixed 22%",
"tax_rate": 0.22,
"freight_taxable": false,
"payment_method_taxable": false,
"gift_card_taxable": false,
"adjustment_taxable": false,
"breakdown": {
"41": {
"tax_rate": 0.22
}
},
"country_code_regex": "AT|BE|BG|CZ|DK|EE|DE|HU|LV|LT",
"not_country_code_regex": "AT|BE|BG|CZ|DK|EE|DE",
"state_code_regex": "A[KLRZ]|C[AOT]|D[CE]|FL",
"not_state_code_regex": "A[KLRZ]|C[AOT]",
"zip_code_regex": "(?i)(JE1|JE2|JE3|JE4|JE5)",
"not_zip_code_regex": "(?i)(JE1|JE2|JE3)",
"created_at": "2018-01-01T12:00:00.000Z",
"updated_at": "2018-01-01T12:00:00.000Z",
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"metadata": {
"foo": "bar"
}
},
"relationships": {
"manual_tax_calculator": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/tax_rules/XAyRWNUzyN/relationships/manual_tax_calculator",
"related": "https://yourdomain.commercelayer.io/api/tax_rules/XAyRWNUzyN/manual_tax_calculator"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/tax_rules/XAyRWNUzyN/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/tax_rules/XAyRWNUzyN/versions"
}
},
"event_stores": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/tax_rules/XAyRWNUzyN/relationships/event_stores",
"related": "https://yourdomain.commercelayer.io/api/tax_rules/XAyRWNUzyN/event_stores"
}
}
},
"meta": {
"mode": "test",
"organization_id": "xRRkjDFafe",
"trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
}
},
{
"other": "... 9 tax_rules (first page)"
}
],
"meta": {
"record_count": 140,
"page_count": 14
},
"links": {
"first": "https://yourdomain.commercelayer.io/api/tax_rules?page[number]=1&page[size]=10",
"next": "https://yourdomain.commercelayer.io/api/tax_rules?page[number]=2&page[size]=10",
"last": "https://yourdomain.commercelayer.io/api/tax_rules?page[number]=14&page[size]=10"
}
}Remember that when you fetch a list of resources you get paginated result.
Sortable fields
The list of tax rules can be sorted by the following fields:
Attributes
nametax_rateidcreated_atupdated_atreferencereference_origin
Relationships
manual_tax_calculator
Filterable fields
The list of tax rules can be filtered by the following fields:
Attributes
nametax_ratefreight_taxablepayment_method_taxablegift_card_taxableadjustment_taxableidcreated_atupdated_atreferencereference_originmetadata
Relationships
manual_tax_calculator
Last updated

