updateOrderTaxLinesWorkflow - Medusa Core Workflows Reference

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

This workflow updates the tax lines of items and shipping methods in an order. It's used by other order-related workflows, such as the createOrderWorkflow to set the order's tax lines.

You can use this workflow within your customizations or your own custom workflows, allowing you to update an order's tax lines in your custom flows.

Source Code

Examples#

Steps#

useRemoteQueryStep

getItemTaxLinesStep

setOrderTaxLinesForItemsStep

Workflow hook

Step conditioned by when

View step details

Input#

UpdateOrderTaxLinesWorkflowInputUpdateOrderTaxLinesWorkflowInput

The data to update the order's tax lines.

order_idstring

The ID of the order to update.

item_idsstring[]Optional

The IDs of the items to update the tax lines for.

shipping_method_idsstring[]Optional

The IDs of the shipping methods to update the tax lines for.

force_tax_calculationbooleanOptional

Whether to force the tax calculation. If enabled, the tax provider may send request to a third-party service to retrieve the calculated tax rates. This depends on the chosen tax provider in the order's tax region.

is_returnbooleanOptional

Whether to calculate the tax lines for a return.

shipping_addressOrderWorkflowDTO["shipping_address"]Optional

The shipping address to use for the tax calculation.