Zoey REST API reference ยท Interactive version: apidocs.zoey.com
GET https://container-url.zoeysite.com/api/rest/tax/rate/?filter[0][attribute]=tax_country_id&filter[0][eq]=US
Tax rates (Admin > Settings > Tax > Tax Zones and Rates). Takes the usual limit, page, order, dir and filter[0][attribute] / filter[0][eq].
A tax rate is a country + region + zip code (or zip range) with a rate percent. It does nothing until a tax rule uses it (Tax / Rule).
Query parameters:
| Name | Example | Notes |
|---|---|---|
filter[0][attribute] | tax_country_id | |
filter[0][eq] | US | Two-letter country code |
GET https://container-url.zoeysite.com/api/rest/tax/rate/:tax_rate_id
One tax rate, with the same fields as Get All.
POST https://container-url.zoeysite.com/api/rest/tax/rate/
Creates a tax rate. It does nothing until a tax rule uses it (Tax / Rule / Create).
Example request body:
{
"code": "US-NY-10001",
"tax_country_id": "US",
"tax_region_id": 43,
"tax_postcode": "10001",
"rate": 8.875,
"titles": [
{
"store_id": 1,
"title": "NY Sales Tax"
}
]
}
PUT https://container-url.zoeysite.com/api/rest/tax/rate/:tax_rate_id
Only the fields sent change. titles replaces all store titles when sent and is kept when left out.
Example request body:
{
"rate": 8.5
}
DELETE https://container-url.zoeysite.com/api/rest/tax/rate/:tax_rate_id
Deletes a tax rate. A rate used by a tax rule can't be deleted: remove it from the rule first (Tax / Rule / Update).