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

createShippingProfilesWorkflow - Medusa Core Workflows Reference

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

This workflow creates one or more shipping profiles. It's used by the Create Shipping Profile Admin API Route.

You can use this workflow within your own customizations or custom workflows, allowing you to create shipping profiles within your custom flows.

Source Code

Examples#

Steps#

createShippingProfilesStep

Workflow Hook

Step conditioned by when

Input#

CreateShippingProfilesWorkflowInputCreateShippingProfilesWorkflowInput
dataCreateShippingProfile[]
The shipping profiles to create.

Output#

CreateShippingProfilesWorkflowOutputCreateShippingProfilesWorkflowOutput
idstring
The ID of the shipping profile.
namestring
The name of the shipping profile.
typestring
The type of the shipping profile.
metadatanull | Record<string, unknown>
Holds custom data in key-value pairs.
shipping_optionsShippingOptionDTO[]
The shipping options associated with the shipping profile.
created_atDate
The creation date of the shipping profile.
updated_atDate
The update date of the shipping profile.
deleted_atnull | Date
The deletion date of the shipping profile.
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
⇧↵