docs: update typedoc, convert packages to esm, generate references (#10699)

2024-12-23 15:20:09 +02:00
1 parent 0559d54c18
commit 870cb6e88c
@@ -1,13 +0,0 @@
---
-displayed_sidebar: fulfillmentModelReference
-slug: /references/fulfillment/models/Fulfillment
-sidebar_label: Fulfillment
---
-
-import { TypeList } from "docs-ui"
-
-# Fulfillment - Fulfillment Module Data Models Reference
-
-This documentation provides a reference to the Fulfillment . This belongs to the Fulfillment Module.
-
-<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"shipped_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"delivered_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOption](../fulfillment_models.ShippingOption/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CALCULATED","type":"`\"calculated\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FLAT","type":"`\"flat\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"service_zone_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"service_zone","type":"[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"fulfillment_set_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"Collection&#60;[GeoZone](../fulfillment_models.GeoZone/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"Collection&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"namLine truncated
@@ -1,13 +0,0 @@
---
-displayed_sidebar: fulfillmentModelReference
-slug: /references/fulfillment/models/FulfillmentAddress
-sidebar_label: FulfillmentAddress
---
-
-import { TypeList } from "docs-ui"
-
-# FulfillmentAddress - Fulfillment Module Data Models Reference
-
-This documentation provides a reference to the FulfillmentAddress . This belongs to the Fulfillment Module.
-
-<TypeList types={[{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FulfillmentAddress"/>
@@ -1,13 +0,0 @@
---
-displayed_sidebar: fulfillmentModelReference
-slug: /references/fulfillment/models/FulfillmentItem
-sidebar_label: FulfillmentItem
---
-
-import { TypeList } from "docs-ui"
-
-# FulfillmentItem - Fulfillment Module Data Models Reference
-
-This documentation provides a reference to the FulfillmentItem . This belongs to the Fulfillment Module.
-
-<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"line_item_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"fulfillment_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"shipped_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"delivered_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOption](../fulfillment_models.ShippingOption/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"service_zone","type":"[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile","type":"`null` \\| [ShippingProfile](../fulfillment_modelLine truncated
@@ -1,13 +0,0 @@
---
-displayed_sidebar: fulfillmentModelReference
-slug: /references/fulfillment/models/FulfillmentLabel
-sidebar_label: FulfillmentLabel
---
-
-import { TypeList } from "docs-ui"
-
-# FulfillmentLabel - Fulfillment Module Data Models Reference
-
-This documentation provides a reference to the FulfillmentLabel . This belongs to the Fulfillment Module.
-
-<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_number","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_url","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label_url","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"shipped_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"delivered_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOption](../fulfillment_models.ShippingOption/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"service_zone","type":"[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile","type":"`null` \\| [ShippingProfile](../fulfillment_models.ShippingProfile/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`null` \\| [FulfillmentProvider](../fulfillment_models.FulfillmentProvider/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ShippingOptionType](../fulfillment_models.ShippingOptionType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"Collection&#60;[ShippingOptionRule](../fulfillment_models.ShippingOptionRule/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillments","tLine truncated
@@ -1,13 +0,0 @@
---
-displayed_sidebar: fulfillmentModelReference
-slug: /references/fulfillment/models/FulfillmentProvider
-sidebar_label: FulfillmentProvider
---
-
-import { TypeList } from "docs-ui"
-
-# FulfillmentProvider - Fulfillment Module Data Models Reference
-
-This documentation provides a reference to the FulfillmentProvider . This belongs to the Fulfillment Module.
-
-<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FulfillmentProvider"/>
@@ -1,13 +0,0 @@
---
-displayed_sidebar: fulfillmentModelReference
-slug: /references/fulfillment/models/FulfillmentSet
-sidebar_label: FulfillmentSet
---
-
-import { TypeList } from "docs-ui"
-
-# FulfillmentSet - Fulfillment Module Data Models Reference
-
-This documentation provides a reference to the FulfillmentSet . This belongs to the Fulfillment Module.
-
-<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"service_zones","type":"Collection&#60;[ServiceZone](../fulfillment_models.ServiceZone/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"fulfillment_set_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FulfillmentSet](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"service_zones","type":"Collection&#60;[ServiceZone](../fulfillment_models.ServiceZone/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"geo_zones","type":"Collection&#60;[GeoZone](../fulfillment_models.GeoZone/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[GeoZoneType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.GeoZoneType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_expression","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"service_zone","type":"[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_options","type":"Collection&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx), oLine truncated
@@ -1,13 +0,0 @@
---
-displayed_sidebar: fulfillmentModelReference
-slug: /references/fulfillment/models/GeoZone
-sidebar_label: GeoZone
---
-
-import { TypeList } from "docs-ui"
-
-# GeoZone - Fulfillment Module Data Models Reference
-
-This documentation provides a reference to the GeoZone . This belongs to the Fulfillment Module.
-
-<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[GeoZoneType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.GeoZoneType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"COUNTRY","type":"`\"country\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROVINCE","type":"`\"province\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CITY","type":"`\"city\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ZIP","type":"`\"zip\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_expression","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"service_zone","type":"[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"fulfillment_set_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"service_zones","type":"Collection&#60;[ServiceZone](../fulfillment_models.ServiceZone/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"geo_zones","type":"Collection&#60;[GeoZone](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[GeoZoneType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.GeoZoneType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_expression","type":"`null` \\| `Record<string, unknown>`","description":Line truncated
@@ -1,13 +0,0 @@
---
-displayed_sidebar: fulfillmentModelReference
-slug: /references/fulfillment/models/ServiceZone
-sidebar_label: ServiceZone
---
-
-import { TypeList } from "docs-ui"
-
-# ServiceZone - Fulfillment Module Data Models Reference
-
-This documentation provides a reference to the ServiceZone . This belongs to the Fulfillment Module.
-
-<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"fulfillment_set_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"service_zones","type":"Collection&#60;[ServiceZone](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"fulfillment_set_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"Collection&#60;[GeoZone](../fulfillment_models.GeoZone/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"Collection&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"geo_zones","type":"Collection&#60;[GeoZone](../fulfillment_models.GeoZone/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[GeoZoneType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.GeoZoneType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"COUNTRY","type":"`\"country\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROVINCE","type":"`\"province\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CITY","type":"`\"city\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ZIP","type":"`\"zip\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":fLine truncated
@@ -1,13 +0,0 @@
---
-displayed_sidebar: fulfillmentModelReference
-slug: /references/fulfillment/models/ShippingOption
-sidebar_label: ShippingOption
---
-
-import { TypeList } from "docs-ui"
-
-# ShippingOption - Fulfillment Module Data Models Reference
-
-This documentation provides a reference to the ShippingOption . This belongs to the Fulfillment Module.
-
-<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CALCULATED","type":"`\"calculated\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FLAT","type":"`\"flat\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"service_zone_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"service_zone","type":"[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"fulfillment_set_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"service_zones","type":"Collection&#60;[ServiceZone](../fulfillment_models.ServiceZone/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"geo_zones","type":"Collection&#60;[GeoZone](../fulfillment_models.GeoZone/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[GeoZoneType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.GeoZoneType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_expression","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable"Line truncated
@@ -1,13 +0,0 @@
---
-displayed_sidebar: fulfillmentModelReference
-slug: /references/fulfillment/models/ShippingOptionRule
-sidebar_label: ShippingOptionRule
---
-
-import { TypeList } from "docs-ui"
-
-# ShippingOptionRule - Fulfillment Module Data Models Reference
-
-This documentation provides a reference to the ShippingOptionRule . This belongs to the Fulfillment Module.
-
-<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"`\"in\"` \\| `\"eq\"` \\| `\"ne\"` \\| `\"gt\"` \\| `\"gte\"` \\| `\"lt\"` \\| `\"lte\"` \\| `\"nin\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string` \\| `string`[]","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CALCULATED","type":"`\"calculated\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FLAT","type":"`\"flat\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"service_zone_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"service_zone","type":"[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"fulfillment_set_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"Collection&#60;[GeoZone](../fulfillment_models.GeoZone/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"Collection&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_profile","type":"`null` \\| [ShippingProfile](../fulfillment_models.ShippingProfile/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_optLine truncated
@@ -1,13 +0,0 @@
---
-displayed_sidebar: fulfillmentModelReference
-slug: /references/fulfillment/models/ShippingOptionType
-sidebar_label: ShippingOptionType
---
-
-import { TypeList } from "docs-ui"
-
-# ShippingOptionType - Fulfillment Module Data Models Reference
-
-This documentation provides a reference to the ShippingOptionType . This belongs to the Fulfillment Module.
-
-<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CALCULATED","type":"`\"calculated\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FLAT","type":"`\"flat\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"service_zone_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"service_zone","type":"[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"fulfillment_set_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"Collection&#60;[GeoZone](../fulfillment_models.GeoZone/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"Collection&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_profile","type":"`null` \\| [ShippingProfile](../fulfillment_models.ShippingProfile/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"Collection&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<strinLine truncated
@@ -1,13 +0,0 @@
---
-displayed_sidebar: fulfillmentModelReference
-slug: /references/fulfillment/models/ShippingProfile
-sidebar_label: ShippingProfile
---
-
-import { TypeList } from "docs-ui"
-
-# ShippingProfile - Fulfillment Module Data Models Reference
-
-This documentation provides a reference to the ShippingProfile . This belongs to the Fulfillment Module.
-
-<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"Collection&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CALCULATED","type":"`\"calculated\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FLAT","type":"`\"flat\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"service_zone_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"service_zone","type":"[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"fulfillment_set_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"Collection&#60;[GeoZone](../fulfillment_models.GeoZone/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"Collection&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_profile","type":"`null` \\| [ShippingProfile](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"Collection&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","descriptiLine truncated
@@ -0,0 +1,15 @@
+---
+displayed_sidebar: fulfillmentModelReference
+slug: /references/fulfillment/models/GeoZoneSchema
+sidebar_label: GeoZoneSchema
+---
+
+import { TypeList } from "docs-ui"
+
+# GeoZoneSchema - Fulfillment Module Data Models Reference
+
+This documentation provides a reference to the GeoZoneSchema data model. It belongs to the Fulfillment Module.
+
+ **GeoZoneSchema**: `Object`
+
+<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo&#60;[ServiceZone](../../variables/fulfillment_models.ServiceZone/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo&#60;[FulfillmentSet](../../variables/fulfillment_models.FulfillmentSet/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"The type of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"HasMany&#60;[ServiceZone](../../variables/fulfillment_models.ServiceZone/page.mdx)&#62;","description":"The associated service zones.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"geo_zones","type":"HasMany&#60;[GeoZone](../../variables/fulfillment_models.GeoZone/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo&#60;[ServiceZone](../../variables/fulfillment_models.ServiceZone/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`TextProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_expression","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_options","type":"HasMany&#60;[ShippingOption](../../variables/fulfillment_models.ShippingOption/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"EnumProperty&#60;typeof [ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)&#62;","description":"The price type of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo&#60;[ServiceZone](../../variables/fulfillment_models.ServiceZone/page.mdx)&#62;","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"HasOneWithForeignKey&#60;[ShippingOptionType](../../variables/fulfillment_models.ShippingOptionType/page.mdx)&#62;","description":"The associated type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rules","type":"HasMany&#60;[ShippingOptionRule](../../variables/fulfillment_models.ShippingOptionRule/page.mdx)&#62;","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"fulfillments","type":"HasMany&#60;[Fulfillment](../../variables/fulfillment_models.Fulfillment/Line truncated
@@ -0,0 +1,15 @@
+---
+displayed_sidebar: fulfillmentModelReference
+slug: /references/fulfillment/models/ServiceZoneSchema
+sidebar_label: ServiceZoneSchema
+---
+
+import { TypeList } from "docs-ui"
+
+# ServiceZoneSchema - Fulfillment Module Data Models Reference
+
+This documentation provides a reference to the ServiceZoneSchema data model. It belongs to the Fulfillment Module.
+
+ **ServiceZoneSchema**: `Object`
+
+<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo&#60;[FulfillmentSet](../../variables/fulfillment_models.FulfillmentSet/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"The type of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"HasMany&#60;[ServiceZone](../../variables/fulfillment_models.ServiceZone/page.mdx)&#62;","description":"The associated service zones.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo&#60;[FulfillmentSet](../../variables/fulfillment_models.FulfillmentSet/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"HasMany&#60;[GeoZone](../../variables/fulfillment_models.GeoZone/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"HasMany&#60;[ShippingOption](../../variables/fulfillment_models.ShippingOption/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"geo_zones","type":"HasMany&#60;[GeoZone](../../variables/fulfillment_models.GeoZone/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo&#60;[ServiceZone](../../variables/fulfillment_models.ServiceZone/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo&#60;[FulfillmentSet](../../variables/fulfillment_models.FulfillmentSet/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"HasMany&#60;[GeoZone](../../variables/fulfillment_models.GeoZone/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"HasMany&#60;[ShippingOption](../../variables/fulfillment_models.ShippingOption/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"province_code","type":"`TextProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_expression","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_options","type":"HasMany&#60;[ShippingOption](../../variables/fulfillment_models.ShippingOption/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":Line truncated
@@ -0,0 +1,13 @@
+---
+displayed_sidebar: fulfillmentModelReference
+slug: /references/fulfillment/models/Fulfillment
+sidebar_label: Fulfillment
+---
+
+import { TypeList } from "docs-ui"
+
+# Fulfillment - Fulfillment Module Data Models Reference
+
+This documentation provides a reference to the Fulfillment data model. It belongs to the Fulfillment Module.
+
+<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`TextProperty`","description":"The ID of the location to fulfill items from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the fulfillment item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany&#60;[FulfillmentItem](../fulfillment_models.FulfillmentItem/page.mdx)&#62;","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`TextProperty`","description":"The SKU of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`TextProperty`","description":"The barcode of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`BigNumberProperty`","description":"The quantity of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"BelongsTo&#60;[Fulfillment](page.mdx)&#62;","description":"The associated fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`TextProperty`","description":"The ID of the location to fulfill items from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the fulfillment item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany&#60;[FulfillmentItem](../fulfillment_models.FulfillmentItem/page.mdx)&#62;","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"labels","type":"HasMany&#60;[FulfillmentLabel](../fulfillment_models.FulfillmentLabel/page.mdx)&#62;","description":"The associated labels.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"packed_at","type":"`DateTimeProperty`","description":"The date the fulfillment items were packed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`DateTimeProperty`","description":"The date the fulfillment items were shipped.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`TextProperty`","description":"The ID of the user that marked this fulfillment as shipped.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created this fulfillment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"`DateTimeProperty`","description":"The date the fulfillment items were delivered.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`DateTimeProperty`","description":"The date the fulfillment was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`JSONProperty`","description":"The data of the fulfillment useful for the associated fulfillment provider. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/fulfillment/item-fulfillment#data-property)","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"HasOneWithForeignKey&#60;[FulfillmentProvider](../fulfillment_models.FulfillmentProvider/page.mdx)&#62;","description":"The associated provider.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_option","type":"BelongsTo&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)&#62;","description":"The associated shipping option.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"delivery_address","type":"HasOneWithForeignKey&#60;[FulfillmentAddress](../fulfillment_models.FulfillmentAddress/page.mdx)&#62;","description":"The associated delivery address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":trueLine truncated
@@ -0,0 +1,13 @@
+---
+displayed_sidebar: fulfillmentModelReference
+slug: /references/fulfillment/models/FulfillmentAddress
+sidebar_label: FulfillmentAddress
+---
+
+import { TypeList } from "docs-ui"
+
+# FulfillmentAddress - Fulfillment Module Data Models Reference
+
+This documentation provides a reference to the FulfillmentAddress data model. It belongs to the Fulfillment Module.
+
+<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the fulfillment address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`TextProperty`","description":"The company of the fulfillment address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`TextProperty`","description":"The first name of the fulfillment address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`TextProperty`","description":"The last name of the fulfillment address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`TextProperty`","description":"The first line of the fulfillment address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`TextProperty`","description":"The second line of the fulfillment address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"The city of the fulfillment address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the fulfillment address.\n\n@example us","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`TextProperty`","description":"The province of the fulfillment address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`TextProperty`","description":"The postal code of the fulfillment address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`TextProperty`","description":"The phone of the fulfillment address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FulfillmentAddress"/>
@@ -0,0 +1,13 @@
+---
+displayed_sidebar: fulfillmentModelReference
+slug: /references/fulfillment/models/FulfillmentItem
+sidebar_label: FulfillmentItem
+---
+
+import { TypeList } from "docs-ui"
+
+# FulfillmentItem - Fulfillment Module Data Models Reference
+
+This documentation provides a reference to the FulfillmentItem data model. It belongs to the Fulfillment Module.
+
+<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`TextProperty`","description":"The SKU of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`TextProperty`","description":"The barcode of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`BigNumberProperty`","description":"The quantity of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"BelongsTo&#60;[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)&#62;","description":"The associated fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`TextProperty`","description":"The ID of the location to fulfill items from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the fulfillment item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany&#60;[FulfillmentItem](page.mdx)&#62;","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`TextProperty`","description":"The SKU of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`TextProperty`","description":"The barcode of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`BigNumberProperty`","description":"The quantity of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"BelongsTo&#60;[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)&#62;","description":"The associated fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"line_item_id","type":"`TextProperty`","description":"The ID the line item being fulfilled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`TextProperty`","description":"The ID of the inventory item being fulfilled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"labels","type":"HasMany&#60;[FulfillmentLabel](../fulfillment_models.FulfillmentLabel/page.mdx)&#62;","description":"The associated labels.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the fulfillment label.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_number","type":"`TextProperty`","description":"The tracking number of the fulfillment label","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_url","type":"`TextProperty`","description":"The tracking URL of the fulfillment label","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label_url","type":"`TextProperty`","description":"The label URL of the fulfillment label","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"BelongsTo&#60;[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)&#62;","description":"The associated fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"packed_at","type":"`DateTimeProperty`","description":"The date the fulfillment items were packed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`DateTimeProperty`","description":"The date the fulfillment items were shipped.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`TextProperty`","description":"The ID of the user that marked this fulfillment as shipped.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created this fulfillment.","optional":true,"defaultValue":Line truncated
@@ -0,0 +1,13 @@
+---
+displayed_sidebar: fulfillmentModelReference
+slug: /references/fulfillment/models/FulfillmentLabel
+sidebar_label: FulfillmentLabel
+---
+
+import { TypeList } from "docs-ui"
+
+# FulfillmentLabel - Fulfillment Module Data Models Reference
+
+This documentation provides a reference to the FulfillmentLabel data model. It belongs to the Fulfillment Module.
+
+<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the fulfillment label.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_number","type":"`TextProperty`","description":"The tracking number of the fulfillment label","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_url","type":"`TextProperty`","description":"The tracking URL of the fulfillment label","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label_url","type":"`TextProperty`","description":"The label URL of the fulfillment label","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"BelongsTo&#60;[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)&#62;","description":"The associated fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`TextProperty`","description":"The ID of the location to fulfill items from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the fulfillment item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany&#60;[FulfillmentItem](../fulfillment_models.FulfillmentItem/page.mdx)&#62;","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`TextProperty`","description":"The SKU of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`TextProperty`","description":"The barcode of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`BigNumberProperty`","description":"The quantity of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"BelongsTo&#60;[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)&#62;","description":"The associated fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"line_item_id","type":"`TextProperty`","description":"The ID the line item being fulfilled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`TextProperty`","description":"The ID of the inventory item being fulfilled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"labels","type":"HasMany&#60;[FulfillmentLabel](page.mdx)&#62;","description":"The associated labels.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the fulfillment label.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_number","type":"`TextProperty`","description":"The tracking number of the fulfillment label","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_url","type":"`TextProperty`","description":"The tracking URL of the fulfillment label","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label_url","type":"`TextProperty`","description":"The label URL of the fulfillment label","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"BelongsTo&#60;[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)&#62;","description":"The associated fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"packed_at","type":"`DateTimeProperty`","description":"The date the fulfillment items were packed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`DateTimeProperty`","description":"The date the fulfillment items were shipped.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`TextProperty`","description":"The ID of the user that marked this fulfillment as shipped.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created this fulfillment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"`DateTimeProperty`","description":"The date the fulfillmeLine truncated
@@ -0,0 +1,13 @@
+---
+displayed_sidebar: fulfillmentModelReference
+slug: /references/fulfillment/models/FulfillmentProvider
+sidebar_label: FulfillmentProvider
+---
+
+import { TypeList } from "docs-ui"
+
+# FulfillmentProvider - Fulfillment Module Data Models Reference
+
+This documentation provides a reference to the FulfillmentProvider data model. It belongs to the Fulfillment Module.
+
+<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`BooleanProperty`","description":"Whether the fulfillment provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FulfillmentProvider"/>
@@ -0,0 +1,13 @@
+---
+displayed_sidebar: fulfillmentModelReference
+slug: /references/fulfillment/models/FulfillmentSet
+sidebar_label: FulfillmentSet
+---
+
+import { TypeList } from "docs-ui"
+
+# FulfillmentSet - Fulfillment Module Data Models Reference
+
+This documentation provides a reference to the FulfillmentSet data model. It belongs to the Fulfillment Module.
+
+<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"The type of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"HasMany&#60;[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)&#62;","description":"The associated service zones.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo&#60;[FulfillmentSet](page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"The type of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"HasMany&#60;[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)&#62;","description":"The associated service zones.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"geo_zones","type":"HasMany&#60;[GeoZone](../fulfillment_models.GeoZone/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo&#60;[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`TextProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_expression","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_options","type":"HasMany&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"EnumProperty&#60;typeof [ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)&#62;","description":"The price type of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo&#60;[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)&#62;","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"HasOneWithForeignKey&#60;[ShippingOptionType](../fulfillment_models.ShippingOptionType/page.mdx)&#62;","description":"The associated type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rules","type":"HasMany&#60;[ShippingOptionRule](../fulfillment_models.ShippingOptionRule/page.mdx)&#62;","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"fulfillments","type":"HasMany&#60;[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)&#62;","description":"The associated fulfillmenLine truncated
@@ -0,0 +1,13 @@
+---
+displayed_sidebar: fulfillmentModelReference
+slug: /references/fulfillment/models/GeoZone
+sidebar_label: GeoZone
+---
+
+import { TypeList } from "docs-ui"
+
+# GeoZone - Fulfillment Module Data Models Reference
+
+This documentation provides a reference to the GeoZone data model. It belongs to the Fulfillment Module.
+
+<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo&#60;[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo&#60;[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"The type of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"HasMany&#60;[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)&#62;","description":"The associated service zones.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"geo_zones","type":"HasMany&#60;[GeoZone](page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo&#60;[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`TextProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_expression","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_options","type":"HasMany&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"EnumProperty&#60;typeof [ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)&#62;","description":"The price type of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo&#60;[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)&#62;","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"HasOneWithForeignKey&#60;[ShippingOptionType](../fulfillment_models.ShippingOptionType/page.mdx)&#62;","description":"The associated type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rules","type":"HasMany&#60;[ShippingOptionRule](../fulfillment_models.ShippingOptionRule/page.mdx)&#62;","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"fulfillments","type":"HasMany&#60;[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)&#62;","description":"The associated fulfillments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"data","type":"`JSONProLine truncated
@@ -0,0 +1,13 @@
+---
+displayed_sidebar: fulfillmentModelReference
+slug: /references/fulfillment/models/ServiceZone
+sidebar_label: ServiceZone
+---
+
+import { TypeList } from "docs-ui"
+
+# ServiceZone - Fulfillment Module Data Models Reference
+
+This documentation provides a reference to the ServiceZone data model. It belongs to the Fulfillment Module.
+
+<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo&#60;[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"The type of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"HasMany&#60;[ServiceZone](page.mdx)&#62;","description":"The associated service zones.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo&#60;[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"HasMany&#60;[GeoZone](../fulfillment_models.GeoZone/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"HasMany&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"geo_zones","type":"HasMany&#60;[GeoZone](../fulfillment_models.GeoZone/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo&#60;[ServiceZone](page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo&#60;[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"HasMany&#60;[GeoZone](../fulfillment_models.GeoZone/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"HasMany&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"province_code","type":"`TextProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_expression","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_options","type":"HasMany&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","deLine truncated
@@ -0,0 +1,13 @@
+---
+displayed_sidebar: fulfillmentModelReference
+slug: /references/fulfillment/models/ShippingOption
+sidebar_label: ShippingOption
+---
+
+import { TypeList } from "docs-ui"
+
+# ShippingOption - Fulfillment Module Data Models Reference
+
+This documentation provides a reference to the ShippingOption data model. It belongs to the Fulfillment Module.
+
+<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"EnumProperty&#60;typeof [ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)&#62;","description":"The price type of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo&#60;[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)&#62;","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo&#60;[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"The type of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"HasMany&#60;[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)&#62;","description":"The associated service zones.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"geo_zones","type":"HasMany&#60;[GeoZone](../fulfillment_models.GeoZone/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo&#60;[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`TextProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_expression","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_options","type":"HasMany&#60;[ShippingOption](page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"EnumProperty&#60;typeof [ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)&#62;","description":"The price type of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo&#60;[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)&#62;","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"HasOneWithForeignKey&#60;[ShippingOptionType](../fulfillment_models.ShippingOptionType/page.mdx)&#62;","description":"The associated type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rules","type":"HasMany&#60;[ShippingOptionRule](../fulfillment_models.ShippingOptionRule/page.mdx)&#62;","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},Line truncated
@@ -0,0 +1,13 @@
+---
+displayed_sidebar: fulfillmentModelReference
+slug: /references/fulfillment/models/ShippingOptionRule
+sidebar_label: ShippingOptionRule
+---
+
+import { TypeList } from "docs-ui"
+
+# ShippingOptionRule - Fulfillment Module Data Models Reference
+
+This documentation provides a reference to the ShippingOptionRule data model. It belongs to the Fulfillment Module.
+
+<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping option rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The name of a property or table that the rule applies to.\n\n@example customer\\_group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty&#60;typeof RuleOperator&#62;","description":"The operator used in the condition.\n\n@example eq","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"BelongsTo&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)&#62;","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"EnumProperty&#60;typeof [ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)&#62;","description":"The price type of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo&#60;[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)&#62;","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo&#60;[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"HasMany&#60;[GeoZone](../fulfillment_models.GeoZone/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"HasMany&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"HasOneWithForeignKey&#60;[ShippingOptionType](../fulfillment_models.ShippingOptionType/page.mdx)&#62;","description":"The associated type.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping option type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`TextProperty`","description":"The label of the shipping option type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the shipping option type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"HasOne&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)&#62;","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the shipping option type","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"HasMany&#60;[ShippingOptionRule](page.mdx)&#62;","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping option rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The name of a property or table that the rule applies to.\n\n@example customer\\_group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty&#60;typeof RuleOperator&#62;","description":"The operator used in the condition.\n\n@example eq","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"BelongsTo&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)&#62;","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"value","type":"`JSONProperty`","description":"The value of the shipping option rule","optional":true,"defaultValue":"","expandable":falsLine truncated
@@ -0,0 +1,13 @@
+---
+displayed_sidebar: fulfillmentModelReference
+slug: /references/fulfillment/models/ShippingOptionType
+sidebar_label: ShippingOptionType
+---
+
+import { TypeList } from "docs-ui"
+
+# ShippingOptionType - Fulfillment Module Data Models Reference
+
+This documentation provides a reference to the ShippingOptionType data model. It belongs to the Fulfillment Module.
+
+<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping option type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`TextProperty`","description":"The label of the shipping option type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the shipping option type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"HasOne&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)&#62;","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"EnumProperty&#60;typeof [ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)&#62;","description":"The price type of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo&#60;[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)&#62;","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo&#60;[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"HasMany&#60;[GeoZone](../fulfillment_models.GeoZone/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"HasMany&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"HasOneWithForeignKey&#60;[ShippingOptionType](page.mdx)&#62;","description":"The associated type.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping option type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`TextProperty`","description":"The label of the shipping option type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the shipping option type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"HasOne&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)&#62;","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the shipping option type","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"HasMany&#60;[ShippingOptionRule](../fulfillment_models.ShippingOptionRule/page.mdx)&#62;","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping option rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The name of a property or table that the rule applies to.\n\n@example customer\\_group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty&#60;typeof RuleOperator&#62;","description":"The operator used in the condition.\n\n@example eq","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"BelongsTo&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)&#62;","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"value","type":"`JSONProperty`","description":"The value of the shipping option rule","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fulfillments","type":"HasMany&#60;[Fulfillment](../fulfillment_models.FulLine truncated
@@ -0,0 +1,13 @@
+---
+displayed_sidebar: fulfillmentModelReference
+slug: /references/fulfillment/models/ShippingProfile
+sidebar_label: ShippingProfile
+---
+
+import { TypeList } from "docs-ui"
+
+# ShippingProfile - Fulfillment Module Data Models Reference
+
+This documentation provides a reference to the ShippingProfile data model. It belongs to the Fulfillment Module.
+
+<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping profile","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"The type of the shipping profile","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"HasMany&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)&#62;","description":"The associated shipping options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"EnumProperty&#60;typeof [ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)&#62;","description":"The price type of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo&#60;[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)&#62;","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo&#60;[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"HasMany&#60;[GeoZone](../fulfillment_models.GeoZone/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"HasMany&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"HasOneWithForeignKey&#60;[ShippingOptionType](../fulfillment_models.ShippingOptionType/page.mdx)&#62;","description":"The associated type.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping option type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`TextProperty`","description":"The label of the shipping option type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the shipping option type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"HasOne&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)&#62;","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the shipping option type","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"HasMany&#60;[ShippingOptionRule](../fulfillment_models.ShippingOptionRule/page.mdx)&#62;","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping option rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The name of a property or table that the rule applies to.\n\n@example customer\\_group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty&#60;typeof RuleOperator&#62;","description":"The operator used in the condition.\n\n@example eq","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"BelongsTo&#60;[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)&#62;","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"value","type":"`JSONProperty`","description":"The value of the shipping option rule","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fulfillments","type":"HasMany&#60;[FulfillmLine truncated