asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

docs: enhance how references are generated (#5805)

Browse Source 
* adjusted configurations

* enhancements to tool and configurations

* change reference in docs

* fixed issue in workflows reference

* added project name

* more optimizations

* fix context error

* added a types reference

* resolved missing types

* fix reference reflection types not having children

* add an expand url parameter

* added new option to the README

* added details about new option
This commit is contained in:
Shahed Nasser authored and GitHub committed 2023-12-05 15:29:41 +02:00
1 parent a418e6cebc
commit 892d737c1f
4358 files changed
+947876 -534760
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/docs/content/references/entities/.nojekyll
-1
View File
@@ -1 +0,0 @@
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
www/apps/docs/content/references/entities/classes/BaseEntity.mdx
-41
View File
@@ -1,41 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# BaseEntity
Base abstract entity for all entities
## Properties
<ParameterTypes parameters={[
{
"name": "created_at",
"type": "`Date`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/entities/classes/SoftDeletableEntity.mdx
-50
View File
@@ -1,50 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# SoftDeletableEntity
Base abstract entity for all entities
## Properties
<ParameterTypes parameters={[
{
"name": "created_at",
"type": "`Date`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`null` \\| `Date`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/entities/classes/TaxLine.mdx
-77
View File
@@ -1,77 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# TaxLine
A tax line represents the taxes amount applied to a line item.
## Properties
<ParameterTypes parameters={[
{
"name": "code",
"type": "`null` \\| `string`",
"description": "A code to identify the tax type by",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The tax line's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string`",
"description": "A human friendly name for the tax",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "rate",
"type": "`number`",
"description": "The numeric rate to charge tax by",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/entities/classes/Address.mdx → www/apps/docs/content/references/entities/classes/entities.Address.mdx
+4 -3
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/Address
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -49,7 +50,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "country",
"type": "`null` \\| [Country](Country.mdx)",
"type": "`null` \\| [Country](entities.Country.mdx)",
"description": "A country object.",
"optional": false,
"defaultValue": "",
@@ -76,7 +77,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "customer",
"type": "`null` \\| [Customer](Customer.mdx)",
"type": "`null` \\| [Customer](entities.Customer.mdx)",
"description": "Available if the relation `customer` is expanded.",
"optional": false,
"defaultValue": "",
@@ -173,4 +174,4 @@ An address is used across the Medusa backend within other schemas and object typ
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/AnalyticsConfig.mdx → www/apps/docs/content/references/entities/classes/entities.AnalyticsConfig.mdx
+2 -3
View File
@@ -1,13 +1,12 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/AnalyticsConfig
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# AnalyticsConfig
Base abstract entity for all entities
## Properties
<ParameterTypes parameters={[
@@ -74,4 +73,4 @@ Base abstract entity for all entities
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/BatchJob.mdx → www/apps/docs/content/references/entities/classes/entities.BatchJob.mdx
+8 -7
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/BatchJob
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -67,7 +68,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "created_by_user",
"type": "[User](User.mdx)",
"type": "[User](entities.User.mdx)",
"description": "The details of the user that created the batch job.",
"optional": false,
"defaultValue": "",
@@ -156,7 +157,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "role",
"type": "[UserRoles](../enums/UserRoles.mdx)",
"type": "[UserRoles](../enums/entities.UserRoles.mdx)",
"description": "The user's role. These roles don't provide any different privileges.",
"optional": false,
"defaultValue": "member",
@@ -230,7 +231,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "result",
"type": "``{ advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../types/BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../types/BatchJobResultStatDescriptor.mdx)[] }`` & `Record<string, unknown>`",
"type": "`object` & `Record<string, unknown>`",
"description": "The result of the batch job.",
"optional": false,
"defaultValue": "",
@@ -256,7 +257,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "errors",
"type": "(`string` \\| [BatchJobResultError](../types/BatchJobResultError.mdx))[]",
"type": "(`string` \\| [BatchJobResultError](../../medusa/types/medusa.BatchJobResultError.mdx))[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -292,7 +293,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "stat_descriptors",
"type": "[BatchJobResultStatDescriptor](../types/BatchJobResultStatDescriptor.mdx)[]",
"type": "[BatchJobResultStatDescriptor](../../medusa/types/medusa.BatchJobResultStatDescriptor.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -303,7 +304,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "status",
"type": "[BatchJobStatus](../enums/BatchJobStatus.mdx)",
"type": "[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx)",
"description": "The status of the batch job.",
"optional": false,
"defaultValue": "created",
@@ -392,4 +393,4 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/Cart.mdx → www/apps/docs/content/references/entities/classes/entities.Cart.mdx
+15 -14
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/Cart
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -13,7 +14,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
<ParameterTypes parameters={[
{
"name": "billing_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the billing address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -58,7 +59,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "customer",
"type": "[Customer](Customer.mdx)",
"type": "[Customer](entities.Customer.mdx)",
"description": "The details of the customer the cart belongs to.",
"optional": false,
"defaultValue": "",
@@ -94,7 +95,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "discounts",
"type": "[Discount](Discount.mdx)[]",
"type": "[Discount](entities.Discount.mdx)[]",
"description": "An array of details of all discounts applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -130,7 +131,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "gift_cards",
"type": "[GiftCard](GiftCard.mdx)[]",
"type": "[GiftCard](entities.GiftCard.mdx)[]",
"description": "An array of details of all gift cards applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -166,7 +167,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The line items added to the cart.",
"optional": false,
"defaultValue": "",
@@ -193,7 +194,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "payment",
"type": "[Payment](Payment.mdx)",
"type": "[Payment](entities.Payment.mdx)",
"description": "The details of the payment associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -220,7 +221,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "payment_session",
"type": "`null` \\| [PaymentSession](PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](entities.PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -229,7 +230,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "payment_sessions",
"type": "[PaymentSession](PaymentSession.mdx)[]",
"type": "[PaymentSession](entities.PaymentSession.mdx)[]",
"description": "The details of all payment sessions created on the cart.",
"optional": false,
"defaultValue": "",
@@ -265,7 +266,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -283,7 +284,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "sales_channel",
"type": "[SalesChannel](SalesChannel.mdx)",
"type": "[SalesChannel](entities.SalesChannel.mdx)",
"description": "The details of the sales channel associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -301,7 +302,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "shipping_address",
"type": "`null` \\| [Address](Address.mdx)",
"type": "`null` \\| [Address](entities.Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -319,7 +320,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods added to the cart.",
"optional": false,
"defaultValue": "",
@@ -373,7 +374,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "type",
"type": "[CartType](../enums/CartType.mdx)",
"type": "[CartType](../enums/entities.CartType.mdx)",
"description": "The cart's type.",
"optional": false,
"defaultValue": "default",
@@ -389,4 +390,4 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ClaimImage.mdx → www/apps/docs/content/references/entities/classes/entities.ClaimImage.mdx
+9 -8
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ClaimImage
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -13,7 +14,7 @@ The details of an image attached to a claim.
<ParameterTypes parameters={[
{
"name": "claim_item",
"type": "[ClaimItem](ClaimItem.mdx)",
"type": "[ClaimItem](entities.ClaimItem.mdx)",
"description": "The details of the claim item this image is associated with.",
"optional": false,
"defaultValue": "",
@@ -21,7 +22,7 @@ The details of an image attached to a claim.
"children": [
{
"name": "claim_order",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)",
"description": "The details of the claim this item belongs to.",
"optional": false,
"defaultValue": "",
@@ -66,7 +67,7 @@ The details of an image attached to a claim.
},
{
"name": "images",
"type": "[ClaimImage](ClaimImage.mdx)[]",
"type": "[ClaimImage](entities.ClaimImage.mdx)[]",
"description": "The claim images that are attached to the claim item.",
"optional": false,
"defaultValue": "",
@@ -75,7 +76,7 @@ The details of an image attached to a claim.
},
{
"name": "item",
"type": "[LineItem](LineItem.mdx)",
"type": "[LineItem](entities.LineItem.mdx)",
"description": "The details of the line item in the original order that this claim item refers to.",
"optional": false,
"defaultValue": "",
@@ -120,7 +121,7 @@ The details of an image attached to a claim.
},
{
"name": "reason",
"type": "[ClaimReason](../enums/ClaimReason.mdx)",
"type": "[ClaimReason](../enums/entities.ClaimReason.mdx)",
"description": "The reason for the claim",
"optional": false,
"defaultValue": "",
@@ -129,7 +130,7 @@ The details of an image attached to a claim.
},
{
"name": "tags",
"type": "[ClaimTag](ClaimTag.mdx)[]",
"type": "[ClaimTag](entities.ClaimTag.mdx)[]",
"description": "User defined tags for easy filtering and grouping.",
"optional": false,
"defaultValue": "",
@@ -147,7 +148,7 @@ The details of an image attached to a claim.
},
{
"name": "variant",
"type": "[ProductVariant](ProductVariant.mdx)",
"type": "[ProductVariant](entities.ProductVariant.mdx)",
"description": "The details of the product variant to potentially replace the item in the original order.",
"optional": false,
"defaultValue": "",
@@ -228,4 +229,4 @@ The details of an image attached to a claim.
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ClaimItem.mdx → www/apps/docs/content/references/entities/classes/entities.ClaimItem.mdx
+32 -31
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ClaimItem
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -13,7 +14,7 @@ A claim item is an item created as part of a claim. It references an item in the
<ParameterTypes parameters={[
{
"name": "claim_order",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)",
"description": "The details of the claim this item belongs to.",
"optional": false,
"defaultValue": "",
@@ -21,7 +22,7 @@ A claim item is an item created as part of a claim. It references an item in the
"children": [
{
"name": "additional_items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the new items to be shipped when the claim's type is `replace`",
"optional": false,
"defaultValue": "",
@@ -39,7 +40,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "claim_items",
"type": "[ClaimItem](ClaimItem.mdx)[]",
"type": "[ClaimItem](entities.ClaimItem.mdx)[]",
"description": "The details of the items that should be replaced or refunded.",
"optional": false,
"defaultValue": "",
@@ -66,7 +67,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "fulfillment_status",
"type": "[ClaimFulfillmentStatus](../enums/ClaimFulfillmentStatus.mdx)",
"type": "[ClaimFulfillmentStatus](../enums/entities.ClaimFulfillmentStatus.mdx)",
"description": "The claim's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -75,7 +76,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "fulfillments",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"type": "[Fulfillment](entities.Fulfillment.mdx)[]",
"description": "The fulfillments of the new items to be shipped",
"optional": false,
"defaultValue": "",
@@ -120,7 +121,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that this claim was created for.",
"optional": false,
"defaultValue": "",
@@ -138,7 +139,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "payment_status",
"type": "[ClaimPaymentStatus](../enums/ClaimPaymentStatus.mdx)",
"type": "[ClaimPaymentStatus](../enums/entities.ClaimPaymentStatus.mdx)",
"description": "The status of the claim's payment",
"optional": false,
"defaultValue": "na",
@@ -156,7 +157,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "return_order",
"type": "[Return](Return.mdx)",
"type": "[Return](entities.Return.mdx)",
"description": "The details of the return associated with the claim if the claim's type is `replace`.",
"optional": false,
"defaultValue": "",
@@ -165,7 +166,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "shipping_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the address that new items should be shipped to.",
"optional": false,
"defaultValue": "",
@@ -183,7 +184,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods that the claim order will be shipped with.",
"optional": false,
"defaultValue": "",
@@ -192,7 +193,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "type",
"type": "[ClaimType](../enums/ClaimType.mdx)",
"type": "[ClaimType](../enums/entities.ClaimType.mdx)",
"description": "The claim's type",
"optional": false,
"defaultValue": "",
@@ -248,7 +249,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "images",
"type": "[ClaimImage](ClaimImage.mdx)[]",
"type": "[ClaimImage](entities.ClaimImage.mdx)[]",
"description": "The claim images that are attached to the claim item.",
"optional": false,
"defaultValue": "",
@@ -256,7 +257,7 @@ A claim item is an item created as part of a claim. It references an item in the
"children": [
{
"name": "claim_item",
"type": "[ClaimItem](ClaimItem.mdx)",
"type": "[ClaimItem](entities.ClaimItem.mdx)",
"description": "The details of the claim item this image is associated with.",
"optional": false,
"defaultValue": "",
@@ -330,7 +331,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "item",
"type": "[LineItem](LineItem.mdx)",
"type": "[LineItem](entities.LineItem.mdx)",
"description": "The details of the line item in the original order that this claim item refers to.",
"optional": false,
"defaultValue": "",
@@ -338,7 +339,7 @@ A claim item is an item created as part of a claim. It references an item in the
"children": [
{
"name": "adjustments",
"type": "[LineItemAdjustment](LineItemAdjustment.mdx)[]",
"type": "[LineItemAdjustment](entities.LineItemAdjustment.mdx)[]",
"description": "The details of the item's adjustments, which are available when a discount is applied on the item.",
"optional": false,
"defaultValue": "",
@@ -356,7 +357,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -374,7 +375,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "claim_order",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)",
"description": "The details of the claim that the line item may belong to.",
"optional": false,
"defaultValue": "",
@@ -492,7 +493,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -501,7 +502,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "order_edit",
"type": "`null` \\| [OrderEdit](OrderEdit.mdx)",
"type": "`null` \\| [OrderEdit](entities.OrderEdit.mdx)",
"description": "The details of the order edit.",
"optional": true,
"defaultValue": "",
@@ -627,7 +628,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "swap",
"type": "[Swap](Swap.mdx)",
"type": "[Swap](entities.Swap.mdx)",
"description": "The details of the swap that the line item may belong to.",
"optional": false,
"defaultValue": "",
@@ -645,7 +646,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "tax_lines",
"type": "[LineItemTaxLine](LineItemTaxLine.mdx)[]",
"type": "[LineItemTaxLine](entities.LineItemTaxLine.mdx)[]",
"description": "The details of the item's tax lines.",
"optional": false,
"defaultValue": "",
@@ -708,7 +709,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "variant",
"type": "[ProductVariant](ProductVariant.mdx)",
"type": "[ProductVariant](entities.ProductVariant.mdx)",
"description": "The details of the product variant that this item was created from.",
"optional": false,
"defaultValue": "",
@@ -764,7 +765,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "reason",
"type": "[ClaimReason](../enums/ClaimReason.mdx)",
"type": "[ClaimReason](../enums/entities.ClaimReason.mdx)",
"description": "The reason for the claim",
"optional": false,
"defaultValue": "",
@@ -810,7 +811,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "tags",
"type": "[ClaimTag](ClaimTag.mdx)[]",
"type": "[ClaimTag](entities.ClaimTag.mdx)[]",
"description": "User defined tags for easy filtering and grouping.",
"optional": false,
"defaultValue": "",
@@ -883,7 +884,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "variant",
"type": "[ProductVariant](ProductVariant.mdx)",
"type": "[ProductVariant](entities.ProductVariant.mdx)",
"description": "The details of the product variant to potentially replace the item in the original order.",
"optional": false,
"defaultValue": "",
@@ -963,7 +964,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "inventory_items",
"type": "[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]",
"type": "[ProductVariantInventoryItem](entities.ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -1026,7 +1027,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "options",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](entities.ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -1044,7 +1045,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "prices",
"type": "[MoneyAmount](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](entities.MoneyAmount.mdx)[]",
"description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.",
"optional": false,
"defaultValue": "",
@@ -1053,7 +1054,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "product",
"type": "[Product](Product.mdx)",
"type": "[Product](entities.Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
@@ -1072,7 +1073,7 @@ A claim item is an item created as part of a claim. It references an item in the
{
"name": "purchasable",
"type": "`boolean`",
"description": "Only used with the inventory modules. A boolean value indicating whether the Product Variant is purchasable. A variant is purchasable if: - inventory is not managed - it has no inventory items - it is in stock - it is backorderable.",
"description": "Only used with the inventory modules.\nA boolean value indicating whether the Product Variant is purchasable.\nA variant is purchasable if:\n - inventory is not managed\n - it has no inventory items\n - it is in stock\n - it is backorderable.\n",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1152,4 +1153,4 @@ A claim item is an item created as part of a claim. It references an item in the
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ClaimOrder.mdx → www/apps/docs/content/references/entities/classes/entities.ClaimOrder.mdx
+12 -11
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ClaimOrder
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -13,7 +14,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
<ParameterTypes parameters={[
{
"name": "additional_items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the new items to be shipped when the claim's type is `replace`",
"optional": false,
"defaultValue": "",
@@ -31,7 +32,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
},
{
"name": "claim_items",
"type": "[ClaimItem](ClaimItem.mdx)[]",
"type": "[ClaimItem](entities.ClaimItem.mdx)[]",
"description": "The details of the items that should be replaced or refunded.",
"optional": false,
"defaultValue": "",
@@ -58,7 +59,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
},
{
"name": "fulfillment_status",
"type": "[ClaimFulfillmentStatus](../enums/ClaimFulfillmentStatus.mdx)",
"type": "[ClaimFulfillmentStatus](../enums/entities.ClaimFulfillmentStatus.mdx)",
"description": "The claim's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -67,7 +68,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
},
{
"name": "fulfillments",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"type": "[Fulfillment](entities.Fulfillment.mdx)[]",
"description": "The fulfillments of the new items to be shipped",
"optional": false,
"defaultValue": "",
@@ -112,7 +113,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that this claim was created for.",
"optional": false,
"defaultValue": "",
@@ -130,7 +131,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
},
{
"name": "payment_status",
"type": "[ClaimPaymentStatus](../enums/ClaimPaymentStatus.mdx)",
"type": "[ClaimPaymentStatus](../enums/entities.ClaimPaymentStatus.mdx)",
"description": "The status of the claim's payment",
"optional": false,
"defaultValue": "na",
@@ -148,7 +149,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
},
{
"name": "return_order",
"type": "[Return](Return.mdx)",
"type": "[Return](entities.Return.mdx)",
"description": "The details of the return associated with the claim if the claim's type is `replace`.",
"optional": false,
"defaultValue": "",
@@ -157,7 +158,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
},
{
"name": "shipping_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the address that new items should be shipped to.",
"optional": false,
"defaultValue": "",
@@ -175,7 +176,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods that the claim order will be shipped with.",
"optional": false,
"defaultValue": "",
@@ -184,7 +185,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
},
{
"name": "type",
"type": "[ClaimType](../enums/ClaimType.mdx)",
"type": "[ClaimType](../enums/entities.ClaimType.mdx)",
"description": "The claim's type",
"optional": false,
"defaultValue": "",
@@ -200,4 +201,4 @@ A Claim represents a group of faulty or missing items. It consists of claim item
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ClaimTag.mdx → www/apps/docs/content/references/entities/classes/entities.ClaimTag.mdx
+2 -1
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ClaimTag
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -65,4 +66,4 @@ Claim Tags are user defined tags that can be assigned to claim items for easy fi
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/Country.mdx → www/apps/docs/content/references/entities/classes/entities.Country.mdx
+9 -8
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/Country
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -67,7 +68,7 @@ Country details
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region the country is associated with.",
"optional": false,
"defaultValue": "",
@@ -84,7 +85,7 @@ Country details
},
{
"name": "countries",
"type": "[Country](Country.mdx)[]",
"type": "[Country](entities.Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -102,7 +103,7 @@ Country details
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -129,7 +130,7 @@ Country details
},
{
"name": "fulfillment_providers",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)[]",
"type": "[FulfillmentProvider](entities.FulfillmentProvider.mdx)[]",
"description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.",
"optional": false,
"defaultValue": "",
@@ -184,7 +185,7 @@ Country details
},
{
"name": "payment_providers",
"type": "[PaymentProvider](PaymentProvider.mdx)[]",
"type": "[PaymentProvider](entities.PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -202,7 +203,7 @@ Country details
},
{
"name": "tax_provider",
"type": "[TaxProvider](TaxProvider.mdx)",
"type": "[TaxProvider](entities.TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
@@ -229,7 +230,7 @@ Country details
},
{
"name": "tax_rates",
"type": "`null` \\| [TaxRate](TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](entities.TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -256,4 +257,4 @@ Country details
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/Currency.mdx → www/apps/docs/content/references/entities/classes/entities.Currency.mdx
+2 -1
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/Currency
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -57,4 +58,4 @@ Currency
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/CustomShippingOption.mdx → www/apps/docs/content/references/entities/classes/entities.CustomShippingOption.mdx
+22 -21
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/CustomShippingOption
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -13,7 +14,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
<ParameterTypes parameters={[
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart this shipping option belongs to.",
"optional": false,
"defaultValue": "",
@@ -21,7 +22,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
"children": [
{
"name": "billing_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the billing address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -66,7 +67,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "customer",
"type": "[Customer](Customer.mdx)",
"type": "[Customer](entities.Customer.mdx)",
"description": "The details of the customer the cart belongs to.",
"optional": false,
"defaultValue": "",
@@ -102,7 +103,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "discounts",
"type": "[Discount](Discount.mdx)[]",
"type": "[Discount](entities.Discount.mdx)[]",
"description": "An array of details of all discounts applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -138,7 +139,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "gift_cards",
"type": "[GiftCard](GiftCard.mdx)[]",
"type": "[GiftCard](entities.GiftCard.mdx)[]",
"description": "An array of details of all gift cards applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -174,7 +175,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The line items added to the cart.",
"optional": false,
"defaultValue": "",
@@ -201,7 +202,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "payment",
"type": "[Payment](Payment.mdx)",
"type": "[Payment](entities.Payment.mdx)",
"description": "The details of the payment associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -228,7 +229,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "payment_session",
"type": "`null` \\| [PaymentSession](PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](entities.PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -237,7 +238,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "payment_sessions",
"type": "[PaymentSession](PaymentSession.mdx)[]",
"type": "[PaymentSession](entities.PaymentSession.mdx)[]",
"description": "The details of all payment sessions created on the cart.",
"optional": false,
"defaultValue": "",
@@ -273,7 +274,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -291,7 +292,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "sales_channel",
"type": "[SalesChannel](SalesChannel.mdx)",
"type": "[SalesChannel](entities.SalesChannel.mdx)",
"description": "The details of the sales channel associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -309,7 +310,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "shipping_address",
"type": "`null` \\| [Address](Address.mdx)",
"type": "`null` \\| [Address](entities.Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -327,7 +328,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods added to the cart.",
"optional": false,
"defaultValue": "",
@@ -381,7 +382,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "type",
"type": "[CartType](../enums/CartType.mdx)",
"type": "[CartType](../enums/entities.CartType.mdx)",
"description": "The cart's type.",
"optional": false,
"defaultValue": "default",
@@ -455,7 +456,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "shipping_option",
"type": "[ShippingOption](ShippingOption.mdx)",
"type": "[ShippingOption](entities.ShippingOption.mdx)",
"description": "The details of the overridden shipping options.",
"optional": false,
"defaultValue": "",
@@ -554,7 +555,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "price_type",
"type": "[ShippingOptionPriceType](../enums/ShippingOptionPriceType.mdx)",
"type": "[ShippingOptionPriceType](../enums/entities.ShippingOptionPriceType.mdx)",
"description": "The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat\\_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.",
"optional": false,
"defaultValue": "",
@@ -563,7 +564,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "profile",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)",
"description": "The details of the shipping profile that the shipping option belongs to.",
"optional": false,
"defaultValue": "",
@@ -581,7 +582,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "provider",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)",
"type": "[FulfillmentProvider](entities.FulfillmentProvider.mdx)",
"description": "The details of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.",
"optional": false,
"defaultValue": "",
@@ -599,7 +600,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region this shipping option can be used in.",
"optional": false,
"defaultValue": "",
@@ -617,7 +618,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "requirements",
"type": "[ShippingOptionRequirement](ShippingOptionRequirement.mdx)[]",
"type": "[ShippingOptionRequirement](entities.ShippingOptionRequirement.mdx)[]",
"description": "The details of the requirements that must be satisfied for the Shipping Option to be available for usage in a Cart.",
"optional": false,
"defaultValue": "",
@@ -653,4 +654,4 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/Customer.mdx → www/apps/docs/content/references/entities/classes/entities.Customer.mdx
+36 -35
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/Customer
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -13,7 +14,7 @@ A customer can make purchases in your store and manage their profile.
<ParameterTypes parameters={[
{
"name": "billing_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the billing address associated with the customer.",
"optional": false,
"defaultValue": "",
@@ -57,7 +58,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "country",
"type": "`null` \\| [Country](Country.mdx)",
"type": "`null` \\| [Country](entities.Country.mdx)",
"description": "A country object.",
"optional": false,
"defaultValue": "",
@@ -84,7 +85,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "customer",
"type": "`null` \\| [Customer](Customer.mdx)",
"type": "`null` \\| [Customer](entities.Customer.mdx)",
"description": "Available if the relation `customer` is expanded.",
"optional": false,
"defaultValue": "",
@@ -230,7 +231,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "groups",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"type": "[CustomerGroup](entities.CustomerGroup.mdx)[]",
"description": "The customer groups the customer belongs to.",
"optional": false,
"defaultValue": "",
@@ -247,7 +248,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "customers",
"type": "[Customer](Customer.mdx)[]",
"type": "[Customer](entities.Customer.mdx)[]",
"description": "The details of the customers that belong to the customer group.",
"optional": false,
"defaultValue": "",
@@ -292,7 +293,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "price_lists",
"type": "[PriceList](PriceList.mdx)[]",
"type": "[PriceList](entities.PriceList.mdx)[]",
"description": "The price lists that are associated with the customer group.",
"optional": false,
"defaultValue": "",
@@ -348,7 +349,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "orders",
"type": "[Order](Order.mdx)[]",
"type": "[Order](entities.Order.mdx)[]",
"description": "The details of the orders this customer placed.",
"optional": false,
"defaultValue": "",
@@ -356,7 +357,7 @@ A customer can make purchases in your store and manage their profile.
"children": [
{
"name": "billing_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -383,7 +384,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -401,7 +402,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "claims",
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -419,7 +420,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -437,7 +438,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "customer",
"type": "[Customer](Customer.mdx)",
"type": "[Customer](entities.Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -464,7 +465,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "discounts",
"type": "[Discount](Discount.mdx)[]",
"type": "[Discount](entities.Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -482,7 +483,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "draft_order",
"type": "[DraftOrder](DraftOrder.mdx)",
"type": "[DraftOrder](entities.DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -500,7 +501,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "edits",
"type": "[OrderEdit](OrderEdit.mdx)[]",
"type": "[OrderEdit](entities.OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -527,7 +528,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "fulfillment_status",
"type": "[FulfillmentStatus](../enums/FulfillmentStatus.mdx)",
"type": "[FulfillmentStatus](../enums/entities.FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -536,7 +537,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "fulfillments",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"type": "[Fulfillment](entities.Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -563,7 +564,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "gift_card_transactions",
"type": "[GiftCardTransaction](GiftCardTransaction.mdx)[]",
"type": "[GiftCardTransaction](entities.GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -572,7 +573,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "gift_cards",
"type": "[GiftCard](GiftCard.mdx)[]",
"type": "[GiftCard](entities.GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -608,7 +609,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -653,7 +654,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "payment_status",
"type": "[PaymentStatus](../enums/PaymentStatus.mdx)",
"type": "[PaymentStatus](../enums/entities.PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -662,7 +663,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "payments",
"type": "[Payment](Payment.mdx)[]",
"type": "[Payment](entities.Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -698,7 +699,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "refunds",
"type": "[Refund](Refund.mdx)[]",
"type": "[Refund](entities.Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -707,7 +708,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -725,7 +726,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "returnable_items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the line items that are returnable as part of the order, swaps, or claims",
"optional": true,
"defaultValue": "",
@@ -734,7 +735,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "returns",
"type": "[Return](Return.mdx)[]",
"type": "[Return](entities.Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -743,7 +744,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "sales_channel",
"type": "[SalesChannel](SalesChannel.mdx)",
"type": "[SalesChannel](entities.SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -761,7 +762,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "shipping_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -779,7 +780,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -806,7 +807,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "status",
"type": "[OrderStatus](../enums/OrderStatus.mdx)",
"type": "[OrderStatus](../enums/entities.OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -824,7 +825,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "swaps",
"type": "[Swap](Swap.mdx)[]",
"type": "[Swap](entities.Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
@@ -889,7 +890,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "shipping_addresses",
"type": "[Address](Address.mdx)[]",
"type": "[Address](entities.Address.mdx)[]",
"description": "The details of the shipping addresses associated with the customer.",
"optional": false,
"defaultValue": "",
@@ -933,7 +934,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "country",
"type": "`null` \\| [Country](Country.mdx)",
"type": "`null` \\| [Country](entities.Country.mdx)",
"description": "A country object.",
"optional": false,
"defaultValue": "",
@@ -960,7 +961,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "customer",
"type": "`null` \\| [Customer](Customer.mdx)",
"type": "`null` \\| [Customer](entities.Customer.mdx)",
"description": "Available if the relation `customer` is expanded.",
"optional": false,
"defaultValue": "",
@@ -1068,4 +1069,4 @@ A customer can make purchases in your store and manage their profile.
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/CustomerGroup.mdx → www/apps/docs/content/references/entities/classes/entities.CustomerGroup.mdx
+12 -11
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/CustomerGroup
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -22,7 +23,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "customers",
"type": "[Customer](Customer.mdx)[]",
"type": "[Customer](entities.Customer.mdx)[]",
"description": "The details of the customers that belong to the customer group.",
"optional": false,
"defaultValue": "",
@@ -30,7 +31,7 @@ A customer group that can be used to organize customers into groups of similar t
"children": [
{
"name": "billing_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the billing address associated with the customer.",
"optional": false,
"defaultValue": "",
@@ -84,7 +85,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "groups",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"type": "[CustomerGroup](entities.CustomerGroup.mdx)[]",
"description": "The customer groups the customer belongs to.",
"optional": false,
"defaultValue": "",
@@ -129,7 +130,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "orders",
"type": "[Order](Order.mdx)[]",
"type": "[Order](entities.Order.mdx)[]",
"description": "The details of the orders this customer placed.",
"optional": false,
"defaultValue": "",
@@ -156,7 +157,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "shipping_addresses",
"type": "[Address](Address.mdx)[]",
"type": "[Address](entities.Address.mdx)[]",
"description": "The details of the shipping addresses associated with the customer.",
"optional": false,
"defaultValue": "",
@@ -212,7 +213,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "price_lists",
"type": "[PriceList](PriceList.mdx)[]",
"type": "[PriceList](entities.PriceList.mdx)[]",
"description": "The price lists that are associated with the customer group.",
"optional": false,
"defaultValue": "",
@@ -229,7 +230,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "customer_groups",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"type": "[CustomerGroup](entities.CustomerGroup.mdx)[]",
"description": "The details of the customer groups that the Price List can apply to.",
"optional": false,
"defaultValue": "",
@@ -293,7 +294,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "prices",
"type": "[MoneyAmount](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](entities.MoneyAmount.mdx)[]",
"description": "The prices that belong to the price list, represented as a Money Amount.",
"optional": false,
"defaultValue": "",
@@ -311,7 +312,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "status",
"type": "[PriceListStatus](../enums/PriceListStatus.mdx)",
"type": "[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)",
"description": "The status of the Price List",
"optional": false,
"defaultValue": "draft",
@@ -320,7 +321,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "type",
"type": "[PriceListType](../enums/PriceListType.mdx)",
"type": "[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)",
"description": "The type of Price List. This can be one of either `sale` or `override`.",
"optional": false,
"defaultValue": "sale",
@@ -347,4 +348,4 @@ A customer group that can be used to organize customers into groups of similar t
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/Discount.mdx → www/apps/docs/content/references/entities/classes/entities.Discount.mdx
+17 -16
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/Discount
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -85,7 +86,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "parent_discount",
"type": "[Discount](Discount.mdx)",
"type": "[Discount](entities.Discount.mdx)",
"description": "The details of the parent discount that this discount was created from.",
"optional": false,
"defaultValue": "",
@@ -165,7 +166,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "parent_discount",
"type": "[Discount](Discount.mdx)",
"type": "[Discount](entities.Discount.mdx)",
"description": "The details of the parent discount that this discount was created from.",
"optional": false,
"defaultValue": "",
@@ -183,7 +184,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "regions",
"type": "[Region](Region.mdx)[]",
"type": "[Region](entities.Region.mdx)[]",
"description": "The details of the regions in which the Discount can be used.",
"optional": false,
"defaultValue": "",
@@ -192,7 +193,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "rule",
"type": "[DiscountRule](DiscountRule.mdx)",
"type": "[DiscountRule](entities.DiscountRule.mdx)",
"description": "The details of the discount rule that defines how the discount will be applied to a cart..",
"optional": false,
"defaultValue": "",
@@ -266,7 +267,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "regions",
"type": "[Region](Region.mdx)[]",
"type": "[Region](entities.Region.mdx)[]",
"description": "The details of the regions in which the Discount can be used.",
"optional": false,
"defaultValue": "",
@@ -283,7 +284,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "countries",
"type": "[Country](Country.mdx)[]",
"type": "[Country](entities.Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -301,7 +302,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -328,7 +329,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "fulfillment_providers",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)[]",
"type": "[FulfillmentProvider](entities.FulfillmentProvider.mdx)[]",
"description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.",
"optional": false,
"defaultValue": "",
@@ -383,7 +384,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "payment_providers",
"type": "[PaymentProvider](PaymentProvider.mdx)[]",
"type": "[PaymentProvider](entities.PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -401,7 +402,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "tax_provider",
"type": "[TaxProvider](TaxProvider.mdx)",
"type": "[TaxProvider](entities.TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
@@ -428,7 +429,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "tax_rates",
"type": "`null` \\| [TaxRate](TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](entities.TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -448,7 +449,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "rule",
"type": "[DiscountRule](DiscountRule.mdx)",
"type": "[DiscountRule](entities.DiscountRule.mdx)",
"description": "The details of the discount rule that defines how the discount will be applied to a cart..",
"optional": false,
"defaultValue": "",
@@ -456,7 +457,7 @@ A discount can be applied to a cart for promotional purposes.
"children": [
{
"name": "allocation",
"type": "[AllocationType](../enums/AllocationType.mdx)",
"type": "[AllocationType](../enums/entities.AllocationType.mdx)",
"description": "The scope that the discount should apply to.",
"optional": false,
"defaultValue": "",
@@ -465,7 +466,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "conditions",
"type": "[DiscountCondition](DiscountCondition.mdx)[]",
"type": "[DiscountCondition](entities.DiscountCondition.mdx)[]",
"description": "The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.",
"optional": false,
"defaultValue": "",
@@ -519,7 +520,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "type",
"type": "[DiscountRuleType](../enums/DiscountRuleType.mdx)",
"type": "[DiscountRuleType](../enums/entities.DiscountRuleType.mdx)",
"description": "The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.",
"optional": false,
"defaultValue": "",
@@ -600,4 +601,4 @@ A discount can be applied to a cart for promotional purposes.
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/DiscountCondition.mdx → www/apps/docs/content/references/entities/classes/entities.DiscountCondition.mdx
+27 -26
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/DiscountCondition
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -22,7 +23,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "customer_groups",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"type": "[CustomerGroup](entities.CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer\\_groups`.",
"optional": false,
"defaultValue": "",
@@ -39,7 +40,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "customers",
"type": "[Customer](Customer.mdx)[]",
"type": "[Customer](entities.Customer.mdx)[]",
"description": "The details of the customers that belong to the customer group.",
"optional": false,
"defaultValue": "",
@@ -84,7 +85,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "price_lists",
"type": "[PriceList](PriceList.mdx)[]",
"type": "[PriceList](entities.PriceList.mdx)[]",
"description": "The price lists that are associated with the customer group.",
"optional": false,
"defaultValue": "",
@@ -113,7 +114,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "discount_rule",
"type": "[DiscountRule](DiscountRule.mdx)",
"type": "[DiscountRule](entities.DiscountRule.mdx)",
"description": "The details of the discount rule associated with the condition.",
"optional": false,
"defaultValue": "",
@@ -121,7 +122,7 @@ Holds rule conditions for when a discount is applicable
"children": [
{
"name": "allocation",
"type": "[AllocationType](../enums/AllocationType.mdx)",
"type": "[AllocationType](../enums/entities.AllocationType.mdx)",
"description": "The scope that the discount should apply to.",
"optional": false,
"defaultValue": "",
@@ -130,7 +131,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "conditions",
"type": "[DiscountCondition](DiscountCondition.mdx)[]",
"type": "[DiscountCondition](entities.DiscountCondition.mdx)[]",
"description": "The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.",
"optional": false,
"defaultValue": "",
@@ -184,7 +185,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "type",
"type": "[DiscountRuleType](../enums/DiscountRuleType.mdx)",
"type": "[DiscountRuleType](../enums/entities.DiscountRuleType.mdx)",
"description": "The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.",
"optional": false,
"defaultValue": "",
@@ -240,7 +241,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "operator",
"type": "[DiscountConditionOperator](../enums/DiscountConditionOperator.mdx)",
"type": "[DiscountConditionOperator](../enums/entities.DiscountConditionOperator.mdx)",
"description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.",
"optional": false,
"defaultValue": "",
@@ -268,7 +269,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "product_collections",
"type": "[ProductCollection](ProductCollection.mdx)[]",
"type": "[ProductCollection](entities.ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product\\_collections`.",
"optional": false,
"defaultValue": "",
@@ -321,7 +322,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "products",
"type": "[Product](Product.mdx)[]",
"type": "[Product](entities.Product.mdx)[]",
"description": "The details of the products that belong to this product collection.",
"optional": false,
"defaultValue": "",
@@ -350,7 +351,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "product_tags",
"type": "[ProductTag](ProductTag.mdx)[]",
"type": "[ProductTag](entities.ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product\\_tags`.",
"optional": false,
"defaultValue": "",
@@ -414,7 +415,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "product_types",
"type": "[ProductType](ProductType.mdx)[]",
"type": "[ProductType](entities.ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product\\_types`.",
"optional": false,
"defaultValue": "",
@@ -478,7 +479,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "products",
"type": "[Product](Product.mdx)[]",
"type": "[Product](entities.Product.mdx)[]",
"description": "products associated with this condition if `type` is `products`.",
"optional": false,
"defaultValue": "",
@@ -486,7 +487,7 @@ Holds rule conditions for when a discount is applicable
"children": [
{
"name": "categories",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"type": "[ProductCategory](entities.ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -496,7 +497,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "collection",
"type": "[ProductCollection](ProductCollection.mdx)",
"type": "[ProductCollection](entities.ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -595,7 +596,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "images",
"type": "[Image](Image.mdx)[]",
"type": "[Image](entities.Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -649,7 +650,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "options",
"type": "[ProductOption](ProductOption.mdx)[]",
"type": "[ProductOption](entities.ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -667,7 +668,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "profile",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
@@ -685,7 +686,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "profiles",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -694,7 +695,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "sales_channels",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"type": "[SalesChannel](entities.SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -703,7 +704,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "status",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/entities.ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -721,7 +722,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "tags",
"type": "[ProductTag](ProductTag.mdx)[]",
"type": "[ProductTag](entities.ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -748,7 +749,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "type",
"type": "[ProductType](ProductType.mdx)",
"type": "[ProductType](entities.ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -775,7 +776,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "variants",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"type": "[ProductVariant](entities.ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -804,7 +805,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "type",
"type": "[DiscountConditionType](../enums/DiscountConditionType.mdx)",
"type": "[DiscountConditionType](../enums/entities.DiscountConditionType.mdx)",
"description": "The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.",
"optional": false,
"defaultValue": "",
@@ -866,4 +867,4 @@ Holds rule conditions for when a discount is applicable
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/DiscountConditionCustomerGroup.mdx → www/apps/docs/content/references/entities/classes/entities.DiscountConditionCustomerGroup.mdx
+14 -13
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/DiscountConditionCustomerGroup
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -31,7 +32,7 @@ Associates a discount condition with a customer group
},
{
"name": "customer_group",
"type": "[CustomerGroup](CustomerGroup.mdx)",
"type": "[CustomerGroup](entities.CustomerGroup.mdx)",
"description": "Available if the relation `customer\\_group` is expanded.",
"optional": true,
"defaultValue": "",
@@ -48,7 +49,7 @@ Associates a discount condition with a customer group
},
{
"name": "customers",
"type": "[Customer](Customer.mdx)[]",
"type": "[Customer](entities.Customer.mdx)[]",
"description": "The details of the customers that belong to the customer group.",
"optional": false,
"defaultValue": "",
@@ -93,7 +94,7 @@ Associates a discount condition with a customer group
},
{
"name": "price_lists",
"type": "[PriceList](PriceList.mdx)[]",
"type": "[PriceList](entities.PriceList.mdx)[]",
"description": "The price lists that are associated with the customer group.",
"optional": false,
"defaultValue": "",
@@ -122,7 +123,7 @@ Associates a discount condition with a customer group
},
{
"name": "discount_condition",
"type": "[DiscountCondition](DiscountCondition.mdx)",
"type": "[DiscountCondition](entities.DiscountCondition.mdx)",
"description": "Available if the relation `discount\\_condition` is expanded.",
"optional": true,
"defaultValue": "",
@@ -139,7 +140,7 @@ Associates a discount condition with a customer group
},
{
"name": "customer_groups",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"type": "[CustomerGroup](entities.CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer\\_groups`.",
"optional": false,
"defaultValue": "",
@@ -157,7 +158,7 @@ Associates a discount condition with a customer group
},
{
"name": "discount_rule",
"type": "[DiscountRule](DiscountRule.mdx)",
"type": "[DiscountRule](entities.DiscountRule.mdx)",
"description": "The details of the discount rule associated with the condition.",
"optional": false,
"defaultValue": "",
@@ -193,7 +194,7 @@ Associates a discount condition with a customer group
},
{
"name": "operator",
"type": "[DiscountConditionOperator](../enums/DiscountConditionOperator.mdx)",
"type": "[DiscountConditionOperator](../enums/entities.DiscountConditionOperator.mdx)",
"description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.",
"optional": false,
"defaultValue": "",
@@ -202,7 +203,7 @@ Associates a discount condition with a customer group
},
{
"name": "product_collections",
"type": "[ProductCollection](ProductCollection.mdx)[]",
"type": "[ProductCollection](entities.ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product\\_collections`.",
"optional": false,
"defaultValue": "",
@@ -211,7 +212,7 @@ Associates a discount condition with a customer group
},
{
"name": "product_tags",
"type": "[ProductTag](ProductTag.mdx)[]",
"type": "[ProductTag](entities.ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product\\_tags`.",
"optional": false,
"defaultValue": "",
@@ -220,7 +221,7 @@ Associates a discount condition with a customer group
},
{
"name": "product_types",
"type": "[ProductType](ProductType.mdx)[]",
"type": "[ProductType](entities.ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product\\_types`.",
"optional": false,
"defaultValue": "",
@@ -229,7 +230,7 @@ Associates a discount condition with a customer group
},
{
"name": "products",
"type": "[Product](Product.mdx)[]",
"type": "[Product](entities.Product.mdx)[]",
"description": "products associated with this condition if `type` is `products`.",
"optional": false,
"defaultValue": "",
@@ -238,7 +239,7 @@ Associates a discount condition with a customer group
},
{
"name": "type",
"type": "[DiscountConditionType](../enums/DiscountConditionType.mdx)",
"type": "[DiscountConditionType](../enums/entities.DiscountConditionType.mdx)",
"description": "The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.",
"optional": false,
"defaultValue": "",
@@ -274,4 +275,4 @@ Associates a discount condition with a customer group
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/DiscountConditionProduct.mdx → www/apps/docs/content/references/entities/classes/entities.DiscountConditionProduct.mdx
+23 -22
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/DiscountConditionProduct
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -31,7 +32,7 @@ This represents the association between a discount condition and a product
},
{
"name": "discount_condition",
"type": "[DiscountCondition](DiscountCondition.mdx)",
"type": "[DiscountCondition](entities.DiscountCondition.mdx)",
"description": "The details of the discount condition.",
"optional": true,
"defaultValue": "",
@@ -48,7 +49,7 @@ This represents the association between a discount condition and a product
},
{
"name": "customer_groups",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"type": "[CustomerGroup](entities.CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer\\_groups`.",
"optional": false,
"defaultValue": "",
@@ -66,7 +67,7 @@ This represents the association between a discount condition and a product
},
{
"name": "discount_rule",
"type": "[DiscountRule](DiscountRule.mdx)",
"type": "[DiscountRule](entities.DiscountRule.mdx)",
"description": "The details of the discount rule associated with the condition.",
"optional": false,
"defaultValue": "",
@@ -102,7 +103,7 @@ This represents the association between a discount condition and a product
},
{
"name": "operator",
"type": "[DiscountConditionOperator](../enums/DiscountConditionOperator.mdx)",
"type": "[DiscountConditionOperator](../enums/entities.DiscountConditionOperator.mdx)",
"description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.",
"optional": false,
"defaultValue": "",
@@ -111,7 +112,7 @@ This represents the association between a discount condition and a product
},
{
"name": "product_collections",
"type": "[ProductCollection](ProductCollection.mdx)[]",
"type": "[ProductCollection](entities.ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product\\_collections`.",
"optional": false,
"defaultValue": "",
@@ -120,7 +121,7 @@ This represents the association between a discount condition and a product
},
{
"name": "product_tags",
"type": "[ProductTag](ProductTag.mdx)[]",
"type": "[ProductTag](entities.ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product\\_tags`.",
"optional": false,
"defaultValue": "",
@@ -129,7 +130,7 @@ This represents the association between a discount condition and a product
},
{
"name": "product_types",
"type": "[ProductType](ProductType.mdx)[]",
"type": "[ProductType](entities.ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product\\_types`.",
"optional": false,
"defaultValue": "",
@@ -138,7 +139,7 @@ This represents the association between a discount condition and a product
},
{
"name": "products",
"type": "[Product](Product.mdx)[]",
"type": "[Product](entities.Product.mdx)[]",
"description": "products associated with this condition if `type` is `products`.",
"optional": false,
"defaultValue": "",
@@ -147,7 +148,7 @@ This represents the association between a discount condition and a product
},
{
"name": "type",
"type": "[DiscountConditionType](../enums/DiscountConditionType.mdx)",
"type": "[DiscountConditionType](../enums/entities.DiscountConditionType.mdx)",
"description": "The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.",
"optional": false,
"defaultValue": "",
@@ -176,7 +177,7 @@ This represents the association between a discount condition and a product
},
{
"name": "product",
"type": "[Product](Product.mdx)",
"type": "[Product](entities.Product.mdx)",
"description": "The details of the product.",
"optional": true,
"defaultValue": "",
@@ -184,7 +185,7 @@ This represents the association between a discount condition and a product
"children": [
{
"name": "categories",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"type": "[ProductCategory](entities.ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -194,7 +195,7 @@ This represents the association between a discount condition and a product
},
{
"name": "collection",
"type": "[ProductCollection](ProductCollection.mdx)",
"type": "[ProductCollection](entities.ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -293,7 +294,7 @@ This represents the association between a discount condition and a product
},
{
"name": "images",
"type": "[Image](Image.mdx)[]",
"type": "[Image](entities.Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -347,7 +348,7 @@ This represents the association between a discount condition and a product
},
{
"name": "options",
"type": "[ProductOption](ProductOption.mdx)[]",
"type": "[ProductOption](entities.ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -365,7 +366,7 @@ This represents the association between a discount condition and a product
},
{
"name": "profile",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
@@ -383,7 +384,7 @@ This represents the association between a discount condition and a product
},
{
"name": "profiles",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -392,7 +393,7 @@ This represents the association between a discount condition and a product
},
{
"name": "sales_channels",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"type": "[SalesChannel](entities.SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -401,7 +402,7 @@ This represents the association between a discount condition and a product
},
{
"name": "status",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/entities.ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -419,7 +420,7 @@ This represents the association between a discount condition and a product
},
{
"name": "tags",
"type": "[ProductTag](ProductTag.mdx)[]",
"type": "[ProductTag](entities.ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -446,7 +447,7 @@ This represents the association between a discount condition and a product
},
{
"name": "type",
"type": "[ProductType](ProductType.mdx)",
"type": "[ProductType](entities.ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -473,7 +474,7 @@ This represents the association between a discount condition and a product
},
{
"name": "variants",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"type": "[ProductVariant](entities.ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -518,4 +519,4 @@ This represents the association between a discount condition and a product
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/DiscountConditionProductCollection.mdx → www/apps/docs/content/references/entities/classes/entities.DiscountConditionProductCollection.mdx
+13 -12
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/DiscountConditionProductCollection
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -31,7 +32,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "discount_condition",
"type": "[DiscountCondition](DiscountCondition.mdx)",
"type": "[DiscountCondition](entities.DiscountCondition.mdx)",
"description": "The details of the discount condition.",
"optional": true,
"defaultValue": "",
@@ -48,7 +49,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "customer_groups",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"type": "[CustomerGroup](entities.CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer\\_groups`.",
"optional": false,
"defaultValue": "",
@@ -66,7 +67,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "discount_rule",
"type": "[DiscountRule](DiscountRule.mdx)",
"type": "[DiscountRule](entities.DiscountRule.mdx)",
"description": "The details of the discount rule associated with the condition.",
"optional": false,
"defaultValue": "",
@@ -102,7 +103,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "operator",
"type": "[DiscountConditionOperator](../enums/DiscountConditionOperator.mdx)",
"type": "[DiscountConditionOperator](../enums/entities.DiscountConditionOperator.mdx)",
"description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.",
"optional": false,
"defaultValue": "",
@@ -111,7 +112,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "product_collections",
"type": "[ProductCollection](ProductCollection.mdx)[]",
"type": "[ProductCollection](entities.ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product\\_collections`.",
"optional": false,
"defaultValue": "",
@@ -120,7 +121,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "product_tags",
"type": "[ProductTag](ProductTag.mdx)[]",
"type": "[ProductTag](entities.ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product\\_tags`.",
"optional": false,
"defaultValue": "",
@@ -129,7 +130,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "product_types",
"type": "[ProductType](ProductType.mdx)[]",
"type": "[ProductType](entities.ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product\\_types`.",
"optional": false,
"defaultValue": "",
@@ -138,7 +139,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "products",
"type": "[Product](Product.mdx)[]",
"type": "[Product](entities.Product.mdx)[]",
"description": "products associated with this condition if `type` is `products`.",
"optional": false,
"defaultValue": "",
@@ -147,7 +148,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "type",
"type": "[DiscountConditionType](../enums/DiscountConditionType.mdx)",
"type": "[DiscountConditionType](../enums/entities.DiscountConditionType.mdx)",
"description": "The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.",
"optional": false,
"defaultValue": "",
@@ -176,7 +177,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "product_collection",
"type": "[ProductCollection](ProductCollection.mdx)",
"type": "[ProductCollection](entities.ProductCollection.mdx)",
"description": "The details of the product collection.",
"optional": true,
"defaultValue": "",
@@ -229,7 +230,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "products",
"type": "[Product](Product.mdx)[]",
"type": "[Product](entities.Product.mdx)[]",
"description": "The details of the products that belong to this product collection.",
"optional": false,
"defaultValue": "",
@@ -274,4 +275,4 @@ This represents the association between a discount condition and a product colle
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/DiscountConditionProductTag.mdx → www/apps/docs/content/references/entities/classes/entities.DiscountConditionProductTag.mdx
+12 -11
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/DiscountConditionProductTag
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -31,7 +32,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "discount_condition",
"type": "[DiscountCondition](DiscountCondition.mdx)",
"type": "[DiscountCondition](entities.DiscountCondition.mdx)",
"description": "The details of the discount condition.",
"optional": true,
"defaultValue": "",
@@ -48,7 +49,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "customer_groups",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"type": "[CustomerGroup](entities.CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer\\_groups`.",
"optional": false,
"defaultValue": "",
@@ -66,7 +67,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "discount_rule",
"type": "[DiscountRule](DiscountRule.mdx)",
"type": "[DiscountRule](entities.DiscountRule.mdx)",
"description": "The details of the discount rule associated with the condition.",
"optional": false,
"defaultValue": "",
@@ -102,7 +103,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "operator",
"type": "[DiscountConditionOperator](../enums/DiscountConditionOperator.mdx)",
"type": "[DiscountConditionOperator](../enums/entities.DiscountConditionOperator.mdx)",
"description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.",
"optional": false,
"defaultValue": "",
@@ -111,7 +112,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "product_collections",
"type": "[ProductCollection](ProductCollection.mdx)[]",
"type": "[ProductCollection](entities.ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product\\_collections`.",
"optional": false,
"defaultValue": "",
@@ -120,7 +121,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "product_tags",
"type": "[ProductTag](ProductTag.mdx)[]",
"type": "[ProductTag](entities.ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product\\_tags`.",
"optional": false,
"defaultValue": "",
@@ -129,7 +130,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "product_types",
"type": "[ProductType](ProductType.mdx)[]",
"type": "[ProductType](entities.ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product\\_types`.",
"optional": false,
"defaultValue": "",
@@ -138,7 +139,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "products",
"type": "[Product](Product.mdx)[]",
"type": "[Product](entities.Product.mdx)[]",
"description": "products associated with this condition if `type` is `products`.",
"optional": false,
"defaultValue": "",
@@ -147,7 +148,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "type",
"type": "[DiscountConditionType](../enums/DiscountConditionType.mdx)",
"type": "[DiscountConditionType](../enums/entities.DiscountConditionType.mdx)",
"description": "The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.",
"optional": false,
"defaultValue": "",
@@ -176,7 +177,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "product_tag",
"type": "[ProductTag](ProductTag.mdx)",
"type": "[ProductTag](entities.ProductTag.mdx)",
"description": "The details of the product tag.",
"optional": true,
"defaultValue": "",
@@ -256,4 +257,4 @@ This represents the association between a discount condition and a product tag
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/DiscountConditionProductType.mdx → www/apps/docs/content/references/entities/classes/entities.DiscountConditionProductType.mdx
+12 -11
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/DiscountConditionProductType
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -31,7 +32,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "discount_condition",
"type": "[DiscountCondition](DiscountCondition.mdx)",
"type": "[DiscountCondition](entities.DiscountCondition.mdx)",
"description": "The details of the discount condition.",
"optional": true,
"defaultValue": "",
@@ -48,7 +49,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "customer_groups",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"type": "[CustomerGroup](entities.CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer\\_groups`.",
"optional": false,
"defaultValue": "",
@@ -66,7 +67,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "discount_rule",
"type": "[DiscountRule](DiscountRule.mdx)",
"type": "[DiscountRule](entities.DiscountRule.mdx)",
"description": "The details of the discount rule associated with the condition.",
"optional": false,
"defaultValue": "",
@@ -102,7 +103,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "operator",
"type": "[DiscountConditionOperator](../enums/DiscountConditionOperator.mdx)",
"type": "[DiscountConditionOperator](../enums/entities.DiscountConditionOperator.mdx)",
"description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.",
"optional": false,
"defaultValue": "",
@@ -111,7 +112,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "product_collections",
"type": "[ProductCollection](ProductCollection.mdx)[]",
"type": "[ProductCollection](entities.ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product\\_collections`.",
"optional": false,
"defaultValue": "",
@@ -120,7 +121,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "product_tags",
"type": "[ProductTag](ProductTag.mdx)[]",
"type": "[ProductTag](entities.ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product\\_tags`.",
"optional": false,
"defaultValue": "",
@@ -129,7 +130,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "product_types",
"type": "[ProductType](ProductType.mdx)[]",
"type": "[ProductType](entities.ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product\\_types`.",
"optional": false,
"defaultValue": "",
@@ -138,7 +139,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "products",
"type": "[Product](Product.mdx)[]",
"type": "[Product](entities.Product.mdx)[]",
"description": "products associated with this condition if `type` is `products`.",
"optional": false,
"defaultValue": "",
@@ -147,7 +148,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "type",
"type": "[DiscountConditionType](../enums/DiscountConditionType.mdx)",
"type": "[DiscountConditionType](../enums/entities.DiscountConditionType.mdx)",
"description": "The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.",
"optional": false,
"defaultValue": "",
@@ -176,7 +177,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "product_type",
"type": "[ProductType](ProductType.mdx)",
"type": "[ProductType](entities.ProductType.mdx)",
"description": "The details of the product type.",
"optional": true,
"defaultValue": "",
@@ -256,4 +257,4 @@ This represents the association between a discount condition and a product type
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/DiscountRule.mdx → www/apps/docs/content/references/entities/classes/entities.DiscountRule.mdx
+13 -12
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/DiscountRule
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -13,7 +14,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
<ParameterTypes parameters={[
{
"name": "allocation",
"type": "[AllocationType](../enums/AllocationType.mdx)",
"type": "[AllocationType](../enums/entities.AllocationType.mdx)",
"description": "The scope that the discount should apply to.",
"optional": false,
"defaultValue": "",
@@ -41,7 +42,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "conditions",
"type": "[DiscountCondition](DiscountCondition.mdx)[]",
"type": "[DiscountCondition](entities.DiscountCondition.mdx)[]",
"description": "The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.",
"optional": false,
"defaultValue": "",
@@ -58,7 +59,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "customer_groups",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"type": "[CustomerGroup](entities.CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer\\_groups`.",
"optional": false,
"defaultValue": "",
@@ -76,7 +77,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "discount_rule",
"type": "[DiscountRule](DiscountRule.mdx)",
"type": "[DiscountRule](entities.DiscountRule.mdx)",
"description": "The details of the discount rule associated with the condition.",
"optional": false,
"defaultValue": "",
@@ -112,7 +113,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "operator",
"type": "[DiscountConditionOperator](../enums/DiscountConditionOperator.mdx)",
"type": "[DiscountConditionOperator](../enums/entities.DiscountConditionOperator.mdx)",
"description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.",
"optional": false,
"defaultValue": "",
@@ -121,7 +122,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "product_collections",
"type": "[ProductCollection](ProductCollection.mdx)[]",
"type": "[ProductCollection](entities.ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product\\_collections`.",
"optional": false,
"defaultValue": "",
@@ -130,7 +131,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "product_tags",
"type": "[ProductTag](ProductTag.mdx)[]",
"type": "[ProductTag](entities.ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product\\_tags`.",
"optional": false,
"defaultValue": "",
@@ -139,7 +140,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "product_types",
"type": "[ProductType](ProductType.mdx)[]",
"type": "[ProductType](entities.ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product\\_types`.",
"optional": false,
"defaultValue": "",
@@ -148,7 +149,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "products",
"type": "[Product](Product.mdx)[]",
"type": "[Product](entities.Product.mdx)[]",
"description": "products associated with this condition if `type` is `products`.",
"optional": false,
"defaultValue": "",
@@ -157,7 +158,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "type",
"type": "[DiscountConditionType](../enums/DiscountConditionType.mdx)",
"type": "[DiscountConditionType](../enums/entities.DiscountConditionType.mdx)",
"description": "The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.",
"optional": false,
"defaultValue": "",
@@ -222,7 +223,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "type",
"type": "[DiscountRuleType](../enums/DiscountRuleType.mdx)",
"type": "[DiscountRuleType](../enums/entities.DiscountRuleType.mdx)",
"description": "The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.",
"optional": false,
"defaultValue": "",
@@ -275,4 +276,4 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/DraftOrder.mdx → www/apps/docs/content/references/entities/classes/entities.DraftOrder.mdx
+5 -4
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/DraftOrder
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -22,7 +23,7 @@ A draft order is created by an admin without direct involvement of the customer.
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart associated with the draft order.",
"optional": false,
"defaultValue": "",
@@ -103,7 +104,7 @@ A draft order is created by an admin without direct involvement of the customer.
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order created from the draft order when its payment is captured.",
"optional": false,
"defaultValue": "",
@@ -121,7 +122,7 @@ A draft order is created by an admin without direct involvement of the customer.
},
{
"name": "status",
"type": "[DraftOrderStatus](../enums/DraftOrderStatus.mdx)",
"type": "[DraftOrderStatus](../enums/entities.DraftOrderStatus.mdx)",
"description": "The status of the draft order. It's changed to `completed` when it's transformed to an order.",
"optional": false,
"defaultValue": "open",
@@ -137,4 +138,4 @@ A draft order is created by an admin without direct involvement of the customer.
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/Fulfillment.mdx → www/apps/docs/content/references/entities/classes/entities.Fulfillment.mdx
+55 -54
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/Fulfillment
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -22,7 +23,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "claim_order",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)",
"description": "The details of the claim that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -30,7 +31,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
"children": [
{
"name": "additional_items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the new items to be shipped when the claim's type is `replace`",
"optional": false,
"defaultValue": "",
@@ -48,7 +49,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "claim_items",
"type": "[ClaimItem](ClaimItem.mdx)[]",
"type": "[ClaimItem](entities.ClaimItem.mdx)[]",
"description": "The details of the items that should be replaced or refunded.",
"optional": false,
"defaultValue": "",
@@ -75,7 +76,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "fulfillment_status",
"type": "[ClaimFulfillmentStatus](../enums/ClaimFulfillmentStatus.mdx)",
"type": "[ClaimFulfillmentStatus](../enums/entities.ClaimFulfillmentStatus.mdx)",
"description": "The claim's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -84,7 +85,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "fulfillments",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"type": "[Fulfillment](entities.Fulfillment.mdx)[]",
"description": "The fulfillments of the new items to be shipped",
"optional": false,
"defaultValue": "",
@@ -129,7 +130,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that this claim was created for.",
"optional": false,
"defaultValue": "",
@@ -147,7 +148,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "payment_status",
"type": "[ClaimPaymentStatus](../enums/ClaimPaymentStatus.mdx)",
"type": "[ClaimPaymentStatus](../enums/entities.ClaimPaymentStatus.mdx)",
"description": "The status of the claim's payment",
"optional": false,
"defaultValue": "na",
@@ -165,7 +166,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "return_order",
"type": "[Return](Return.mdx)",
"type": "[Return](entities.Return.mdx)",
"description": "The details of the return associated with the claim if the claim's type is `replace`.",
"optional": false,
"defaultValue": "",
@@ -174,7 +175,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "shipping_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the address that new items should be shipped to.",
"optional": false,
"defaultValue": "",
@@ -192,7 +193,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods that the claim order will be shipped with.",
"optional": false,
"defaultValue": "",
@@ -201,7 +202,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "type",
"type": "[ClaimType](../enums/ClaimType.mdx)",
"type": "[ClaimType](../enums/entities.ClaimType.mdx)",
"description": "The claim's type",
"optional": false,
"defaultValue": "",
@@ -266,7 +267,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "items",
"type": "[FulfillmentItem](FulfillmentItem.mdx)[]",
"type": "[FulfillmentItem](entities.FulfillmentItem.mdx)[]",
"description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.",
"optional": false,
"defaultValue": "",
@@ -274,7 +275,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
"children": [
{
"name": "fulfillment",
"type": "[Fulfillment](Fulfillment.mdx)",
"type": "[Fulfillment](entities.Fulfillment.mdx)",
"description": "The details of the fulfillment.",
"optional": false,
"defaultValue": "",
@@ -292,7 +293,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "item",
"type": "[LineItem](LineItem.mdx)",
"type": "[LineItem](entities.LineItem.mdx)",
"description": "The details of the line item.",
"optional": false,
"defaultValue": "",
@@ -348,7 +349,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -356,7 +357,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
"children": [
{
"name": "billing_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -383,7 +384,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -401,7 +402,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "claims",
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -419,7 +420,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -437,7 +438,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "customer",
"type": "[Customer](Customer.mdx)",
"type": "[Customer](entities.Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -464,7 +465,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "discounts",
"type": "[Discount](Discount.mdx)[]",
"type": "[Discount](entities.Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -482,7 +483,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "draft_order",
"type": "[DraftOrder](DraftOrder.mdx)",
"type": "[DraftOrder](entities.DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -500,7 +501,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "edits",
"type": "[OrderEdit](OrderEdit.mdx)[]",
"type": "[OrderEdit](entities.OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -527,7 +528,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "fulfillment_status",
"type": "[FulfillmentStatus](../enums/FulfillmentStatus.mdx)",
"type": "[FulfillmentStatus](../enums/entities.FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -536,7 +537,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "fulfillments",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"type": "[Fulfillment](entities.Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -563,7 +564,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "gift_card_transactions",
"type": "[GiftCardTransaction](GiftCardTransaction.mdx)[]",
"type": "[GiftCardTransaction](entities.GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -572,7 +573,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "gift_cards",
"type": "[GiftCard](GiftCard.mdx)[]",
"type": "[GiftCard](entities.GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -608,7 +609,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -653,7 +654,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "payment_status",
"type": "[PaymentStatus](../enums/PaymentStatus.mdx)",
"type": "[PaymentStatus](../enums/entities.PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -662,7 +663,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "payments",
"type": "[Payment](Payment.mdx)[]",
"type": "[Payment](entities.Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -698,7 +699,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "refunds",
"type": "[Refund](Refund.mdx)[]",
"type": "[Refund](entities.Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -707,7 +708,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -725,7 +726,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "returnable_items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the line items that are returnable as part of the order, swaps, or claims",
"optional": true,
"defaultValue": "",
@@ -734,7 +735,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "returns",
"type": "[Return](Return.mdx)[]",
"type": "[Return](entities.Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -743,7 +744,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "sales_channel",
"type": "[SalesChannel](SalesChannel.mdx)",
"type": "[SalesChannel](entities.SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -761,7 +762,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "shipping_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -779,7 +780,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -806,7 +807,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "status",
"type": "[OrderStatus](../enums/OrderStatus.mdx)",
"type": "[OrderStatus](../enums/entities.OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -824,7 +825,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "swaps",
"type": "[Swap](Swap.mdx)[]",
"type": "[Swap](entities.Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
@@ -880,7 +881,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "provider",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)",
"type": "[FulfillmentProvider](entities.FulfillmentProvider.mdx)",
"description": "The details of the fulfillment provider responsible for handling the fulfillment.",
"optional": false,
"defaultValue": "",
@@ -926,7 +927,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "swap",
"type": "[Swap](Swap.mdx)",
"type": "[Swap](entities.Swap.mdx)",
"description": "The details of the swap that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -934,7 +935,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
"children": [
{
"name": "additional_items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the new products to send to the customer, represented as line items.",
"optional": false,
"defaultValue": "",
@@ -961,7 +962,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart that the customer uses to complete the swap.",
"optional": false,
"defaultValue": "",
@@ -1015,7 +1016,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "fulfillment_status",
"type": "[SwapFulfillmentStatus](../enums/SwapFulfillmentStatus.mdx)",
"type": "[SwapFulfillmentStatus](../enums/entities.SwapFulfillmentStatus.mdx)",
"description": "The status of the Fulfillment of the Swap.",
"optional": false,
"defaultValue": "",
@@ -1024,7 +1025,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "fulfillments",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"type": "[Fulfillment](entities.Fulfillment.mdx)[]",
"description": "The details of the fulfillments that are used to send the new items to the customer.",
"optional": false,
"defaultValue": "",
@@ -1069,7 +1070,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the swap belongs to.",
"optional": false,
"defaultValue": "",
@@ -1087,7 +1088,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "payment",
"type": "[Payment](Payment.mdx)",
"type": "[Payment](entities.Payment.mdx)",
"description": "The details of the additional payment authorized by the customer when `difference\\_due` is positive.",
"optional": false,
"defaultValue": "",
@@ -1096,7 +1097,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "payment_status",
"type": "[SwapPaymentStatus](../enums/SwapPaymentStatus.mdx)",
"type": "[SwapPaymentStatus](../enums/entities.SwapPaymentStatus.mdx)",
"description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.",
"optional": false,
"defaultValue": "",
@@ -1105,7 +1106,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "return_order",
"type": "[Return](Return.mdx)",
"type": "[Return](entities.Return.mdx)",
"description": "The details of the return that belongs to the swap, which holds the details on the items being returned.",
"optional": false,
"defaultValue": "",
@@ -1114,7 +1115,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "shipping_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the shipping address that the new items should be sent to.",
"optional": false,
"defaultValue": "",
@@ -1132,7 +1133,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used to fulfill the additional items purchased.",
"optional": false,
"defaultValue": "",
@@ -1161,7 +1162,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "tracking_links",
"type": "[TrackingLink](TrackingLink.mdx)[]",
"type": "[TrackingLink](entities.TrackingLink.mdx)[]",
"description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.",
"optional": false,
"defaultValue": "",
@@ -1187,7 +1188,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "fulfillment",
"type": "[Fulfillment](Fulfillment.mdx)",
"type": "[Fulfillment](entities.Fulfillment.mdx)",
"description": "The details of the fulfillment that the tracking link belongs to.",
"optional": false,
"defaultValue": "",
@@ -1277,4 +1278,4 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/FulfillmentItem.mdx → www/apps/docs/content/references/entities/classes/entities.FulfillmentItem.mdx
+18 -17
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/FulfillmentItem
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -13,7 +14,7 @@ This represents the association between a Line Item and a Fulfillment.
<ParameterTypes parameters={[
{
"name": "fulfillment",
"type": "[Fulfillment](Fulfillment.mdx)",
"type": "[Fulfillment](entities.Fulfillment.mdx)",
"description": "The details of the fulfillment.",
"optional": false,
"defaultValue": "",
@@ -30,7 +31,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "claim_order",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)",
"description": "The details of the claim that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -84,7 +85,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "items",
"type": "[FulfillmentItem](FulfillmentItem.mdx)[]",
"type": "[FulfillmentItem](entities.FulfillmentItem.mdx)[]",
"description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.",
"optional": false,
"defaultValue": "",
@@ -120,7 +121,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -138,7 +139,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "provider",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)",
"type": "[FulfillmentProvider](entities.FulfillmentProvider.mdx)",
"description": "The details of the fulfillment provider responsible for handling the fulfillment.",
"optional": false,
"defaultValue": "",
@@ -165,7 +166,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "swap",
"type": "[Swap](Swap.mdx)",
"type": "[Swap](entities.Swap.mdx)",
"description": "The details of the swap that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -183,7 +184,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "tracking_links",
"type": "[TrackingLink](TrackingLink.mdx)[]",
"type": "[TrackingLink](entities.TrackingLink.mdx)[]",
"description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.",
"optional": false,
"defaultValue": "",
@@ -221,7 +222,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "item",
"type": "[LineItem](LineItem.mdx)",
"type": "[LineItem](entities.LineItem.mdx)",
"description": "The details of the line item.",
"optional": false,
"defaultValue": "",
@@ -229,7 +230,7 @@ This represents the association between a Line Item and a Fulfillment.
"children": [
{
"name": "adjustments",
"type": "[LineItemAdjustment](LineItemAdjustment.mdx)[]",
"type": "[LineItemAdjustment](entities.LineItemAdjustment.mdx)[]",
"description": "The details of the item's adjustments, which are available when a discount is applied on the item.",
"optional": false,
"defaultValue": "",
@@ -247,7 +248,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -265,7 +266,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "claim_order",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)",
"description": "The details of the claim that the line item may belong to.",
"optional": false,
"defaultValue": "",
@@ -383,7 +384,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -392,7 +393,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "order_edit",
"type": "`null` \\| [OrderEdit](OrderEdit.mdx)",
"type": "`null` \\| [OrderEdit](entities.OrderEdit.mdx)",
"description": "The details of the order edit.",
"optional": true,
"defaultValue": "",
@@ -518,7 +519,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "swap",
"type": "[Swap](Swap.mdx)",
"type": "[Swap](entities.Swap.mdx)",
"description": "The details of the swap that the line item may belong to.",
"optional": false,
"defaultValue": "",
@@ -536,7 +537,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "tax_lines",
"type": "[LineItemTaxLine](LineItemTaxLine.mdx)[]",
"type": "[LineItemTaxLine](entities.LineItemTaxLine.mdx)[]",
"description": "The details of the item's tax lines.",
"optional": false,
"defaultValue": "",
@@ -599,7 +600,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "variant",
"type": "[ProductVariant](ProductVariant.mdx)",
"type": "[ProductVariant](entities.ProductVariant.mdx)",
"description": "The details of the product variant that this item was created from.",
"optional": false,
"defaultValue": "",
@@ -635,4 +636,4 @@ This represents the association between a Line Item and a Fulfillment.
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/FulfillmentProvider.mdx → www/apps/docs/content/references/entities/classes/entities.FulfillmentProvider.mdx
+2 -1
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/FulfillmentProvider
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -29,4 +30,4 @@ A fulfillment provider represents a fulfillment service installed in the Medusa
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/GiftCard.mdx → www/apps/docs/content/references/entities/classes/entities.GiftCard.mdx
+34 -33
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/GiftCard
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -85,7 +86,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the gift card was purchased in.",
"optional": false,
"defaultValue": "",
@@ -93,7 +94,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
"children": [
{
"name": "billing_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -120,7 +121,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -138,7 +139,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "claims",
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -156,7 +157,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -174,7 +175,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "customer",
"type": "[Customer](Customer.mdx)",
"type": "[Customer](entities.Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -201,7 +202,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "discounts",
"type": "[Discount](Discount.mdx)[]",
"type": "[Discount](entities.Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -219,7 +220,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "draft_order",
"type": "[DraftOrder](DraftOrder.mdx)",
"type": "[DraftOrder](entities.DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -237,7 +238,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "edits",
"type": "[OrderEdit](OrderEdit.mdx)[]",
"type": "[OrderEdit](entities.OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -264,7 +265,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "fulfillment_status",
"type": "[FulfillmentStatus](../enums/FulfillmentStatus.mdx)",
"type": "[FulfillmentStatus](../enums/entities.FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -273,7 +274,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "fulfillments",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"type": "[Fulfillment](entities.Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -300,7 +301,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "gift_card_transactions",
"type": "[GiftCardTransaction](GiftCardTransaction.mdx)[]",
"type": "[GiftCardTransaction](entities.GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -309,7 +310,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "gift_cards",
"type": "[GiftCard](GiftCard.mdx)[]",
"type": "[GiftCard](entities.GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -345,7 +346,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -390,7 +391,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "payment_status",
"type": "[PaymentStatus](../enums/PaymentStatus.mdx)",
"type": "[PaymentStatus](../enums/entities.PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -399,7 +400,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "payments",
"type": "[Payment](Payment.mdx)[]",
"type": "[Payment](entities.Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -435,7 +436,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "refunds",
"type": "[Refund](Refund.mdx)[]",
"type": "[Refund](entities.Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -444,7 +445,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -462,7 +463,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "returnable_items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the line items that are returnable as part of the order, swaps, or claims",
"optional": true,
"defaultValue": "",
@@ -471,7 +472,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "returns",
"type": "[Return](Return.mdx)[]",
"type": "[Return](entities.Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -480,7 +481,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "sales_channel",
"type": "[SalesChannel](SalesChannel.mdx)",
"type": "[SalesChannel](entities.SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -498,7 +499,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "shipping_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -516,7 +517,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -543,7 +544,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "status",
"type": "[OrderStatus](../enums/OrderStatus.mdx)",
"type": "[OrderStatus](../enums/entities.OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -561,7 +562,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "swaps",
"type": "[Swap](Swap.mdx)[]",
"type": "[Swap](entities.Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
@@ -617,7 +618,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region this gift card is available in.",
"optional": false,
"defaultValue": "",
@@ -634,7 +635,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "countries",
"type": "[Country](Country.mdx)[]",
"type": "[Country](entities.Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -652,7 +653,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -679,7 +680,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "fulfillment_providers",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)[]",
"type": "[FulfillmentProvider](entities.FulfillmentProvider.mdx)[]",
"description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.",
"optional": false,
"defaultValue": "",
@@ -734,7 +735,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "payment_providers",
"type": "[PaymentProvider](PaymentProvider.mdx)[]",
"type": "[PaymentProvider](entities.PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -752,7 +753,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "tax_provider",
"type": "[TaxProvider](TaxProvider.mdx)",
"type": "[TaxProvider](entities.TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
@@ -779,7 +780,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "tax_rates",
"type": "`null` \\| [TaxRate](TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](entities.TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -833,4 +834,4 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/GiftCardTransaction.mdx → www/apps/docs/content/references/entities/classes/entities.GiftCardTransaction.mdx
+30 -29
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/GiftCardTransaction
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -31,7 +32,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "gift_card",
"type": "[GiftCard](GiftCard.mdx)",
"type": "[GiftCard](entities.GiftCard.mdx)",
"description": "The details of the gift card associated used in this transaction.",
"optional": false,
"defaultValue": "",
@@ -111,7 +112,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the gift card was purchased in.",
"optional": false,
"defaultValue": "",
@@ -129,7 +130,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region this gift card is available in.",
"optional": false,
"defaultValue": "",
@@ -203,7 +204,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the gift card was used for payment.",
"optional": false,
"defaultValue": "",
@@ -211,7 +212,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
"children": [
{
"name": "billing_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -238,7 +239,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -256,7 +257,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "claims",
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -274,7 +275,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -292,7 +293,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "customer",
"type": "[Customer](Customer.mdx)",
"type": "[Customer](entities.Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -319,7 +320,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "discounts",
"type": "[Discount](Discount.mdx)[]",
"type": "[Discount](entities.Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -337,7 +338,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "draft_order",
"type": "[DraftOrder](DraftOrder.mdx)",
"type": "[DraftOrder](entities.DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -355,7 +356,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "edits",
"type": "[OrderEdit](OrderEdit.mdx)[]",
"type": "[OrderEdit](entities.OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -382,7 +383,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "fulfillment_status",
"type": "[FulfillmentStatus](../enums/FulfillmentStatus.mdx)",
"type": "[FulfillmentStatus](../enums/entities.FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -391,7 +392,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "fulfillments",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"type": "[Fulfillment](entities.Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -418,7 +419,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "gift_card_transactions",
"type": "[GiftCardTransaction](GiftCardTransaction.mdx)[]",
"type": "[GiftCardTransaction](entities.GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -427,7 +428,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "gift_cards",
"type": "[GiftCard](GiftCard.mdx)[]",
"type": "[GiftCard](entities.GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -463,7 +464,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -508,7 +509,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "payment_status",
"type": "[PaymentStatus](../enums/PaymentStatus.mdx)",
"type": "[PaymentStatus](../enums/entities.PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -517,7 +518,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "payments",
"type": "[Payment](Payment.mdx)[]",
"type": "[Payment](entities.Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -553,7 +554,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "refunds",
"type": "[Refund](Refund.mdx)[]",
"type": "[Refund](entities.Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -562,7 +563,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -580,7 +581,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "returnable_items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the line items that are returnable as part of the order, swaps, or claims",
"optional": true,
"defaultValue": "",
@@ -589,7 +590,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "returns",
"type": "[Return](Return.mdx)[]",
"type": "[Return](entities.Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -598,7 +599,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "sales_channel",
"type": "[SalesChannel](SalesChannel.mdx)",
"type": "[SalesChannel](entities.SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -616,7 +617,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "shipping_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -634,7 +635,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -661,7 +662,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "status",
"type": "[OrderStatus](../enums/OrderStatus.mdx)",
"type": "[OrderStatus](../enums/entities.OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -679,7 +680,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "swaps",
"type": "[Swap](Swap.mdx)[]",
"type": "[Swap](entities.Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
@@ -742,4 +743,4 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/IdempotencyKey.mdx → www/apps/docs/content/references/entities/classes/entities.IdempotencyKey.mdx
+2 -1
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/IdempotencyKey
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -101,4 +102,4 @@ Idempotency Key is used to continue a process in case of any failure that might
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/Image.mdx → www/apps/docs/content/references/entities/classes/entities.Image.mdx
+2 -1
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/Image
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -65,4 +66,4 @@ An Image is used to store details about uploaded images. Images are uploaded by
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/Invite.mdx → www/apps/docs/content/references/entities/classes/entities.Invite.mdx
+3 -2
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/Invite
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -67,7 +68,7 @@ An invite is created when an admin user invites a new user to join the store's t
},
{
"name": "role",
"type": "[UserRoles](../enums/UserRoles.mdx)",
"type": "[UserRoles](../enums/entities.UserRoles.mdx)",
"description": "The user's role. These roles don't change the privileges of the user.",
"optional": false,
"defaultValue": "member",
@@ -129,4 +130,4 @@ An invite is created when an admin user invites a new user to join the store's t
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/LineItem.mdx → www/apps/docs/content/references/entities/classes/entities.LineItem.mdx
+10 -9
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/LineItem
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -13,7 +14,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
<ParameterTypes parameters={[
{
"name": "adjustments",
"type": "[LineItemAdjustment](LineItemAdjustment.mdx)[]",
"type": "[LineItemAdjustment](entities.LineItemAdjustment.mdx)[]",
"description": "The details of the item's adjustments, which are available when a discount is applied on the item.",
"optional": false,
"defaultValue": "",
@@ -31,7 +32,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -49,7 +50,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "claim_order",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)",
"description": "The details of the claim that the line item may belong to.",
"optional": false,
"defaultValue": "",
@@ -167,7 +168,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -176,7 +177,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "order_edit",
"type": "`null` \\| [OrderEdit](OrderEdit.mdx)",
"type": "`null` \\| [OrderEdit](entities.OrderEdit.mdx)",
"description": "The details of the order edit.",
"optional": true,
"defaultValue": "",
@@ -302,7 +303,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "swap",
"type": "[Swap](Swap.mdx)",
"type": "[Swap](entities.Swap.mdx)",
"description": "The details of the swap that the line item may belong to.",
"optional": false,
"defaultValue": "",
@@ -320,7 +321,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "tax_lines",
"type": "[LineItemTaxLine](LineItemTaxLine.mdx)[]",
"type": "[LineItemTaxLine](entities.LineItemTaxLine.mdx)[]",
"description": "The details of the item's tax lines.",
"optional": false,
"defaultValue": "",
@@ -383,7 +384,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "variant",
"type": "[ProductVariant](ProductVariant.mdx)",
"type": "[ProductVariant](entities.ProductVariant.mdx)",
"description": "The details of the product variant that this item was created from.",
"optional": false,
"defaultValue": "",
@@ -399,4 +400,4 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/LineItemAdjustment.mdx → www/apps/docs/content/references/entities/classes/entities.LineItemAdjustment.mdx
+4 -3
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/LineItemAdjustment
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -31,7 +32,7 @@ A Line Item Adjustment includes details on discounts applied on a line item.
},
{
"name": "discount",
"type": "[Discount](Discount.mdx)",
"type": "[Discount](entities.Discount.mdx)",
"description": "The details of the discount associated with the adjustment.",
"optional": false,
"defaultValue": "",
@@ -58,7 +59,7 @@ A Line Item Adjustment includes details on discounts applied on a line item.
},
{
"name": "item",
"type": "[LineItem](LineItem.mdx)",
"type": "[LineItem](entities.LineItem.mdx)",
"description": "The details of the line item.",
"optional": false,
"defaultValue": "",
@@ -83,4 +84,4 @@ A Line Item Adjustment includes details on discounts applied on a line item.
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/LineItemTaxLine.mdx → www/apps/docs/content/references/entities/classes/entities.LineItemTaxLine.mdx
+3 -2
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/LineItemTaxLine
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -40,7 +41,7 @@ A Line Item Tax Line represents the taxes applied on a line item.
},
{
"name": "item",
"type": "[LineItem](LineItem.mdx)",
"type": "[LineItem](entities.LineItem.mdx)",
"description": "The details of the line item.",
"optional": false,
"defaultValue": "",
@@ -92,4 +93,4 @@ A Line Item Tax Line represents the taxes applied on a line item.
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/MoneyAmount.mdx → www/apps/docs/content/references/entities/classes/entities.MoneyAmount.mdx
+23 -22
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/MoneyAmount
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -31,7 +32,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency that the money amount may belong to.",
"optional": true,
"defaultValue": "",
@@ -132,7 +133,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "price_list",
"type": "`null` \\| [PriceList](PriceList.mdx)",
"type": "`null` \\| [PriceList](entities.PriceList.mdx)",
"description": "The details of the price list that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -150,7 +151,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region that the money amount may belong to.",
"optional": true,
"defaultValue": "",
@@ -167,7 +168,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "countries",
"type": "[Country](Country.mdx)[]",
"type": "[Country](entities.Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -185,7 +186,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -212,7 +213,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "fulfillment_providers",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)[]",
"type": "[FulfillmentProvider](entities.FulfillmentProvider.mdx)[]",
"description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.",
"optional": false,
"defaultValue": "",
@@ -267,7 +268,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "payment_providers",
"type": "[PaymentProvider](PaymentProvider.mdx)[]",
"type": "[PaymentProvider](entities.PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -285,7 +286,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "tax_provider",
"type": "[TaxProvider](TaxProvider.mdx)",
"type": "[TaxProvider](entities.TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
@@ -312,7 +313,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "tax_rates",
"type": "`null` \\| [TaxRate](TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](entities.TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -350,7 +351,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "variant",
"type": "[ProductVariant](ProductVariant.mdx)",
"type": "[ProductVariant](entities.ProductVariant.mdx)",
"description": "The details of the product variant that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -430,7 +431,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "inventory_items",
"type": "[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]",
"type": "[ProductVariantInventoryItem](entities.ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -493,7 +494,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "options",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](entities.ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -511,7 +512,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "prices",
"type": "[MoneyAmount](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](entities.MoneyAmount.mdx)[]",
"description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.",
"optional": false,
"defaultValue": "",
@@ -520,7 +521,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "product",
"type": "[Product](Product.mdx)",
"type": "[Product](entities.Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
@@ -539,7 +540,7 @@ A Money Amount represent a price amount, for example, a product variant's price
{
"name": "purchasable",
"type": "`boolean`",
"description": "Only used with the inventory modules. A boolean value indicating whether the Product Variant is purchasable. A variant is purchasable if: - inventory is not managed - it has no inventory items - it is in stock - it is backorderable.",
"description": "Only used with the inventory modules.\nA boolean value indicating whether the Product Variant is purchasable.\nA variant is purchasable if:\n - inventory is not managed\n - it has no inventory items\n - it is in stock\n - it is backorderable.\n",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -621,7 +622,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "variants",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"type": "[ProductVariant](entities.ProductVariant.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -701,7 +702,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "inventory_items",
"type": "[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]",
"type": "[ProductVariantInventoryItem](entities.ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -764,7 +765,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "options",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](entities.ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -782,7 +783,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "prices",
"type": "[MoneyAmount](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](entities.MoneyAmount.mdx)[]",
"description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.",
"optional": false,
"defaultValue": "",
@@ -791,7 +792,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "product",
"type": "[Product](Product.mdx)",
"type": "[Product](entities.Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
@@ -810,7 +811,7 @@ A Money Amount represent a price amount, for example, a product variant's price
{
"name": "purchasable",
"type": "`boolean`",
"description": "Only used with the inventory modules. A boolean value indicating whether the Product Variant is purchasable. A variant is purchasable if: - inventory is not managed - it has no inventory items - it is in stock - it is backorderable.",
"description": "Only used with the inventory modules.\nA boolean value indicating whether the Product Variant is purchasable.\nA variant is purchasable if:\n - inventory is not managed\n - it has no inventory items\n - it is in stock\n - it is backorderable.\n",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -881,4 +882,4 @@ A Money Amount represent a price amount, for example, a product variant's price
}
]
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/Note.mdx → www/apps/docs/content/references/entities/classes/entities.Note.mdx
+4 -3
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/Note
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -13,7 +14,7 @@ A Note is an element that can be used in association with different resources to
<ParameterTypes parameters={[
{
"name": "author",
"type": "[User](User.mdx)",
"type": "[User](entities.User.mdx)",
"description": "The details of the user that created the note.",
"optional": false,
"defaultValue": "",
@@ -102,7 +103,7 @@ A Note is an element that can be used in association with different resources to
},
{
"name": "role",
"type": "[UserRoles](../enums/UserRoles.mdx)",
"type": "[UserRoles](../enums/entities.UserRoles.mdx)",
"description": "The user's role. These roles don't provide any different privileges.",
"optional": false,
"defaultValue": "member",
@@ -201,4 +202,4 @@ A Note is an element that can be used in association with different resources to
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/Notification.mdx → www/apps/docs/content/references/entities/classes/entities.Notification.mdx
+18 -17
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/Notification
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -22,7 +23,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "customer",
"type": "[Customer](Customer.mdx)",
"type": "[Customer](entities.Customer.mdx)",
"description": "The details of the customer that this notification was sent to.",
"optional": false,
"defaultValue": "",
@@ -30,7 +31,7 @@ A notification is an alert sent, typically to customers, using the installed Not
"children": [
{
"name": "billing_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the billing address associated with the customer.",
"optional": false,
"defaultValue": "",
@@ -84,7 +85,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "groups",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"type": "[CustomerGroup](entities.CustomerGroup.mdx)[]",
"description": "The customer groups the customer belongs to.",
"optional": false,
"defaultValue": "",
@@ -129,7 +130,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "orders",
"type": "[Order](Order.mdx)[]",
"type": "[Order](entities.Order.mdx)[]",
"description": "The details of the orders this customer placed.",
"optional": false,
"defaultValue": "",
@@ -156,7 +157,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "shipping_addresses",
"type": "[Address](Address.mdx)[]",
"type": "[Address](entities.Address.mdx)[]",
"description": "The details of the shipping addresses associated with the customer.",
"optional": false,
"defaultValue": "",
@@ -221,7 +222,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "parent_notification",
"type": "[Notification](Notification.mdx)",
"type": "[Notification](entities.Notification.mdx)",
"description": "The details of the parent notification.",
"optional": false,
"defaultValue": "",
@@ -238,7 +239,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "customer",
"type": "[Customer](Customer.mdx)",
"type": "[Customer](entities.Customer.mdx)",
"description": "The details of the customer that this notification was sent to.",
"optional": false,
"defaultValue": "",
@@ -292,7 +293,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "parent_notification",
"type": "[Notification](Notification.mdx)",
"type": "[Notification](entities.Notification.mdx)",
"description": "The details of the parent notification.",
"optional": false,
"defaultValue": "",
@@ -301,7 +302,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "provider",
"type": "[NotificationProvider](NotificationProvider.mdx)",
"type": "[NotificationProvider](entities.NotificationProvider.mdx)",
"description": "The notification provider used to send the notification.",
"optional": false,
"defaultValue": "",
@@ -319,7 +320,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "resends",
"type": "[Notification](Notification.mdx)[]",
"type": "[Notification](entities.Notification.mdx)[]",
"description": "The details of all resends of the notification.",
"optional": false,
"defaultValue": "",
@@ -366,7 +367,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "provider",
"type": "[NotificationProvider](NotificationProvider.mdx)",
"type": "[NotificationProvider](entities.NotificationProvider.mdx)",
"description": "The notification provider used to send the notification.",
"optional": false,
"defaultValue": "",
@@ -403,7 +404,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "resends",
"type": "[Notification](Notification.mdx)[]",
"type": "[Notification](entities.Notification.mdx)[]",
"description": "The details of all resends of the notification.",
"optional": false,
"defaultValue": "",
@@ -420,7 +421,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "customer",
"type": "[Customer](Customer.mdx)",
"type": "[Customer](entities.Customer.mdx)",
"description": "The details of the customer that this notification was sent to.",
"optional": false,
"defaultValue": "",
@@ -474,7 +475,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "parent_notification",
"type": "[Notification](Notification.mdx)",
"type": "[Notification](entities.Notification.mdx)",
"description": "The details of the parent notification.",
"optional": false,
"defaultValue": "",
@@ -483,7 +484,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "provider",
"type": "[NotificationProvider](NotificationProvider.mdx)",
"type": "[NotificationProvider](entities.NotificationProvider.mdx)",
"description": "The notification provider used to send the notification.",
"optional": false,
"defaultValue": "",
@@ -501,7 +502,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "resends",
"type": "[Notification](Notification.mdx)[]",
"type": "[Notification](entities.Notification.mdx)[]",
"description": "The details of all resends of the notification.",
"optional": false,
"defaultValue": "",
@@ -582,4 +583,4 @@ A notification is an alert sent, typically to customers, using the installed Not
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/NotificationProvider.mdx → www/apps/docs/content/references/entities/classes/entities.NotificationProvider.mdx
+2 -1
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/NotificationProvider
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -29,4 +30,4 @@ A notification provider represents a notification service installed in the Medus
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/Oauth.mdx → www/apps/docs/content/references/entities/classes/entities.Oauth.mdx
+2 -1
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/Oauth
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -63,4 +64,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/Order.mdx → www/apps/docs/content/references/entities/classes/entities.Order.mdx
+26 -25
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/Order
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -13,7 +14,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
<ParameterTypes parameters={[
{
"name": "billing_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -40,7 +41,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -58,7 +59,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "claims",
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -76,7 +77,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -94,7 +95,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "customer",
"type": "[Customer](Customer.mdx)",
"type": "[Customer](entities.Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -121,7 +122,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "discounts",
"type": "[Discount](Discount.mdx)[]",
"type": "[Discount](entities.Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -139,7 +140,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "draft_order",
"type": "[DraftOrder](DraftOrder.mdx)",
"type": "[DraftOrder](entities.DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -157,7 +158,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "edits",
"type": "[OrderEdit](OrderEdit.mdx)[]",
"type": "[OrderEdit](entities.OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -184,7 +185,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "fulfillment_status",
"type": "[FulfillmentStatus](../enums/FulfillmentStatus.mdx)",
"type": "[FulfillmentStatus](../enums/entities.FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -193,7 +194,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "fulfillments",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"type": "[Fulfillment](entities.Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -220,7 +221,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "gift_card_transactions",
"type": "[GiftCardTransaction](GiftCardTransaction.mdx)[]",
"type": "[GiftCardTransaction](entities.GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -229,7 +230,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "gift_cards",
"type": "[GiftCard](GiftCard.mdx)[]",
"type": "[GiftCard](entities.GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -265,7 +266,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -310,7 +311,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "payment_status",
"type": "[PaymentStatus](../enums/PaymentStatus.mdx)",
"type": "[PaymentStatus](../enums/entities.PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -319,7 +320,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "payments",
"type": "[Payment](Payment.mdx)[]",
"type": "[Payment](entities.Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -355,7 +356,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "refunds",
"type": "[Refund](Refund.mdx)[]",
"type": "[Refund](entities.Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -364,7 +365,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -382,7 +383,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "returnable_items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the line items that are returnable as part of the order, swaps, or claims",
"optional": true,
"defaultValue": "",
@@ -391,7 +392,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "returns",
"type": "[Return](Return.mdx)[]",
"type": "[Return](entities.Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -400,7 +401,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "sales_channel",
"type": "[SalesChannel](SalesChannel.mdx)",
"type": "[SalesChannel](entities.SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -418,7 +419,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "shipping_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -436,7 +437,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -463,7 +464,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "status",
"type": "[OrderStatus](../enums/OrderStatus.mdx)",
"type": "[OrderStatus](../enums/entities.OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -481,7 +482,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "swaps",
"type": "[Swap](Swap.mdx)[]",
"type": "[Swap](entities.Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
@@ -524,4 +525,4 @@ An order is a purchase made by a customer. It holds details about payment and fu
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/OrderEdit.mdx → www/apps/docs/content/references/entities/classes/entities.OrderEdit.mdx
+8 -7
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/OrderEdit
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -31,7 +32,7 @@ Order edit allows modifying items in an order, such as adding, updating, or dele
},
{
"name": "changes",
"type": "[OrderItemChange](OrderItemChange.mdx)[]",
"type": "[OrderItemChange](entities.OrderItemChange.mdx)[]",
"description": "The details of all the changes on the original order's line items.",
"optional": false,
"defaultValue": "",
@@ -95,7 +96,7 @@ Order edit allows modifying items in an order, such as adding, updating, or dele
{
"name": "declined_reason",
"type": "`string`",
"description": "An optional note why the order edit is declined.",
"description": "An optional note why the order edit is declined.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -157,7 +158,7 @@ Order edit allows modifying items in an order, such as adding, updating, or dele
},
{
"name": "items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.",
"optional": false,
"defaultValue": "",
@@ -166,7 +167,7 @@ Order edit allows modifying items in an order, such as adding, updating, or dele
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that this order edit was created for.",
"optional": false,
"defaultValue": "",
@@ -184,7 +185,7 @@ Order edit allows modifying items in an order, such as adding, updating, or dele
},
{
"name": "payment_collection",
"type": "[PaymentCollection](PaymentCollection.mdx)",
"type": "[PaymentCollection](entities.PaymentCollection.mdx)",
"description": "The details of the payment collection used to authorize additional payment if necessary.",
"optional": false,
"defaultValue": "",
@@ -229,7 +230,7 @@ Order edit allows modifying items in an order, such as adding, updating, or dele
},
{
"name": "status",
"type": "[OrderEditStatus](../enums/OrderEditStatus.mdx)",
"type": "[OrderEditStatus](../enums/entities.OrderEditStatus.mdx)",
"description": "The status of the order edit.",
"optional": false,
"defaultValue": "",
@@ -272,4 +273,4 @@ Order edit allows modifying items in an order, such as adding, updating, or dele
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/OrderItemChange.mdx → www/apps/docs/content/references/entities/classes/entities.OrderItemChange.mdx
+6 -5
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/OrderItemChange
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -40,7 +41,7 @@ An order item change is a change made within an order edit to an order's items.
},
{
"name": "line_item",
"type": "[LineItem](LineItem.mdx)",
"type": "[LineItem](entities.LineItem.mdx)",
"description": "The details of the resulting line item after the item change. This line item is then used in the original order once the order edit is confirmed.",
"optional": true,
"defaultValue": "",
@@ -58,7 +59,7 @@ An order item change is a change made within an order edit to an order's items.
},
{
"name": "order_edit",
"type": "[OrderEdit](OrderEdit.mdx)",
"type": "[OrderEdit](entities.OrderEdit.mdx)",
"description": "The details of the order edit the item change is associated with.",
"optional": false,
"defaultValue": "",
@@ -76,7 +77,7 @@ An order item change is a change made within an order edit to an order's items.
},
{
"name": "original_line_item",
"type": "[LineItem](LineItem.mdx)",
"type": "[LineItem](entities.LineItem.mdx)",
"description": "The details of the original line item this item change references. This is used if the item change updates or deletes the original item.",
"optional": true,
"defaultValue": "",
@@ -94,7 +95,7 @@ An order item change is a change made within an order edit to an order's items.
},
{
"name": "type",
"type": "[OrderEditItemChangeType](../enums/OrderEditItemChangeType.mdx)",
"type": "[OrderEditItemChangeType](../enums/entities.OrderEditItemChangeType.mdx)",
"description": "The order item change's status",
"optional": false,
"defaultValue": "",
@@ -110,4 +111,4 @@ An order item change is a change made within an order edit to an order's items.
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/Payment.mdx → www/apps/docs/content/references/entities/classes/entities.Payment.mdx
+53 -52
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/Payment
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -49,7 +50,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -57,7 +58,7 @@ A payment is originally created from a payment session. Once a payment session i
"children": [
{
"name": "billing_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the billing address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -102,7 +103,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "customer",
"type": "[Customer](Customer.mdx)",
"type": "[Customer](entities.Customer.mdx)",
"description": "The details of the customer the cart belongs to.",
"optional": false,
"defaultValue": "",
@@ -138,7 +139,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "discounts",
"type": "[Discount](Discount.mdx)[]",
"type": "[Discount](entities.Discount.mdx)[]",
"description": "An array of details of all discounts applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -174,7 +175,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "gift_cards",
"type": "[GiftCard](GiftCard.mdx)[]",
"type": "[GiftCard](entities.GiftCard.mdx)[]",
"description": "An array of details of all gift cards applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -210,7 +211,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The line items added to the cart.",
"optional": false,
"defaultValue": "",
@@ -237,7 +238,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "payment",
"type": "[Payment](Payment.mdx)",
"type": "[Payment](entities.Payment.mdx)",
"description": "The details of the payment associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -264,7 +265,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "payment_session",
"type": "`null` \\| [PaymentSession](PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](entities.PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -273,7 +274,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "payment_sessions",
"type": "[PaymentSession](PaymentSession.mdx)[]",
"type": "[PaymentSession](entities.PaymentSession.mdx)[]",
"description": "The details of all payment sessions created on the cart.",
"optional": false,
"defaultValue": "",
@@ -309,7 +310,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -327,7 +328,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "sales_channel",
"type": "[SalesChannel](SalesChannel.mdx)",
"type": "[SalesChannel](entities.SalesChannel.mdx)",
"description": "The details of the sales channel associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -345,7 +346,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "shipping_address",
"type": "`null` \\| [Address](Address.mdx)",
"type": "`null` \\| [Address](entities.Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -363,7 +364,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods added to the cart.",
"optional": false,
"defaultValue": "",
@@ -417,7 +418,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "type",
"type": "[CartType](../enums/CartType.mdx)",
"type": "[CartType](../enums/entities.CartType.mdx)",
"description": "The cart's type.",
"optional": false,
"defaultValue": "default",
@@ -455,7 +456,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency of the payment.",
"optional": false,
"defaultValue": "",
@@ -556,7 +557,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -564,7 +565,7 @@ A payment is originally created from a payment session. Once a payment session i
"children": [
{
"name": "billing_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -591,7 +592,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -609,7 +610,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "claims",
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -627,7 +628,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -645,7 +646,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "customer",
"type": "[Customer](Customer.mdx)",
"type": "[Customer](entities.Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -672,7 +673,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "discounts",
"type": "[Discount](Discount.mdx)[]",
"type": "[Discount](entities.Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -690,7 +691,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "draft_order",
"type": "[DraftOrder](DraftOrder.mdx)",
"type": "[DraftOrder](entities.DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -708,7 +709,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "edits",
"type": "[OrderEdit](OrderEdit.mdx)[]",
"type": "[OrderEdit](entities.OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -735,7 +736,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "fulfillment_status",
"type": "[FulfillmentStatus](../enums/FulfillmentStatus.mdx)",
"type": "[FulfillmentStatus](../enums/entities.FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -744,7 +745,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "fulfillments",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"type": "[Fulfillment](entities.Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -771,7 +772,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "gift_card_transactions",
"type": "[GiftCardTransaction](GiftCardTransaction.mdx)[]",
"type": "[GiftCardTransaction](entities.GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -780,7 +781,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "gift_cards",
"type": "[GiftCard](GiftCard.mdx)[]",
"type": "[GiftCard](entities.GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -816,7 +817,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -861,7 +862,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "payment_status",
"type": "[PaymentStatus](../enums/PaymentStatus.mdx)",
"type": "[PaymentStatus](../enums/entities.PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -870,7 +871,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "payments",
"type": "[Payment](Payment.mdx)[]",
"type": "[Payment](entities.Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -906,7 +907,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "refunds",
"type": "[Refund](Refund.mdx)[]",
"type": "[Refund](entities.Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -915,7 +916,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -933,7 +934,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "returnable_items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the line items that are returnable as part of the order, swaps, or claims",
"optional": true,
"defaultValue": "",
@@ -942,7 +943,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "returns",
"type": "[Return](Return.mdx)[]",
"type": "[Return](entities.Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -951,7 +952,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "sales_channel",
"type": "[SalesChannel](SalesChannel.mdx)",
"type": "[SalesChannel](entities.SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -969,7 +970,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "shipping_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -987,7 +988,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -1014,7 +1015,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "status",
"type": "[OrderStatus](../enums/OrderStatus.mdx)",
"type": "[OrderStatus](../enums/entities.OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -1032,7 +1033,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "swaps",
"type": "[Swap](Swap.mdx)[]",
"type": "[Swap](entities.Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
@@ -1097,7 +1098,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "swap",
"type": "[Swap](Swap.mdx)",
"type": "[Swap](entities.Swap.mdx)",
"description": "The details of the swap that this payment was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -1105,7 +1106,7 @@ A payment is originally created from a payment session. Once a payment session i
"children": [
{
"name": "additional_items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the new products to send to the customer, represented as line items.",
"optional": false,
"defaultValue": "",
@@ -1132,7 +1133,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart that the customer uses to complete the swap.",
"optional": false,
"defaultValue": "",
@@ -1186,7 +1187,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "fulfillment_status",
"type": "[SwapFulfillmentStatus](../enums/SwapFulfillmentStatus.mdx)",
"type": "[SwapFulfillmentStatus](../enums/entities.SwapFulfillmentStatus.mdx)",
"description": "The status of the Fulfillment of the Swap.",
"optional": false,
"defaultValue": "",
@@ -1195,7 +1196,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "fulfillments",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"type": "[Fulfillment](entities.Fulfillment.mdx)[]",
"description": "The details of the fulfillments that are used to send the new items to the customer.",
"optional": false,
"defaultValue": "",
@@ -1240,7 +1241,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the swap belongs to.",
"optional": false,
"defaultValue": "",
@@ -1258,7 +1259,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "payment",
"type": "[Payment](Payment.mdx)",
"type": "[Payment](entities.Payment.mdx)",
"description": "The details of the additional payment authorized by the customer when `difference\\_due` is positive.",
"optional": false,
"defaultValue": "",
@@ -1267,7 +1268,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "payment_status",
"type": "[SwapPaymentStatus](../enums/SwapPaymentStatus.mdx)",
"type": "[SwapPaymentStatus](../enums/entities.SwapPaymentStatus.mdx)",
"description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.",
"optional": false,
"defaultValue": "",
@@ -1276,7 +1277,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "return_order",
"type": "[Return](Return.mdx)",
"type": "[Return](entities.Return.mdx)",
"description": "The details of the return that belongs to the swap, which holds the details on the items being returned.",
"optional": false,
"defaultValue": "",
@@ -1285,7 +1286,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "shipping_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the shipping address that the new items should be sent to.",
"optional": false,
"defaultValue": "",
@@ -1303,7 +1304,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used to fulfill the additional items purchased.",
"optional": false,
"defaultValue": "",
@@ -1339,4 +1340,4 @@ A payment is originally created from a payment session. Once a payment session i
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/PaymentCollection.mdx → www/apps/docs/content/references/entities/classes/entities.PaymentCollection.mdx
+19 -18
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/PaymentCollection
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -49,7 +50,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency this payment collection is associated with.",
"optional": false,
"defaultValue": "",
@@ -150,7 +151,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "payment_sessions",
"type": "[PaymentSession](PaymentSession.mdx)[]",
"type": "[PaymentSession](entities.PaymentSession.mdx)[]",
"description": "The details of the payment sessions created as part of the payment collection.",
"optional": false,
"defaultValue": "",
@@ -167,7 +168,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart that the payment session was created for.",
"optional": false,
"defaultValue": "",
@@ -277,7 +278,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "payments",
"type": "[Payment](Payment.mdx)[]",
"type": "[Payment](entities.Payment.mdx)[]",
"description": "The details of the payments created as part of the payment collection.",
"optional": false,
"defaultValue": "",
@@ -321,7 +322,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -348,7 +349,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency of the payment.",
"optional": false,
"defaultValue": "",
@@ -402,7 +403,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -429,7 +430,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "swap",
"type": "[Swap](Swap.mdx)",
"type": "[Swap](entities.Swap.mdx)",
"description": "The details of the swap that this payment was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -458,7 +459,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region this payment collection is associated with.",
"optional": false,
"defaultValue": "",
@@ -475,7 +476,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "countries",
"type": "[Country](Country.mdx)[]",
"type": "[Country](entities.Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -493,7 +494,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -520,7 +521,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "fulfillment_providers",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)[]",
"type": "[FulfillmentProvider](entities.FulfillmentProvider.mdx)[]",
"description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.",
"optional": false,
"defaultValue": "",
@@ -575,7 +576,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "payment_providers",
"type": "[PaymentProvider](PaymentProvider.mdx)[]",
"type": "[PaymentProvider](entities.PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -593,7 +594,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "tax_provider",
"type": "[TaxProvider](TaxProvider.mdx)",
"type": "[TaxProvider](entities.TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
@@ -620,7 +621,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "tax_rates",
"type": "`null` \\| [TaxRate](TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](entities.TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -649,7 +650,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "status",
"type": "[PaymentCollectionStatus](../enums/PaymentCollectionStatus.mdx)",
"type": "[PaymentCollectionStatus](../enums/entities.PaymentCollectionStatus.mdx)",
"description": "The type of the payment collection",
"optional": false,
"defaultValue": "",
@@ -704,7 +705,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "type",
"type": "[ORDER_EDIT](../enums/PaymentCollectionType.mdx#order_edit)",
"type": "[ORDER_EDIT](../enums/entities.PaymentCollectionType.mdx#order_edit)",
"description": "The type of the payment collection",
"optional": false,
"defaultValue": "",
@@ -720,4 +721,4 @@ A payment collection allows grouping and managing a list of payments at one. Thi
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/PaymentProvider.mdx → www/apps/docs/content/references/entities/classes/entities.PaymentProvider.mdx
+2 -1
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/PaymentProvider
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -29,4 +30,4 @@ A payment provider represents a payment service installed in the Medusa backend,
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/PaymentSession.mdx → www/apps/docs/content/references/entities/classes/entities.PaymentSession.mdx
+16 -15
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/PaymentSession
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -22,7 +23,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart that the payment session was created for.",
"optional": false,
"defaultValue": "",
@@ -30,7 +31,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
"children": [
{
"name": "billing_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the billing address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -75,7 +76,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "customer",
"type": "[Customer](Customer.mdx)",
"type": "[Customer](entities.Customer.mdx)",
"description": "The details of the customer the cart belongs to.",
"optional": false,
"defaultValue": "",
@@ -111,7 +112,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "discounts",
"type": "[Discount](Discount.mdx)[]",
"type": "[Discount](entities.Discount.mdx)[]",
"description": "An array of details of all discounts applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -147,7 +148,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "gift_cards",
"type": "[GiftCard](GiftCard.mdx)[]",
"type": "[GiftCard](entities.GiftCard.mdx)[]",
"description": "An array of details of all gift cards applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -183,7 +184,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The line items added to the cart.",
"optional": false,
"defaultValue": "",
@@ -210,7 +211,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "payment",
"type": "[Payment](Payment.mdx)",
"type": "[Payment](entities.Payment.mdx)",
"description": "The details of the payment associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -237,7 +238,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "payment_session",
"type": "`null` \\| [PaymentSession](PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](entities.PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -246,7 +247,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "payment_sessions",
"type": "[PaymentSession](PaymentSession.mdx)[]",
"type": "[PaymentSession](entities.PaymentSession.mdx)[]",
"description": "The details of all payment sessions created on the cart.",
"optional": false,
"defaultValue": "",
@@ -282,7 +283,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -300,7 +301,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "sales_channel",
"type": "[SalesChannel](SalesChannel.mdx)",
"type": "[SalesChannel](entities.SalesChannel.mdx)",
"description": "The details of the sales channel associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -318,7 +319,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "shipping_address",
"type": "`null` \\| [Address](Address.mdx)",
"type": "`null` \\| [Address](entities.Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -336,7 +337,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods added to the cart.",
"optional": false,
"defaultValue": "",
@@ -390,7 +391,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "type",
"type": "[CartType](../enums/CartType.mdx)",
"type": "[CartType](../enums/entities.CartType.mdx)",
"description": "The cart's type.",
"optional": false,
"defaultValue": "default",
@@ -507,4 +508,4 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/PriceList.mdx → www/apps/docs/content/references/entities/classes/entities.PriceList.mdx
+13 -12
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/PriceList
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -22,7 +23,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "customer_groups",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"type": "[CustomerGroup](entities.CustomerGroup.mdx)[]",
"description": "The details of the customer groups that the Price List can apply to.",
"optional": false,
"defaultValue": "",
@@ -39,7 +40,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "customers",
"type": "[Customer](Customer.mdx)[]",
"type": "[Customer](entities.Customer.mdx)[]",
"description": "The details of the customers that belong to the customer group.",
"optional": false,
"defaultValue": "",
@@ -84,7 +85,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "price_lists",
"type": "[PriceList](PriceList.mdx)[]",
"type": "[PriceList](entities.PriceList.mdx)[]",
"description": "The price lists that are associated with the customer group.",
"optional": false,
"defaultValue": "",
@@ -159,7 +160,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "prices",
"type": "[MoneyAmount](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](entities.MoneyAmount.mdx)[]",
"description": "The prices that belong to the price list, represented as a Money Amount.",
"optional": false,
"defaultValue": "",
@@ -185,7 +186,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency that the money amount may belong to.",
"optional": true,
"defaultValue": "",
@@ -239,7 +240,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "price_list",
"type": "`null` \\| [PriceList](PriceList.mdx)",
"type": "`null` \\| [PriceList](entities.PriceList.mdx)",
"description": "The details of the price list that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -257,7 +258,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region that the money amount may belong to.",
"optional": true,
"defaultValue": "",
@@ -284,7 +285,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "variant",
"type": "[ProductVariant](ProductVariant.mdx)",
"type": "[ProductVariant](entities.ProductVariant.mdx)",
"description": "The details of the product variant that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -302,7 +303,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "variants",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"type": "[ProductVariant](entities.ProductVariant.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -322,7 +323,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "status",
"type": "[PriceListStatus](../enums/PriceListStatus.mdx)",
"type": "[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)",
"description": "The status of the Price List",
"optional": false,
"defaultValue": "draft",
@@ -350,7 +351,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "type",
"type": "[PriceListType](../enums/PriceListType.mdx)",
"type": "[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)",
"description": "The type of Price List. This can be one of either `sale` or `override`.",
"optional": false,
"defaultValue": "sale",
@@ -385,4 +386,4 @@ A Price List represents a set of prices that override the default price for one
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/Product.mdx → www/apps/docs/content/references/entities/classes/entities.Product.mdx
+33 -32
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/Product
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -13,7 +14,7 @@ A product is a saleable item that holds general information such as name or desc
<ParameterTypes parameters={[
{
"name": "categories",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"type": "[ProductCategory](entities.ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -22,7 +23,7 @@ A product is a saleable item that holds general information such as name or desc
"children": [
{
"name": "category_children",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"type": "[ProductCategory](entities.ProductCategory.mdx)[]",
"description": "The details of the category's children.",
"optional": false,
"defaultValue": "",
@@ -67,7 +68,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "is_active",
"type": "[Boolean](../index.mdx#boolean)",
"type": "`Boolean`",
"description": "A flag to make product category visible/hidden in the store front",
"optional": false,
"defaultValue": "false",
@@ -76,7 +77,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "is_internal",
"type": "[Boolean](../index.mdx#boolean)",
"type": "`Boolean`",
"description": "A flag to make product category an internal category for admins",
"optional": false,
"defaultValue": "false",
@@ -103,7 +104,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "parent_category",
"type": "`null` \\| [ProductCategory](ProductCategory.mdx)",
"type": "`null` \\| [ProductCategory](entities.ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
@@ -121,7 +122,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "products",
"type": "[Product](Product.mdx)[]",
"type": "[Product](entities.Product.mdx)[]",
"description": "The details of the products that belong to this category.",
"optional": false,
"defaultValue": "",
@@ -168,7 +169,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "collection",
"type": "[ProductCollection](ProductCollection.mdx)",
"type": "[ProductCollection](entities.ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -221,7 +222,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "products",
"type": "[Product](Product.mdx)[]",
"type": "[Product](entities.Product.mdx)[]",
"description": "The details of the products that belong to this product collection.",
"optional": false,
"defaultValue": "",
@@ -340,7 +341,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "images",
"type": "[Image](Image.mdx)[]",
"type": "[Image](entities.Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -449,7 +450,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "options",
"type": "[ProductOption](ProductOption.mdx)[]",
"type": "[ProductOption](entities.ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -493,7 +494,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "product",
"type": "[Product](Product.mdx)",
"type": "[Product](entities.Product.mdx)",
"description": "The details of the product that this product option belongs to.",
"optional": false,
"defaultValue": "",
@@ -529,7 +530,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "values",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](entities.ProductOptionValue.mdx)[]",
"description": "The details of the values of the product option.",
"optional": false,
"defaultValue": "",
@@ -549,7 +550,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "profile",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
@@ -602,7 +603,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "products",
"type": "[Product](Product.mdx)[]",
"type": "[Product](entities.Product.mdx)[]",
"description": "The details of the products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.",
"optional": false,
"defaultValue": "",
@@ -611,7 +612,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "shipping_options",
"type": "[ShippingOption](ShippingOption.mdx)[]",
"type": "[ShippingOption](entities.ShippingOption.mdx)[]",
"description": "The details of the shipping options that can be used to create shipping methods for the Products in the Shipping Profile.",
"optional": false,
"defaultValue": "",
@@ -620,7 +621,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "type",
"type": "[ShippingProfileType](../enums/ShippingProfileType.mdx)",
"type": "[ShippingProfileType](../enums/entities.ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift\\_card` or `custom`.",
"optional": false,
"defaultValue": "",
@@ -649,7 +650,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "profiles",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -702,7 +703,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "products",
"type": "[Product](Product.mdx)[]",
"type": "[Product](entities.Product.mdx)[]",
"description": "The details of the products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.",
"optional": false,
"defaultValue": "",
@@ -711,7 +712,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "shipping_options",
"type": "[ShippingOption](ShippingOption.mdx)[]",
"type": "[ShippingOption](entities.ShippingOption.mdx)[]",
"description": "The details of the shipping options that can be used to create shipping methods for the Products in the Shipping Profile.",
"optional": false,
"defaultValue": "",
@@ -720,7 +721,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "type",
"type": "[ShippingProfileType](../enums/ShippingProfileType.mdx)",
"type": "[ShippingProfileType](../enums/entities.ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift\\_card` or `custom`.",
"optional": false,
"defaultValue": "",
@@ -740,7 +741,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "sales_channels",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"type": "[SalesChannel](entities.SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -793,7 +794,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "locations",
"type": "[SalesChannelLocation](SalesChannelLocation.mdx)[]",
"type": "[SalesChannelLocation](entities.SalesChannelLocation.mdx)[]",
"description": "The details of the stock locations related to the sales channel.",
"optional": false,
"defaultValue": "",
@@ -831,7 +832,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "status",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/entities.ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -886,7 +887,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "tags",
"type": "[ProductTag](ProductTag.mdx)[]",
"type": "[ProductTag](entities.ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -968,7 +969,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "type",
"type": "[ProductType](ProductType.mdx)",
"type": "[ProductType](entities.ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -1050,7 +1051,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "variants",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"type": "[ProductVariant](entities.ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -1130,7 +1131,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "inventory_items",
"type": "[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]",
"type": "[ProductVariantInventoryItem](entities.ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -1193,7 +1194,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "options",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](entities.ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -1211,7 +1212,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "prices",
"type": "[MoneyAmount](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](entities.MoneyAmount.mdx)[]",
"description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.",
"optional": false,
"defaultValue": "",
@@ -1220,7 +1221,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "product",
"type": "[Product](Product.mdx)",
"type": "[Product](entities.Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
@@ -1239,7 +1240,7 @@ A product is a saleable item that holds general information such as name or desc
{
"name": "purchasable",
"type": "`boolean`",
"description": "Only used with the inventory modules. A boolean value indicating whether the Product Variant is purchasable. A variant is purchasable if: - inventory is not managed - it has no inventory items - it is in stock - it is backorderable.",
"description": "Only used with the inventory modules.\nA boolean value indicating whether the Product Variant is purchasable.\nA variant is purchasable if:\n - inventory is not managed\n - it has no inventory items\n - it is in stock\n - it is backorderable.\n",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -1328,4 +1329,4 @@ A product is a saleable item that holds general information such as name or desc
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ProductCategory.mdx → www/apps/docs/content/references/entities/classes/entities.ProductCategory.mdx
+23 -22
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ProductCategory
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -13,7 +14,7 @@ A product category can be used to categorize products into a hierarchy of catego
<ParameterTypes parameters={[
{
"name": "category_children",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"type": "[ProductCategory](entities.ProductCategory.mdx)[]",
"description": "The details of the category's children.",
"optional": false,
"defaultValue": "",
@@ -21,7 +22,7 @@ A product category can be used to categorize products into a hierarchy of catego
"children": [
{
"name": "category_children",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"type": "[ProductCategory](entities.ProductCategory.mdx)[]",
"description": "The details of the category's children.",
"optional": false,
"defaultValue": "",
@@ -66,7 +67,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "is_active",
"type": "[Boolean](../index.mdx#boolean)",
"type": "`Boolean`",
"description": "A flag to make product category visible/hidden in the store front",
"optional": false,
"defaultValue": "false",
@@ -75,7 +76,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "is_internal",
"type": "[Boolean](../index.mdx#boolean)",
"type": "`Boolean`",
"description": "A flag to make product category an internal category for admins",
"optional": false,
"defaultValue": "false",
@@ -102,7 +103,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "parent_category",
"type": "`null` \\| [ProductCategory](ProductCategory.mdx)",
"type": "`null` \\| [ProductCategory](entities.ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
@@ -120,7 +121,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "products",
"type": "[Product](Product.mdx)[]",
"type": "[Product](entities.Product.mdx)[]",
"description": "The details of the products that belong to this category.",
"optional": false,
"defaultValue": "",
@@ -203,7 +204,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "is_active",
"type": "[Boolean](../index.mdx#boolean)",
"type": "`Boolean`",
"description": "A flag to make product category visible/hidden in the store front",
"optional": false,
"defaultValue": "false",
@@ -212,7 +213,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "is_internal",
"type": "[Boolean](../index.mdx#boolean)",
"type": "`Boolean`",
"description": "A flag to make product category an internal category for admins",
"optional": false,
"defaultValue": "false",
@@ -239,7 +240,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "parent_category",
"type": "`null` \\| [ProductCategory](ProductCategory.mdx)",
"type": "`null` \\| [ProductCategory](entities.ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
@@ -257,7 +258,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "products",
"type": "[Product](Product.mdx)[]",
"type": "[Product](entities.Product.mdx)[]",
"description": "The details of the products that belong to this category.",
"optional": false,
"defaultValue": "",
@@ -265,7 +266,7 @@ A product category can be used to categorize products into a hierarchy of catego
"children": [
{
"name": "categories",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"type": "[ProductCategory](entities.ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -275,7 +276,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "collection",
"type": "[ProductCollection](ProductCollection.mdx)",
"type": "[ProductCollection](entities.ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -374,7 +375,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "images",
"type": "[Image](Image.mdx)[]",
"type": "[Image](entities.Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -428,7 +429,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "options",
"type": "[ProductOption](ProductOption.mdx)[]",
"type": "[ProductOption](entities.ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -446,7 +447,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "profile",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
@@ -464,7 +465,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "profiles",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -473,7 +474,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "sales_channels",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"type": "[SalesChannel](entities.SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -482,7 +483,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "status",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/entities.ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -500,7 +501,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "tags",
"type": "[ProductTag](ProductTag.mdx)[]",
"type": "[ProductTag](entities.ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -527,7 +528,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "type",
"type": "[ProductType](ProductType.mdx)",
"type": "[ProductType](entities.ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -554,7 +555,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "variants",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"type": "[ProductVariant](entities.ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -617,4 +618,4 @@ A product category can be used to categorize products into a hierarchy of catego
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ProductCollection.mdx → www/apps/docs/content/references/entities/classes/entities.ProductCollection.mdx
+14 -13
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ProductCollection
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -58,7 +59,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "products",
"type": "[Product](Product.mdx)[]",
"type": "[Product](entities.Product.mdx)[]",
"description": "The details of the products that belong to this product collection.",
"optional": false,
"defaultValue": "",
@@ -66,7 +67,7 @@ A Product Collection allows grouping together products for promotional purposes.
"children": [
{
"name": "categories",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"type": "[ProductCategory](entities.ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -76,7 +77,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "collection",
"type": "[ProductCollection](ProductCollection.mdx)",
"type": "[ProductCollection](entities.ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -175,7 +176,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "images",
"type": "[Image](Image.mdx)[]",
"type": "[Image](entities.Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -229,7 +230,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "options",
"type": "[ProductOption](ProductOption.mdx)[]",
"type": "[ProductOption](entities.ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -247,7 +248,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "profile",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
@@ -265,7 +266,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "profiles",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -274,7 +275,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "sales_channels",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"type": "[SalesChannel](entities.SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -283,7 +284,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "status",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/entities.ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -301,7 +302,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "tags",
"type": "[ProductTag](ProductTag.mdx)[]",
"type": "[ProductTag](entities.ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -328,7 +329,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "type",
"type": "[ProductType](ProductType.mdx)",
"type": "[ProductType](entities.ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -355,7 +356,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "variants",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"type": "[ProductVariant](entities.ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -400,4 +401,4 @@ A Product Collection allows grouping together products for promotional purposes.
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ProductOption.mdx → www/apps/docs/content/references/entities/classes/entities.ProductOption.mdx
+17 -16
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ProductOption
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -49,7 +50,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "product",
"type": "[Product](Product.mdx)",
"type": "[Product](entities.Product.mdx)",
"description": "The details of the product that this product option belongs to.",
"optional": false,
"defaultValue": "",
@@ -57,7 +58,7 @@ A Product Option defines properties that may vary between different variants of
"children": [
{
"name": "categories",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"type": "[ProductCategory](entities.ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -67,7 +68,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "collection",
"type": "[ProductCollection](ProductCollection.mdx)",
"type": "[ProductCollection](entities.ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -166,7 +167,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "images",
"type": "[Image](Image.mdx)[]",
"type": "[Image](entities.Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -220,7 +221,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "options",
"type": "[ProductOption](ProductOption.mdx)[]",
"type": "[ProductOption](entities.ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -238,7 +239,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "profile",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
@@ -256,7 +257,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "profiles",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -265,7 +266,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "sales_channels",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"type": "[SalesChannel](entities.SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -274,7 +275,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "status",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/entities.ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -292,7 +293,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "tags",
"type": "[ProductTag](ProductTag.mdx)[]",
"type": "[ProductTag](entities.ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -319,7 +320,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "type",
"type": "[ProductType](ProductType.mdx)",
"type": "[ProductType](entities.ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -346,7 +347,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "variants",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"type": "[ProductVariant](entities.ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -402,7 +403,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "values",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](entities.ProductOptionValue.mdx)[]",
"description": "The details of the values of the product option.",
"optional": false,
"defaultValue": "",
@@ -446,7 +447,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "option",
"type": "[ProductOption](ProductOption.mdx)",
"type": "[ProductOption](entities.ProductOption.mdx)",
"description": "The details of the product option that the Product Option Value belongs to.",
"optional": false,
"defaultValue": "",
@@ -482,7 +483,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "variant",
"type": "[ProductVariant](ProductVariant.mdx)",
"type": "[ProductVariant](entities.ProductVariant.mdx)",
"description": "The details of the product variant that uses this product option value.",
"optional": false,
"defaultValue": "",
@@ -500,4 +501,4 @@ A Product Option defines properties that may vary between different variants of
}
]
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ProductOptionValue.mdx → www/apps/docs/content/references/entities/classes/entities.ProductOptionValue.mdx
+11 -10
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ProductOptionValue
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -49,7 +50,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "option",
"type": "[ProductOption](ProductOption.mdx)",
"type": "[ProductOption](entities.ProductOption.mdx)",
"description": "The details of the product option that the Product Option Value belongs to.",
"optional": false,
"defaultValue": "",
@@ -93,7 +94,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "product",
"type": "[Product](Product.mdx)",
"type": "[Product](entities.Product.mdx)",
"description": "The details of the product that this product option belongs to.",
"optional": false,
"defaultValue": "",
@@ -129,7 +130,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "values",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](entities.ProductOptionValue.mdx)[]",
"description": "The details of the values of the product option.",
"optional": false,
"defaultValue": "",
@@ -167,7 +168,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "variant",
"type": "[ProductVariant](ProductVariant.mdx)",
"type": "[ProductVariant](entities.ProductVariant.mdx)",
"description": "The details of the product variant that uses this product option value.",
"optional": false,
"defaultValue": "",
@@ -247,7 +248,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "inventory_items",
"type": "[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]",
"type": "[ProductVariantInventoryItem](entities.ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -310,7 +311,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "options",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](entities.ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -328,7 +329,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "prices",
"type": "[MoneyAmount](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](entities.MoneyAmount.mdx)[]",
"description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.",
"optional": false,
"defaultValue": "",
@@ -337,7 +338,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "product",
"type": "[Product](Product.mdx)",
"type": "[Product](entities.Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
@@ -356,7 +357,7 @@ An option value is one of the possible values of a Product Option. Product Varia
{
"name": "purchasable",
"type": "`boolean`",
"description": "Only used with the inventory modules. A boolean value indicating whether the Product Variant is purchasable. A variant is purchasable if: - inventory is not managed - it has no inventory items - it is in stock - it is backorderable.",
"description": "Only used with the inventory modules.\nA boolean value indicating whether the Product Variant is purchasable.\nA variant is purchasable if:\n - inventory is not managed\n - it has no inventory items\n - it is in stock\n - it is backorderable.\n",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -436,4 +437,4 @@ An option value is one of the possible values of a Product Option. Product Varia
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ProductTag.mdx → www/apps/docs/content/references/entities/classes/entities.ProductTag.mdx
+2 -1
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ProductTag
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -65,4 +66,4 @@ A Product Tag can be added to Products for easy filtering and grouping.
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ProductTaxRate.mdx → www/apps/docs/content/references/entities/classes/entities.ProductTaxRate.mdx
+19 -18
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ProductTaxRate
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -31,7 +32,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "product",
"type": "[Product](Product.mdx)",
"type": "[Product](entities.Product.mdx)",
"description": "The details of the product.",
"optional": true,
"defaultValue": "",
@@ -39,7 +40,7 @@ This represents the association between a tax rate and a product to indicate tha
"children": [
{
"name": "categories",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"type": "[ProductCategory](entities.ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -49,7 +50,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "collection",
"type": "[ProductCollection](ProductCollection.mdx)",
"type": "[ProductCollection](entities.ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -148,7 +149,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "images",
"type": "[Image](Image.mdx)[]",
"type": "[Image](entities.Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -202,7 +203,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "options",
"type": "[ProductOption](ProductOption.mdx)[]",
"type": "[ProductOption](entities.ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -220,7 +221,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "profile",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
@@ -238,7 +239,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "profiles",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -247,7 +248,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "sales_channels",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"type": "[SalesChannel](entities.SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -256,7 +257,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "status",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/entities.ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -274,7 +275,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "tags",
"type": "[ProductTag](ProductTag.mdx)[]",
"type": "[ProductTag](entities.ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -301,7 +302,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "type",
"type": "[ProductType](ProductType.mdx)",
"type": "[ProductType](entities.ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -328,7 +329,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "variants",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"type": "[ProductVariant](entities.ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -375,7 +376,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "tax_rate",
"type": "[TaxRate](TaxRate.mdx)",
"type": "[TaxRate](entities.TaxRate.mdx)",
"description": "The details of the tax rate.",
"optional": true,
"defaultValue": "",
@@ -446,7 +447,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "product_types",
"type": "[ProductType](ProductType.mdx)[]",
"type": "[ProductType](entities.ProductType.mdx)[]",
"description": "The details of the product types that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -455,7 +456,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "products",
"type": "[Product](Product.mdx)[]",
"type": "[Product](entities.Product.mdx)[]",
"description": "The details of the products that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -473,7 +474,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region that the rate belongs to.",
"optional": false,
"defaultValue": "",
@@ -500,7 +501,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "shipping_options",
"type": "[ShippingOption](ShippingOption.mdx)[]",
"type": "[ShippingOption](entities.ShippingOption.mdx)[]",
"description": "The details of the shipping options that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -527,4 +528,4 @@ This represents the association between a tax rate and a product to indicate tha
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ProductType.mdx → www/apps/docs/content/references/entities/classes/entities.ProductType.mdx
+2 -1
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ProductType
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -65,4 +66,4 @@ A Product Type can be added to Products for filtering and reporting purposes.
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ProductTypeTaxRate.mdx → www/apps/docs/content/references/entities/classes/entities.ProductTypeTaxRate.mdx
+8 -7
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ProductTypeTaxRate
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -31,7 +32,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "product_type",
"type": "[ProductType](ProductType.mdx)",
"type": "[ProductType](entities.ProductType.mdx)",
"description": "The details of the product type.",
"optional": true,
"defaultValue": "",
@@ -113,7 +114,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "tax_rate",
"type": "[TaxRate](TaxRate.mdx)",
"type": "[TaxRate](entities.TaxRate.mdx)",
"description": "The details of the tax rate.",
"optional": true,
"defaultValue": "",
@@ -184,7 +185,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "product_types",
"type": "[ProductType](ProductType.mdx)[]",
"type": "[ProductType](entities.ProductType.mdx)[]",
"description": "The details of the product types that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -193,7 +194,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "products",
"type": "[Product](Product.mdx)[]",
"type": "[Product](entities.Product.mdx)[]",
"description": "The details of the products that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -211,7 +212,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region that the rate belongs to.",
"optional": false,
"defaultValue": "",
@@ -238,7 +239,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "shipping_options",
"type": "[ShippingOption](ShippingOption.mdx)[]",
"type": "[ShippingOption](entities.ShippingOption.mdx)[]",
"description": "The details of the shipping options that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -265,4 +266,4 @@ This represents the association between a tax rate and a product type to indicat
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ProductVariant.mdx → www/apps/docs/content/references/entities/classes/entities.ProductVariant.mdx
+26 -25
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ProductVariant
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -85,7 +86,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "inventory_items",
"type": "[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]",
"type": "[ProductVariantInventoryItem](entities.ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -147,7 +148,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "variant",
"type": "[ProductVariant](ProductVariant.mdx)",
"type": "[ProductVariant](entities.ProductVariant.mdx)",
"description": "The details of the product variant.",
"optional": false,
"defaultValue": "",
@@ -221,7 +222,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "options",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](entities.ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -265,7 +266,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "option",
"type": "[ProductOption](ProductOption.mdx)",
"type": "[ProductOption](entities.ProductOption.mdx)",
"description": "The details of the product option that the Product Option Value belongs to.",
"optional": false,
"defaultValue": "",
@@ -301,7 +302,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "variant",
"type": "[ProductVariant](ProductVariant.mdx)",
"type": "[ProductVariant](entities.ProductVariant.mdx)",
"description": "The details of the product variant that uses this product option value.",
"optional": false,
"defaultValue": "",
@@ -330,7 +331,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "prices",
"type": "[MoneyAmount](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](entities.MoneyAmount.mdx)[]",
"description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.",
"optional": false,
"defaultValue": "",
@@ -356,7 +357,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency that the money amount may belong to.",
"optional": true,
"defaultValue": "",
@@ -410,7 +411,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "price_list",
"type": "`null` \\| [PriceList](PriceList.mdx)",
"type": "`null` \\| [PriceList](entities.PriceList.mdx)",
"description": "The details of the price list that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -428,7 +429,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region that the money amount may belong to.",
"optional": true,
"defaultValue": "",
@@ -455,7 +456,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "variant",
"type": "[ProductVariant](ProductVariant.mdx)",
"type": "[ProductVariant](entities.ProductVariant.mdx)",
"description": "The details of the product variant that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -473,7 +474,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "variants",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"type": "[ProductVariant](entities.ProductVariant.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -484,7 +485,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "product",
"type": "[Product](Product.mdx)",
"type": "[Product](entities.Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
@@ -492,7 +493,7 @@ A Product Variant represents a Product with a specific set of Product Option con
"children": [
{
"name": "categories",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"type": "[ProductCategory](entities.ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -502,7 +503,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "collection",
"type": "[ProductCollection](ProductCollection.mdx)",
"type": "[ProductCollection](entities.ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -601,7 +602,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "images",
"type": "[Image](Image.mdx)[]",
"type": "[Image](entities.Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -655,7 +656,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "options",
"type": "[ProductOption](ProductOption.mdx)[]",
"type": "[ProductOption](entities.ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -673,7 +674,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "profile",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
@@ -691,7 +692,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "profiles",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -700,7 +701,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "sales_channels",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"type": "[SalesChannel](entities.SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -709,7 +710,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "status",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/entities.ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -727,7 +728,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "tags",
"type": "[ProductTag](ProductTag.mdx)[]",
"type": "[ProductTag](entities.ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -754,7 +755,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "type",
"type": "[ProductType](ProductType.mdx)",
"type": "[ProductType](entities.ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -781,7 +782,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "variants",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"type": "[ProductVariant](entities.ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -820,7 +821,7 @@ A Product Variant represents a Product with a specific set of Product Option con
{
"name": "purchasable",
"type": "`boolean`",
"description": "Only used with the inventory modules. A boolean value indicating whether the Product Variant is purchasable. A variant is purchasable if: - inventory is not managed - it has no inventory items - it is in stock - it is backorderable.",
"description": "Only used with the inventory modules.\nA boolean value indicating whether the Product Variant is purchasable.\nA variant is purchasable if:\n - inventory is not managed\n - it has no inventory items\n - it is in stock\n - it is backorderable.\n",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -889,4 +890,4 @@ A Product Variant represents a Product with a specific set of Product Option con
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ProductVariantInventoryItem.mdx → www/apps/docs/content/references/entities/classes/entities.ProductVariantInventoryItem.mdx
+8 -7
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ProductVariantInventoryItem
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -67,7 +68,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "variant",
"type": "[ProductVariant](ProductVariant.mdx)",
"type": "[ProductVariant](entities.ProductVariant.mdx)",
"description": "The details of the product variant.",
"optional": false,
"defaultValue": "",
@@ -147,7 +148,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "inventory_items",
"type": "[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]",
"type": "[ProductVariantInventoryItem](entities.ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -210,7 +211,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "options",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](entities.ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -228,7 +229,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "prices",
"type": "[MoneyAmount](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](entities.MoneyAmount.mdx)[]",
"description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.",
"optional": false,
"defaultValue": "",
@@ -237,7 +238,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "product",
"type": "[Product](Product.mdx)",
"type": "[Product](entities.Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
@@ -256,7 +257,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
{
"name": "purchasable",
"type": "`boolean`",
"description": "Only used with the inventory modules. A boolean value indicating whether the Product Variant is purchasable. A variant is purchasable if: - inventory is not managed - it has no inventory items - it is in stock - it is backorderable.",
"description": "Only used with the inventory modules.\nA boolean value indicating whether the Product Variant is purchasable.\nA variant is purchasable if:\n - inventory is not managed\n - it has no inventory items\n - it is in stock\n - it is backorderable.\n",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -336,4 +337,4 @@ A Product Variant Inventory Item links variants with inventory items and denotes
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ProductVariantMoneyAmount.mdx → www/apps/docs/content/references/entities/classes/entities.ProductVariantMoneyAmount.mdx
+2 -3
View File
@@ -1,13 +1,12 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ProductVariantMoneyAmount
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# ProductVariantMoneyAmount
Base abstract entity for all entities
## Properties
<ParameterTypes parameters={[
@@ -65,4 +64,4 @@ Base abstract entity for all entities
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/PublishableApiKey.mdx → www/apps/docs/content/references/entities/classes/entities.PublishableApiKey.mdx
+2 -1
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/PublishableApiKey
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -74,4 +75,4 @@ A Publishable API key defines scopes that resources are available in. Then, it c
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/PublishableApiKeySalesChannel.mdx → www/apps/docs/content/references/entities/classes/entities.PublishableApiKeySalesChannel.mdx
+2 -1
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/PublishableApiKeySalesChannel
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -29,4 +30,4 @@ This represents the association between the Publishable API keys and Sales Chann
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/Refund.mdx → www/apps/docs/content/references/entities/classes/entities.Refund.mdx
+32 -31
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/Refund
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -67,7 +68,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order this refund was created for.",
"optional": false,
"defaultValue": "",
@@ -75,7 +76,7 @@ A refund represents an amount of money transfered back to the customer for a giv
"children": [
{
"name": "billing_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -102,7 +103,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -120,7 +121,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "claims",
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -138,7 +139,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -156,7 +157,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "customer",
"type": "[Customer](Customer.mdx)",
"type": "[Customer](entities.Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -183,7 +184,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "discounts",
"type": "[Discount](Discount.mdx)[]",
"type": "[Discount](entities.Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -201,7 +202,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "draft_order",
"type": "[DraftOrder](DraftOrder.mdx)",
"type": "[DraftOrder](entities.DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -219,7 +220,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "edits",
"type": "[OrderEdit](OrderEdit.mdx)[]",
"type": "[OrderEdit](entities.OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -246,7 +247,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "fulfillment_status",
"type": "[FulfillmentStatus](../enums/FulfillmentStatus.mdx)",
"type": "[FulfillmentStatus](../enums/entities.FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -255,7 +256,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "fulfillments",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"type": "[Fulfillment](entities.Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -282,7 +283,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "gift_card_transactions",
"type": "[GiftCardTransaction](GiftCardTransaction.mdx)[]",
"type": "[GiftCardTransaction](entities.GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -291,7 +292,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "gift_cards",
"type": "[GiftCard](GiftCard.mdx)[]",
"type": "[GiftCard](entities.GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -327,7 +328,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -372,7 +373,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "payment_status",
"type": "[PaymentStatus](../enums/PaymentStatus.mdx)",
"type": "[PaymentStatus](../enums/entities.PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -381,7 +382,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "payments",
"type": "[Payment](Payment.mdx)[]",
"type": "[Payment](entities.Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -417,7 +418,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "refunds",
"type": "[Refund](Refund.mdx)[]",
"type": "[Refund](entities.Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -426,7 +427,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -444,7 +445,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "returnable_items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the line items that are returnable as part of the order, swaps, or claims",
"optional": true,
"defaultValue": "",
@@ -453,7 +454,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "returns",
"type": "[Return](Return.mdx)[]",
"type": "[Return](entities.Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -462,7 +463,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "sales_channel",
"type": "[SalesChannel](SalesChannel.mdx)",
"type": "[SalesChannel](entities.SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -480,7 +481,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "shipping_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -498,7 +499,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -525,7 +526,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "status",
"type": "[OrderStatus](../enums/OrderStatus.mdx)",
"type": "[OrderStatus](../enums/entities.OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -543,7 +544,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "swaps",
"type": "[Swap](Swap.mdx)[]",
"type": "[Swap](entities.Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
@@ -599,7 +600,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "payment",
"type": "[Payment](Payment.mdx)",
"type": "[Payment](entities.Payment.mdx)",
"description": "The details of the payment associated with the refund.",
"optional": false,
"defaultValue": "",
@@ -643,7 +644,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -670,7 +671,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency of the payment.",
"optional": false,
"defaultValue": "",
@@ -724,7 +725,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -751,7 +752,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "swap",
"type": "[Swap](Swap.mdx)",
"type": "[Swap](entities.Swap.mdx)",
"description": "The details of the swap that this payment was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -805,4 +806,4 @@ A refund represents an amount of money transfered back to the customer for a giv
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/Region.mdx → www/apps/docs/content/references/entities/classes/entities.Region.mdx
+9 -8
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/Region
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -22,7 +23,7 @@ A region holds settings specific to a geographical location, including the curre
},
{
"name": "countries",
"type": "[Country](Country.mdx)[]",
"type": "[Country](entities.Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -84,7 +85,7 @@ A region holds settings specific to a geographical location, including the curre
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region the country is associated with.",
"optional": false,
"defaultValue": "",
@@ -113,7 +114,7 @@ A region holds settings specific to a geographical location, including the curre
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -187,7 +188,7 @@ A region holds settings specific to a geographical location, including the curre
},
{
"name": "fulfillment_providers",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)[]",
"type": "[FulfillmentProvider](entities.FulfillmentProvider.mdx)[]",
"description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.",
"optional": false,
"defaultValue": "",
@@ -261,7 +262,7 @@ A region holds settings specific to a geographical location, including the curre
},
{
"name": "payment_providers",
"type": "[PaymentProvider](PaymentProvider.mdx)[]",
"type": "[PaymentProvider](entities.PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -298,7 +299,7 @@ A region holds settings specific to a geographical location, including the curre
},
{
"name": "tax_provider",
"type": "[TaxProvider](TaxProvider.mdx)",
"type": "[TaxProvider](entities.TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
@@ -344,7 +345,7 @@ A region holds settings specific to a geographical location, including the curre
},
{
"name": "tax_rates",
"type": "`null` \\| [TaxRate](TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](entities.TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -360,4 +361,4 @@ A region holds settings specific to a geographical location, including the curre
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/Return.mdx → www/apps/docs/content/references/entities/classes/entities.Return.mdx
+62 -61
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/Return
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -13,7 +14,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
<ParameterTypes parameters={[
{
"name": "claim_order",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)",
"description": "The details of the claim that the return may belong to.",
"optional": false,
"defaultValue": "",
@@ -21,7 +22,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
"children": [
{
"name": "additional_items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the new items to be shipped when the claim's type is `replace`",
"optional": false,
"defaultValue": "",
@@ -39,7 +40,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "claim_items",
"type": "[ClaimItem](ClaimItem.mdx)[]",
"type": "[ClaimItem](entities.ClaimItem.mdx)[]",
"description": "The details of the items that should be replaced or refunded.",
"optional": false,
"defaultValue": "",
@@ -66,7 +67,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "fulfillment_status",
"type": "[ClaimFulfillmentStatus](../enums/ClaimFulfillmentStatus.mdx)",
"type": "[ClaimFulfillmentStatus](../enums/entities.ClaimFulfillmentStatus.mdx)",
"description": "The claim's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -75,7 +76,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "fulfillments",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"type": "[Fulfillment](entities.Fulfillment.mdx)[]",
"description": "The fulfillments of the new items to be shipped",
"optional": false,
"defaultValue": "",
@@ -120,7 +121,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that this claim was created for.",
"optional": false,
"defaultValue": "",
@@ -138,7 +139,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "payment_status",
"type": "[ClaimPaymentStatus](../enums/ClaimPaymentStatus.mdx)",
"type": "[ClaimPaymentStatus](../enums/entities.ClaimPaymentStatus.mdx)",
"description": "The status of the claim's payment",
"optional": false,
"defaultValue": "na",
@@ -156,7 +157,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "return_order",
"type": "[Return](Return.mdx)",
"type": "[Return](entities.Return.mdx)",
"description": "The details of the return associated with the claim if the claim's type is `replace`.",
"optional": false,
"defaultValue": "",
@@ -165,7 +166,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "shipping_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the address that new items should be shipped to.",
"optional": false,
"defaultValue": "",
@@ -183,7 +184,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods that the claim order will be shipped with.",
"optional": false,
"defaultValue": "",
@@ -192,7 +193,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "type",
"type": "[ClaimType](../enums/ClaimType.mdx)",
"type": "[ClaimType](../enums/entities.ClaimType.mdx)",
"description": "The claim's type",
"optional": false,
"defaultValue": "",
@@ -248,7 +249,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "items",
"type": "[ReturnItem](ReturnItem.mdx)[]",
"type": "[ReturnItem](entities.ReturnItem.mdx)[]",
"description": "The details of the items that the customer is returning.",
"optional": false,
"defaultValue": "",
@@ -265,7 +266,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "item",
"type": "[LineItem](LineItem.mdx)",
"type": "[LineItem](entities.LineItem.mdx)",
"description": "The details of the line item in the original order to be returned.",
"optional": false,
"defaultValue": "",
@@ -310,7 +311,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "reason",
"type": "[ReturnReason](ReturnReason.mdx)",
"type": "[ReturnReason](entities.ReturnReason.mdx)",
"description": "The details of the reason for returning the item.",
"optional": false,
"defaultValue": "",
@@ -355,7 +356,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "return_order",
"type": "[Return](Return.mdx)",
"type": "[Return](entities.Return.mdx)",
"description": "Details of the Return that the Return Item belongs to.",
"optional": false,
"defaultValue": "",
@@ -393,7 +394,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the return was created for.",
"optional": false,
"defaultValue": "",
@@ -401,7 +402,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
"children": [
{
"name": "billing_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -428,7 +429,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -446,7 +447,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "claims",
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -464,7 +465,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -482,7 +483,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "customer",
"type": "[Customer](Customer.mdx)",
"type": "[Customer](entities.Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -509,7 +510,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "discounts",
"type": "[Discount](Discount.mdx)[]",
"type": "[Discount](entities.Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -527,7 +528,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "draft_order",
"type": "[DraftOrder](DraftOrder.mdx)",
"type": "[DraftOrder](entities.DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -545,7 +546,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "edits",
"type": "[OrderEdit](OrderEdit.mdx)[]",
"type": "[OrderEdit](entities.OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -572,7 +573,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "fulfillment_status",
"type": "[FulfillmentStatus](../enums/FulfillmentStatus.mdx)",
"type": "[FulfillmentStatus](../enums/entities.FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -581,7 +582,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "fulfillments",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"type": "[Fulfillment](entities.Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -608,7 +609,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "gift_card_transactions",
"type": "[GiftCardTransaction](GiftCardTransaction.mdx)[]",
"type": "[GiftCardTransaction](entities.GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -617,7 +618,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "gift_cards",
"type": "[GiftCard](GiftCard.mdx)[]",
"type": "[GiftCard](entities.GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -653,7 +654,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -698,7 +699,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "payment_status",
"type": "[PaymentStatus](../enums/PaymentStatus.mdx)",
"type": "[PaymentStatus](../enums/entities.PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -707,7 +708,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "payments",
"type": "[Payment](Payment.mdx)[]",
"type": "[Payment](entities.Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -743,7 +744,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "refunds",
"type": "[Refund](Refund.mdx)[]",
"type": "[Refund](entities.Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -752,7 +753,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -770,7 +771,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "returnable_items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the line items that are returnable as part of the order, swaps, or claims",
"optional": true,
"defaultValue": "",
@@ -779,7 +780,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "returns",
"type": "[Return](Return.mdx)[]",
"type": "[Return](entities.Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -788,7 +789,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "sales_channel",
"type": "[SalesChannel](SalesChannel.mdx)",
"type": "[SalesChannel](entities.SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -806,7 +807,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "shipping_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -824,7 +825,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -851,7 +852,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "status",
"type": "[OrderStatus](../enums/OrderStatus.mdx)",
"type": "[OrderStatus](../enums/entities.OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -869,7 +870,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "swaps",
"type": "[Swap](Swap.mdx)[]",
"type": "[Swap](entities.Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
@@ -952,7 +953,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "shipping_method",
"type": "[ShippingMethod](ShippingMethod.mdx)",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)",
"description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.",
"optional": false,
"defaultValue": "",
@@ -960,7 +961,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
"children": [
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -978,7 +979,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "claim_order",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)",
"description": "The details of the claim that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -1024,7 +1025,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -1060,7 +1061,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "return_order",
"type": "[Return](Return.mdx)",
"type": "[Return](entities.Return.mdx)",
"description": "The details of the return that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -1069,7 +1070,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "shipping_option",
"type": "[ShippingOption](ShippingOption.mdx)",
"type": "[ShippingOption](entities.ShippingOption.mdx)",
"description": "The details of the shipping option the method was created from.",
"optional": false,
"defaultValue": "",
@@ -1096,7 +1097,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "swap",
"type": "[Swap](Swap.mdx)",
"type": "[Swap](entities.Swap.mdx)",
"description": "The details of the swap that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -1114,7 +1115,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "tax_lines",
"type": "[ShippingMethodTaxLine](ShippingMethodTaxLine.mdx)[]",
"type": "[ShippingMethodTaxLine](entities.ShippingMethodTaxLine.mdx)[]",
"description": "The details of the tax lines applied on the shipping method.",
"optional": false,
"defaultValue": "",
@@ -1143,7 +1144,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "status",
"type": "[ReturnStatus](../enums/ReturnStatus.mdx)",
"type": "[ReturnStatus](../enums/entities.ReturnStatus.mdx)",
"description": "Status of the Return.",
"optional": false,
"defaultValue": "requested",
@@ -1189,7 +1190,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "swap",
"type": "[Swap](Swap.mdx)",
"type": "[Swap](entities.Swap.mdx)",
"description": "The details of the swap that the return may belong to.",
"optional": false,
"defaultValue": "",
@@ -1197,7 +1198,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
"children": [
{
"name": "additional_items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the new products to send to the customer, represented as line items.",
"optional": false,
"defaultValue": "",
@@ -1224,7 +1225,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart that the customer uses to complete the swap.",
"optional": false,
"defaultValue": "",
@@ -1278,7 +1279,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "fulfillment_status",
"type": "[SwapFulfillmentStatus](../enums/SwapFulfillmentStatus.mdx)",
"type": "[SwapFulfillmentStatus](../enums/entities.SwapFulfillmentStatus.mdx)",
"description": "The status of the Fulfillment of the Swap.",
"optional": false,
"defaultValue": "",
@@ -1287,7 +1288,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "fulfillments",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"type": "[Fulfillment](entities.Fulfillment.mdx)[]",
"description": "The details of the fulfillments that are used to send the new items to the customer.",
"optional": false,
"defaultValue": "",
@@ -1332,7 +1333,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the swap belongs to.",
"optional": false,
"defaultValue": "",
@@ -1350,7 +1351,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "payment",
"type": "[Payment](Payment.mdx)",
"type": "[Payment](entities.Payment.mdx)",
"description": "The details of the additional payment authorized by the customer when `difference\\_due` is positive.",
"optional": false,
"defaultValue": "",
@@ -1359,7 +1360,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "payment_status",
"type": "[SwapPaymentStatus](../enums/SwapPaymentStatus.mdx)",
"type": "[SwapPaymentStatus](../enums/entities.SwapPaymentStatus.mdx)",
"description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.",
"optional": false,
"defaultValue": "",
@@ -1368,7 +1369,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "return_order",
"type": "[Return](Return.mdx)",
"type": "[Return](entities.Return.mdx)",
"description": "The details of the return that belongs to the swap, which holds the details on the items being returned.",
"optional": false,
"defaultValue": "",
@@ -1377,7 +1378,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "shipping_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the shipping address that the new items should be sent to.",
"optional": false,
"defaultValue": "",
@@ -1395,7 +1396,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used to fulfill the additional items purchased.",
"optional": false,
"defaultValue": "",
@@ -1431,4 +1432,4 @@ A Return holds information about Line Items that a Customer wishes to send back,
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ReturnItem.mdx → www/apps/docs/content/references/entities/classes/entities.ReturnItem.mdx
+21 -20
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ReturnItem
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -22,7 +23,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "item",
"type": "[LineItem](LineItem.mdx)",
"type": "[LineItem](entities.LineItem.mdx)",
"description": "The details of the line item in the original order to be returned.",
"optional": false,
"defaultValue": "",
@@ -30,7 +31,7 @@ A return item represents a line item in an order that is to be returned. It incl
"children": [
{
"name": "adjustments",
"type": "[LineItemAdjustment](LineItemAdjustment.mdx)[]",
"type": "[LineItemAdjustment](entities.LineItemAdjustment.mdx)[]",
"description": "The details of the item's adjustments, which are available when a discount is applied on the item.",
"optional": false,
"defaultValue": "",
@@ -48,7 +49,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -66,7 +67,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "claim_order",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)",
"description": "The details of the claim that the line item may belong to.",
"optional": false,
"defaultValue": "",
@@ -184,7 +185,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -193,7 +194,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "order_edit",
"type": "`null` \\| [OrderEdit](OrderEdit.mdx)",
"type": "`null` \\| [OrderEdit](entities.OrderEdit.mdx)",
"description": "The details of the order edit.",
"optional": true,
"defaultValue": "",
@@ -319,7 +320,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "swap",
"type": "[Swap](Swap.mdx)",
"type": "[Swap](entities.Swap.mdx)",
"description": "The details of the swap that the line item may belong to.",
"optional": false,
"defaultValue": "",
@@ -337,7 +338,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "tax_lines",
"type": "[LineItemTaxLine](LineItemTaxLine.mdx)[]",
"type": "[LineItemTaxLine](entities.LineItemTaxLine.mdx)[]",
"description": "The details of the item's tax lines.",
"optional": false,
"defaultValue": "",
@@ -400,7 +401,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "variant",
"type": "[ProductVariant](ProductVariant.mdx)",
"type": "[ProductVariant](entities.ProductVariant.mdx)",
"description": "The details of the product variant that this item was created from.",
"optional": false,
"defaultValue": "",
@@ -456,7 +457,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "reason",
"type": "[ReturnReason](ReturnReason.mdx)",
"type": "[ReturnReason](entities.ReturnReason.mdx)",
"description": "The details of the reason for returning the item.",
"optional": false,
"defaultValue": "",
@@ -518,7 +519,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "parent_return_reason",
"type": "`null` \\| [ReturnReason](ReturnReason.mdx)",
"type": "`null` \\| [ReturnReason](entities.ReturnReason.mdx)",
"description": "The details of the parent reason.",
"optional": false,
"defaultValue": "",
@@ -536,7 +537,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "return_reason_children",
"type": "[ReturnReason](ReturnReason.mdx)[]",
"type": "[ReturnReason](entities.ReturnReason.mdx)[]",
"description": "The details of the child reasons.",
"optional": false,
"defaultValue": "",
@@ -601,7 +602,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "return_order",
"type": "[Return](Return.mdx)",
"type": "[Return](entities.Return.mdx)",
"description": "Details of the Return that the Return Item belongs to.",
"optional": false,
"defaultValue": "",
@@ -609,7 +610,7 @@ A return item represents a line item in an order that is to be returned. It incl
"children": [
{
"name": "claim_order",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)",
"description": "The details of the claim that the return may belong to.",
"optional": false,
"defaultValue": "",
@@ -654,7 +655,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "items",
"type": "[ReturnItem](ReturnItem.mdx)[]",
"type": "[ReturnItem](entities.ReturnItem.mdx)[]",
"description": "The details of the items that the customer is returning.",
"optional": false,
"defaultValue": "",
@@ -690,7 +691,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the return was created for.",
"optional": false,
"defaultValue": "",
@@ -735,7 +736,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "shipping_method",
"type": "[ShippingMethod](ShippingMethod.mdx)",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)",
"description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.",
"optional": false,
"defaultValue": "",
@@ -744,7 +745,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "status",
"type": "[ReturnStatus](../enums/ReturnStatus.mdx)",
"type": "[ReturnStatus](../enums/entities.ReturnStatus.mdx)",
"description": "Status of the Return.",
"optional": false,
"defaultValue": "requested",
@@ -753,7 +754,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "swap",
"type": "[Swap](Swap.mdx)",
"type": "[Swap](entities.Swap.mdx)",
"description": "The details of the swap that the return may belong to.",
"optional": false,
"defaultValue": "",
@@ -780,4 +781,4 @@ A return item represents a line item in an order that is to be returned. It incl
}
]
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ReturnReason.mdx → www/apps/docs/content/references/entities/classes/entities.ReturnReason.mdx
+6 -5
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ReturnReason
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -67,7 +68,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i
},
{
"name": "parent_return_reason",
"type": "`null` \\| [ReturnReason](ReturnReason.mdx)",
"type": "`null` \\| [ReturnReason](entities.ReturnReason.mdx)",
"description": "The details of the parent reason.",
"optional": false,
"defaultValue": "",
@@ -85,7 +86,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i
},
{
"name": "return_reason_children",
"type": "[ReturnReason](ReturnReason.mdx)[]",
"type": "[ReturnReason](entities.ReturnReason.mdx)[]",
"description": "The details of the child reasons.",
"optional": false,
"defaultValue": "",
@@ -147,7 +148,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i
},
{
"name": "parent_return_reason",
"type": "`null` \\| [ReturnReason](ReturnReason.mdx)",
"type": "`null` \\| [ReturnReason](entities.ReturnReason.mdx)",
"description": "The details of the parent reason.",
"optional": false,
"defaultValue": "",
@@ -165,7 +166,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i
},
{
"name": "return_reason_children",
"type": "[ReturnReason](ReturnReason.mdx)[]",
"type": "[ReturnReason](entities.ReturnReason.mdx)[]",
"description": "The details of the child reasons.",
"optional": false,
"defaultValue": "",
@@ -210,4 +211,4 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/SalesChannel.mdx → www/apps/docs/content/references/entities/classes/entities.SalesChannel.mdx
+4 -3
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/SalesChannel
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -58,7 +59,7 @@ A Sales Channel is a method a business offers its products for purchase for the
},
{
"name": "locations",
"type": "[SalesChannelLocation](SalesChannelLocation.mdx)[]",
"type": "[SalesChannelLocation](entities.SalesChannelLocation.mdx)[]",
"description": "The details of the stock locations related to the sales channel.",
"optional": false,
"defaultValue": "",
@@ -102,7 +103,7 @@ A Sales Channel is a method a business offers its products for purchase for the
},
{
"name": "sales_channel",
"type": "[SalesChannel](SalesChannel.mdx)",
"type": "[SalesChannel](entities.SalesChannel.mdx)",
"description": "The details of the sales channel the location is associated with.",
"optional": false,
"defaultValue": "",
@@ -156,4 +157,4 @@ A Sales Channel is a method a business offers its products for purchase for the
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/SalesChannelLocation.mdx → www/apps/docs/content/references/entities/classes/entities.SalesChannelLocation.mdx
+4 -3
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/SalesChannelLocation
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -49,7 +50,7 @@ This represents the association between a sales channel and a stock locations.
},
{
"name": "sales_channel",
"type": "[SalesChannel](SalesChannel.mdx)",
"type": "[SalesChannel](entities.SalesChannel.mdx)",
"description": "The details of the sales channel the location is associated with.",
"optional": false,
"defaultValue": "",
@@ -102,7 +103,7 @@ This represents the association between a sales channel and a stock locations.
},
{
"name": "locations",
"type": "[SalesChannelLocation](SalesChannelLocation.mdx)[]",
"type": "[SalesChannelLocation](entities.SalesChannelLocation.mdx)[]",
"description": "The details of the stock locations related to the sales channel.",
"optional": false,
"defaultValue": "",
@@ -156,4 +157,4 @@ This represents the association between a sales channel and a stock locations.
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ShippingMethod.mdx → www/apps/docs/content/references/entities/classes/entities.ShippingMethod.mdx
+78 -77
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ShippingMethod
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -13,7 +14,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
<ParameterTypes parameters={[
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -21,7 +22,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
"children": [
{
"name": "billing_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the billing address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -66,7 +67,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "customer",
"type": "[Customer](Customer.mdx)",
"type": "[Customer](entities.Customer.mdx)",
"description": "The details of the customer the cart belongs to.",
"optional": false,
"defaultValue": "",
@@ -102,7 +103,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "discounts",
"type": "[Discount](Discount.mdx)[]",
"type": "[Discount](entities.Discount.mdx)[]",
"description": "An array of details of all discounts applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -138,7 +139,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "gift_cards",
"type": "[GiftCard](GiftCard.mdx)[]",
"type": "[GiftCard](entities.GiftCard.mdx)[]",
"description": "An array of details of all gift cards applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -174,7 +175,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The line items added to the cart.",
"optional": false,
"defaultValue": "",
@@ -201,7 +202,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "payment",
"type": "[Payment](Payment.mdx)",
"type": "[Payment](entities.Payment.mdx)",
"description": "The details of the payment associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -228,7 +229,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "payment_session",
"type": "`null` \\| [PaymentSession](PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](entities.PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -237,7 +238,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "payment_sessions",
"type": "[PaymentSession](PaymentSession.mdx)[]",
"type": "[PaymentSession](entities.PaymentSession.mdx)[]",
"description": "The details of all payment sessions created on the cart.",
"optional": false,
"defaultValue": "",
@@ -273,7 +274,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -291,7 +292,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "sales_channel",
"type": "[SalesChannel](SalesChannel.mdx)",
"type": "[SalesChannel](entities.SalesChannel.mdx)",
"description": "The details of the sales channel associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -309,7 +310,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "shipping_address",
"type": "`null` \\| [Address](Address.mdx)",
"type": "`null` \\| [Address](entities.Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -327,7 +328,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods added to the cart.",
"optional": false,
"defaultValue": "",
@@ -381,7 +382,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "type",
"type": "[CartType](../enums/CartType.mdx)",
"type": "[CartType](../enums/entities.CartType.mdx)",
"description": "The cart's type.",
"optional": false,
"defaultValue": "default",
@@ -410,7 +411,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "claim_order",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)",
"description": "The details of the claim that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -418,7 +419,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
"children": [
{
"name": "additional_items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the new items to be shipped when the claim's type is `replace`",
"optional": false,
"defaultValue": "",
@@ -436,7 +437,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "claim_items",
"type": "[ClaimItem](ClaimItem.mdx)[]",
"type": "[ClaimItem](entities.ClaimItem.mdx)[]",
"description": "The details of the items that should be replaced or refunded.",
"optional": false,
"defaultValue": "",
@@ -463,7 +464,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "fulfillment_status",
"type": "[ClaimFulfillmentStatus](../enums/ClaimFulfillmentStatus.mdx)",
"type": "[ClaimFulfillmentStatus](../enums/entities.ClaimFulfillmentStatus.mdx)",
"description": "The claim's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -472,7 +473,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "fulfillments",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"type": "[Fulfillment](entities.Fulfillment.mdx)[]",
"description": "The fulfillments of the new items to be shipped",
"optional": false,
"defaultValue": "",
@@ -517,7 +518,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that this claim was created for.",
"optional": false,
"defaultValue": "",
@@ -535,7 +536,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "payment_status",
"type": "[ClaimPaymentStatus](../enums/ClaimPaymentStatus.mdx)",
"type": "[ClaimPaymentStatus](../enums/entities.ClaimPaymentStatus.mdx)",
"description": "The status of the claim's payment",
"optional": false,
"defaultValue": "na",
@@ -553,7 +554,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "return_order",
"type": "[Return](Return.mdx)",
"type": "[Return](entities.Return.mdx)",
"description": "The details of the return associated with the claim if the claim's type is `replace`.",
"optional": false,
"defaultValue": "",
@@ -562,7 +563,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "shipping_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the address that new items should be shipped to.",
"optional": false,
"defaultValue": "",
@@ -580,7 +581,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods that the claim order will be shipped with.",
"optional": false,
"defaultValue": "",
@@ -589,7 +590,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "type",
"type": "[ClaimType](../enums/ClaimType.mdx)",
"type": "[ClaimType](../enums/entities.ClaimType.mdx)",
"description": "The claim's type",
"optional": false,
"defaultValue": "",
@@ -646,7 +647,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -654,7 +655,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
"children": [
{
"name": "billing_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -681,7 +682,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -699,7 +700,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "claims",
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -717,7 +718,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -735,7 +736,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "customer",
"type": "[Customer](Customer.mdx)",
"type": "[Customer](entities.Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -762,7 +763,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "discounts",
"type": "[Discount](Discount.mdx)[]",
"type": "[Discount](entities.Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -780,7 +781,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "draft_order",
"type": "[DraftOrder](DraftOrder.mdx)",
"type": "[DraftOrder](entities.DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -798,7 +799,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "edits",
"type": "[OrderEdit](OrderEdit.mdx)[]",
"type": "[OrderEdit](entities.OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -825,7 +826,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "fulfillment_status",
"type": "[FulfillmentStatus](../enums/FulfillmentStatus.mdx)",
"type": "[FulfillmentStatus](../enums/entities.FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -834,7 +835,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "fulfillments",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"type": "[Fulfillment](entities.Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -861,7 +862,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "gift_card_transactions",
"type": "[GiftCardTransaction](GiftCardTransaction.mdx)[]",
"type": "[GiftCardTransaction](entities.GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -870,7 +871,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "gift_cards",
"type": "[GiftCard](GiftCard.mdx)[]",
"type": "[GiftCard](entities.GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -906,7 +907,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -951,7 +952,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "payment_status",
"type": "[PaymentStatus](../enums/PaymentStatus.mdx)",
"type": "[PaymentStatus](../enums/entities.PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -960,7 +961,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "payments",
"type": "[Payment](Payment.mdx)[]",
"type": "[Payment](entities.Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -996,7 +997,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "refunds",
"type": "[Refund](Refund.mdx)[]",
"type": "[Refund](entities.Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -1005,7 +1006,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -1023,7 +1024,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "returnable_items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the line items that are returnable as part of the order, swaps, or claims",
"optional": true,
"defaultValue": "",
@@ -1032,7 +1033,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "returns",
"type": "[Return](Return.mdx)[]",
"type": "[Return](entities.Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -1041,7 +1042,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "sales_channel",
"type": "[SalesChannel](SalesChannel.mdx)",
"type": "[SalesChannel](entities.SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -1059,7 +1060,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "shipping_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -1077,7 +1078,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -1104,7 +1105,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "status",
"type": "[OrderStatus](../enums/OrderStatus.mdx)",
"type": "[OrderStatus](../enums/entities.OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -1122,7 +1123,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "swaps",
"type": "[Swap](Swap.mdx)[]",
"type": "[Swap](entities.Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
@@ -1196,7 +1197,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "return_order",
"type": "[Return](Return.mdx)",
"type": "[Return](entities.Return.mdx)",
"description": "The details of the return that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -1204,7 +1205,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
"children": [
{
"name": "claim_order",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)",
"description": "The details of the claim that the return may belong to.",
"optional": false,
"defaultValue": "",
@@ -1249,7 +1250,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "items",
"type": "[ReturnItem](ReturnItem.mdx)[]",
"type": "[ReturnItem](entities.ReturnItem.mdx)[]",
"description": "The details of the items that the customer is returning.",
"optional": false,
"defaultValue": "",
@@ -1285,7 +1286,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the return was created for.",
"optional": false,
"defaultValue": "",
@@ -1330,7 +1331,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "shipping_method",
"type": "[ShippingMethod](ShippingMethod.mdx)",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)",
"description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.",
"optional": false,
"defaultValue": "",
@@ -1339,7 +1340,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "status",
"type": "[ReturnStatus](../enums/ReturnStatus.mdx)",
"type": "[ReturnStatus](../enums/entities.ReturnStatus.mdx)",
"description": "Status of the Return.",
"optional": false,
"defaultValue": "requested",
@@ -1348,7 +1349,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "swap",
"type": "[Swap](Swap.mdx)",
"type": "[Swap](entities.Swap.mdx)",
"description": "The details of the swap that the return may belong to.",
"optional": false,
"defaultValue": "",
@@ -1377,7 +1378,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "shipping_option",
"type": "[ShippingOption](ShippingOption.mdx)",
"type": "[ShippingOption](entities.ShippingOption.mdx)",
"description": "The details of the shipping option the method was created from.",
"optional": false,
"defaultValue": "",
@@ -1476,7 +1477,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "price_type",
"type": "[ShippingOptionPriceType](../enums/ShippingOptionPriceType.mdx)",
"type": "[ShippingOptionPriceType](../enums/entities.ShippingOptionPriceType.mdx)",
"description": "The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat\\_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.",
"optional": false,
"defaultValue": "",
@@ -1485,7 +1486,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "profile",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)",
"description": "The details of the shipping profile that the shipping option belongs to.",
"optional": false,
"defaultValue": "",
@@ -1503,7 +1504,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "provider",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)",
"type": "[FulfillmentProvider](entities.FulfillmentProvider.mdx)",
"description": "The details of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.",
"optional": false,
"defaultValue": "",
@@ -1521,7 +1522,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region this shipping option can be used in.",
"optional": false,
"defaultValue": "",
@@ -1539,7 +1540,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "requirements",
"type": "[ShippingOptionRequirement](ShippingOptionRequirement.mdx)[]",
"type": "[ShippingOptionRequirement](entities.ShippingOptionRequirement.mdx)[]",
"description": "The details of the requirements that must be satisfied for the Shipping Option to be available for usage in a Cart.",
"optional": false,
"defaultValue": "",
@@ -1577,7 +1578,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "swap",
"type": "[Swap](Swap.mdx)",
"type": "[Swap](entities.Swap.mdx)",
"description": "The details of the swap that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -1585,7 +1586,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
"children": [
{
"name": "additional_items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the new products to send to the customer, represented as line items.",
"optional": false,
"defaultValue": "",
@@ -1612,7 +1613,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart that the customer uses to complete the swap.",
"optional": false,
"defaultValue": "",
@@ -1666,7 +1667,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "fulfillment_status",
"type": "[SwapFulfillmentStatus](../enums/SwapFulfillmentStatus.mdx)",
"type": "[SwapFulfillmentStatus](../enums/entities.SwapFulfillmentStatus.mdx)",
"description": "The status of the Fulfillment of the Swap.",
"optional": false,
"defaultValue": "",
@@ -1675,7 +1676,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "fulfillments",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"type": "[Fulfillment](entities.Fulfillment.mdx)[]",
"description": "The details of the fulfillments that are used to send the new items to the customer.",
"optional": false,
"defaultValue": "",
@@ -1720,7 +1721,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the swap belongs to.",
"optional": false,
"defaultValue": "",
@@ -1738,7 +1739,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "payment",
"type": "[Payment](Payment.mdx)",
"type": "[Payment](entities.Payment.mdx)",
"description": "The details of the additional payment authorized by the customer when `difference\\_due` is positive.",
"optional": false,
"defaultValue": "",
@@ -1747,7 +1748,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "payment_status",
"type": "[SwapPaymentStatus](../enums/SwapPaymentStatus.mdx)",
"type": "[SwapPaymentStatus](../enums/entities.SwapPaymentStatus.mdx)",
"description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.",
"optional": false,
"defaultValue": "",
@@ -1756,7 +1757,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "return_order",
"type": "[Return](Return.mdx)",
"type": "[Return](entities.Return.mdx)",
"description": "The details of the return that belongs to the swap, which holds the details on the items being returned.",
"optional": false,
"defaultValue": "",
@@ -1765,7 +1766,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "shipping_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the shipping address that the new items should be sent to.",
"optional": false,
"defaultValue": "",
@@ -1783,7 +1784,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used to fulfill the additional items purchased.",
"optional": false,
"defaultValue": "",
@@ -1812,7 +1813,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "tax_lines",
"type": "[ShippingMethodTaxLine](ShippingMethodTaxLine.mdx)[]",
"type": "[ShippingMethodTaxLine](entities.ShippingMethodTaxLine.mdx)[]",
"description": "The details of the tax lines applied on the shipping method.",
"optional": false,
"defaultValue": "",
@@ -1874,7 +1875,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "shipping_method",
"type": "[ShippingMethod](ShippingMethod.mdx)",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)",
"description": "The details of the associated shipping method.",
"optional": false,
"defaultValue": "",
@@ -1919,4 +1920,4 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ShippingMethodTaxLine.mdx → www/apps/docs/content/references/entities/classes/entities.ShippingMethodTaxLine.mdx
+10 -9
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ShippingMethodTaxLine
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -67,7 +68,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
},
{
"name": "shipping_method",
"type": "[ShippingMethod](ShippingMethod.mdx)",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)",
"description": "The details of the associated shipping method.",
"optional": false,
"defaultValue": "",
@@ -75,7 +76,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
"children": [
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -93,7 +94,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
},
{
"name": "claim_order",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)",
"description": "The details of the claim that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -139,7 +140,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -175,7 +176,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
},
{
"name": "return_order",
"type": "[Return](Return.mdx)",
"type": "[Return](entities.Return.mdx)",
"description": "The details of the return that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -184,7 +185,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
},
{
"name": "shipping_option",
"type": "[ShippingOption](ShippingOption.mdx)",
"type": "[ShippingOption](entities.ShippingOption.mdx)",
"description": "The details of the shipping option the method was created from.",
"optional": false,
"defaultValue": "",
@@ -211,7 +212,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
},
{
"name": "swap",
"type": "[Swap](Swap.mdx)",
"type": "[Swap](entities.Swap.mdx)",
"description": "The details of the swap that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -229,7 +230,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
},
{
"name": "tax_lines",
"type": "[ShippingMethodTaxLine](ShippingMethodTaxLine.mdx)[]",
"type": "[ShippingMethodTaxLine](entities.ShippingMethodTaxLine.mdx)[]",
"description": "The details of the tax lines applied on the shipping method.",
"optional": false,
"defaultValue": "",
@@ -274,4 +275,4 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ShippingOption.mdx → www/apps/docs/content/references/entities/classes/entities.ShippingOption.mdx
+18 -17
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ShippingOption
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -104,7 +105,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "price_type",
"type": "[ShippingOptionPriceType](../enums/ShippingOptionPriceType.mdx)",
"type": "[ShippingOptionPriceType](../enums/entities.ShippingOptionPriceType.mdx)",
"description": "The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat\\_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.",
"optional": false,
"defaultValue": "",
@@ -132,7 +133,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "profile",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)",
"description": "The details of the shipping profile that the shipping option belongs to.",
"optional": false,
"defaultValue": "",
@@ -185,7 +186,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "products",
"type": "[Product](Product.mdx)[]",
"type": "[Product](entities.Product.mdx)[]",
"description": "The details of the products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.",
"optional": false,
"defaultValue": "",
@@ -194,7 +195,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "shipping_options",
"type": "[ShippingOption](ShippingOption.mdx)[]",
"type": "[ShippingOption](entities.ShippingOption.mdx)[]",
"description": "The details of the shipping options that can be used to create shipping methods for the Products in the Shipping Profile.",
"optional": false,
"defaultValue": "",
@@ -203,7 +204,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "type",
"type": "[ShippingProfileType](../enums/ShippingProfileType.mdx)",
"type": "[ShippingProfileType](../enums/entities.ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift\\_card` or `custom`.",
"optional": false,
"defaultValue": "",
@@ -232,7 +233,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "provider",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)",
"type": "[FulfillmentProvider](entities.FulfillmentProvider.mdx)",
"description": "The details of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.",
"optional": false,
"defaultValue": "",
@@ -269,7 +270,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region this shipping option can be used in.",
"optional": false,
"defaultValue": "",
@@ -286,7 +287,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "countries",
"type": "[Country](Country.mdx)[]",
"type": "[Country](entities.Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -304,7 +305,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -331,7 +332,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "fulfillment_providers",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)[]",
"type": "[FulfillmentProvider](entities.FulfillmentProvider.mdx)[]",
"description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.",
"optional": false,
"defaultValue": "",
@@ -386,7 +387,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "payment_providers",
"type": "[PaymentProvider](PaymentProvider.mdx)[]",
"type": "[PaymentProvider](entities.PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -404,7 +405,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "tax_provider",
"type": "[TaxProvider](TaxProvider.mdx)",
"type": "[TaxProvider](entities.TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
@@ -431,7 +432,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "tax_rates",
"type": "`null` \\| [TaxRate](TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](entities.TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -460,7 +461,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "requirements",
"type": "[ShippingOptionRequirement](ShippingOptionRequirement.mdx)[]",
"type": "[ShippingOptionRequirement](entities.ShippingOptionRequirement.mdx)[]",
"description": "The details of the requirements that must be satisfied for the Shipping Option to be available for usage in a Cart.",
"optional": false,
"defaultValue": "",
@@ -495,7 +496,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "shipping_option",
"type": "[ShippingOption](ShippingOption.mdx)",
"type": "[ShippingOption](entities.ShippingOption.mdx)",
"description": "The details of the shipping option that the requirements belong to.",
"optional": false,
"defaultValue": "",
@@ -513,7 +514,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "type",
"type": "[RequirementType](../enums/RequirementType.mdx)",
"type": "[RequirementType](../enums/entities.RequirementType.mdx)",
"description": "The type of the requirement, this defines how the value will be compared to the Cart's total. `min\\_subtotal` requirements define the minimum subtotal that is needed for the Shipping Option to be available, while the `max\\_subtotal` defines the maximum subtotal that the Cart can have for the Shipping Option to be available.",
"optional": false,
"defaultValue": "",
@@ -531,4 +532,4 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ShippingOptionRequirement.mdx → www/apps/docs/content/references/entities/classes/entities.ShippingOptionRequirement.mdx
+9 -8
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ShippingOptionRequirement
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -40,7 +41,7 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
},
{
"name": "shipping_option",
"type": "[ShippingOption](ShippingOption.mdx)",
"type": "[ShippingOption](entities.ShippingOption.mdx)",
"description": "The details of the shipping option that the requirements belong to.",
"optional": false,
"defaultValue": "",
@@ -139,7 +140,7 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
},
{
"name": "price_type",
"type": "[ShippingOptionPriceType](../enums/ShippingOptionPriceType.mdx)",
"type": "[ShippingOptionPriceType](../enums/entities.ShippingOptionPriceType.mdx)",
"description": "The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat\\_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.",
"optional": false,
"defaultValue": "",
@@ -148,7 +149,7 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
},
{
"name": "profile",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)",
"description": "The details of the shipping profile that the shipping option belongs to.",
"optional": false,
"defaultValue": "",
@@ -166,7 +167,7 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
},
{
"name": "provider",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)",
"type": "[FulfillmentProvider](entities.FulfillmentProvider.mdx)",
"description": "The details of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.",
"optional": false,
"defaultValue": "",
@@ -184,7 +185,7 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region this shipping option can be used in.",
"optional": false,
"defaultValue": "",
@@ -202,7 +203,7 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
},
{
"name": "requirements",
"type": "[ShippingOptionRequirement](ShippingOptionRequirement.mdx)[]",
"type": "[ShippingOptionRequirement](entities.ShippingOptionRequirement.mdx)[]",
"description": "The details of the requirements that must be satisfied for the Shipping Option to be available for usage in a Cart.",
"optional": false,
"defaultValue": "",
@@ -231,7 +232,7 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
},
{
"name": "type",
"type": "[RequirementType](../enums/RequirementType.mdx)",
"type": "[RequirementType](../enums/entities.RequirementType.mdx)",
"description": "The type of the requirement, this defines how the value will be compared to the Cart's total. `min\\_subtotal` requirements define the minimum subtotal that is needed for the Shipping Option to be available, while the `max\\_subtotal` defines the maximum subtotal that the Cart can have for the Shipping Option to be available.",
"optional": false,
"defaultValue": "",
@@ -257,4 +258,4 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
}
]
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ShippingProfile.mdx → www/apps/docs/content/references/entities/classes/entities.ShippingProfile.mdx
+21 -20
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ShippingProfile
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -58,7 +59,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "products",
"type": "[Product](Product.mdx)[]",
"type": "[Product](entities.Product.mdx)[]",
"description": "The details of the products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.",
"optional": false,
"defaultValue": "",
@@ -66,7 +67,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
"children": [
{
"name": "categories",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"type": "[ProductCategory](entities.ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -76,7 +77,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "collection",
"type": "[ProductCollection](ProductCollection.mdx)",
"type": "[ProductCollection](entities.ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -175,7 +176,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "images",
"type": "[Image](Image.mdx)[]",
"type": "[Image](entities.Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -229,7 +230,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "options",
"type": "[ProductOption](ProductOption.mdx)[]",
"type": "[ProductOption](entities.ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -247,7 +248,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "profile",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
@@ -265,7 +266,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "profiles",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -274,7 +275,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "sales_channels",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"type": "[SalesChannel](entities.SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -283,7 +284,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "status",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/entities.ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -301,7 +302,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "tags",
"type": "[ProductTag](ProductTag.mdx)[]",
"type": "[ProductTag](entities.ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -328,7 +329,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "type",
"type": "[ProductType](ProductType.mdx)",
"type": "[ProductType](entities.ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -355,7 +356,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "variants",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"type": "[ProductVariant](entities.ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -384,7 +385,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "shipping_options",
"type": "[ShippingOption](ShippingOption.mdx)[]",
"type": "[ShippingOption](entities.ShippingOption.mdx)[]",
"description": "The details of the shipping options that can be used to create shipping methods for the Products in the Shipping Profile.",
"optional": false,
"defaultValue": "",
@@ -483,7 +484,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "price_type",
"type": "[ShippingOptionPriceType](../enums/ShippingOptionPriceType.mdx)",
"type": "[ShippingOptionPriceType](../enums/entities.ShippingOptionPriceType.mdx)",
"description": "The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat\\_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.",
"optional": false,
"defaultValue": "",
@@ -492,7 +493,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "profile",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)",
"description": "The details of the shipping profile that the shipping option belongs to.",
"optional": false,
"defaultValue": "",
@@ -510,7 +511,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "provider",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)",
"type": "[FulfillmentProvider](entities.FulfillmentProvider.mdx)",
"description": "The details of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.",
"optional": false,
"defaultValue": "",
@@ -528,7 +529,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region this shipping option can be used in.",
"optional": false,
"defaultValue": "",
@@ -546,7 +547,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "requirements",
"type": "[ShippingOptionRequirement](ShippingOptionRequirement.mdx)[]",
"type": "[ShippingOptionRequirement](entities.ShippingOptionRequirement.mdx)[]",
"description": "The details of the requirements that must be satisfied for the Shipping Option to be available for usage in a Cart.",
"optional": false,
"defaultValue": "",
@@ -566,7 +567,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "type",
"type": "[ShippingProfileType](../enums/ShippingProfileType.mdx)",
"type": "[ShippingProfileType](../enums/entities.ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift\\_card` or `custom`.",
"optional": false,
"defaultValue": "",
@@ -610,4 +611,4 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/ShippingTaxRate.mdx → www/apps/docs/content/references/entities/classes/entities.ShippingTaxRate.mdx
+13 -12
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/ShippingTaxRate
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -40,7 +41,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "shipping_option",
"type": "[ShippingOption](ShippingOption.mdx)",
"type": "[ShippingOption](entities.ShippingOption.mdx)",
"description": "The details of the shipping option.",
"optional": true,
"defaultValue": "",
@@ -139,7 +140,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "price_type",
"type": "[ShippingOptionPriceType](../enums/ShippingOptionPriceType.mdx)",
"type": "[ShippingOptionPriceType](../enums/entities.ShippingOptionPriceType.mdx)",
"description": "The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat\\_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.",
"optional": false,
"defaultValue": "",
@@ -148,7 +149,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "profile",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)",
"description": "The details of the shipping profile that the shipping option belongs to.",
"optional": false,
"defaultValue": "",
@@ -166,7 +167,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "provider",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)",
"type": "[FulfillmentProvider](entities.FulfillmentProvider.mdx)",
"description": "The details of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.",
"optional": false,
"defaultValue": "",
@@ -184,7 +185,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region this shipping option can be used in.",
"optional": false,
"defaultValue": "",
@@ -202,7 +203,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "requirements",
"type": "[ShippingOptionRequirement](ShippingOptionRequirement.mdx)[]",
"type": "[ShippingOptionRequirement](entities.ShippingOptionRequirement.mdx)[]",
"description": "The details of the requirements that must be satisfied for the Shipping Option to be available for usage in a Cart.",
"optional": false,
"defaultValue": "",
@@ -231,7 +232,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "tax_rate",
"type": "[TaxRate](TaxRate.mdx)",
"type": "[TaxRate](entities.TaxRate.mdx)",
"description": "The details of the associated tax rate.",
"optional": true,
"defaultValue": "",
@@ -302,7 +303,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "product_types",
"type": "[ProductType](ProductType.mdx)[]",
"type": "[ProductType](entities.ProductType.mdx)[]",
"description": "The details of the product types that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -311,7 +312,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "products",
"type": "[Product](Product.mdx)[]",
"type": "[Product](entities.Product.mdx)[]",
"description": "The details of the products that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -329,7 +330,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region that the rate belongs to.",
"optional": false,
"defaultValue": "",
@@ -356,7 +357,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "shipping_options",
"type": "[ShippingOption](ShippingOption.mdx)[]",
"type": "[ShippingOption](entities.ShippingOption.mdx)[]",
"description": "The details of the shipping options that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -383,4 +384,4 @@ This represents the tax rates applied on a shipping option.
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/StagedJob.mdx → www/apps/docs/content/references/entities/classes/entities.StagedJob.mdx
+2 -1
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/StagedJob
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -47,4 +48,4 @@ A staged job resource
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/Store.mdx → www/apps/docs/content/references/entities/classes/entities.Store.mdx
+6 -5
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/Store
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -22,7 +23,7 @@ A store holds the main settings of the commerce shop. By default, only one store
},
{
"name": "currencies",
"type": "[Currency](Currency.mdx)[]",
"type": "[Currency](entities.Currency.mdx)[]",
"description": "The details of the enabled currencies in the store.",
"optional": false,
"defaultValue": "",
@@ -78,7 +79,7 @@ A store holds the main settings of the commerce shop. By default, only one store
},
{
"name": "default_currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the store's default currency.",
"optional": false,
"defaultValue": "usd",
@@ -152,7 +153,7 @@ A store holds the main settings of the commerce shop. By default, only one store
},
{
"name": "default_sales_channel",
"type": "[SalesChannel](SalesChannel.mdx)",
"type": "[SalesChannel](entities.SalesChannel.mdx)",
"description": "The details of the store's default sales channel.",
"optional": false,
"defaultValue": "",
@@ -205,7 +206,7 @@ A store holds the main settings of the commerce shop. By default, only one store
},
{
"name": "locations",
"type": "[SalesChannelLocation](SalesChannelLocation.mdx)[]",
"type": "[SalesChannelLocation](entities.SalesChannelLocation.mdx)[]",
"description": "The details of the stock locations related to the sales channel.",
"optional": false,
"defaultValue": "",
@@ -313,4 +314,4 @@ A store holds the main settings of the commerce shop. By default, only one store
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/Swap.mdx → www/apps/docs/content/references/entities/classes/entities.Swap.mdx
+12 -11
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/Swap
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -13,7 +14,7 @@ A swap can be created when a Customer wishes to exchange Products that they have
<ParameterTypes parameters={[
{
"name": "additional_items",
"type": "[LineItem](LineItem.mdx)[]",
"type": "[LineItem](entities.LineItem.mdx)[]",
"description": "The details of the new products to send to the customer, represented as line items.",
"optional": false,
"defaultValue": "",
@@ -40,7 +41,7 @@ A swap can be created when a Customer wishes to exchange Products that they have
},
{
"name": "cart",
"type": "[Cart](Cart.mdx)",
"type": "[Cart](entities.Cart.mdx)",
"description": "The details of the cart that the customer uses to complete the swap.",
"optional": false,
"defaultValue": "",
@@ -94,7 +95,7 @@ A swap can be created when a Customer wishes to exchange Products that they have
},
{
"name": "fulfillment_status",
"type": "[SwapFulfillmentStatus](../enums/SwapFulfillmentStatus.mdx)",
"type": "[SwapFulfillmentStatus](../enums/entities.SwapFulfillmentStatus.mdx)",
"description": "The status of the Fulfillment of the Swap.",
"optional": false,
"defaultValue": "",
@@ -103,7 +104,7 @@ A swap can be created when a Customer wishes to exchange Products that they have
},
{
"name": "fulfillments",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"type": "[Fulfillment](entities.Fulfillment.mdx)[]",
"description": "The details of the fulfillments that are used to send the new items to the customer.",
"optional": false,
"defaultValue": "",
@@ -148,7 +149,7 @@ A swap can be created when a Customer wishes to exchange Products that they have
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the swap belongs to.",
"optional": false,
"defaultValue": "",
@@ -166,7 +167,7 @@ A swap can be created when a Customer wishes to exchange Products that they have
},
{
"name": "payment",
"type": "[Payment](Payment.mdx)",
"type": "[Payment](entities.Payment.mdx)",
"description": "The details of the additional payment authorized by the customer when `difference\\_due` is positive.",
"optional": false,
"defaultValue": "",
@@ -175,7 +176,7 @@ A swap can be created when a Customer wishes to exchange Products that they have
},
{
"name": "payment_status",
"type": "[SwapPaymentStatus](../enums/SwapPaymentStatus.mdx)",
"type": "[SwapPaymentStatus](../enums/entities.SwapPaymentStatus.mdx)",
"description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.",
"optional": false,
"defaultValue": "",
@@ -184,7 +185,7 @@ A swap can be created when a Customer wishes to exchange Products that they have
},
{
"name": "return_order",
"type": "[Return](Return.mdx)",
"type": "[Return](entities.Return.mdx)",
"description": "The details of the return that belongs to the swap, which holds the details on the items being returned.",
"optional": false,
"defaultValue": "",
@@ -193,7 +194,7 @@ A swap can be created when a Customer wishes to exchange Products that they have
},
{
"name": "shipping_address",
"type": "[Address](Address.mdx)",
"type": "[Address](entities.Address.mdx)",
"description": "The details of the shipping address that the new items should be sent to.",
"optional": false,
"defaultValue": "",
@@ -211,7 +212,7 @@ A swap can be created when a Customer wishes to exchange Products that they have
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used to fulfill the additional items purchased.",
"optional": false,
"defaultValue": "",
@@ -227,4 +228,4 @@ A swap can be created when a Customer wishes to exchange Products that they have
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/TaxProvider.mdx → www/apps/docs/content/references/entities/classes/entities.TaxProvider.mdx
+2 -1
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/TaxProvider
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -29,4 +30,4 @@ A tax provider represents a tax service installed in the Medusa backend, either
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/TaxRate.mdx → www/apps/docs/content/references/entities/classes/entities.TaxRate.mdx
+28 -27
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/TaxRate
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -76,7 +77,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "product_types",
"type": "[ProductType](ProductType.mdx)[]",
"type": "[ProductType](entities.ProductType.mdx)[]",
"description": "The details of the product types that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -140,7 +141,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "products",
"type": "[Product](Product.mdx)[]",
"type": "[Product](entities.Product.mdx)[]",
"description": "The details of the products that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -148,7 +149,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
"children": [
{
"name": "categories",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"type": "[ProductCategory](entities.ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -158,7 +159,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "collection",
"type": "[ProductCollection](ProductCollection.mdx)",
"type": "[ProductCollection](entities.ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -257,7 +258,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "images",
"type": "[Image](Image.mdx)[]",
"type": "[Image](entities.Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -311,7 +312,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "options",
"type": "[ProductOption](ProductOption.mdx)[]",
"type": "[ProductOption](entities.ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -329,7 +330,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "profile",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
@@ -347,7 +348,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "profiles",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -356,7 +357,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "sales_channels",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"type": "[SalesChannel](entities.SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -365,7 +366,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "status",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/entities.ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -383,7 +384,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "tags",
"type": "[ProductTag](ProductTag.mdx)[]",
"type": "[ProductTag](entities.ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -410,7 +411,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "type",
"type": "[ProductType](ProductType.mdx)",
"type": "[ProductType](entities.ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -437,7 +438,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "variants",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"type": "[ProductVariant](entities.ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
@@ -475,7 +476,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region that the rate belongs to.",
"optional": false,
"defaultValue": "",
@@ -492,7 +493,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "countries",
"type": "[Country](Country.mdx)[]",
"type": "[Country](entities.Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -510,7 +511,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "currency",
"type": "[Currency](Currency.mdx)",
"type": "[Currency](entities.Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -537,7 +538,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "fulfillment_providers",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)[]",
"type": "[FulfillmentProvider](entities.FulfillmentProvider.mdx)[]",
"description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.",
"optional": false,
"defaultValue": "",
@@ -592,7 +593,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "payment_providers",
"type": "[PaymentProvider](PaymentProvider.mdx)[]",
"type": "[PaymentProvider](entities.PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -610,7 +611,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "tax_provider",
"type": "[TaxProvider](TaxProvider.mdx)",
"type": "[TaxProvider](entities.TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
@@ -637,7 +638,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "tax_rates",
"type": "`null` \\| [TaxRate](TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](entities.TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -675,7 +676,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "shipping_options",
"type": "[ShippingOption](ShippingOption.mdx)[]",
"type": "[ShippingOption](entities.ShippingOption.mdx)[]",
"description": "The details of the shipping options that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -774,7 +775,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "price_type",
"type": "[ShippingOptionPriceType](../enums/ShippingOptionPriceType.mdx)",
"type": "[ShippingOptionPriceType](../enums/entities.ShippingOptionPriceType.mdx)",
"description": "The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat\\_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.",
"optional": false,
"defaultValue": "",
@@ -783,7 +784,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "profile",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"type": "[ShippingProfile](entities.ShippingProfile.mdx)",
"description": "The details of the shipping profile that the shipping option belongs to.",
"optional": false,
"defaultValue": "",
@@ -801,7 +802,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "provider",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)",
"type": "[FulfillmentProvider](entities.FulfillmentProvider.mdx)",
"description": "The details of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.",
"optional": false,
"defaultValue": "",
@@ -819,7 +820,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"type": "[Region](entities.Region.mdx)",
"description": "The details of the region this shipping option can be used in.",
"optional": false,
"defaultValue": "",
@@ -837,7 +838,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "requirements",
"type": "[ShippingOptionRequirement](ShippingOptionRequirement.mdx)[]",
"type": "[ShippingOptionRequirement](entities.ShippingOptionRequirement.mdx)[]",
"description": "The details of the requirements that must be satisfied for the Shipping Option to be available for usage in a Cart.",
"optional": false,
"defaultValue": "",
@@ -864,4 +865,4 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/TrackingLink.mdx → www/apps/docs/content/references/entities/classes/entities.TrackingLink.mdx
+9 -8
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/TrackingLink
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -31,7 +32,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac
},
{
"name": "fulfillment",
"type": "[Fulfillment](Fulfillment.mdx)",
"type": "[Fulfillment](entities.Fulfillment.mdx)",
"description": "The details of the fulfillment that the tracking link belongs to.",
"optional": false,
"defaultValue": "",
@@ -48,7 +49,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac
},
{
"name": "claim_order",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"type": "[ClaimOrder](entities.ClaimOrder.mdx)",
"description": "The details of the claim that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -102,7 +103,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac
},
{
"name": "items",
"type": "[FulfillmentItem](FulfillmentItem.mdx)[]",
"type": "[FulfillmentItem](entities.FulfillmentItem.mdx)[]",
"description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.",
"optional": false,
"defaultValue": "",
@@ -138,7 +139,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac
},
{
"name": "order",
"type": "[Order](Order.mdx)",
"type": "[Order](entities.Order.mdx)",
"description": "The details of the order that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -156,7 +157,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac
},
{
"name": "provider",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)",
"type": "[FulfillmentProvider](entities.FulfillmentProvider.mdx)",
"description": "The details of the fulfillment provider responsible for handling the fulfillment.",
"optional": false,
"defaultValue": "",
@@ -183,7 +184,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac
},
{
"name": "swap",
"type": "[Swap](Swap.mdx)",
"type": "[Swap](entities.Swap.mdx)",
"description": "The details of the swap that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -201,7 +202,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac
},
{
"name": "tracking_links",
"type": "[TrackingLink](TrackingLink.mdx)[]",
"type": "[TrackingLink](entities.TrackingLink.mdx)[]",
"description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.",
"optional": false,
"defaultValue": "",
@@ -291,4 +292,4 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/classes/User.mdx → www/apps/docs/content/references/entities/classes/entities.User.mdx
+3 -2
View File
@@ -1,5 +1,6 @@
---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/User
---
import ParameterTypes from "@site/src/components/ParameterTypes"
@@ -94,7 +95,7 @@ A User is an administrator who can manage store settings and data.
},
{
"name": "role",
"type": "[UserRoles](../enums/UserRoles.mdx)",
"type": "[UserRoles](../enums/entities.UserRoles.mdx)",
"description": "The user's role. These roles don't provide any different privileges.",
"optional": false,
"defaultValue": "member",
@@ -138,4 +139,4 @@ A User is an administrator who can manage store settings and data.
"expandable": false,
"children": []
}
]} />
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
www/apps/docs/content/references/entities/enums/BatchJobStatus.mdx
-49
View File
@@ -1,49 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# BatchJobStatus
## Enumeration Members
### CANCELED
**CANCELED** = `"canceled"`
___
### COMPLETED
**COMPLETED** = `"completed"`
___
### CONFIRMED
**CONFIRMED** = `"confirmed"`
___
### CREATED
**CREATED** = `"created"`
___
### FAILED
**FAILED** = `"failed"`
___
### PRE\_PROCESSED
**PRE\_PROCESSED** = `"pre_processed"`
___
### PROCESSING
**PROCESSING** = `"processing"`
www/apps/docs/content/references/entities/enums/PriceListStatus.mdx
-19
View File
@@ -1,19 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# PriceListStatus
## Enumeration Members
### ACTIVE
**ACTIVE** = `"active"`
___
### DRAFT
**DRAFT** = `"draft"`
www/apps/docs/content/references/entities/enums/PriceListType.mdx
-19
View File
@@ -1,19 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# PriceListType
## Enumeration Members
### OVERRIDE
**OVERRIDE** = `"override"`
___
### SALE
**SALE** = `"sale"`
www/apps/docs/content/references/entities/enums/AllocationType.mdx → www/apps/docs/content/references/entities/enums/entities.AllocationType.mdx
View File
File renamed without changes.
www/apps/docs/content/references/entities/enums/CartType.mdx → www/apps/docs/content/references/entities/enums/entities.CartType.mdx
View File
File renamed without changes.
www/apps/docs/content/references/entities/enums/ClaimFulfillmentStatus.mdx → www/apps/docs/content/references/entities/enums/entities.ClaimFulfillmentStatus.mdx
View File
File renamed without changes.
www/apps/docs/content/references/entities/enums/ClaimPaymentStatus.mdx → www/apps/docs/content/references/entities/enums/entities.ClaimPaymentStatus.mdx
View File
File renamed without changes.
www/apps/docs/content/references/entities/enums/ClaimReason.mdx → www/apps/docs/content/references/entities/enums/entities.ClaimReason.mdx
View File
File renamed without changes.
www/apps/docs/content/references/entities/enums/ClaimType.mdx → www/apps/docs/content/references/entities/enums/entities.ClaimType.mdx
View File
File renamed without changes.
www/apps/docs/content/references/entities/enums/DiscountConditionOperator.mdx → www/apps/docs/content/references/entities/enums/entities.DiscountConditionOperator.mdx
View File
File renamed without changes.
www/apps/docs/content/references/entities/enums/DiscountConditionType.mdx → www/apps/docs/content/references/entities/enums/entities.DiscountConditionType.mdx
View File
File renamed without changes.
www/apps/docs/content/references/entities/enums/DiscountRuleType.mdx → www/apps/docs/content/references/entities/enums/entities.DiscountRuleType.mdx
View File
File renamed without changes.
www/apps/docs/content/references/entities/enums/DraftOrderStatus.mdx → www/apps/docs/content/references/entities/enums/entities.DraftOrderStatus.mdx
View File
File renamed without changes.
www/apps/docs/content/references/entities/enums/FulfillmentStatus.mdx → www/apps/docs/content/references/entities/enums/entities.FulfillmentStatus.mdx
View File
File renamed without changes.
www/apps/docs/content/references/entities/enums/OrderEditItemChangeType.mdx → www/apps/docs/content/references/entities/enums/entities.OrderEditItemChangeType.mdx
View File
File renamed without changes.
www/apps/docs/content/references/entities/enums/OrderEditStatus.mdx → www/apps/docs/content/references/entities/enums/entities.OrderEditStatus.mdx
View File
File renamed without changes.
Loaded 100 of 4358 files, more files were not shown because too many files have changed in this diff. Show more