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.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"
}
]
}
]
}List Tax Rates
Retrieve a list of tax rates. The tax rates can be filtered by fields such as id. The tax rates can also be sorted or paginated.
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.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
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.
The number of items to skip when retrieving a list.
Limit the number of items returned in the list.
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 -.
Search terms to filter the tax rate's searchable properties.
Filter by a tax region ID to retrieve its associated rates.
Filter by whether the tax rate is a default in its tax region.
true, false Filter by a tax rate's creation date.
Show child attributes
Show child attributes
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Filter by an exact match.
Filter by values not equal to this parameter.
Filter by values in this array.
Filter by values in this array.
Filter by values not in this array.
Filter by values not in this array.
Filter by values not matching the conditions in this parameter.
Filter by values greater than this parameter. Useful for numbers and dates only.
Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
Filter by values less than this parameter. Useful for numbers and dates only.
Filter by values less than or equal to this parameter. Useful for numbers and dates only.
Apply a like filter. Useful for strings only.
Apply a regex filter. Useful for strings only.
Apply a case-insensitive like filter. Useful for strings only.
Filter to apply on full-text properties.
Filter arrays that have overlapping values with this parameter.
Filter arrays that have overlapping values with this parameter.
Filter arrays that contain some of the values of this parameter.
Filter arrays that contain some of the values of this parameter.
Filter arrays that contain all values of this parameter.
Filter arrays that contain all values of this parameter.
Filter by whether a value for this parameter exists (not null).
Filter by a tax rate's update date.
Show child attributes
Show child attributes
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Filter by an exact match.
Filter by values not equal to this parameter.
Filter by values in this array.
Filter by values in this array.
Filter by values not in this array.
Filter by values not in this array.
Filter by values not matching the conditions in this parameter.
Filter by values greater than this parameter. Useful for numbers and dates only.
Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
Filter by values less than this parameter. Useful for numbers and dates only.
Filter by values less than or equal to this parameter. Useful for numbers and dates only.
Apply a like filter. Useful for strings only.
Apply a regex filter. Useful for strings only.
Apply a case-insensitive like filter. Useful for strings only.
Filter to apply on full-text properties.
Filter arrays that have overlapping values with this parameter.
Filter arrays that have overlapping values with this parameter.
Filter arrays that contain some of the values of this parameter.
Filter arrays that contain some of the values of this parameter.
Filter arrays that contain all values of this parameter.
Filter arrays that contain all values of this parameter.
Filter by whether a value for this parameter exists (not null).
Filter by a tax rate's deletion date.
Show child attributes
Show child attributes
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Filter by an exact match.
Filter by values not equal to this parameter.
Filter by values in this array.
Filter by values in this array.
Filter by values not in this array.
Filter by values not in this array.
Filter by values not matching the conditions in this parameter.
Filter by values greater than this parameter. Useful for numbers and dates only.
Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
Filter by values less than this parameter. Useful for numbers and dates only.
Filter by values less than or equal to this parameter. Useful for numbers and dates only.
Apply a like filter. Useful for strings only.
Apply a regex filter. Useful for strings only.
Apply a case-insensitive like filter. Useful for strings only.
Filter to apply on full-text properties.
Filter arrays that have overlapping values with this parameter.
Filter arrays that have overlapping values with this parameter.
Filter arrays that contain some of the values of this parameter.
Filter arrays that contain some of the values of this parameter.
Filter arrays that contain all values of this parameter.
Filter arrays that contain all values of this parameter.
Filter by whether a value for this parameter exists (not null).
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Filter by a service zone's ID to retrieve its associated tax rates.
Filter by a shipping profile's ID to retrieve its associated tax rates.
Filter by a fulfillment provider's ID to retrieve its associated tax rates.
Filter by a shipping option type's ID to retrieve its associated tax rates.
Whether to include deleted records in the result.
Response
OK
The paginated list of tax rates. The paginated list of tax rates.
The maximum number of items returned.
The number of items skipped before retrieving the returned items.
The total number of items.
The tax rate's tax rates.
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.