Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

batchShippingOptionRulesWorkflow - Medusa Core Workflows Reference

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

This workflow manages shipping option rules allowing you to create, update, or delete them. It's used by the Manage the Rules of Shipping Option Admin API Route.

You can use this workflow within your own customizations or custom workflows, allowing you to manage shipping option rules within your custom flows.

Source Code

Examples#

Steps#

createShippingOptionRulesStep

updateShippingOptionRulesStep

deleteShippingOptionRulesStep

Workflow Hook

Step conditioned by when

Input#

BatchShippingOptionRulesInputBatchShippingOptionRulesInput
The data to manage the shipping option rules in bulk.
createCreateShippingOptionRuleDTO[]Optional
The shipping option rules to create.
updateUpdateShippingOptionRuleDTO[]Optional
The shipping option rules to update.
deletestring[]Optional
The IDs of the shipping option rules to delete.

Output#

BatchShippingOptionRulesOutputBatchShippingOptionRulesOutput
The result of managing the shipping option rules in bulk.
createdShippingOptionRuleDTO[]
The shipping option rules that were created.
updatedShippingOptionRuleDTO[]
The shipping option rules that were updated.
deletedstring[]
The IDs of the shipping option rules that were deleted.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧↵