listShippingOptionsForCartWithPricingWorkflow - Medusa Core Workflows Reference

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

This workflow lists shipping options that can be used during checkout for a cart. It also retrieves the prices of these shipping options, including calculated prices that may be retrieved from third-party providers.

This workflow is executed in other cart-related workflows, such as addShippingMethodToCartWorkflow to retrieve the price of the shipping method being added to the cart.

You can use this workflow within your own customizations or custom workflows, allowing you to retrieve the shipping options of a cart and their prices in your custom flows.

Source Code

Examples#

Steps#

useQueryGraphStep

validatePresenceOfStep

useQueryGraphStep

useRemoteQueryStep

calculateShippingOptionsPricesStep

Workflow hook

Step conditioned by when

View step details

Input#

ListShippingOptionsForCartWithPricingWorkflowInputListShippingOptionsForCartWithPricingWorkflowInput

The context for retrieving the shipping options.

cart_idstring

The cart's ID.

optionsobject[]Optional

Specify the shipping options to retrieve their details and prices. If not provided, all applicable shipping options are retrieved.

is_returnbooleanOptional

Whether to retrieve return shipping options. By default, non-return shipping options are retrieved.

Default: false

enabled_in_storebooleanOptional

Whether to retrieve the shipping option's enabled in the store, which is the default.

Default: true

Output#

any[]any[]

anyany