Get Started
Product
Resources
Tools & SDKs
Framework
Reference

listShippingOptionsForCartWorkflow - Medusa Core Workflows Reference

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

This workflow lists the shipping options of a cart. It's executed by the List Shipping Options Store API Route.

Note: This workflow doesn't retrieve the calculated prices of the shipping options. If you need to retrieve the prices of the shipping options, use the listShippingOptionsForCartWithPricingWorkflow workflow.

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

Source Code

Examples#

Steps#

useQueryGraphStep

validatePresenceOfStep

useQueryGraphStep

useRemoteQueryStep

Workflow Hook

Step conditioned by when

Input#

ListShippingOptionsForCartWorkflowInputListShippingOptionsForCartWorkflowInput

The context for retrieving the shipping options.

cart_idstring

The cart's ID.

option_idsstring[]Optional

Specify the shipping options to retrieve their details. If not specified, 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

Was this page helpful?