updateTaxRatesWorkflow - Medusa Core Workflows Reference

This documentation provides a reference to the updateTaxRatesWorkflow. It belongs to the @medusajs/medusa/core-flows package.

This workflow updates tax rates matching specified filters. It's used by the Update Tax Rates Admin API Route.

You can use this workflow within your own customizations or custom workflows, allowing you to update tax rates in your custom flows.

Examples#

updateTaxRatesStep

deleteTaxRateRulesStep

createTaxRateRulesStep

Workflow Hook

Step conditioned by when

UpdateTaxRatesWorkflowInputUpdateTaxRatesWorkflowInput

The data to update tax rates.

The filters to select the tax rates to update.

The data to update in the tax rates.

UpdateTaxRatesWorkflowOutputUpdateTaxRatesWorkflowOutput

The updated tax rates.

idstring

The ID of the tax rate.

ratenull | number

The rate to charge.

codenull | string

The code the tax rate is identified by.

namestring

The name of the Tax Rate.

metadatanull | Record<string, unknown>

Holds custom data in key-value pairs.

tax_region_idstring

The ID of the associated tax region.

is_combinableboolean

Whether the tax rate should be combined with parent rates. Learn more here.

is_defaultboolean

Whether the tax rate is the default rate for the region.

created_atstring | Date

The creation date of the tax rate.

updated_atstring | Date

The update date of the tax rate.

deleted_atnull | Date

The deletion date of the tax rate.

created_bynull | string

Who created the tax rate. For example, the ID of the user that created the tax rate.

Was this page helpful?