updateTaxRegionsWorkflow - Medusa Core Workflows Reference

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

This workflow updates one or more tax regions. It's used by the Update Tax Regions Admin API Route.

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

Examples#

updateTaxRegionsStep

Workflow Hook

Step conditioned by when

UpdateTaxRegionsWorkflowInputUpdateTaxRegionsWorkflowInput

The tax regions to update.

idstring

The id of the tax region to update

province_codenull | stringOptional

The province code of the tax region.

metadataMetadataTypeOptional

Holds custom data in key-value pairs.

UpdateTaxRegionsWorkflowOutputUpdateTaxRegionsWorkflowOutput

The updated tax regions.

idstring

The ID of the tax region.

country_codestring

The ISO 2 character country code of the tax region.

province_codenull | string

The province code of the tax region.

parent_idnull | string

The ID of the tax region's parent tax region.

metadatanull | Record<string, unknown>

Holds custom data in key-value pairs.

created_atstring | Date

The creation date of the tax region.

updated_atstring | Date

The update date of the tax region.

created_bynull | string

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

deleted_atnull | string | Date

The deletion date of the tax region.

Was this page helpful?