Back to Medusa

UpdateServiceZoneDTO

www/apps/resources/references/fulfillment/interfaces/fulfillment.UpdateServiceZoneDTO/page.mdx

2.14.22.8 KB
Original Source

import { TypeList } from "docs-ui"

UpdateServiceZoneDTO

The attributes to update in the service zone.

<TypeList types={[{"name":"id","type":"string","description":"The ID of the service zone.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"null \| string","description":"The name of the service zone.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"(UpdateCountryGeoZoneDTO \| UpdateProvinceGeoZoneDTO \| UpdateCityGeoZoneDTO \| UpdateZipGeoZoneDTO \| Omit<CreateCountryGeoZoneDTO, "service_zone_id"> \| Omit<CreateProvinceGeoZoneDTO, "service_zone_id"> \| Omit<CreateCityGeoZoneDTO, "service_zone_id"> \| Omit<CreateZipGeoZoneDTO, "service_zone_id"> \| object)[]","description":"The geo zones associated with the service zone.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID 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":"service_zone_id","type":"string","description":"The associated service zone's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"string","description":"The ISO 2 character country code of the geo zone.","optional":true,"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":"city","type":"string","description":"The city of the geo zone.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_expression","type":"Record<string, any>","description":"The postal expression of the geo zone.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="UpdateServiceZoneDTO"/>