List Tax Rates

GET

/admin/tax-rates

Tax Rates

Retrieve a list of tax rates. The tax rates can be filtered by fields such as id. The tax rates can also be sorted or paginated.

Response Example

200 - Example 1

{
    "limit": 0,
    "offset": 0,
    "count": 0,
    "tax_rates": [
        {
            "tax_region": {
                "id": "string",
                "country_code": "us",
                "metadata": {},
                "parent_id": "string",
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "created_by": "string",
                "parent": {},
                "province_code": "us-ca",
                "tax_rates": [
                    {}
                ],
                "children": [
                    {}
                ]
            },
            "id": "string",
            "rate": 10,
            "code": "string",
            "name": "string",
            "metadata": {},
            "tax_region_id": "string",
            "is_default": true,
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "created_by": "string",
            "rules": [
                {
                    "reference": "product_type",
                    "reference_id": "ptyp_1"
                }
            ],
            "is_combinable": true
        }
    ]
}

Request

Authorization

Query Params

fields

string

fields

optional

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

offset

number

offset

optional

The number of items to skip when retrieving a list.

limit

number

limit

optional

Limit the number of items returned in the list.

order

string

order

optional

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

string

optional

Search terms to filter the tax rate's searchable properties.

tax_region_id

optional

One of

tax_region_id

array[string]

object

Filter by a tax region ID to retrieve its associated rates.

is_default

enum<string>

optional

Filter by whether the tax rate is a default in its tax region.

Allowed values:

truefalse

$ne

array[string]

optional

Filter by values not equal to this parameter.

Example:

["","",""]

$gt

array[string]

optional

Filter by values greater than this parameter. Useful for numbers and dates only.

Example:

["","",""]

$gte

array[string]

optional

Filter by values greater than or equal to this parameter. Useful for numbers and dates only.

Example:

["","",""]

$lt

array[string]

optional

Filter by values less than this parameter. Useful for numbers and dates only.

Example:

["","",""]

$lte

array[string]

optional

Filter by values less than or equal to this parameter. Useful for numbers and dates only.

Example:

["","",""]

$like

array[string]

optional

Apply a like filter. Useful for strings only.

Example:

["","",""]

$re

array[string]

optional

Apply a regex filter. Useful for strings only.

Example:

["","",""]

$ilike

array[string]

optional

Apply a case-insensitive like filter. Useful for strings only.

Example:

["","",""]

$fulltext

array[string]

optional

Filter to apply on full-text properties.

Example:

["","",""]

$exists

array[string]

optional

Filter by whether a value for this parameter exists (not null).

Example:

["","",""]

$and

array [object]

$and

optional

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

Example:

["","",""]

$or

array [object]

$or

optional

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

Example:

["","",""]

$in

array[string]

optional

Filter by values in this array.

Example:

["","",""]

$nin

array[string]

optional

Filter by values not in this array.

Example:

["","",""]

$overlap

array[string]

optional

Filter arrays that have overlapping values with this parameter.

Example:

["","",""]

$contains

array[string]

optional

Filter arrays that contain some of the values of this parameter.

Example:

["","",""]

$contained

array[string]

optional

Filter arrays that contain all values of this parameter.

Example:

["","",""]

$eq

array[string]

optional

Example:

["","",""]

$not

array[string]

optional

Example:

["","",""]

service_zone_id

string

service_zone_id

optional

Filter by a service zone's ID to retrieve its associated tax rates.

shipping_profile_id

string

shipping_profile_id

optional

Filter by a shipping profile's ID to retrieve its associated tax rates.

provider_id

string

provider_id

optional

Filter by a fulfillment provider's ID to retrieve its associated tax rates.

shipping_option_type_id

string

shipping_option_type_id

optional

Filter by a shipping option type's ID to retrieve its associated tax rates.

Responses

🟢200OK

application/json

Body

The paginated list of tax rates.

limit

number

limit

required

The maximum number of items returned.

offset

number

offset

required

The number of items skipped before retrieving the returned items.

count

number

count

required

The total number of items.

tax_rates

array[object (AdminTaxRate) {14}]

required

The tax rate's tax rates.

tax_region

object

AdminTaxRegion

required

The tax region's details.

string

required

The tax rate's ID.

rate

number

rate

required

The rate to charge.

Example:

code

string

code

required

The code the tax rate is identified by.

name

string

name

required

The tax rate's name.

metadata

object

required

The tax rate's metadata, can hold custom key-value pairs.

tax_region_id

string

tax_region_id

required

The ID of the tax region this rate belongs to.

is_default

boolean

is_default

required

Whether this tax rate is the default in the tax region.

created_at

string <date-time>

created_at

required

The date the tax rate was created.

updated_at

string <date-time>

updated_at

required

The date the tax rate was updated.

deleted_at

string <date-time>

deleted_at

required

The date the tax rate was deleted.

created_by

string

created_by

required

The ID of the user that created the tax rate.

rules

array[object (AdminTaxRateRule) {2}]

required

The tax rate's rules.

is_combinable

boolean

is_combinable

required

Whether the tax rate should be combined with parent rates.

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

Modified at 2025-06-17 04:10:32

Create Tax Rate

Delete a Price Preference