createTaxRateRulesWorkflow - Medusa Core Workflows Reference

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

This workflow creates one or more tax rules for rates. It's used by the Create Tax Rules for Rates Admin API Route.

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

Examples#

createTaxRateRulesStep

Workflow Hook

Step conditioned by when

CreateTaxRateRulesWorkflowInputCreateTaxRateRulesWorkflowInput

The data to create tax rules for rates.

The rules to create.

CreateTaxRateRulesWorkflowOutputCreateTaxRateRulesWorkflowOutput

The created tax rules for rates.

idstring

The ID of the tax rate rule.

referencestring

The snake-case name of the data model that the tax rule references. For example, product. Learn more in this guide.

reference_idstring

The ID of the record of the data model that the tax rule references. For example, prod_123. Learn more in this guide.

tax_rate_idstring

The associated tax rate's ID.

created_atstring | Date

The creation date of the tax rate rule.

updated_atstring | Date

The update date of the tax rate rule.

created_bynull | string

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

tax_rateTaxRateDTOOptional

The associated tax rate.

metadatanull | Record<string, unknown>Optional

Holds custom data in key-value pairs.

Was this page helpful?