API ReferenceCommerce

Taxes

Tax categories, which decide how a product is taxed.

Prefix /cdna-api/taxes ReferenceCategory model GuideTax zones and providers

About taxes

A tax category groups products that are taxed the same way: it has a unique code, a name, its rates, and the codes a tax provider such as Avalara uses for it. A product names its category in taxCategory. Categories and rates are set up in the admin; the API only lists the categories.

Writing Admin only

Tax categories are set up in the admin.

Tax and shipping
Access Admin users

Members are refused: a 404 by default, a 403 where the site’s access-denied setting says so. Call it from a server with an admin user’s OAuth token or API key.

Authentication and authorisation

Learn more

GuideTax zones and providers GuideProduct, description and variant

List tax categories#

GET /cdna-api/taxes/categories

Lists tax categories. Without limit every match comes back. This site has none.

Access
Admin users and integrations, with an OAuth access token or an API key.
Model
Category, in the Reference

Parameters

propertiesquery
selector
The fields and relations to return, such as {id,code,name}.
filtersquery
name=value
Any stored field, or a relation with a dot, such as parent.id=12. Prefix the name with !, >, <, % or |. Use stored field names exactly as in the model, and compare totalCount with the unfiltered list's to confirm a filter applied.
orderByquery
string
field:ASC or field:DESC, comma-separated. Stored fields only.
limitquery
integer
Records per response. There is no default.
offsetquery
integer
Records to skip.

Example

List tax categories 
GET /cdna-api/taxes/categories?limit=2&properties={id,code,name} HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json
Response 200 OK 
{
  "result": "success",
  "totalCount": 0,
  "data": []
}
Real response from this documentation site