createTaxRegionsWorkflow - Medusa Core Workflows Reference

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

This workflow creates one or more tax regions. It's used by the Create Tax Region Admin API Route.

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

Examples#

createTaxRegionsStep

Workflow Hook

Step conditioned by when

CreateTaxRegionsWorkflowInputCreateTaxRegionsWorkflowInput

The tax regions to create.

country_codestring

The ISO 3 character country code of the tax region.

province_codenull | stringOptional

The province code of the tax region.

parent_idnull | stringOptional

The ID of the tax region's parent.

metadataMetadataTypeOptional

Holds custom data in key-value pairs.

created_bystringOptional

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

default_tax_rateobjectOptional

The default tax rate of the tax region.

CreateTaxRegionsWorkflowOutputCreateTaxRegionsWorkflowOutput

The created 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?