Skip to main content
GET
/
admin
/
tax-regions
/
{id}
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.retrieve("txreg_123")
.then(({ tax_region }) => {
  console.log(tax_region)
})
{
  "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": [
      {}
    ]
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The tax region's ID.

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.

​
province_code
string

Filter by a tax region's province code.

​
provider_id
string

Filter by a tax provider ID to retrieve the tax regions using it.

​
metadata
object

Filter by a tax region's metadata. Refer to the Object Query Parameter section to learn how to filter by object fields.

Response

OK

The tax region's details.

​
tax_region
object
required

The tax region's details.