getItemTaxLinesStep - Medusa Core Workflows Reference

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

This step retrieves the tax lines for an order or cart's line items and shipping methods.

Note: You can retrieve an order, cart, item, shipping method, and address details using Query, or useQueryGraphStep.

Example#

Code
1const data = getItemTaxLinesStep({2  orderOrCart: {3    id: "order_123",4    // other order details...5  },6  items: [7    {8      id: "orli_123",9      // other order item details...10    }11  ],12  shipping_methods: [13    {14      id: "osm_213",15      // other shipping method details...16    }17  ],18})

Input#

GetItemTaxLinesStepInputGetItemTaxLinesStepInput

The data to retrieve tax lines for an order or cart's line items and shipping methods.

orderOrCartCartWorkflowDTO | OrderWorkflowDTO

The order or cart details.

itemsCartLineItemDTO[] | OrderLineItemDTO[]

The order or cart's items.

shipping_methodsCartShippingMethodDTO[] | OrderShippingMethodDTO[]

The order or cart's shipping methods.

force_tax_calculationbooleanOptional

Whether to re-calculate taxes. Enabling this may require sending requests to third-party services, depending on the implementation of the tax provider associated with the cart or order's region.

is_returnbooleanOptional

Whether the tax lines are for an order return.

shipping_addressOrderAddressDTOOptional

The shipping address of the order.

Output#

WorkflowDataPropertiesWorkflowDataProperties<object>

lineItemTaxLinesItemTaxLineDTO[]

shippingMethodsTaxLinesShippingTaxLineDTO[]