- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
createShippingOptionsWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the createShippingOptionsWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow creates one or more shipping options. It's used by the Create Shipping Option Admin API Route.
You can use this workflow within your own customizations or custom workflows, allowing you to create shipping options within your custom flows.
Source CodeExamples#
To calculate a shipping option with flat rate prices:
To calculate shipping option with calculated prices, set
to
and don't pass a
array:
Note: You can calculate the shipping option's price for a cart using the calculateShippingOptionsPricesWorkflow.
Steps#
Workflow Hook
Step conditioned by when
Input#
CreateShippingOptionsWorkflowInputCreateShippingOptionsWorkflowInputThe data to create the shipping options.
CreateShippingOptionsWorkflowInputCreateShippingOptionsWorkflowInputCreateShippingOptionsWorkflowInputCreateShippingOptionsWorkflowInput[]The data to create the shipping options.
CreateShippingOptionsWorkflowInputCreateShippingOptionsWorkflowInput[]Output#
CreateShippingOptionsWorkflowOutputCreateShippingOptionsWorkflowOutput
CreateShippingOptionsWorkflowOutputCreateShippingOptionsWorkflowOutputidstringThe ID of the shipping option.
idstringnamestringThe name of the shipping option.
namestringprice_typeShippingOptionPriceTypeThe type of the shipping option's price.
price_typeShippingOptionPriceTypeservice_zone_idstringThe associated service zone's ID.
service_zone_idstringshipping_profile_idstringThe associated shipping profile's ID.
shipping_profile_idstringprovider_idstringThe associated fulfillment provider's ID.
provider_idstringshipping_option_type_idnull | stringThe associated shipping option type's ID.
shipping_option_type_idnull | stringdatanull | Record<string, unknown>The data necessary for the associated fulfillment provider to process the shipping option
and, later, its associated fulfillments.
datanull | Record<string, unknown>metadatanull | Record<string, unknown>Holds custom data in key-value pairs.
metadatanull | Record<string, unknown>service_zoneServiceZoneDTOThe associated service zone.
service_zoneServiceZoneDTOshipping_profileShippingProfileDTOThe associated shipping profile.
shipping_profileShippingProfileDTOfulfillment_providerFulfillmentProviderDTOThe associated fulfillment provider.
fulfillment_providerFulfillmentProviderDTOThe associated shipping option type.
rulesShippingOptionRuleDTO[]The rules associated with the shipping option.
rulesShippingOptionRuleDTO[]fulfillmentsFulfillmentDTO[]The fulfillments associated with the shipping option.
fulfillmentsFulfillmentDTO[]created_atDateThe creation date of the shipping option.
created_atDateupdated_atDateThe update date of the shipping option.
updated_atDatedeleted_atnull | DateThe deletion date of the shipping option.
deleted_atnull | DateWas this page helpful?