GET
/
admin
/
tax-rates
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.taxRate.list()
.then(({ tax_rates, count, limit, offset }) => {
  console.log(tax_rates)
})
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "tax_rates": [
    {
      "id": "<string>",
      "rate": 10,
      "code": "<string>",
      "name": "<string>",
      "metadata": {},
      "tax_region_id": "<string>",
      "is_combinable": true,
      "is_default": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "tax_region": {
        "id": "<string>",
        "country_code": "us",
        "province_code": "us-ca",
        "metadata": {},
        "parent_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "tax_rates": [
          {}
        ],
        "parent": {},
        "children": [
          {}
        ]
      },
      "rules": [
        {
          "reference": "product_type",
          "reference_id": "ptyp_1"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
fields
string

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

The number of items to skip when retrieving a list.

​
limit
number

Limit the number of items returned in the list.

​
order
string

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 -.

​
q
string

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

​
tax_region_id

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

​
is_default
enum<string>

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

Available options:
true,
false
​
created_at
object

Filter by a tax rate's creation date.

​
updated_at
object

Filter by a tax rate's update date.

​
deleted_at
object

Filter by a tax rate's deletion date.

​
$and
$and · object[]

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

​
$or
$or · object[]

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

​
service_zone_id
string

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

​
shipping_profile_id
string

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

​
provider_id
string

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

​
shipping_option_type_id
string

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

​
with_deleted
boolean

Whether to include deleted records in the result.

Response

200
application/json

OK

The paginated list of tax rates.