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.taxRegion.create({
country_code: "us",
province_code: "ca",
default_tax_rate: {
code: "VAT",
name: "VAT",
rate: 20, // 20%
is_combinable: true,
},
})
.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": [
{}
]
}
}Create Tax Region
Create a tax region.
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.taxRegion.create({
country_code: "us",
province_code: "ca",
default_tax_rate: {
code: "VAT",
name: "VAT",
rate: 20, // 20%
is_combinable: true,
},
})
.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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
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.
Body
The tax region's details.
The tax region's country code.
"us"
The tax region's ISO 3166-2 province code. Must be lower-case.
"us-ca"
The ID of the parent tax region.
The tax region's default tax rate.
Show child attributes
Show child attributes
The code the tax rate is identified by
The default tax rate's name.
"VAT"
The rate to charge.
10
Whether the tax rate should be combined with parent rates.
The default tax rate's metadata, used to store custom key-value pairs.
The tax region's metadata, used to store custom key-value pairs.
The ID of the tax provider used to calculate the tax rate in this tax region.
Response
OK
The tax region's details.
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.