import Switchyard from "@switchyard/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.retrieve("txrat_123")
.then(({ tax_rate }) => {
console.log(tax_rate)
}){
"tax_rate": {
"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"
}
]
}
}Get a Tax Rate
Retrieve a tax rate by its ID. You can expand the tax rate’s relations or select the fields that should be returned.
import Switchyard from "@switchyard/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.retrieve("txrat_123")
.then(({ tax_rate }) => {
console.log(tax_rate)
}){
"tax_rate": {
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The tax rate's ID.
Query Parameters
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.
Response
OK
The tax rate's details.
The tax rate's details.
Show child attributes
Show child attributes
The tax rate's ID.
The rate to charge.
10
The code the tax rate is identified by.
The tax rate's name.
The tax rate's metadata, can hold custom key-value pairs.
The ID of the tax region this rate belongs to.
Whether the tax rate should be combined with parent rates.
Whether this tax rate is the default in the tax region.
The date the tax rate was created.
The date the tax rate was updated.
The date the tax rate was deleted.
The ID of the user that created the tax rate.
The tax region's details.
Show child attributes
Show child attributes
The tax region's ID.
The tax region's country code.
"us"
The tax region's lower-case ISO 3166-2 province code.
"us-ca"
The tax region's metadata, can hold custom key-value pairs.
The ID of the parent tax region.
The date the tax region was created.
The date the tax region was updated.
The date the tax region was deleted.
The ID of the user that created the tax region.
The tax region's rates.
The tax region's children.