GET
/
admin
/
tax-regions
JS SDK
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.taxRegion.list()
.then(({ tax_regions, count, limit, offset }) => {
  console.log(tax_regions)
})
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "tax_regions": [
    {}
  ]
}

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 term to filter a tax region's searchable properties.

​
id

Filter by a tax region ID.

​
country_code

Filter by a country code.

​
province_code

Filter by a ISO 3166-2 province code. Must be lower-case.

Example:

"us-ca"

​
parent_id

Filter by the ID of a parent tax region to retrieve its child tax regions.

​
created_by

Filter by the ID of the user to retrieve the tax regions they created.

​
created_at

Filter by a tax region's creation date.

​
updated_at

Filter by a tax region's update date.

​
deleted_at

Filter by a tax region'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.

​
with_deleted
boolean

Whether to include deleted records in the result.

Response

200
application/json

OK

The paginated list of tax regions.