chore(docs): Generated References (automated) (#14199)
Generated the following references: - `api_key_models` - `auth_models` - `auth_provider` - `caching` - `cart_models` - `core_flows` - `currency_models` - `customer_models` - `fulfillment_models` - `inventory_next_models` - `js_sdk` - `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` --- > [!NOTE] > Regenerates API reference pages across models, workflows/steps, and JS SDK, and updates generated Typedoc JSON and edit-dates script. > > - **Documentation**: > - **Models References**: Regenerated pages under `apps/resources/references/*_models/variables` for `api_key`, `auth`, `cart`, `currency`, `customer`, `fulfillment`, `inventory_next`, `order`, `payment`, `pricing`, `product`, `promotion`, `region`, `sales_channel`, `stock_location_next`, `store`, `tax`, `user`. > - **Core Flows**: Added/updated `Workflows_*` and `Steps_*` reference pages across modules including `Api_Key`, `Auth`, `Cart`, `Common`, `Customer`, `Customer_Group`, `Defaults`, `Draft_Order`, `File`, `Fulfillment`, `Inventory`, `Invite`, `Line_Item`, `Order`, `Payment`, `Payment_Collection`, `Price_List`, `Pricing`, `Product`, `Product_Category`, `Promotion`, `Region`, `Reservation`, `Return_Reason`, `Sales_Channel`, `Settings`, `Shipping_Options`, `Shipping_Profile`, `Stock_Location`, `Store`, `Tax`, `User`. > - **JS SDK**: Added `js_sdk.admin.Admin.order` property and `admin.Order.updateOrderChange` method references. > - **Types**: Added `types/CachingTypes.interfaces.ICachingModuleService` reference. > - **Generated Assets**: > - Updated `utils/generated/typedoc-json-output/0-medusa.json` and `0-types.json`. > - Updated `apps/resources/generated/edit-dates.mjs`. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 796f722aa33abd2033f488a33e0df81903b1b3f2. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
co-authored by
Oli Juhl
Oli Juhl
parent
b3bcfb7b49
commit
471ab72ecb
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the Order data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/order/src/models/order.ts#L131" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/order/src/models/order.ts#L131" />
|
||||
|
||||
<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":"custom_display_id","type":"`TextProperty`","description":"The custom display id of the order","optional":true,"defaultValue":"","expandable":false,"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"/>
|
||||
<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":"custom_display_id","type":"`TextProperty`","description":"The custom display ID of the order","optional":true,"defaultValue":"","expandable":false,"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"/>
|
||||
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderAddress data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/order/src/models/address.ts#L27" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/order/src/models/address.ts#L27" />
|
||||
|
||||
<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"/>
|
||||
|
||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderChange data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/order/src/models/order-change.ts#L89" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/order/src/models/order-change.ts#L89" />
|
||||
|
||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderChangeAction data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/order/src/models/order-change-action.ts#L72" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/order/src/models/order-change-action.ts#L72" />
|
||||
|
||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderClaim data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/order/src/models/claim.ts#L84" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/order/src/models/claim.ts#L84" />
|
||||
|
||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderClaimItem data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/order/src/models/claim-item.ts#L51" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/order/src/models/claim-item.ts#L51" />
|
||||
|
||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderClaimItemImage data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/order/src/models/claim-item-image.ts#L31" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/order/src/models/claim-item-image.ts#L31" />
|
||||
|
||||
+2
-2
File diff suppressed because one or more lines are too long
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderExchange data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/order/src/models/exchange.ts#L78" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/order/src/models/exchange.ts#L78" />
|
||||
|
||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderExchangeItem data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/order/src/models/exchange-item.ts#L39" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/order/src/models/exchange-item.ts#L39" />
|
||||
|
||||
+2
-2
File diff suppressed because one or more lines are too long
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderLineItem data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/order/src/models/line-item.ts#L75" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/order/src/models/line-item.ts#L75" />
|
||||
|
||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderLineItemAdjustment data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/order/src/models/line-item-adjustment.ts#L26" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/order/src/models/line-item-adjustment.ts#L26" />
|
||||
|
||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderLineItemTaxLine data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/order/src/models/line-item-tax-line.ts#L24" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/order/src/models/line-item-tax-line.ts#L24" />
|
||||
|
||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderShipping data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/order/src/models/order-shipping-method.ts#L83" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/order/src/models/order-shipping-method.ts#L83" />
|
||||
|
||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderShippingMethod data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/order/src/models/shipping-method.ts#L40" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/order/src/models/shipping-method.ts#L40" />
|
||||
|
||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderShippingMethodAdjustment data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/order/src/models/shipping-method-adjustment.ts#L33" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/order/src/models/shipping-method-adjustment.ts#L33" />
|
||||
|
||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderShippingMethodTaxLine data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/order/src/models/shipping-method-tax-line.ts#L33" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/order/src/models/shipping-method-tax-line.ts#L33" />
|
||||
|
||||
+2
-2
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderSummary data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/order/src/models/order-summary.ts#L34" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/order/src/models/order-summary.ts#L34" />
|
||||
|
||||
<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":"custom_display_id","type":"`TextProperty`","description":"The custom display id of the order","optional":true,"defaultValue":"","expandable":false,"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"/>
|
||||
<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":"custom_display_id","type":"`TextProperty`","description":"The custom display ID of the order","optional":true,"defaultValue":"","expandable":false,"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"/>
|
||||
|
||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderTransaction data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/order/src/models/transaction.ts#L89" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/order/src/models/transaction.ts#L89" />
|
||||
|
||||
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the Return data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/order/src/models/return.ts#L90" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/order/src/models/return.ts#L90" />
|
||||
|
||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the ReturnItem data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/order/src/models/return-item.ts#L59" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/order/src/models/return-item.ts#L59" />
|
||||
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the ReturnReason data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/order/src/models/return-reason.ts#L43" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/da5d0e3a1430979ab9cda7f239ea7066ded1f7ab/packages/modules/order/src/models/return-reason.ts#L43" />
|
||||
|
||||
<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