taxRate - JS SDK Admin Reference

This documentation provides a reference to the sdk.admin.taxRate set of methods used to send requests to Medusa's Admin API routes.

create#

This method creates a tax rate. It sends a request to the Create Tax Rate API route.

Example#

Code
1sdk.admin.taxRate.create({2  name: "VAT",3  tax_region_id: "txreg_123",4  code: "VAT",5  rate: 2, // 2%6})7.then(({ tax_rate }) => {8  console.log(tax_rate)9})

Parameters#

Returns#

update#

This method updates a tax rate. It sends a request to the Update Tax Rate API route.

Example#

Code
1sdk.admin.taxRate.update("txrat_123", {2  name: "VAT",3  code: "VAT",4})5.then(({ tax_rate }) => {6  console.log(tax_rate)7})

Parameters#

Returns#

delete#

This method deletes a tax rate. It sends a request to the Delete Tax Rate API route.

Example#

Code
1sdk.admin.taxRate.delete("txrat_123")2.then(({ deleted }) => {3  console.log(deleted)4})

Parameters#

Returns#

retrieve#

This method retrieves a tax rate. It sends a request to the Get Tax Rate API route.

Example#

To retrieve a tax rate by its ID:

Code
1sdk.admin.taxRate.retrieve("txrat_123")2.then(({ tax_rate }) => {3  console.log(tax_rate)4})

To specify the fields and relations to retrieve:

Code
1sdk.admin.taxRate.retrieve("txrat_123", {2  fields: "id,*tax_region"3})4.then(({ tax_rate }) => {5  console.log(tax_rate)6})

Learn more about the fields property in the API reference.

Parameters#

Returns#

list#

This method retrieves a list of tax rates. It sends a request to the List Tax Rates API route.

Example#

To retrieve the list of tax rates:

Code
1sdk.admin.taxRate.list()2.then(({ tax_rates, count, limit, offset }) => {3  console.log(tax_rates)4})

To configure the pagination, pass the limit and offset query parameters.

For example, to retrieve only 10 items and skip 10 items:

Code
1sdk.admin.taxRate.list({2  limit: 10,3  offset: 104})5.then(({ tax_rates, count, limit, offset }) => {6  console.log(tax_rates)7})

Using the fields query parameter, you can specify the fields and relations to retrieve in each tax rate:

Code
1sdk.admin.taxRate.list({2  fields: "id,*tax_region"3})4.then(({ tax_rates, count, limit, offset }) => {5  console.log(tax_rates)6})

Learn more about the fields property in the API reference.

Parameters#

Returns#