updateTaxRegionsStep - Medusa Core Workflows Reference

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

This step updates tax regions.

Example#

Code
1const data = updateTaxRegionsStep([2  {3    id: "txreg_123",4    province_code: "CA",5  }6])

UpdateTaxRegionDTO[]UpdateTaxRegionDTO[]

idstring

The id of the tax region to update

province_codenull | stringOptional

The lower-case ISO 3166-2 province or state code of the tax region.

provider_idnull | stringOptional

The ID of the tax provider for the region.

metadataMetadataTypeOptional

Holds custom data in key-value pairs.

TaxRegionDTO[]TaxRegionDTO[]

idstring

The ID of the tax region.

country_codestring

The ISO 2 character country code of the tax region.

province_codenull | string

The lower-case ISO 3166-2 province or state code of the tax region.

parent_idnull | string

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

provider_idnull | string

The ID of the tax provider for the 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.