www/apps/resources/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createGeoZones/page.mdx
import { TypeList } from "docs-ui"
This documentation provides a reference to the createGeoZones method. This belongs to the Fulfillment Module.
You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.
</Note>This method creates geo zones.
const geoZones =
await fulfillmentModuleService.createGeoZones([
{
type: "country",
service_zone_id: "serzo_123",
country_code: "us",
},
{
type: "city",
service_zone_id: "serzo_321",
province_code: "us-vt",
city: "Vermont",
country_code: "us",
},
])
<TypeList types={[{"name":"data","type":"CreateGeoZoneDTO[]","description":"The geo zones to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"service_zone_id","type":"string","description":"The associated service zone's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"string","description":"The ISO 2 character country code of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"\"country\"","description":"The type of the geo zone.","optional":false,"defaultValue":"\"country\"","expandable":false,"children":[]},{"name":"province_code","type":"string","description":"The lower-case ISO 3166-2 province code of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"string","description":"The city of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_expression","type":"Record<string, any>","description":"The postal expression of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, any>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"Context","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type TManager, which is a typed parameter passed to the context to specify the type of the transactionManager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type TManager, which is a typed parameter passed to the context to specify the type of the manager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"string","description":"A string indicating the isolation level of the context. Possible values are READ UNCOMMITTED, READ COMMITTED, REPEATABLE READ, or SERIALIZABLE.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"boolean","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"string","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"string","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"runId","type":"string","description":"A string indicating the ID of the current run.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"IMessageAggregator","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"string","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preventReleaseEvents","type":"boolean","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isCancelling","type":"boolean","description":"A boolean value indicating whether the current workflow execution is being cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cancelingFromParentStep","type":"boolean","description":"Weither or not a sub workflow cancellation is being triggered from a parent step.\nIf true, the parent step will not be triggered by the sub workflow.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createGeoZones"/>
<TypeList types={[{"name":"Promise","type":"Promise<GeoZoneDTO[]>","optional":false,"defaultValue":"","description":"The created geo zones.","expandable":false,"children":[{"name":"GeoZoneDTO[]","type":"GeoZoneDTO[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"GeoZoneType","description":"The type of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"string","description":"The country code of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"null \| string","description":"The lower-case ISO 3166-2 province code of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"null \| string","description":"The city of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_expression","type":"null \| Record<string, unknown>","description":"The postal expression of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"Date","description":"The creation date of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"Date","description":"The update date of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"null \| Date","description":"The deletion date of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createGeoZones"/>
This method creates a geo zones.
const geoZones =
await fulfillmentModuleService.createGeoZones({
type: "country",
service_zone_id: "serzo_123",
country_code: "us",
})
<TypeList types={[{"name":"data","type":"CreateGeoZoneDTO","description":"The geo zone to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"service_zone_id","type":"string","description":"The associated service zone's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"string","description":"The ISO 2 character country code of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"\"country\"","description":"The type of the geo zone.","optional":false,"defaultValue":"\"country\"","expandable":false,"children":[]},{"name":"province_code","type":"string","description":"The lower-case ISO 3166-2 province code of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"string","description":"The city of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_expression","type":"Record<string, any>","description":"The postal expression of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, any>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"Context","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type TManager, which is a typed parameter passed to the context to specify the type of the transactionManager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type TManager, which is a typed parameter passed to the context to specify the type of the manager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"string","description":"A string indicating the isolation level of the context. Possible values are READ UNCOMMITTED, READ COMMITTED, REPEATABLE READ, or SERIALIZABLE.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"boolean","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"string","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"string","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"runId","type":"string","description":"A string indicating the ID of the current run.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"IMessageAggregator","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"string","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preventReleaseEvents","type":"boolean","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isCancelling","type":"boolean","description":"A boolean value indicating whether the current workflow execution is being cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cancelingFromParentStep","type":"boolean","description":"Weither or not a sub workflow cancellation is being triggered from a parent step.\nIf true, the parent step will not be triggered by the sub workflow.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createGeoZones"/>
<TypeList types={[{"name":"Promise","type":"Promise<GeoZoneDTO>","optional":false,"defaultValue":"","description":"The created geo zones.","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"GeoZoneType","description":"The type of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"string","description":"The country code of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"null \| string","description":"The lower-case ISO 3166-2 province code of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"null \| string","description":"The city of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_expression","type":"null \| Record<string, unknown>","description":"The postal expression of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"Date","description":"The creation date of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"Date","description":"The update date of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"null \| Date","description":"The deletion date of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createGeoZones"/>