docs: generate references manually for 2.4.0 (#11171)
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
65d8d6dc0e
commit
4ccb489dbe
444 files changed
+236833
-244966
No files matched your search
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/Order
|
||||
sidebar_label: Order
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Order - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the Order data model. It belongs to the Order Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`AutoIncrementProperty`","description":"The display ID of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`NumberProperty`","description":"The version of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)>","description":"The status of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_draft_order","type":"`BooleanProperty`","description":"Whether the order is a draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the order.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"HasMany<any>","description":"The associated summary.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"items","type":"HasMany<any>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"HasMany<any>","description":"The associated shipping methods.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"transactions","type":"HasMany<any>","description":"The associated transactions, which include amounts captured and refunded.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"credit_lines","type":"HasMany<any>","description":"The associated credit lines, which include additional payment amounts for an order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"returns","type":"HasMany<any>","description":"The associated returns.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the region that the order was purchased in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the customer that placed the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`TextProperty`","description":"The ID of the sales channel that the order was purchased through.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the order's customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`BooleanProperty`","description":"Whether the customer should receive notifications for order updates.","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":"canceled_at","type":"`DateTimeProperty`","description":"The date the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"HasOneWithForeignKey<any, undefined>","description":"The associated shipping\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address","type":"HasOneWithForeignKey<any, undefined>","description":"The associated billing address.","optional":true,"defaultValue":"","expandable":true,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Order"/>
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/OrderAddress
|
||||
sidebar_label: OrderAddress
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# OrderAddress - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the OrderAddress data model. It belongs to the Order Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the order address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the customer that the address belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`TextProperty`","description":"The company of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`TextProperty`","description":"The first name of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`TextProperty`","description":"The last name of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`TextProperty`","description":"The first line of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`TextProperty`","description":"The second line of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"The city of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the order address.\n\n@example us","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`TextProperty`","description":"The province of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`TextProperty`","description":"The postal code of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`TextProperty`","description":"The phone of the order 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="OrderAddress"/>
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/OrderChange
|
||||
sidebar_label: OrderChange
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# OrderChange - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the OrderChange data model. It belongs to the Order Module.
|
||||
|
||||
`Const` **OrderChange**: `any` = `_OrderChange`
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/OrderChangeAction
|
||||
sidebar_label: OrderChangeAction
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# OrderChangeAction - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the OrderChangeAction data model. It belongs to the Order Module.
|
||||
|
||||
`Const` **OrderChangeAction**: `any` = `_OrderChangeAction`
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/OrderClaim
|
||||
sidebar_label: OrderClaim
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# OrderClaim - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the OrderClaim data model. It belongs to the Order Module.
|
||||
|
||||
`Const` **OrderClaim**: `any` = `_OrderClaim`
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/OrderClaimItem
|
||||
sidebar_label: OrderClaimItem
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# OrderClaimItem - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the OrderClaimItem data model. It belongs to the Order Module.
|
||||
|
||||
`Const` **OrderClaimItem**: `any` = `_OrderClaimItem`
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/OrderClaimItemImage
|
||||
sidebar_label: OrderClaimItemImage
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# OrderClaimItemImage - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the OrderClaimItemImage data model. It belongs to the Order Module.
|
||||
|
||||
`Const` **OrderClaimItemImage**: `any` = `_OrderClaimItemImage`
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/OrderCreditLine
|
||||
sidebar_label: OrderCreditLine
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# OrderCreditLine - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the OrderCreditLine data model. It belongs to the Order Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the order credit line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"BelongsTo<[Order](../order_models.Order/page.mdx)>","description":"The associated order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`AutoIncrementProperty`","description":"The display ID of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`NumberProperty`","description":"The version of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)>","description":"The status of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_draft_order","type":"`BooleanProperty`","description":"Whether the order is a draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the order.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"HasMany<any>","description":"The associated summary.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"items","type":"HasMany<any>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"HasMany<any>","description":"The associated shipping methods.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"transactions","type":"HasMany<any>","description":"The associated transactions, which include amounts captured and refunded.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"credit_lines","type":"HasMany<any>","description":"The associated credit lines, which include additional payment amounts for an order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"returns","type":"HasMany<any>","description":"The associated returns.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the region that the order was purchased in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the customer that placed the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`TextProperty`","description":"The ID of the sales channel that the order was purchased through.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the order's customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`BooleanProperty`","description":"Whether the customer should receive notifications for order updates.","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":"canceled_at","type":"`DateTimeProperty`","description":"The date the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"HasOneWithForeignKey<any, undefined>","description":"The associated shipping\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address","type":"HasOneWithForeignKey<any, undefined>","description":"The associated billing address.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the order credit line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"`JSONProperty`","description":"The raw amount of the order credit line","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`TextProperty`","description":"The table that this credit line references. For example, `payment\\_collection`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`TextProperty`","description":"The ID of the record in the referenced table. For example, `paycol\\_123`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","descripLine truncated
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/OrderExchange
|
||||
sidebar_label: OrderExchange
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# OrderExchange - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the OrderExchange data model. It belongs to the Order Module.
|
||||
|
||||
`Const` **OrderExchange**: `any` = `_OrderExchange`
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/OrderExchangeItem
|
||||
sidebar_label: OrderExchangeItem
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# OrderExchangeItem - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the OrderExchangeItem data model. It belongs to the Order Module.
|
||||
|
||||
`Const` **OrderExchangeItem**: `any` = `_OrderExchangeItem`
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/OrderItem
|
||||
sidebar_label: OrderItem
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# OrderItem - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the OrderItem data model. It belongs to the Order Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the order item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`NumberProperty`","description":"The version that the order item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`BigNumberProperty`","description":"The quantity of the order item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"`BigNumberProperty`","description":"The fulfilled quantity of the order item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_quantity","type":"`BigNumberProperty`","description":"The delivered quantity of the order item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`BigNumberProperty`","description":"The shipped quantity of the order item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_requested_quantity","type":"`BigNumberProperty`","description":"The quantity requested to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_received_quantity","type":"`BigNumberProperty`","description":"The quantity received by a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_dismissed_quantity","type":"`BigNumberProperty`","description":"The quantity dismissed by a return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"written_off_quantity","type":"`BigNumberProperty`","description":"The quantity written off by an order edit.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"BelongsTo<[Order](../order_models.Order/page.mdx)>","description":"The associated order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`AutoIncrementProperty`","description":"The display ID of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`NumberProperty`","description":"The version of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)>","description":"The status of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_draft_order","type":"`BooleanProperty`","description":"Whether the order is a draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the order.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"HasMany<any>","description":"The associated summary.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"items","type":"HasMany<any>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"HasMany<any>","description":"The associated shipping methods.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"transactions","type":"HasMany<any>","description":"The associated transactions, which include amounts captured and refunded.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"credit_lines","type":"HasMany<any>","description":"The associated credit lines, which include additional payment amounts for an order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"returns","type":"HasMany<any>","description":"The associated returns.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the region that the order was purchased in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the customer that placed the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`TextProperty`","description":"The ID of the sales channel that the order was purchased through.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the order's customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`BooleanProperty`","description":"Whether the customer should receive notificaLine truncated
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/OrderLineItem
|
||||
sidebar_label: OrderLineItem
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# OrderLineItem - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the OrderLineItem data model. It belongs to the Order Module.
|
||||
|
||||
`Const` **OrderLineItem**: `any` = `_OrderLineItem`
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/OrderLineItemAdjustment
|
||||
sidebar_label: OrderLineItemAdjustment
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# OrderLineItemAdjustment - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the OrderLineItemAdjustment data model. It belongs to the Order Module.
|
||||
|
||||
`Const` **OrderLineItemAdjustment**: `any` = `_OrderLineItemAdjustment`
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/OrderLineItemTaxLine
|
||||
sidebar_label: OrderLineItemTaxLine
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# OrderLineItemTaxLine - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the OrderLineItemTaxLine data model. It belongs to the Order Module.
|
||||
|
||||
`Const` **OrderLineItemTaxLine**: `any` = `_OrderLineItemTaxLine`
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/OrderShipping
|
||||
sidebar_label: OrderShipping
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# OrderShipping - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the OrderShipping data model. It belongs to the Order Module.
|
||||
|
||||
`Const` **OrderShipping**: `any` = `_OrderShipping`
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/OrderShippingMethod
|
||||
sidebar_label: OrderShippingMethod
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# OrderShippingMethod - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the OrderShippingMethod data model. It belongs to the Order Module.
|
||||
|
||||
`Const` **OrderShippingMethod**: `any` = `_OrderShippingMethod`
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/OrderShippingMethodAdjustment
|
||||
sidebar_label: OrderShippingMethodAdjustment
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# OrderShippingMethodAdjustment - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the OrderShippingMethodAdjustment data model. It belongs to the Order Module.
|
||||
|
||||
`Const` **OrderShippingMethodAdjustment**: `any` = `_OrderShippingMethodAdjustment`
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/OrderShippingMethodTaxLine
|
||||
sidebar_label: OrderShippingMethodTaxLine
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# OrderShippingMethodTaxLine - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the OrderShippingMethodTaxLine data model. It belongs to the Order Module.
|
||||
|
||||
`Const` **OrderShippingMethodTaxLine**: `any` = `_OrderShippingMethodTaxLine`
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/OrderSummary
|
||||
sidebar_label: OrderSummary
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# OrderSummary - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the OrderSummary data model. It belongs to the Order Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`NumberProperty`","description":"The version that the summary belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"totals","type":"`JSONProperty`","description":"The totals of the order summary","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"BelongsTo<[Order](../order_models.Order/page.mdx)>","description":"The associated order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`AutoIncrementProperty`","description":"The display ID of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`NumberProperty`","description":"The version of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)>","description":"The status of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_draft_order","type":"`BooleanProperty`","description":"Whether the order is a draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the order.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"HasMany<any>","description":"The associated summary.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"items","type":"HasMany<any>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"HasMany<any>","description":"The associated shipping methods.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"transactions","type":"HasMany<any>","description":"The associated transactions, which include amounts captured and refunded.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"credit_lines","type":"HasMany<any>","description":"The associated credit lines, which include additional payment amounts for an order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"returns","type":"HasMany<any>","description":"The associated returns.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the region that the order was purchased in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the customer that placed the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`TextProperty`","description":"The ID of the sales channel that the order was purchased through.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the order's customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`BooleanProperty`","description":"Whether the customer should receive notifications for order updates.","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":"canceled_at","type":"`DateTimeProperty`","description":"The date the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"HasOneWithForeignKey<any, undefined>","description":"The associated shipping\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address","type":"HasOneWithForeignKey<any, undefined>","description":"The associated billing address.","optional":true,"defaultValue":"","expandable":true,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OrderSummary"/>
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/OrderTransaction
|
||||
sidebar_label: OrderTransaction
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# OrderTransaction - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the OrderTransaction data model. It belongs to the Order Module.
|
||||
|
||||
`Const` **OrderTransaction**: `any`
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/Return
|
||||
sidebar_label: Return
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Return - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the Return data model. It belongs to the Order Module.
|
||||
|
||||
`Const` **Return**: `any` = `_Return`
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/ReturnItem
|
||||
sidebar_label: ReturnItem
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ReturnItem - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the ReturnItem data model. It belongs to the Order Module.
|
||||
|
||||
`Const` **ReturnItem**: `any` = `_ReturnItem`
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: orderModelReference
|
||||
slug: /references/order/models/ReturnReason
|
||||
sidebar_label: ReturnReason
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ReturnReason - Order Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the ReturnReason data model. It belongs to the Order Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the return reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`TextProperty`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"HasMany<() => any>","description":"The associated return\\_reason\\_children.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the return reason","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":"parent_return_reason","type":"BelongsTo<() => any, undefined>","description":"The associated parent\\_return\\_reason.","optional":true,"defaultValue":"","expandable":true,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ReturnReason"/>
|
||||
Reference in new issue
Block a user