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 CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
ListShippingOptionsForCartWorkflowInput & AdditionalDataListShippingOptionsForCartWorkflowInput & AdditionalData
ListShippingOptionsForCartWorkflowInput & AdditionalDataListShippingOptionsForCartWorkflowInput & AdditionalDataListShippingOptionsForCartWorkflowInputListShippingOptionsForCartWorkflowInputThe context for retrieving the shipping options.
ListShippingOptionsForCartWorkflowInputListShippingOptionsForCartWorkflowInputAdditionalDataAdditionalData
AdditionalDataAdditionalDataHooks#
Hooks allow you to inject custom functionalities into the workflow. You'll receive data from the workflow, as well as additional data sent through an HTTP request.
Learn more about Hooks and Additional Data.
setPricingContext#
Handlers consuming this hook accept the following input.
inputobject
inputobjectcartany
cartanyfulfillmentSetIdsstring[]
fulfillmentSetIdsstring[]additional_dataRecord<string, unknown> | undefinedAdditional data that can be passed through the additional_data property in HTTP requests.
Learn more in this documentation.
additional_dataRecord<string, unknown> | undefinedadditional_data property in HTTP requests.
Learn more in this documentation.Was this page helpful?