createServiceZonesWorkflow - Medusa Core Workflows Reference

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

This workflow creates one or more service zones. It's used by the Add Service Zone to Fulfillment Set Admin API Route.

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

Source Code

Examples#

Steps#

Workflow Hook

Step conditioned by when

Input#

CreateServiceZonesWorkflowInputCreateServiceZonesWorkflowInput
The service zones to create.

Output#

CreateServiceZonesWorkflowOutputCreateServiceZonesWorkflowOutput
The service zones to create.
idstring
The ID of the service zone.
namestring
The name of the service zone.
metadatanull | Record<string, unknown>
Holds custom data in key-value pairs.
fulfillment_setFulfillmentSetDTO
The fulfillment set assoiated with the service zone.
fulfillment_set_idstring
The fulfillment set id of the service zone.
geo_zonesGeoZoneDTO[]
The geo zones assoiated with the service zone.
shipping_optionsShippingOptionDTO[]
The shipping options assoiated with the service zone.
created_atDate
The creation date of the service zone.
updated_atDate
The update date of the service zone.
deleted_atnull | Date
The deletion date of the service zone.
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