medusa-store/www/apps/docs/content/references/js-client/classes/AdminTaxRatesResource.md

displayed_sidebar

displayed_sidebar
jsClientSidebar

Class: AdminTaxRatesResource

Hierarchy

• default

  ↳ AdminTaxRatesResource

Methods

addProductTypes

▸ addProductTypes(id, payload, query?, customHeaders?): ResponsePromise<AdminTaxRatesRes>

Parameters

Name	Type
id	string
payload	AdminPostTaxRatesTaxRateProductTypesReq
query?	AdminGetTaxRatesTaxRateParams
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminTaxRatesRes>

Defined in

packages/medusa-js/src/resources/admin/tax-rates.ts:100

---

addProducts

▸ addProducts(id, payload, query?, customHeaders?): ResponsePromise<AdminTaxRatesRes>

Parameters

Name	Type
id	string
payload	AdminPostTaxRatesTaxRateProductsReq
query?	AdminGetTaxRatesTaxRateParams
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminTaxRatesRes>

Defined in

packages/medusa-js/src/resources/admin/tax-rates.ts:84

---

addShippingOptions

▸ addShippingOptions(id, payload, query?, customHeaders?): ResponsePromise<AdminTaxRatesRes>

Parameters

Name	Type
id	string
payload	AdminPostTaxRatesTaxRateShippingOptionsReq
query?	AdminGetTaxRatesTaxRateParams
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminTaxRatesRes>

Defined in

packages/medusa-js/src/resources/admin/tax-rates.ts:116

---

create

▸ create(payload, query?, customHeaders?): ResponsePromise<AdminTaxRatesRes>

Parameters

Name	Type
payload	AdminPostTaxRatesReq
query?	AdminGetTaxRatesTaxRateParams
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminTaxRatesRes>

Defined in

packages/medusa-js/src/resources/admin/tax-rates.ts:53

---

delete

▸ delete(id, customHeaders?): ResponsePromise<DeleteResponse>

Parameters

Name	Type
id	string
customHeaders	Record<string, any>

Returns

ResponsePromise<DeleteResponse>

Defined in

packages/medusa-js/src/resources/admin/tax-rates.ts:180

---

list

▸ list(query?, customHeaders?): ResponsePromise<AdminTaxRatesListRes>

Parameters

Name	Type
query?	AdminGetTaxRatesParams
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminTaxRatesListRes>

Defined in

packages/medusa-js/src/resources/admin/tax-rates.ts:39

---

removeProductTypes

▸ removeProductTypes(id, payload, query?, customHeaders?): ResponsePromise<AdminTaxRatesRes>

Parameters

Name	Type
id	string
payload	AdminDeleteTaxRatesTaxRateProductTypesReq
query?	AdminDeleteTaxRatesTaxRateProductTypesParams
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminTaxRatesRes>

Defined in

packages/medusa-js/src/resources/admin/tax-rates.ts:148

---

removeProducts

▸ removeProducts(id, payload, query?, customHeaders?): ResponsePromise<AdminTaxRatesRes>

Parameters

Name	Type
id	string
payload	AdminDeleteTaxRatesTaxRateProductsReq
query?	AdminDeleteTaxRatesTaxRateProductsParams
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminTaxRatesRes>

Defined in

packages/medusa-js/src/resources/admin/tax-rates.ts:132

---

removeShippingOptions

▸ removeShippingOptions(id, payload, query?, customHeaders?): ResponsePromise<AdminTaxRatesRes>

Parameters

Name	Type
id	string
payload	AdminDeleteTaxRatesTaxRateShippingOptionsReq
query?	AdminDeleteTaxRatesTaxRateShippingOptionsParams
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminTaxRatesRes>

Defined in

packages/medusa-js/src/resources/admin/tax-rates.ts:164

---

retrieve

▸ retrieve(id, query?, customHeaders?): ResponsePromise<AdminTaxRatesRes>

Parameters

Name	Type
id	string
query?	AdminGetTaxRatesTaxRateParams
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminTaxRatesRes>

Defined in

packages/medusa-js/src/resources/admin/tax-rates.ts:24

---

update

▸ update(id, payload, query?, customHeaders?): ResponsePromise<AdminTaxRatesRes>

Parameters

Name	Type
id	string
payload	AdminPostTaxRatesTaxRateReq
query?	AdminGetTaxRatesTaxRateParams
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminTaxRatesRes>

Defined in

packages/medusa-js/src/resources/admin/tax-rates.ts:68