chore(docs): Generated References (automated) (#12492)
Generated the following references: - `api_key_models` - `auth_models` - `cart_models` - `core_flows` - `currency_models` - `customer_models` - `fulfillment_models` - `inventory_next_models` - `js_sdk` - `modules` - `order_models` - `payment_models` - `pricing_models` - `product_models` - `promotion_models` - `region_models` - `sales_channel_models` - `stock_location_next_models` - `store_models` - `tax_models` - `types` - `user_models` - `utils` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andOli Juhl authored and 
GitHub committed
1 parent
d3d138bad3
commit
e81d2333bc
579 files changed
+143451
-141621
No files matched your search
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the Fulfillment data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/fulfillment/src/models/fulfillment.ts#L9" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/3e617155977e9bfd2f5318a9ab5eedea24664e0c/packages/modules/fulfillment/src/models/fulfillment.ts#L9" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[FulfillmentItem](../fulfillment_models.FulfillmentItem/page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[Fulfillment](./page.mdx)>","description":"The associated fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[FulfillmentItem](../fulfillment_models.FulfillmentItem/page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"labels","type":"HasMany<[FulfillmentLabel](../fulfillment_models.FulfillmentLabel/page.mdx)>","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<[FulfillmentProvider](../fulfillment_models.FulfillmentProvider/page.mdx)>","description":"The associated provider.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_option","type":"BelongsTo<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"The associated shipping option.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"delivery_address","type":"HasOneWithForeignKey<[FulfillmentAddress](../fulfillment_models.FulfillmentAddress/page.mdx)>","description":"The associated delivery address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":trLine truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the FulfillmentAddress data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/fulfillment/src/models/address.ts#L3" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/3e617155977e9bfd2f5318a9ab5eedea24664e0c/packages/modules/fulfillment/src/models/address.ts#L3" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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"/>
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the FulfillmentItem data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/fulfillment/src/models/fulfillment-item.ts#L5" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/3e617155977e9bfd2f5318a9ab5eedea24664e0c/packages/modules/fulfillment/src/models/fulfillment-item.ts#L5" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)>","description":"The associated fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[FulfillmentItem](./page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)>","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<[FulfillmentLabel](../fulfillment_models.FulfillmentLabel/page.mdx)>","description":"The associated labels.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)>","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,"defaultValueLine truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the FulfillmentLabel data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/fulfillment/src/models/fulfillment-label.ts#L5" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/3e617155977e9bfd2f5318a9ab5eedea24664e0c/packages/modules/fulfillment/src/models/fulfillment-label.ts#L5" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)>","description":"The associated fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[FulfillmentItem](../fulfillment_models.FulfillmentItem/page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)>","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<[FulfillmentLabel](./page.mdx)>","description":"The associated labels.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)>","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 fulfillLine truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the FulfillmentProvider data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/fulfillment/src/models/fulfillment-provider.ts#L3" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/3e617155977e9bfd2f5318a9ab5eedea24664e0c/packages/modules/fulfillment/src/models/fulfillment-provider.ts#L3" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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"/>
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the FulfillmentSet data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/fulfillment/src/models/fulfillment-set.ts#L5" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/3e617155977e9bfd2f5318a9ab5eedea24664e0c/packages/modules/fulfillment/src/models/fulfillment-set.ts#L5" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"The associated service zones.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo<[FulfillmentSet](./page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","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<[GeoZone](../fulfillment_models.GeoZone/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","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<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<typeof [ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)>","description":"The price type of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"HasOneWithForeignKey<[ShippingOptionType](../fulfillment_models.ShippingOptionType/page.mdx)>","description":"The associated type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rules","type":"HasMany<[ShippingOptionRule](../fulfillment_models.ShippingOptionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"fulfillments","type":"HasMany<[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)>","description":"The associated fulfillmLine truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the GeoZone data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/fulfillment/src/models/geo-zone.ts#L27" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/3e617155977e9bfd2f5318a9ab5eedea24664e0c/packages/modules/fulfillment/src/models/geo-zone.ts#L27" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo<[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","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<[GeoZone](./page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","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<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<typeof [ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)>","description":"The price type of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"HasOneWithForeignKey<[ShippingOptionType](../fulfillment_models.ShippingOptionType/page.mdx)>","description":"The associated type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rules","type":"HasMany<[ShippingOptionRule](../fulfillment_models.ShippingOptionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"fulfillments","type":"HasMany<[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)>","description":"The associated fulfillments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"data","type":"`JSONPLine truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the ServiceZone data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/fulfillment/src/models/service-zone.ts#L27" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/3e617155977e9bfd2f5318a9ab5eedea24664e0c/packages/modules/fulfillment/src/models/service-zone.ts#L27" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo<[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[ServiceZone](./page.mdx)>","description":"The associated service zones.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo<[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"HasMany<[GeoZone](../fulfillment_models.GeoZone/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"HasMany<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","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<[GeoZone](../fulfillment_models.GeoZone/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[ServiceZone](./page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo<[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"HasMany<[GeoZone](../fulfillment_models.GeoZone/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"HasMany<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","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<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`"Line truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the ShippingOption data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/fulfillment/src/models/shipping-option.ts#L10" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/3e617155977e9bfd2f5318a9ab5eedea24664e0c/packages/modules/fulfillment/src/models/shipping-option.ts#L10" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<typeof [ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)>","description":"The price type of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo<[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","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<[GeoZone](../fulfillment_models.GeoZone/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","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<[ShippingOption](./page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<typeof [ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)>","description":"The price type of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"HasOneWithForeignKey<[ShippingOptionType](../fulfillment_models.ShippingOptionType/page.mdx)>","description":"The associated type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rules","type":"HasMany<[ShippingOptionRule](../fulfillment_models.ShippingOptionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]Line truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the ShippingOptionRule data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/fulfillment/src/models/shipping-option-rule.ts#L4" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/3e617155977e9bfd2f5318a9ab5eedea24664e0c/packages/modules/fulfillment/src/models/shipping-option-rule.ts#L4" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<typeof RuleOperator>","description":"The operator used in the condition.\n\n@example eq","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"BelongsTo<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<typeof [ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)>","description":"The price type of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo<[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"HasMany<[GeoZone](../fulfillment_models.GeoZone/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"HasMany<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"HasOneWithForeignKey<[ShippingOptionType](../fulfillment_models.ShippingOptionType/page.mdx)>","description":"The associated type.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","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<[ShippingOptionRule](./page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<typeof RuleOperator>","description":"The operator used in the condition.\n\n@example eq","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"BelongsTo<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","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":faLine truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the ShippingOptionType data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/fulfillment/src/models/shipping-option-type.ts#L5" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/3e617155977e9bfd2f5318a9ab5eedea24664e0c/packages/modules/fulfillment/src/models/shipping-option-type.ts#L5" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<typeof [ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)>","description":"The price type of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo<[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"HasMany<[GeoZone](../fulfillment_models.GeoZone/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"HasMany<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"HasOneWithForeignKey<[ShippingOptionType](./page.mdx)>","description":"The associated type.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","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<[ShippingOptionRule](../fulfillment_models.ShippingOptionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<typeof RuleOperator>","description":"The operator used in the condition.\n\n@example eq","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"BelongsTo<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","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<[Fulfillment](../fulfillment_models.FLine truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the ShippingProfile data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/fulfillment/src/models/shipping-profile.ts#L5" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/3e617155977e9bfd2f5318a9ab5eedea24664e0c/packages/modules/fulfillment/src/models/shipping-profile.ts#L5" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"The associated shipping options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<typeof [ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)>","description":"The price type of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo<[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"HasMany<[GeoZone](../fulfillment_models.GeoZone/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"HasMany<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"HasOneWithForeignKey<[ShippingOptionType](../fulfillment_models.ShippingOptionType/page.mdx)>","description":"The associated type.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","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<[ShippingOptionRule](../fulfillment_models.ShippingOptionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<typeof RuleOperator>","description":"The operator used in the condition.\n\n@example eq","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"BelongsTo<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","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<[FulfillmLine truncated
|
||||
Reference in new issue
Block a user