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

docs: update docusaurus to v3 (#5625)

Browse Source 
* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
This commit is contained in:
Shahed Nasser authored and GitHub committed 2023-11-13 20:11:50 +02:00
1 parent cedab58339
commit c6dff873de
2265 files changed
+46163 -47195
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/docs/content/references/entities/classes/Address.mdx
+3 -3
View File
@@ -49,7 +49,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](Country.mdx)",
"description": "A country object.",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,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](Customer.mdx)",
"description": "Available if the relation `customer` is expanded.",
"optional": false,
"defaultValue": "",
@@ -130,7 +130,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/BatchJob.mdx
+8 -8
View File
@@ -40,7 +40,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "context",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The context of the batch job, the type of the batch job determines what the context should contain.",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,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](User.mdx)",
"description": "The details of the user that created the batch job.",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -156,7 +156,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/UserRoles.mdx)",
"description": "The user's role. These roles don't provide any different privileges.",
"optional": false,
"defaultValue": "member",
@@ -230,7 +230,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": "`&#123; 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)[] &#125;` & `Record<string, unknown>`",
"description": "The result of the batch job.",
"optional": false,
"defaultValue": "",
@@ -256,7 +256,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](../types/BatchJobResultError.mdx))[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -292,7 +292,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](../types/BatchJobResultStatDescriptor.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -303,7 +303,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "status",
"type": "[`BatchJobStatus`](../enums/BatchJobStatus.mdx)",
"type": "[BatchJobStatus](../enums/BatchJobStatus.mdx)",
"description": "The status of the batch job.",
"optional": false,
"defaultValue": "created",
www/apps/docs/content/references/entities/classes/Cart.mdx
+15 -15
View File
@@ -13,7 +13,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](Address.mdx)",
"description": "The details of the billing address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -40,7 +40,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "context",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The context of the cart which can include info like IP or user agent.",
"optional": false,
"defaultValue": "",
@@ -58,7 +58,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](Customer.mdx)",
"description": "The details of the customer the cart belongs to.",
"optional": false,
"defaultValue": "",
@@ -94,7 +94,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](Discount.mdx)[]",
"description": "An array of details of all discounts applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -130,7 +130,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](GiftCard.mdx)[]",
"description": "An array of details of all gift cards applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -166,7 +166,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](LineItem.mdx)[]",
"description": "The line items added to the cart.",
"optional": false,
"defaultValue": "",
@@ -175,7 +175,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -193,7 +193,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](Payment.mdx)",
"description": "The details of the payment associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -220,7 +220,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](PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -229,7 +229,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](PaymentSession.mdx)[]",
"description": "The details of all payment sessions created on the cart.",
"optional": false,
"defaultValue": "",
@@ -265,7 +265,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](Region.mdx)",
"description": "The details of the region associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -283,7 +283,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](SalesChannel.mdx)",
"description": "The details of the sales channel associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -301,7 +301,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](Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -319,7 +319,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](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods added to the cart.",
"optional": false,
"defaultValue": "",
@@ -373,7 +373,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/CartType.mdx)",
"description": "The cart's type.",
"optional": false,
"defaultValue": "default",
www/apps/docs/content/references/entities/classes/ClaimImage.mdx
+9 -9
View File
@@ -13,7 +13,7 @@ The details of an image attached to a claim.
<ParameterTypes parameters={[
{
"name": "claim_item",
"type": "[`ClaimItem`](ClaimItem.mdx)",
"type": "[ClaimItem](ClaimItem.mdx)",
"description": "The details of the claim item this image is associated with.",
"optional": false,
"defaultValue": "",
@@ -21,7 +21,7 @@ The details of an image attached to a claim.
"children": [
{
"name": "claim_order",
"type": "[`ClaimOrder`](ClaimOrder.mdx)",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"description": "The details of the claim this item belongs to.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,7 @@ The details of an image attached to a claim.
},
{
"name": "images",
"type": "[`ClaimImage`](ClaimImage.mdx)[]",
"type": "[ClaimImage](ClaimImage.mdx)[]",
"description": "The claim images that are attached to the claim item.",
"optional": false,
"defaultValue": "",
@@ -75,7 +75,7 @@ The details of an image attached to a claim.
},
{
"name": "item",
"type": "[`LineItem`](LineItem.mdx)",
"type": "[LineItem](LineItem.mdx)",
"description": "The details of the line item in the original order that this claim item refers to.",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ The details of an image attached to a claim.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -120,7 +120,7 @@ The details of an image attached to a claim.
},
{
"name": "reason",
"type": "[`ClaimReason`](../enums/ClaimReason.mdx)",
"type": "[ClaimReason](../enums/ClaimReason.mdx)",
"description": "The reason for the claim",
"optional": false,
"defaultValue": "",
@@ -129,7 +129,7 @@ The details of an image attached to a claim.
},
{
"name": "tags",
"type": "[`ClaimTag`](ClaimTag.mdx)[]",
"type": "[ClaimTag](ClaimTag.mdx)[]",
"description": "User defined tags for easy filtering and grouping.",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,7 @@ The details of an image attached to a claim.
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant to potentially replace the item in the original order.",
"optional": false,
"defaultValue": "",
@@ -203,7 +203,7 @@ The details of an image attached to a claim.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ClaimItem.mdx
+37 -37
View File
@@ -13,7 +13,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](ClaimOrder.mdx)",
"description": "The details of the claim this item belongs to.",
"optional": false,
"defaultValue": "",
@@ -21,7 +21,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](LineItem.mdx)[]",
"description": "The details of the new items to be shipped when the claim's type is `replace`",
"optional": false,
"defaultValue": "",
@@ -39,7 +39,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](ClaimItem.mdx)[]",
"description": "The details of the items that should be replaced or refunded.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,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/ClaimFulfillmentStatus.mdx)",
"description": "The claim's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -75,7 +75,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](Fulfillment.mdx)[]",
"description": "The fulfillments of the new items to be shipped",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -120,7 +120,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](Order.mdx)",
"description": "The details of the order that this claim was created for.",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,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/ClaimPaymentStatus.mdx)",
"description": "The status of the claim's payment",
"optional": false,
"defaultValue": "na",
@@ -156,7 +156,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](Return.mdx)",
"description": "The details of the return associated with the claim if the claim's type is `replace`.",
"optional": false,
"defaultValue": "",
@@ -165,7 +165,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](Address.mdx)",
"description": "The details of the address that new items should be shipped to.",
"optional": false,
"defaultValue": "",
@@ -183,7 +183,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](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods that the claim order will be shipped with.",
"optional": false,
"defaultValue": "",
@@ -192,7 +192,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/ClaimType.mdx)",
"description": "The claim's type",
"optional": false,
"defaultValue": "",
@@ -248,7 +248,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](ClaimImage.mdx)[]",
"description": "The claim images that are attached to the claim item.",
"optional": false,
"defaultValue": "",
@@ -256,7 +256,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](ClaimItem.mdx)",
"description": "The details of the claim item this image is associated with.",
"optional": false,
"defaultValue": "",
@@ -301,7 +301,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -330,7 +330,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](LineItem.mdx)",
"description": "The details of the line item in the original order that this claim item refers to.",
"optional": false,
"defaultValue": "",
@@ -338,7 +338,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](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 +356,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](Cart.mdx)",
"description": "The details of the cart that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -374,7 +374,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](ClaimOrder.mdx)",
"description": "The details of the claim that the line item may belong to.",
"optional": false,
"defaultValue": "",
@@ -456,7 +456,7 @@ A claim item is an item created as part of a claim. It references an item in the
{
"name": "includes_tax",
"type": "`boolean`",
"description": "Indicates if the line item unit_price include tax",
"description": "Indicates if the line item unit\\_price include tax",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -483,7 +483,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -492,7 +492,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](Order.mdx)",
"description": "The details of the order that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -501,7 +501,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](OrderEdit.mdx)",
"description": "The details of the order edit.",
"optional": true,
"defaultValue": "",
@@ -627,7 +627,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](Swap.mdx)",
"description": "The details of the swap that the line item may belong to.",
"optional": false,
"defaultValue": "",
@@ -645,7 +645,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](LineItemTaxLine.mdx)[]",
"description": "The details of the item's tax lines.",
"optional": false,
"defaultValue": "",
@@ -708,7 +708,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](ProductVariant.mdx)",
"description": "The details of the product variant that this item was created from.",
"optional": false,
"defaultValue": "",
@@ -737,7 +737,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -764,7 +764,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/ClaimReason.mdx)",
"description": "The reason for the claim",
"optional": false,
"defaultValue": "",
@@ -810,7 +810,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](ClaimTag.mdx)[]",
"description": "User defined tags for easy filtering and grouping.",
"optional": false,
"defaultValue": "",
@@ -845,7 +845,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -883,7 +883,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](ProductVariant.mdx)",
"description": "The details of the product variant to potentially replace the item in the original order.",
"optional": false,
"defaultValue": "",
@@ -892,7 +892,7 @@ A claim item is an item created as part of a claim. It references an item in the
{
"name": "allow_backorder",
"type": "`boolean`",
"description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.",
"description": "Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -963,7 +963,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](ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -1008,7 +1008,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1026,7 +1026,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](ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -1044,7 +1044,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](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 +1053,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](Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ClaimOrder.mdx
+11 -11
View File
@@ -13,7 +13,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](LineItem.mdx)[]",
"description": "The details of the new items to be shipped when the claim's type is `replace`",
"optional": false,
"defaultValue": "",
@@ -31,7 +31,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](ClaimItem.mdx)[]",
"description": "The details of the items that should be replaced or refunded.",
"optional": false,
"defaultValue": "",
@@ -58,7 +58,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/ClaimFulfillmentStatus.mdx)",
"description": "The claim's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -67,7 +67,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The fulfillments of the new items to be shipped",
"optional": false,
"defaultValue": "",
@@ -94,7 +94,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -112,7 +112,7 @@ A Claim represents a group of faulty or missing items. It consists of claim item
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that this claim was created for.",
"optional": false,
"defaultValue": "",
@@ -130,7 +130,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/ClaimPaymentStatus.mdx)",
"description": "The status of the claim's payment",
"optional": false,
"defaultValue": "na",
@@ -148,7 +148,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](Return.mdx)",
"description": "The details of the return associated with the claim if the claim's type is `replace`.",
"optional": false,
"defaultValue": "",
@@ -157,7 +157,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](Address.mdx)",
"description": "The details of the address that new items should be shipped to.",
"optional": false,
"defaultValue": "",
@@ -175,7 +175,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](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods that the claim order will be shipped with.",
"optional": false,
"defaultValue": "",
@@ -184,7 +184,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/ClaimType.mdx)",
"description": "The claim's type",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ClaimTag.mdx
+1 -1
View File
@@ -40,7 +40,7 @@ Claim Tags are user defined tags that can be assigned to claim items for easy fi
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Country.mdx
+8 -8
View File
@@ -67,7 +67,7 @@ Country details
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region the country is associated with.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ Country details
},
{
"name": "countries",
"type": "[`Country`](Country.mdx)[]",
"type": "[Country](Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ Country details
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -129,7 +129,7 @@ Country details
},
{
"name": "fulfillment_providers",
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]",
"type": "[FulfillmentProvider](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": "",
@@ -166,7 +166,7 @@ Country details
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -184,7 +184,7 @@ Country details
},
{
"name": "payment_providers",
"type": "[`PaymentProvider`](PaymentProvider.mdx)[]",
"type": "[PaymentProvider](PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -202,7 +202,7 @@ Country details
},
{
"name": "tax_provider",
"type": "[`TaxProvider`](TaxProvider.mdx)",
"type": "[TaxProvider](TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
@@ -229,7 +229,7 @@ Country details
},
{
"name": "tax_rates",
"type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]",
"type": "``null`` \\| [TaxRate](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/CustomShippingOption.mdx
+27 -27
View File
@@ -13,7 +13,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
<ParameterTypes parameters={[
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart this shipping option belongs to.",
"optional": false,
"defaultValue": "",
@@ -21,7 +21,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
"children": [
{
"name": "billing_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the billing address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -48,7 +48,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "context",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The context of the cart which can include info like IP or user agent.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer the cart belongs to.",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "discounts",
"type": "[`Discount`](Discount.mdx)[]",
"type": "[Discount](Discount.mdx)[]",
"description": "An array of details of all discounts applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "gift_cards",
"type": "[`GiftCard`](GiftCard.mdx)[]",
"type": "[GiftCard](GiftCard.mdx)[]",
"description": "An array of details of all gift cards applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -174,7 +174,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The line items added to the cart.",
"optional": false,
"defaultValue": "",
@@ -183,7 +183,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -201,7 +201,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "payment",
"type": "[`Payment`](Payment.mdx)",
"type": "[Payment](Payment.mdx)",
"description": "The details of the payment associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -228,7 +228,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "payment_session",
"type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)",
"type": "``null`` \\| [PaymentSession](PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -237,7 +237,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "payment_sessions",
"type": "[`PaymentSession`](PaymentSession.mdx)[]",
"type": "[PaymentSession](PaymentSession.mdx)[]",
"description": "The details of all payment sessions created on the cart.",
"optional": false,
"defaultValue": "",
@@ -273,7 +273,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -291,7 +291,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "sales_channel",
"type": "[`SalesChannel`](SalesChannel.mdx)",
"type": "[SalesChannel](SalesChannel.mdx)",
"description": "The details of the sales channel associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -309,7 +309,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "shipping_address",
"type": "``null`` \\| [`Address`](Address.mdx)",
"type": "``null`` \\| [Address](Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -327,7 +327,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods added to the cart.",
"optional": false,
"defaultValue": "",
@@ -381,7 +381,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "type",
"type": "[`CartType`](../enums/CartType.mdx)",
"type": "[CartType](../enums/CartType.mdx)",
"description": "The cart's type.",
"optional": false,
"defaultValue": "default",
@@ -437,7 +437,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -455,7 +455,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "shipping_option",
"type": "[`ShippingOption`](ShippingOption.mdx)",
"type": "[ShippingOption](ShippingOption.mdx)",
"description": "The details of the overridden shipping options.",
"optional": false,
"defaultValue": "",
@@ -473,7 +473,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
{
"name": "amount",
"type": "``null`` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat_rate`.",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -490,7 +490,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data needed for the Fulfillment Provider to identify the Shipping Option.",
"optional": false,
"defaultValue": "",
@@ -536,7 +536,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -554,8 +554,8 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "price_type",
"type": "[`ShippingOptionPriceType`](../enums/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.",
"type": "[ShippingOptionPriceType](../enums/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": "",
"expandable": false,
@@ -563,7 +563,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "profile",
"type": "[`ShippingProfile`](ShippingProfile.mdx)",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"description": "The details of the shipping profile that the shipping option belongs to.",
"optional": false,
"defaultValue": "",
@@ -581,7 +581,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "provider",
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)",
"type": "[FulfillmentProvider](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 +599,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this shipping option can be used in.",
"optional": false,
"defaultValue": "",
@@ -617,7 +617,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "requirements",
"type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]",
"type": "[ShippingOptionRequirement](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": "",
www/apps/docs/content/references/entities/classes/Customer.mdx
+39 -39
View File
@@ -13,7 +13,7 @@ A customer can make purchases in your store and manage their profile.
<ParameterTypes parameters={[
{
"name": "billing_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the billing address associated with the customer.",
"optional": false,
"defaultValue": "",
@@ -57,7 +57,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "country",
"type": "``null`` \\| [`Country`](Country.mdx)",
"type": "``null`` \\| [Country](Country.mdx)",
"description": "A country object.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "customer",
"type": "``null`` \\| [`Customer`](Customer.mdx)",
"type": "``null`` \\| [Customer](Customer.mdx)",
"description": "Available if the relation `customer` is expanded.",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -230,7 +230,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "groups",
"type": "[`CustomerGroup`](CustomerGroup.mdx)[]",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"description": "The customer groups the customer belongs to.",
"optional": false,
"defaultValue": "",
@@ -247,7 +247,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "customers",
"type": "[`Customer`](Customer.mdx)[]",
"type": "[Customer](Customer.mdx)[]",
"description": "The details of the customers that belong to the customer group.",
"optional": false,
"defaultValue": "",
@@ -274,7 +274,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -292,7 +292,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "price_lists",
"type": "[`PriceList`](PriceList.mdx)[]",
"type": "[PriceList](PriceList.mdx)[]",
"description": "The price lists that are associated with the customer group.",
"optional": false,
"defaultValue": "",
@@ -339,7 +339,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -348,7 +348,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "orders",
"type": "[`Order`](Order.mdx)[]",
"type": "[Order](Order.mdx)[]",
"description": "The details of the orders this customer placed.",
"optional": false,
"defaultValue": "",
@@ -356,7 +356,7 @@ A customer can make purchases in your store and manage their profile.
"children": [
{
"name": "billing_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -383,7 +383,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -401,7 +401,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "claims",
"type": "[`ClaimOrder`](ClaimOrder.mdx)[]",
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -419,7 +419,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -437,7 +437,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -464,7 +464,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "discounts",
"type": "[`Discount`](Discount.mdx)[]",
"type": "[Discount](Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -482,7 +482,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "draft_order",
"type": "[`DraftOrder`](DraftOrder.mdx)",
"type": "[DraftOrder](DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -500,7 +500,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "edits",
"type": "[`OrderEdit`](OrderEdit.mdx)[]",
"type": "[OrderEdit](OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -527,7 +527,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "fulfillment_status",
"type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)",
"type": "[FulfillmentStatus](../enums/FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -536,7 +536,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -563,7 +563,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "gift_card_transactions",
"type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]",
"type": "[GiftCardTransaction](GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -572,7 +572,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "gift_cards",
"type": "[`GiftCard`](GiftCard.mdx)[]",
"type": "[GiftCard](GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -608,7 +608,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -617,7 +617,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -653,7 +653,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "payment_status",
"type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)",
"type": "[PaymentStatus](../enums/PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -662,7 +662,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "payments",
"type": "[`Payment`](Payment.mdx)[]",
"type": "[Payment](Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -698,7 +698,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "refunds",
"type": "[`Refund`](Refund.mdx)[]",
"type": "[Refund](Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -707,7 +707,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -725,7 +725,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "returnable_items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](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 +734,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "returns",
"type": "[`Return`](Return.mdx)[]",
"type": "[Return](Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -743,7 +743,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "sales_channel",
"type": "[`SalesChannel`](SalesChannel.mdx)",
"type": "[SalesChannel](SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -761,7 +761,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "shipping_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -779,7 +779,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -806,7 +806,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "status",
"type": "[`OrderStatus`](../enums/OrderStatus.mdx)",
"type": "[OrderStatus](../enums/OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -824,7 +824,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "swaps",
"type": "[`Swap`](Swap.mdx)[]",
"type": "[Swap](Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
@@ -889,7 +889,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "shipping_addresses",
"type": "[`Address`](Address.mdx)[]",
"type": "[Address](Address.mdx)[]",
"description": "The details of the shipping addresses associated with the customer.",
"optional": false,
"defaultValue": "",
@@ -933,7 +933,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "country",
"type": "``null`` \\| [`Country`](Country.mdx)",
"type": "``null`` \\| [Country](Country.mdx)",
"description": "A country object.",
"optional": false,
"defaultValue": "",
@@ -960,7 +960,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "customer",
"type": "``null`` \\| [`Customer`](Customer.mdx)",
"type": "``null`` \\| [Customer](Customer.mdx)",
"description": "Available if the relation `customer` is expanded.",
"optional": false,
"defaultValue": "",
@@ -1014,7 +1014,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/CustomerGroup.mdx
+12 -12
View File
@@ -22,7 +22,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "customers",
"type": "[`Customer`](Customer.mdx)[]",
"type": "[Customer](Customer.mdx)[]",
"description": "The details of the customers that belong to the customer group.",
"optional": false,
"defaultValue": "",
@@ -30,7 +30,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](Address.mdx)",
"description": "The details of the billing address associated with the customer.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "groups",
"type": "[`CustomerGroup`](CustomerGroup.mdx)[]",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"description": "The customer groups the customer belongs to.",
"optional": false,
"defaultValue": "",
@@ -120,7 +120,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -129,7 +129,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "orders",
"type": "[`Order`](Order.mdx)[]",
"type": "[Order](Order.mdx)[]",
"description": "The details of the orders this customer placed.",
"optional": false,
"defaultValue": "",
@@ -156,7 +156,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](Address.mdx)[]",
"description": "The details of the shipping addresses associated with the customer.",
"optional": false,
"defaultValue": "",
@@ -194,7 +194,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -212,7 +212,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](PriceList.mdx)[]",
"description": "The price lists that are associated with the customer group.",
"optional": false,
"defaultValue": "",
@@ -229,7 +229,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](CustomerGroup.mdx)[]",
"description": "The details of the customer groups that the Price List can apply to.",
"optional": false,
"defaultValue": "",
@@ -293,7 +293,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "prices",
"type": "[`MoneyAmount`](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](MoneyAmount.mdx)[]",
"description": "The prices that belong to the price list, represented as a Money Amount.",
"optional": false,
"defaultValue": "",
@@ -311,7 +311,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](../enums/PriceListStatus.mdx)",
"description": "The status of the Price List",
"optional": false,
"defaultValue": "draft",
@@ -320,7 +320,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](../enums/PriceListType.mdx)",
"description": "The type of Price List. This can be one of either `sale` or `override`.",
"optional": false,
"defaultValue": "sale",
www/apps/docs/content/references/entities/classes/Discount.mdx
+20 -20
View File
@@ -76,7 +76,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "parent_discount",
"type": "[`Discount`](Discount.mdx)",
"type": "[Discount](Discount.mdx)",
"description": "The details of the parent discount that this discount was created from.",
"optional": false,
"defaultValue": "",
@@ -156,7 +156,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -165,7 +165,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "parent_discount",
"type": "[`Discount`](Discount.mdx)",
"type": "[Discount](Discount.mdx)",
"description": "The details of the parent discount that this discount was created from.",
"optional": false,
"defaultValue": "",
@@ -183,7 +183,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "regions",
"type": "[`Region`](Region.mdx)[]",
"type": "[Region](Region.mdx)[]",
"description": "The details of the regions in which the Discount can be used.",
"optional": false,
"defaultValue": "",
@@ -192,7 +192,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "rule",
"type": "[`DiscountRule`](DiscountRule.mdx)",
"type": "[DiscountRule](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 +266,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "regions",
"type": "[`Region`](Region.mdx)[]",
"type": "[Region](Region.mdx)[]",
"description": "The details of the regions in which the Discount can be used.",
"optional": false,
"defaultValue": "",
@@ -283,7 +283,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "countries",
"type": "[`Country`](Country.mdx)[]",
"type": "[Country](Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -301,7 +301,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -328,7 +328,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "fulfillment_providers",
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]",
"type": "[FulfillmentProvider](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": "",
@@ -365,7 +365,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -383,7 +383,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "payment_providers",
"type": "[`PaymentProvider`](PaymentProvider.mdx)[]",
"type": "[PaymentProvider](PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -401,7 +401,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "tax_provider",
"type": "[`TaxProvider`](TaxProvider.mdx)",
"type": "[TaxProvider](TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
@@ -428,7 +428,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "tax_rates",
"type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]",
"type": "``null`` \\| [TaxRate](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -448,7 +448,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "rule",
"type": "[`DiscountRule`](DiscountRule.mdx)",
"type": "[DiscountRule](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 +456,7 @@ A discount can be applied to a cart for promotional purposes.
"children": [
{
"name": "allocation",
"type": "[`AllocationType`](../enums/AllocationType.mdx)",
"type": "[AllocationType](../enums/AllocationType.mdx)",
"description": "The scope that the discount should apply to.",
"optional": false,
"defaultValue": "",
@@ -465,7 +465,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "conditions",
"type": "[`DiscountCondition`](DiscountCondition.mdx)[]",
"type": "[DiscountCondition](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": "",
@@ -510,7 +510,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -519,8 +519,8 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "type",
"type": "[`DiscountRuleType`](../enums/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.",
"type": "[DiscountRuleType](../enums/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": "",
"expandable": false,
www/apps/docs/content/references/entities/classes/DiscountCondition.mdx
+38 -38
View File
@@ -22,8 +22,8 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "customer_groups",
"type": "[`CustomerGroup`](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer_groups`.",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer\\_groups`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -39,7 +39,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "customers",
"type": "[`Customer`](Customer.mdx)[]",
"type": "[Customer](Customer.mdx)[]",
"description": "The details of the customers that belong to the customer group.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "price_lists",
"type": "[`PriceList`](PriceList.mdx)[]",
"type": "[PriceList](PriceList.mdx)[]",
"description": "The price lists that are associated with the customer group.",
"optional": false,
"defaultValue": "",
@@ -113,7 +113,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "discount_rule",
"type": "[`DiscountRule`](DiscountRule.mdx)",
"type": "[DiscountRule](DiscountRule.mdx)",
"description": "The details of the discount rule associated with the condition.",
"optional": false,
"defaultValue": "",
@@ -121,7 +121,7 @@ Holds rule conditions for when a discount is applicable
"children": [
{
"name": "allocation",
"type": "[`AllocationType`](../enums/AllocationType.mdx)",
"type": "[AllocationType](../enums/AllocationType.mdx)",
"description": "The scope that the discount should apply to.",
"optional": false,
"defaultValue": "",
@@ -130,7 +130,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "conditions",
"type": "[`DiscountCondition`](DiscountCondition.mdx)[]",
"type": "[DiscountCondition](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": "",
@@ -175,7 +175,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -184,8 +184,8 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "type",
"type": "[`DiscountRuleType`](../enums/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.",
"type": "[DiscountRuleType](../enums/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": "",
"expandable": false,
@@ -231,7 +231,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -240,8 +240,8 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "operator",
"type": "[`DiscountConditionOperator`](../enums/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.",
"type": "[DiscountConditionOperator](../enums/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": "",
"expandable": false,
@@ -268,8 +268,8 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "product_collections",
"type": "[`ProductCollection`](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product_collections`.",
"type": "[ProductCollection](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product\\_collections`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -312,7 +312,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -321,7 +321,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "The details of the products that belong to this product collection.",
"optional": false,
"defaultValue": "",
@@ -350,8 +350,8 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "product_tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product_tags`.",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product\\_tags`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -385,7 +385,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -414,8 +414,8 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "product_types",
"type": "[`ProductType`](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product_types`.",
"type": "[ProductType](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product\\_types`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -449,7 +449,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -478,7 +478,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "products associated with this condition if `type` is `products`.",
"optional": false,
"defaultValue": "",
@@ -486,7 +486,7 @@ Holds rule conditions for when a discount is applicable
"children": [
{
"name": "categories",
"type": "[`ProductCategory`](ProductCategory.mdx)[]",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -496,7 +496,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "collection",
"type": "[`ProductCollection`](ProductCollection.mdx)",
"type": "[ProductCollection](ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -595,7 +595,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "images",
"type": "[`Image`](Image.mdx)[]",
"type": "[Image](Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -631,7 +631,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -649,7 +649,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "options",
"type": "[`ProductOption`](ProductOption.mdx)[]",
"type": "[ProductOption](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 +667,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "profile",
"type": "[`ShippingProfile`](ShippingProfile.mdx)",
"type": "[ShippingProfile](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 +685,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "profiles",
"type": "[`ShippingProfile`](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -694,7 +694,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "sales_channels",
"type": "[`SalesChannel`](SalesChannel.mdx)[]",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -703,7 +703,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "status",
"type": "[`ProductStatus`](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -721,7 +721,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -748,7 +748,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "type",
"type": "[`ProductType`](ProductType.mdx)",
"type": "[ProductType](ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -775,7 +775,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](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 +804,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "type",
"type": "[`DiscountConditionType`](../enums/DiscountConditionType.mdx)",
"type": "[DiscountConditionType](../enums/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": "",
www/apps/docs/content/references/entities/classes/DiscountConditionCustomerGroup.mdx
+22 -22
View File
@@ -31,8 +31,8 @@ Associates a discount condition with a customer group
},
{
"name": "customer_group",
"type": "[`CustomerGroup`](CustomerGroup.mdx)",
"description": "Available if the relation `customer_group` is expanded.",
"type": "[CustomerGroup](CustomerGroup.mdx)",
"description": "Available if the relation `customer\\_group` is expanded.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -48,7 +48,7 @@ Associates a discount condition with a customer group
},
{
"name": "customers",
"type": "[`Customer`](Customer.mdx)[]",
"type": "[Customer](Customer.mdx)[]",
"description": "The details of the customers that belong to the customer group.",
"optional": false,
"defaultValue": "",
@@ -75,7 +75,7 @@ Associates a discount condition with a customer group
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ Associates a discount condition with a customer group
},
{
"name": "price_lists",
"type": "[`PriceList`](PriceList.mdx)[]",
"type": "[PriceList](PriceList.mdx)[]",
"description": "The price lists that are associated with the customer group.",
"optional": false,
"defaultValue": "",
@@ -122,8 +122,8 @@ Associates a discount condition with a customer group
},
{
"name": "discount_condition",
"type": "[`DiscountCondition`](DiscountCondition.mdx)",
"description": "Available if the relation `discount_condition` is expanded.",
"type": "[DiscountCondition](DiscountCondition.mdx)",
"description": "Available if the relation `discount\\_condition` is expanded.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -139,8 +139,8 @@ Associates a discount condition with a customer group
},
{
"name": "customer_groups",
"type": "[`CustomerGroup`](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer_groups`.",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer\\_groups`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -157,7 +157,7 @@ Associates a discount condition with a customer group
},
{
"name": "discount_rule",
"type": "[`DiscountRule`](DiscountRule.mdx)",
"type": "[DiscountRule](DiscountRule.mdx)",
"description": "The details of the discount rule associated with the condition.",
"optional": false,
"defaultValue": "",
@@ -184,7 +184,7 @@ Associates a discount condition with a customer group
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -193,8 +193,8 @@ Associates a discount condition with a customer group
},
{
"name": "operator",
"type": "[`DiscountConditionOperator`](../enums/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.",
"type": "[DiscountConditionOperator](../enums/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": "",
"expandable": false,
@@ -202,8 +202,8 @@ Associates a discount condition with a customer group
},
{
"name": "product_collections",
"type": "[`ProductCollection`](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product_collections`.",
"type": "[ProductCollection](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product\\_collections`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -211,8 +211,8 @@ Associates a discount condition with a customer group
},
{
"name": "product_tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product_tags`.",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product\\_tags`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -220,8 +220,8 @@ Associates a discount condition with a customer group
},
{
"name": "product_types",
"type": "[`ProductType`](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product_types`.",
"type": "[ProductType](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product\\_types`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -229,7 +229,7 @@ Associates a discount condition with a customer group
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "products associated with this condition if `type` is `products`.",
"optional": false,
"defaultValue": "",
@@ -238,7 +238,7 @@ Associates a discount condition with a customer group
},
{
"name": "type",
"type": "[`DiscountConditionType`](../enums/DiscountConditionType.mdx)",
"type": "[DiscountConditionType](../enums/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": "",
@@ -258,7 +258,7 @@ Associates a discount condition with a customer group
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/DiscountConditionProduct.mdx
+29 -29
View File
@@ -31,7 +31,7 @@ This represents the association between a discount condition and a product
},
{
"name": "discount_condition",
"type": "[`DiscountCondition`](DiscountCondition.mdx)",
"type": "[DiscountCondition](DiscountCondition.mdx)",
"description": "The details of the discount condition.",
"optional": true,
"defaultValue": "",
@@ -48,8 +48,8 @@ This represents the association between a discount condition and a product
},
{
"name": "customer_groups",
"type": "[`CustomerGroup`](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer_groups`.",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer\\_groups`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -66,7 +66,7 @@ This represents the association between a discount condition and a product
},
{
"name": "discount_rule",
"type": "[`DiscountRule`](DiscountRule.mdx)",
"type": "[DiscountRule](DiscountRule.mdx)",
"description": "The details of the discount rule associated with the condition.",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ This represents the association between a discount condition and a product
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -102,8 +102,8 @@ This represents the association between a discount condition and a product
},
{
"name": "operator",
"type": "[`DiscountConditionOperator`](../enums/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.",
"type": "[DiscountConditionOperator](../enums/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": "",
"expandable": false,
@@ -111,8 +111,8 @@ This represents the association between a discount condition and a product
},
{
"name": "product_collections",
"type": "[`ProductCollection`](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product_collections`.",
"type": "[ProductCollection](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product\\_collections`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -120,8 +120,8 @@ This represents the association between a discount condition and a product
},
{
"name": "product_tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product_tags`.",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product\\_tags`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -129,8 +129,8 @@ This represents the association between a discount condition and a product
},
{
"name": "product_types",
"type": "[`ProductType`](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product_types`.",
"type": "[ProductType](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product\\_types`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -138,7 +138,7 @@ This represents the association between a discount condition and a product
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "products associated with this condition if `type` is `products`.",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,7 @@ This represents the association between a discount condition and a product
},
{
"name": "type",
"type": "[`DiscountConditionType`](../enums/DiscountConditionType.mdx)",
"type": "[DiscountConditionType](../enums/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": "",
@@ -167,7 +167,7 @@ This represents the association between a discount condition and a product
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -176,7 +176,7 @@ This represents the association between a discount condition and a product
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product.",
"optional": true,
"defaultValue": "",
@@ -184,7 +184,7 @@ This represents the association between a discount condition and a product
"children": [
{
"name": "categories",
"type": "[`ProductCategory`](ProductCategory.mdx)[]",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -194,7 +194,7 @@ This represents the association between a discount condition and a product
},
{
"name": "collection",
"type": "[`ProductCollection`](ProductCollection.mdx)",
"type": "[ProductCollection](ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -293,7 +293,7 @@ This represents the association between a discount condition and a product
},
{
"name": "images",
"type": "[`Image`](Image.mdx)[]",
"type": "[Image](Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -329,7 +329,7 @@ This represents the association between a discount condition and a product
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -347,7 +347,7 @@ This represents the association between a discount condition and a product
},
{
"name": "options",
"type": "[`ProductOption`](ProductOption.mdx)[]",
"type": "[ProductOption](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 +365,7 @@ This represents the association between a discount condition and a product
},
{
"name": "profile",
"type": "[`ShippingProfile`](ShippingProfile.mdx)",
"type": "[ShippingProfile](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 +383,7 @@ This represents the association between a discount condition and a product
},
{
"name": "profiles",
"type": "[`ShippingProfile`](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -392,7 +392,7 @@ This represents the association between a discount condition and a product
},
{
"name": "sales_channels",
"type": "[`SalesChannel`](SalesChannel.mdx)[]",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -401,7 +401,7 @@ This represents the association between a discount condition and a product
},
{
"name": "status",
"type": "[`ProductStatus`](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -419,7 +419,7 @@ This represents the association between a discount condition and a product
},
{
"name": "tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -446,7 +446,7 @@ This represents the association between a discount condition and a product
},
{
"name": "type",
"type": "[`ProductType`](ProductType.mdx)",
"type": "[ProductType](ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -473,7 +473,7 @@ This represents the association between a discount condition and a product
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](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": "",
www/apps/docs/content/references/entities/classes/DiscountConditionProductCollection.mdx
+19 -19
View File
@@ -31,7 +31,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "discount_condition",
"type": "[`DiscountCondition`](DiscountCondition.mdx)",
"type": "[DiscountCondition](DiscountCondition.mdx)",
"description": "The details of the discount condition.",
"optional": true,
"defaultValue": "",
@@ -48,8 +48,8 @@ This represents the association between a discount condition and a product colle
},
{
"name": "customer_groups",
"type": "[`CustomerGroup`](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer_groups`.",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer\\_groups`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -66,7 +66,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "discount_rule",
"type": "[`DiscountRule`](DiscountRule.mdx)",
"type": "[DiscountRule](DiscountRule.mdx)",
"description": "The details of the discount rule associated with the condition.",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -102,8 +102,8 @@ This represents the association between a discount condition and a product colle
},
{
"name": "operator",
"type": "[`DiscountConditionOperator`](../enums/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.",
"type": "[DiscountConditionOperator](../enums/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": "",
"expandable": false,
@@ -111,8 +111,8 @@ This represents the association between a discount condition and a product colle
},
{
"name": "product_collections",
"type": "[`ProductCollection`](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product_collections`.",
"type": "[ProductCollection](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product\\_collections`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -120,8 +120,8 @@ This represents the association between a discount condition and a product colle
},
{
"name": "product_tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product_tags`.",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product\\_tags`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -129,8 +129,8 @@ This represents the association between a discount condition and a product colle
},
{
"name": "product_types",
"type": "[`ProductType`](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product_types`.",
"type": "[ProductType](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product\\_types`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -138,7 +138,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "products associated with this condition if `type` is `products`.",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "type",
"type": "[`DiscountConditionType`](../enums/DiscountConditionType.mdx)",
"type": "[DiscountConditionType](../enums/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": "",
@@ -167,7 +167,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -176,7 +176,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "product_collection",
"type": "[`ProductCollection`](ProductCollection.mdx)",
"type": "[ProductCollection](ProductCollection.mdx)",
"description": "The details of the product collection.",
"optional": true,
"defaultValue": "",
@@ -220,7 +220,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -229,7 +229,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "The details of the products that belong to this product collection.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/DiscountConditionProductTag.mdx
+18 -18
View File
@@ -31,7 +31,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "discount_condition",
"type": "[`DiscountCondition`](DiscountCondition.mdx)",
"type": "[DiscountCondition](DiscountCondition.mdx)",
"description": "The details of the discount condition.",
"optional": true,
"defaultValue": "",
@@ -48,8 +48,8 @@ This represents the association between a discount condition and a product tag
},
{
"name": "customer_groups",
"type": "[`CustomerGroup`](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer_groups`.",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer\\_groups`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -66,7 +66,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "discount_rule",
"type": "[`DiscountRule`](DiscountRule.mdx)",
"type": "[DiscountRule](DiscountRule.mdx)",
"description": "The details of the discount rule associated with the condition.",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -102,8 +102,8 @@ This represents the association between a discount condition and a product tag
},
{
"name": "operator",
"type": "[`DiscountConditionOperator`](../enums/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.",
"type": "[DiscountConditionOperator](../enums/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": "",
"expandable": false,
@@ -111,8 +111,8 @@ This represents the association between a discount condition and a product tag
},
{
"name": "product_collections",
"type": "[`ProductCollection`](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product_collections`.",
"type": "[ProductCollection](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product\\_collections`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -120,8 +120,8 @@ This represents the association between a discount condition and a product tag
},
{
"name": "product_tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product_tags`.",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product\\_tags`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -129,8 +129,8 @@ This represents the association between a discount condition and a product tag
},
{
"name": "product_types",
"type": "[`ProductType`](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product_types`.",
"type": "[ProductType](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product\\_types`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -138,7 +138,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "products associated with this condition if `type` is `products`.",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "type",
"type": "[`DiscountConditionType`](../enums/DiscountConditionType.mdx)",
"type": "[DiscountConditionType](../enums/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": "",
@@ -167,7 +167,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -176,7 +176,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "product_tag",
"type": "[`ProductTag`](ProductTag.mdx)",
"type": "[ProductTag](ProductTag.mdx)",
"description": "The details of the product tag.",
"optional": true,
"defaultValue": "",
@@ -211,7 +211,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/DiscountConditionProductType.mdx
+18 -18
View File
@@ -31,7 +31,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "discount_condition",
"type": "[`DiscountCondition`](DiscountCondition.mdx)",
"type": "[DiscountCondition](DiscountCondition.mdx)",
"description": "The details of the discount condition.",
"optional": true,
"defaultValue": "",
@@ -48,8 +48,8 @@ This represents the association between a discount condition and a product type
},
{
"name": "customer_groups",
"type": "[`CustomerGroup`](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer_groups`.",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer\\_groups`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -66,7 +66,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "discount_rule",
"type": "[`DiscountRule`](DiscountRule.mdx)",
"type": "[DiscountRule](DiscountRule.mdx)",
"description": "The details of the discount rule associated with the condition.",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -102,8 +102,8 @@ This represents the association between a discount condition and a product type
},
{
"name": "operator",
"type": "[`DiscountConditionOperator`](../enums/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.",
"type": "[DiscountConditionOperator](../enums/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": "",
"expandable": false,
@@ -111,8 +111,8 @@ This represents the association between a discount condition and a product type
},
{
"name": "product_collections",
"type": "[`ProductCollection`](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product_collections`.",
"type": "[ProductCollection](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product\\_collections`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -120,8 +120,8 @@ This represents the association between a discount condition and a product type
},
{
"name": "product_tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product_tags`.",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product\\_tags`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -129,8 +129,8 @@ This represents the association between a discount condition and a product type
},
{
"name": "product_types",
"type": "[`ProductType`](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product_types`.",
"type": "[ProductType](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product\\_types`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -138,7 +138,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "products associated with this condition if `type` is `products`.",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "type",
"type": "[`DiscountConditionType`](../enums/DiscountConditionType.mdx)",
"type": "[DiscountConditionType](../enums/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": "",
@@ -167,7 +167,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -176,7 +176,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "product_type",
"type": "[`ProductType`](ProductType.mdx)",
"type": "[ProductType](ProductType.mdx)",
"description": "The details of the product type.",
"optional": true,
"defaultValue": "",
@@ -211,7 +211,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/DiscountRule.mdx
+19 -19
View File
@@ -13,7 +13,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/AllocationType.mdx)",
"description": "The scope that the discount should apply to.",
"optional": false,
"defaultValue": "",
@@ -41,7 +41,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "conditions",
"type": "[`DiscountCondition`](DiscountCondition.mdx)[]",
"type": "[DiscountCondition](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,8 +58,8 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "customer_groups",
"type": "[`CustomerGroup`](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer_groups`.",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"description": "Customer groups associated with this condition if `type` is `customer\\_groups`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -76,7 +76,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "discount_rule",
"type": "[`DiscountRule`](DiscountRule.mdx)",
"type": "[DiscountRule](DiscountRule.mdx)",
"description": "The details of the discount rule associated with the condition.",
"optional": false,
"defaultValue": "",
@@ -103,7 +103,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -112,8 +112,8 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "operator",
"type": "[`DiscountConditionOperator`](../enums/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.",
"type": "[DiscountConditionOperator](../enums/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": "",
"expandable": false,
@@ -121,8 +121,8 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "product_collections",
"type": "[`ProductCollection`](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product_collections`.",
"type": "[ProductCollection](ProductCollection.mdx)[]",
"description": "Product collections associated with this condition if `type` is `product\\_collections`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -130,8 +130,8 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "product_tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product_tags`.",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "Product tags associated with this condition if `type` is `product\\_tags`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -139,8 +139,8 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "product_types",
"type": "[`ProductType`](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product_types`.",
"type": "[ProductType](ProductType.mdx)[]",
"description": "Product types associated with this condition if `type` is `product\\_types`.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -148,7 +148,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "products associated with this condition if `type` is `products`.",
"optional": false,
"defaultValue": "",
@@ -157,7 +157,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/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": "",
@@ -213,7 +213,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -222,8 +222,8 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "type",
"type": "[`DiscountRuleType`](../enums/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.",
"type": "[DiscountRuleType](../enums/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": "",
"expandable": false,
www/apps/docs/content/references/entities/classes/DraftOrder.mdx
+4 -4
View File
@@ -22,7 +22,7 @@ A draft order is created by an admin without direct involvement of the customer.
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart associated with the draft order.",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ A draft order is created by an admin without direct involvement of the customer.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -103,7 +103,7 @@ A draft order is created by an admin without direct involvement of the customer.
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order created from the draft order when its payment is captured.",
"optional": false,
"defaultValue": "",
@@ -121,7 +121,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/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",
www/apps/docs/content/references/entities/classes/Fulfillment.mdx
+61 -61
View File
@@ -22,7 +22,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "claim_order",
"type": "[`ClaimOrder`](ClaimOrder.mdx)",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"description": "The details of the claim that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -30,7 +30,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
"children": [
{
"name": "additional_items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the new items to be shipped when the claim's type is `replace`",
"optional": false,
"defaultValue": "",
@@ -48,7 +48,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "claim_items",
"type": "[`ClaimItem`](ClaimItem.mdx)[]",
"type": "[ClaimItem](ClaimItem.mdx)[]",
"description": "The details of the items that should be replaced or refunded.",
"optional": false,
"defaultValue": "",
@@ -75,7 +75,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/ClaimFulfillmentStatus.mdx)",
"description": "The claim's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -84,7 +84,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The fulfillments of the new items to be shipped",
"optional": false,
"defaultValue": "",
@@ -111,7 +111,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -129,7 +129,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that this claim was created for.",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,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/ClaimPaymentStatus.mdx)",
"description": "The status of the claim's payment",
"optional": false,
"defaultValue": "na",
@@ -165,7 +165,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "return_order",
"type": "[`Return`](Return.mdx)",
"type": "[Return](Return.mdx)",
"description": "The details of the return associated with the claim if the claim's type is `replace`.",
"optional": false,
"defaultValue": "",
@@ -174,7 +174,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "shipping_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the address that new items should be shipped to.",
"optional": false,
"defaultValue": "",
@@ -192,7 +192,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods that the claim order will be shipped with.",
"optional": false,
"defaultValue": "",
@@ -201,7 +201,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "type",
"type": "[`ClaimType`](../enums/ClaimType.mdx)",
"type": "[ClaimType](../enums/ClaimType.mdx)",
"description": "The claim's type",
"optional": false,
"defaultValue": "",
@@ -239,7 +239,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.",
"optional": false,
"defaultValue": "",
@@ -266,7 +266,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "items",
"type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]",
"type": "[FulfillmentItem](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 +274,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
"children": [
{
"name": "fulfillment",
"type": "[`Fulfillment`](Fulfillment.mdx)",
"type": "[Fulfillment](Fulfillment.mdx)",
"description": "The details of the fulfillment.",
"optional": false,
"defaultValue": "",
@@ -292,7 +292,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "item",
"type": "[`LineItem`](LineItem.mdx)",
"type": "[LineItem](LineItem.mdx)",
"description": "The details of the line item.",
"optional": false,
"defaultValue": "",
@@ -330,7 +330,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -348,7 +348,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -356,7 +356,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
"children": [
{
"name": "billing_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -383,7 +383,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -401,7 +401,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "claims",
"type": "[`ClaimOrder`](ClaimOrder.mdx)[]",
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -419,7 +419,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -437,7 +437,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -464,7 +464,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "discounts",
"type": "[`Discount`](Discount.mdx)[]",
"type": "[Discount](Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -482,7 +482,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "draft_order",
"type": "[`DraftOrder`](DraftOrder.mdx)",
"type": "[DraftOrder](DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -500,7 +500,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "edits",
"type": "[`OrderEdit`](OrderEdit.mdx)[]",
"type": "[OrderEdit](OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -527,7 +527,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/FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -536,7 +536,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -563,7 +563,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "gift_card_transactions",
"type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]",
"type": "[GiftCardTransaction](GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -572,7 +572,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "gift_cards",
"type": "[`GiftCard`](GiftCard.mdx)[]",
"type": "[GiftCard](GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -608,7 +608,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -617,7 +617,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -653,7 +653,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/PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -662,7 +662,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "payments",
"type": "[`Payment`](Payment.mdx)[]",
"type": "[Payment](Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -698,7 +698,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "refunds",
"type": "[`Refund`](Refund.mdx)[]",
"type": "[Refund](Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -707,7 +707,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -725,7 +725,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "returnable_items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](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 +734,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "returns",
"type": "[`Return`](Return.mdx)[]",
"type": "[Return](Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -743,7 +743,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "sales_channel",
"type": "[`SalesChannel`](SalesChannel.mdx)",
"type": "[SalesChannel](SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -761,7 +761,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "shipping_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -779,7 +779,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -806,7 +806,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "status",
"type": "[`OrderStatus`](../enums/OrderStatus.mdx)",
"type": "[OrderStatus](../enums/OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -824,7 +824,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "swaps",
"type": "[`Swap`](Swap.mdx)[]",
"type": "[Swap](Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
@@ -880,7 +880,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "provider",
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)",
"description": "The details of the fulfillment provider responsible for handling the fulfillment.",
"optional": false,
"defaultValue": "",
@@ -898,7 +898,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
{
"name": "is_installed",
"type": "`boolean`",
"description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is_installed` attribute is set to `false`.",
"description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is\\_installed` attribute is set to `false`.",
"optional": false,
"defaultValue": "true",
"expandable": false,
@@ -926,7 +926,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "swap",
"type": "[`Swap`](Swap.mdx)",
"type": "[Swap](Swap.mdx)",
"description": "The details of the swap that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -934,7 +934,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
"children": [
{
"name": "additional_items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the new products to send to the customer, represented as line items.",
"optional": false,
"defaultValue": "",
@@ -961,7 +961,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the customer uses to complete the swap.",
"optional": false,
"defaultValue": "",
@@ -1015,7 +1015,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/SwapFulfillmentStatus.mdx)",
"description": "The status of the Fulfillment of the Swap.",
"optional": false,
"defaultValue": "",
@@ -1024,7 +1024,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The details of the fulfillments that are used to send the new items to the customer.",
"optional": false,
"defaultValue": "",
@@ -1051,7 +1051,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1069,7 +1069,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the swap belongs to.",
"optional": false,
"defaultValue": "",
@@ -1087,8 +1087,8 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "payment",
"type": "[`Payment`](Payment.mdx)",
"description": "The details of the additional payment authorized by the customer when `difference_due` is positive.",
"type": "[Payment](Payment.mdx)",
"description": "The details of the additional payment authorized by the customer when `difference\\_due` is positive.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -1096,7 +1096,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/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 +1105,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "return_order",
"type": "[`Return`](Return.mdx)",
"type": "[Return](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 +1114,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "shipping_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the shipping address that the new items should be sent to.",
"optional": false,
"defaultValue": "",
@@ -1132,7 +1132,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used to fulfill the additional items purchased.",
"optional": false,
"defaultValue": "",
@@ -1161,7 +1161,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "tracking_links",
"type": "[`TrackingLink`](TrackingLink.mdx)[]",
"type": "[TrackingLink](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 +1187,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "fulfillment",
"type": "[`Fulfillment`](Fulfillment.mdx)",
"type": "[Fulfillment](Fulfillment.mdx)",
"description": "The details of the fulfillment that the tracking link belongs to.",
"optional": false,
"defaultValue": "",
@@ -1223,7 +1223,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/FulfillmentItem.mdx
+20 -20
View File
@@ -13,7 +13,7 @@ This represents the association between a Line Item and a Fulfillment.
<ParameterTypes parameters={[
{
"name": "fulfillment",
"type": "[`Fulfillment`](Fulfillment.mdx)",
"type": "[Fulfillment](Fulfillment.mdx)",
"description": "The details of the fulfillment.",
"optional": false,
"defaultValue": "",
@@ -30,7 +30,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "claim_order",
"type": "[`ClaimOrder`](ClaimOrder.mdx)",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"description": "The details of the claim that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -57,7 +57,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "items",
"type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]",
"type": "[FulfillmentItem](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": "",
@@ -102,7 +102,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -120,7 +120,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "provider",
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)",
"description": "The details of the fulfillment provider responsible for handling the fulfillment.",
"optional": false,
"defaultValue": "",
@@ -165,7 +165,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "swap",
"type": "[`Swap`](Swap.mdx)",
"type": "[Swap](Swap.mdx)",
"description": "The details of the swap that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -183,7 +183,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "tracking_links",
"type": "[`TrackingLink`](TrackingLink.mdx)[]",
"type": "[TrackingLink](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 +221,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "item",
"type": "[`LineItem`](LineItem.mdx)",
"type": "[LineItem](LineItem.mdx)",
"description": "The details of the line item.",
"optional": false,
"defaultValue": "",
@@ -229,7 +229,7 @@ This represents the association between a Line Item and a Fulfillment.
"children": [
{
"name": "adjustments",
"type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]",
"type": "[LineItemAdjustment](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 +247,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -265,7 +265,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "claim_order",
"type": "[`ClaimOrder`](ClaimOrder.mdx)",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"description": "The details of the claim that the line item may belong to.",
"optional": false,
"defaultValue": "",
@@ -347,7 +347,7 @@ This represents the association between a Line Item and a Fulfillment.
{
"name": "includes_tax",
"type": "`boolean`",
"description": "Indicates if the line item unit_price include tax",
"description": "Indicates if the line item unit\\_price include tax",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -374,7 +374,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -383,7 +383,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -392,7 +392,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "order_edit",
"type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)",
"type": "``null`` \\| [OrderEdit](OrderEdit.mdx)",
"description": "The details of the order edit.",
"optional": true,
"defaultValue": "",
@@ -518,7 +518,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "swap",
"type": "[`Swap`](Swap.mdx)",
"type": "[Swap](Swap.mdx)",
"description": "The details of the swap that the line item may belong to.",
"optional": false,
"defaultValue": "",
@@ -536,7 +536,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "tax_lines",
"type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]",
"type": "[LineItemTaxLine](LineItemTaxLine.mdx)[]",
"description": "The details of the item's tax lines.",
"optional": false,
"defaultValue": "",
@@ -599,7 +599,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant that this item was created from.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/FulfillmentProvider.mdx
+1 -1
View File
@@ -23,7 +23,7 @@ A fulfillment provider represents a fulfillment service installed in the Medusa
{
"name": "is_installed",
"type": "`boolean`",
"description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is_installed` attribute is set to `false`.",
"description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is\\_installed` attribute is set to `false`.",
"optional": false,
"defaultValue": "true",
"expandable": false,
www/apps/docs/content/references/entities/classes/GiftCard.mdx
+35 -35
View File
@@ -76,7 +76,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the gift card was purchased in.",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,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](Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -120,7 +120,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "claims",
"type": "[`ClaimOrder`](ClaimOrder.mdx)[]",
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -156,7 +156,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -174,7 +174,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -201,7 +201,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "discounts",
"type": "[`Discount`](Discount.mdx)[]",
"type": "[Discount](Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -219,7 +219,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](DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -237,7 +237,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "edits",
"type": "[`OrderEdit`](OrderEdit.mdx)[]",
"type": "[OrderEdit](OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -264,7 +264,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/FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -273,7 +273,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -300,7 +300,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](GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -309,7 +309,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](GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -345,7 +345,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -354,7 +354,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -390,7 +390,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/PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -399,7 +399,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "payments",
"type": "[`Payment`](Payment.mdx)[]",
"type": "[Payment](Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -435,7 +435,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "refunds",
"type": "[`Refund`](Refund.mdx)[]",
"type": "[Refund](Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -444,7 +444,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -462,7 +462,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](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 +471,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "returns",
"type": "[`Return`](Return.mdx)[]",
"type": "[Return](Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -480,7 +480,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](SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -498,7 +498,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](Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -516,7 +516,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](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -543,7 +543,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/OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -561,7 +561,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "swaps",
"type": "[`Swap`](Swap.mdx)[]",
"type": "[Swap](Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
@@ -617,7 +617,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this gift card is available in.",
"optional": false,
"defaultValue": "",
@@ -634,7 +634,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "countries",
"type": "[`Country`](Country.mdx)[]",
"type": "[Country](Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -652,7 +652,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -679,7 +679,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](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": "",
@@ -716,7 +716,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -734,7 +734,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](PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -752,7 +752,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](TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
@@ -779,7 +779,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](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/GiftCardTransaction.mdx
+30 -30
View File
@@ -31,7 +31,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](GiftCard.mdx)",
"description": "The details of the gift card associated used in this transaction.",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -111,7 +111,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](Order.mdx)",
"description": "The details of the order that the gift card was purchased in.",
"optional": false,
"defaultValue": "",
@@ -129,7 +129,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](Region.mdx)",
"description": "The details of the region this gift card is available in.",
"optional": false,
"defaultValue": "",
@@ -203,7 +203,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](Order.mdx)",
"description": "The details of the order that the gift card was used for payment.",
"optional": false,
"defaultValue": "",
@@ -211,7 +211,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](Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -238,7 +238,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](Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -256,7 +256,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](ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -274,7 +274,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](Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -292,7 +292,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](Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -319,7 +319,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](Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -337,7 +337,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](DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -355,7 +355,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](OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -382,7 +382,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/FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -391,7 +391,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](Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -418,7 +418,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](GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -427,7 +427,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](GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -463,7 +463,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](LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -472,7 +472,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -508,7 +508,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/PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -517,7 +517,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](Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -553,7 +553,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](Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -562,7 +562,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](Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -580,7 +580,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](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 +589,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](Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -598,7 +598,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](SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -616,7 +616,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](Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -634,7 +634,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](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -661,7 +661,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/OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -679,7 +679,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](Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/IdempotencyKey.mdx
+2 -2
View File
@@ -67,7 +67,7 @@ Idempotency Key is used to continue a process in case of any failure that might
},
{
"name": "request_params",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The parameters passed to the request",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ Idempotency Key is used to continue a process in case of any failure that might
},
{
"name": "response_body",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The response's body",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Image.mdx
+1 -1
View File
@@ -40,7 +40,7 @@ An Image is used to store details about uploaded images. Images are uploaded by
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Invite.mdx
+2 -2
View File
@@ -58,7 +58,7 @@ An invite is created when an admin user invites a new user to join the store's t
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,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/UserRoles.mdx)",
"description": "The user's role. These roles don't change the privileges of the user.",
"optional": false,
"defaultValue": "member",
www/apps/docs/content/references/entities/classes/LineItem.mdx
+10 -10
View File
@@ -13,7 +13,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](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 +31,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](Cart.mdx)",
"description": "The details of the cart that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -49,7 +49,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](ClaimOrder.mdx)",
"description": "The details of the claim that the line item may belong to.",
"optional": false,
"defaultValue": "",
@@ -131,7 +131,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
{
"name": "includes_tax",
"type": "`boolean`",
"description": "Indicates if the line item unit_price include tax",
"description": "Indicates if the line item unit\\_price include tax",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -158,7 +158,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -167,7 +167,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](Order.mdx)",
"description": "The details of the order that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -176,7 +176,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](OrderEdit.mdx)",
"description": "The details of the order edit.",
"optional": true,
"defaultValue": "",
@@ -302,7 +302,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](Swap.mdx)",
"description": "The details of the swap that the line item may belong to.",
"optional": false,
"defaultValue": "",
@@ -320,7 +320,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](LineItemTaxLine.mdx)[]",
"description": "The details of the item's tax lines.",
"optional": false,
"defaultValue": "",
@@ -383,7 +383,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](ProductVariant.mdx)",
"description": "The details of the product variant that this item was created from.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/LineItemAdjustment.mdx
+3 -3
View File
@@ -31,7 +31,7 @@ A Line Item Adjustment includes details on discounts applied on a line item.
},
{
"name": "discount",
"type": "[`Discount`](Discount.mdx)",
"type": "[Discount](Discount.mdx)",
"description": "The details of the discount associated with the adjustment.",
"optional": false,
"defaultValue": "",
@@ -58,7 +58,7 @@ A Line Item Adjustment includes details on discounts applied on a line item.
},
{
"name": "item",
"type": "[`LineItem`](LineItem.mdx)",
"type": "[LineItem](LineItem.mdx)",
"description": "The details of the line item.",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ A Line Item Adjustment includes details on discounts applied on a line item.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/LineItemTaxLine.mdx
+2 -2
View File
@@ -40,7 +40,7 @@ A Line Item Tax Line represents the taxes applied on a line item.
},
{
"name": "item",
"type": "[`LineItem`](LineItem.mdx)",
"type": "[LineItem](LineItem.mdx)",
"description": "The details of the line item.",
"optional": false,
"defaultValue": "",
@@ -58,7 +58,7 @@ A Line Item Tax Line represents the taxes applied on a line item.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/MoneyAmount.mdx
+24 -24
View File
@@ -31,7 +31,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency that the money amount may belong to.",
"optional": true,
"defaultValue": "",
@@ -132,7 +132,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](PriceList.mdx)",
"description": "The details of the price list that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -150,7 +150,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region that the money amount may belong to.",
"optional": true,
"defaultValue": "",
@@ -167,7 +167,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "countries",
"type": "[`Country`](Country.mdx)[]",
"type": "[Country](Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -185,7 +185,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -212,7 +212,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "fulfillment_providers",
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]",
"type": "[FulfillmentProvider](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": "",
@@ -249,7 +249,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -267,7 +267,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "payment_providers",
"type": "[`PaymentProvider`](PaymentProvider.mdx)[]",
"type": "[PaymentProvider](PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -285,7 +285,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "tax_provider",
"type": "[`TaxProvider`](TaxProvider.mdx)",
"type": "[TaxProvider](TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
@@ -312,7 +312,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](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -350,7 +350,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -359,7 +359,7 @@ A Money Amount represent a price amount, for example, a product variant's price
{
"name": "allow_backorder",
"type": "`boolean`",
"description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.",
"description": "Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -430,7 +430,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "inventory_items",
"type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]",
"type": "[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -475,7 +475,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -493,7 +493,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "options",
"type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -511,7 +511,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "prices",
"type": "[`MoneyAmount`](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](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 +520,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
@@ -621,7 +621,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -630,7 +630,7 @@ A Money Amount represent a price amount, for example, a product variant's price
{
"name": "allow_backorder",
"type": "`boolean`",
"description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.",
"description": "Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -701,7 +701,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "inventory_items",
"type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]",
"type": "[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -746,7 +746,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -764,7 +764,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "options",
"type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -782,7 +782,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "prices",
"type": "[`MoneyAmount`](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](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 +791,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Note.mdx
+4 -4
View File
@@ -13,7 +13,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](User.mdx)",
"description": "The details of the user that created the note.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ A Note is an element that can be used in association with different resources to
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,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/UserRoles.mdx)",
"description": "The user's role. These roles don't provide any different privileges.",
"optional": false,
"defaultValue": "member",
@@ -158,7 +158,7 @@ A Note is an element that can be used in association with different resources to
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Notification.mdx
+21 -21
View File
@@ -22,7 +22,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer that this notification was sent to.",
"optional": false,
"defaultValue": "",
@@ -30,7 +30,7 @@ A notification is an alert sent, typically to customers, using the installed Not
"children": [
{
"name": "billing_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the billing address associated with the customer.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "groups",
"type": "[`CustomerGroup`](CustomerGroup.mdx)[]",
"type": "[CustomerGroup](CustomerGroup.mdx)[]",
"description": "The customer groups the customer belongs to.",
"optional": false,
"defaultValue": "",
@@ -120,7 +120,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -129,7 +129,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "orders",
"type": "[`Order`](Order.mdx)[]",
"type": "[Order](Order.mdx)[]",
"description": "The details of the orders this customer placed.",
"optional": false,
"defaultValue": "",
@@ -156,7 +156,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "shipping_addresses",
"type": "[`Address`](Address.mdx)[]",
"type": "[Address](Address.mdx)[]",
"description": "The details of the shipping addresses associated with the customer.",
"optional": false,
"defaultValue": "",
@@ -185,7 +185,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.",
"optional": false,
"defaultValue": "",
@@ -221,7 +221,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "parent_notification",
"type": "[`Notification`](Notification.mdx)",
"type": "[Notification](Notification.mdx)",
"description": "The details of the parent notification.",
"optional": false,
"defaultValue": "",
@@ -238,7 +238,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer that this notification was sent to.",
"optional": false,
"defaultValue": "",
@@ -256,7 +256,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.",
"optional": false,
"defaultValue": "",
@@ -292,7 +292,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "parent_notification",
"type": "[`Notification`](Notification.mdx)",
"type": "[Notification](Notification.mdx)",
"description": "The details of the parent notification.",
"optional": false,
"defaultValue": "",
@@ -301,7 +301,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "provider",
"type": "[`NotificationProvider`](NotificationProvider.mdx)",
"type": "[NotificationProvider](NotificationProvider.mdx)",
"description": "The notification provider used to send the notification.",
"optional": false,
"defaultValue": "",
@@ -319,7 +319,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "resends",
"type": "[`Notification`](Notification.mdx)[]",
"type": "[Notification](Notification.mdx)[]",
"description": "The details of all resends of the notification.",
"optional": false,
"defaultValue": "",
@@ -366,7 +366,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "provider",
"type": "[`NotificationProvider`](NotificationProvider.mdx)",
"type": "[NotificationProvider](NotificationProvider.mdx)",
"description": "The notification provider used to send the notification.",
"optional": false,
"defaultValue": "",
@@ -384,7 +384,7 @@ A notification is an alert sent, typically to customers, using the installed Not
{
"name": "is_installed",
"type": "`boolean`",
"description": "Whether the notification service is installed in the current version. If a notification service is no longer installed, the `is_installed` attribute is set to `false`.",
"description": "Whether the notification service is installed in the current version. If a notification service is no longer installed, the `is\\_installed` attribute is set to `false`.",
"optional": false,
"defaultValue": "true",
"expandable": false,
@@ -403,7 +403,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "resends",
"type": "[`Notification`](Notification.mdx)[]",
"type": "[Notification](Notification.mdx)[]",
"description": "The details of all resends of the notification.",
"optional": false,
"defaultValue": "",
@@ -420,7 +420,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer that this notification was sent to.",
"optional": false,
"defaultValue": "",
@@ -438,7 +438,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.",
"optional": false,
"defaultValue": "",
@@ -474,7 +474,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "parent_notification",
"type": "[`Notification`](Notification.mdx)",
"type": "[Notification](Notification.mdx)",
"description": "The details of the parent notification.",
"optional": false,
"defaultValue": "",
@@ -483,7 +483,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "provider",
"type": "[`NotificationProvider`](NotificationProvider.mdx)",
"type": "[NotificationProvider](NotificationProvider.mdx)",
"description": "The notification provider used to send the notification.",
"optional": false,
"defaultValue": "",
@@ -501,7 +501,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "resends",
"type": "[`Notification`](Notification.mdx)[]",
"type": "[Notification](Notification.mdx)[]",
"description": "The details of all resends of the notification.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/NotificationProvider.mdx
+1 -1
View File
@@ -23,7 +23,7 @@ A notification provider represents a notification service installed in the Medus
{
"name": "is_installed",
"type": "`boolean`",
"description": "Whether the notification service is installed in the current version. If a notification service is no longer installed, the `is_installed` attribute is set to `false`.",
"description": "Whether the notification service is installed in the current version. If a notification service is no longer installed, the `is\\_installed` attribute is set to `false`.",
"optional": false,
"defaultValue": "true",
"expandable": false,
www/apps/docs/content/references/entities/classes/Oauth.mdx
+1 -1
View File
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Order.mdx
+25 -25
View File
@@ -13,7 +13,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](Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -40,7 +40,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](Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -58,7 +58,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](ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,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](Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -94,7 +94,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](Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -121,7 +121,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](Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -139,7 +139,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](DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -157,7 +157,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](OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -184,7 +184,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/FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -193,7 +193,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](Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -220,7 +220,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](GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -229,7 +229,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](GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -265,7 +265,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](LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -274,7 +274,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -310,7 +310,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/PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -319,7 +319,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](Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -355,7 +355,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](Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -364,7 +364,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](Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -382,7 +382,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](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 +391,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](Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -400,7 +400,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](SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -418,7 +418,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](Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -436,7 +436,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](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -463,7 +463,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/OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -481,7 +481,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](Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/OrderEdit.mdx
+5 -5
View File
@@ -31,7 +31,7 @@ Order edit allows modifying items in an order, such as adding, updating, or dele
},
{
"name": "changes",
"type": "[`OrderItemChange`](OrderItemChange.mdx)[]",
"type": "[OrderItemChange](OrderItemChange.mdx)[]",
"description": "The details of all the changes on the original order's line items.",
"optional": false,
"defaultValue": "",
@@ -157,7 +157,7 @@ Order edit allows modifying items in an order, such as adding, updating, or dele
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](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 +166,7 @@ Order edit allows modifying items in an order, such as adding, updating, or dele
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that this order edit was created for.",
"optional": false,
"defaultValue": "",
@@ -184,7 +184,7 @@ Order edit allows modifying items in an order, such as adding, updating, or dele
},
{
"name": "payment_collection",
"type": "[`PaymentCollection`](PaymentCollection.mdx)",
"type": "[PaymentCollection](PaymentCollection.mdx)",
"description": "The details of the payment collection used to authorize additional payment if necessary.",
"optional": false,
"defaultValue": "",
@@ -229,7 +229,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/OrderEditStatus.mdx)",
"description": "The status of the order edit.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/OrderItemChange.mdx
+4 -4
View File
@@ -40,7 +40,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](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 +58,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](OrderEdit.mdx)",
"description": "The details of the order edit the item change is associated with.",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,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](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 +94,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/OrderEditItemChangeType.mdx)",
"description": "The order item change's status",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Payment.mdx
+58 -58
View File
@@ -49,7 +49,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -57,7 +57,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](Address.mdx)",
"description": "The details of the billing address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "context",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The context of the cart which can include info like IP or user agent.",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer the cart belongs to.",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "discounts",
"type": "[`Discount`](Discount.mdx)[]",
"type": "[Discount](Discount.mdx)[]",
"description": "An array of details of all discounts applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -174,7 +174,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "gift_cards",
"type": "[`GiftCard`](GiftCard.mdx)[]",
"type": "[GiftCard](GiftCard.mdx)[]",
"description": "An array of details of all gift cards applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -210,7 +210,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The line items added to the cart.",
"optional": false,
"defaultValue": "",
@@ -219,7 +219,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -237,7 +237,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "payment",
"type": "[`Payment`](Payment.mdx)",
"type": "[Payment](Payment.mdx)",
"description": "The details of the payment associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -264,7 +264,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](PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -273,7 +273,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "payment_sessions",
"type": "[`PaymentSession`](PaymentSession.mdx)[]",
"type": "[PaymentSession](PaymentSession.mdx)[]",
"description": "The details of all payment sessions created on the cart.",
"optional": false,
"defaultValue": "",
@@ -309,7 +309,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -327,7 +327,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "sales_channel",
"type": "[`SalesChannel`](SalesChannel.mdx)",
"type": "[SalesChannel](SalesChannel.mdx)",
"description": "The details of the sales channel associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -345,7 +345,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](Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -363,7 +363,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods added to the cart.",
"optional": false,
"defaultValue": "",
@@ -417,7 +417,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/CartType.mdx)",
"description": "The cart's type.",
"optional": false,
"defaultValue": "default",
@@ -455,7 +455,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency of the payment.",
"optional": false,
"defaultValue": "",
@@ -520,7 +520,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.",
"optional": false,
"defaultValue": "",
@@ -547,7 +547,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -556,7 +556,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -564,7 +564,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](Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -591,7 +591,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -609,7 +609,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "claims",
"type": "[`ClaimOrder`](ClaimOrder.mdx)[]",
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -627,7 +627,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -645,7 +645,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -672,7 +672,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "discounts",
"type": "[`Discount`](Discount.mdx)[]",
"type": "[Discount](Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -690,7 +690,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "draft_order",
"type": "[`DraftOrder`](DraftOrder.mdx)",
"type": "[DraftOrder](DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -708,7 +708,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "edits",
"type": "[`OrderEdit`](OrderEdit.mdx)[]",
"type": "[OrderEdit](OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -735,7 +735,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/FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -744,7 +744,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -771,7 +771,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](GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -780,7 +780,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "gift_cards",
"type": "[`GiftCard`](GiftCard.mdx)[]",
"type": "[GiftCard](GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -816,7 +816,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -825,7 +825,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -861,7 +861,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/PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -870,7 +870,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "payments",
"type": "[`Payment`](Payment.mdx)[]",
"type": "[Payment](Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -906,7 +906,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "refunds",
"type": "[`Refund`](Refund.mdx)[]",
"type": "[Refund](Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -915,7 +915,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -933,7 +933,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "returnable_items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](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 +942,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "returns",
"type": "[`Return`](Return.mdx)[]",
"type": "[Return](Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -951,7 +951,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "sales_channel",
"type": "[`SalesChannel`](SalesChannel.mdx)",
"type": "[SalesChannel](SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -969,7 +969,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "shipping_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -987,7 +987,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -1014,7 +1014,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/OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -1032,7 +1032,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "swaps",
"type": "[`Swap`](Swap.mdx)[]",
"type": "[Swap](Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
@@ -1097,7 +1097,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "swap",
"type": "[`Swap`](Swap.mdx)",
"type": "[Swap](Swap.mdx)",
"description": "The details of the swap that this payment was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -1105,7 +1105,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](LineItem.mdx)[]",
"description": "The details of the new products to send to the customer, represented as line items.",
"optional": false,
"defaultValue": "",
@@ -1132,7 +1132,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the customer uses to complete the swap.",
"optional": false,
"defaultValue": "",
@@ -1186,7 +1186,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/SwapFulfillmentStatus.mdx)",
"description": "The status of the Fulfillment of the Swap.",
"optional": false,
"defaultValue": "",
@@ -1195,7 +1195,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The details of the fulfillments that are used to send the new items to the customer.",
"optional": false,
"defaultValue": "",
@@ -1222,7 +1222,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1240,7 +1240,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the swap belongs to.",
"optional": false,
"defaultValue": "",
@@ -1258,8 +1258,8 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "payment",
"type": "[`Payment`](Payment.mdx)",
"description": "The details of the additional payment authorized by the customer when `difference_due` is positive.",
"type": "[Payment](Payment.mdx)",
"description": "The details of the additional payment authorized by the customer when `difference\\_due` is positive.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -1267,7 +1267,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/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 +1276,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "return_order",
"type": "[`Return`](Return.mdx)",
"type": "[Return](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 +1285,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "shipping_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the shipping address that the new items should be sent to.",
"optional": false,
"defaultValue": "",
@@ -1303,7 +1303,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used to fulfill the additional items purchased.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/PaymentCollection.mdx
+23 -23
View File
@@ -49,7 +49,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency this payment collection is associated with.",
"optional": false,
"defaultValue": "",
@@ -141,7 +141,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -150,7 +150,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "payment_sessions",
"type": "[`PaymentSession`](PaymentSession.mdx)[]",
"type": "[PaymentSession](PaymentSession.mdx)[]",
"description": "The details of the payment sessions created as part of the payment collection.",
"optional": false,
"defaultValue": "",
@@ -167,7 +167,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the payment session was created for.",
"optional": false,
"defaultValue": "",
@@ -194,7 +194,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.",
"optional": false,
"defaultValue": "",
@@ -258,7 +258,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
{
"name": "status",
"type": "`string`",
"description": "Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires_more` to indicate that further actions are to be completed by the Customer.",
"description": "Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires\\_more` to indicate that further actions are to be completed by the Customer.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -277,7 +277,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "payments",
"type": "[`Payment`](Payment.mdx)[]",
"type": "[Payment](Payment.mdx)[]",
"description": "The details of the payments created as part of the payment collection.",
"optional": false,
"defaultValue": "",
@@ -321,7 +321,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -348,7 +348,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency of the payment.",
"optional": false,
"defaultValue": "",
@@ -366,7 +366,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.",
"optional": false,
"defaultValue": "",
@@ -393,7 +393,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -402,7 +402,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -429,7 +429,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "swap",
"type": "[`Swap`](Swap.mdx)",
"type": "[Swap](Swap.mdx)",
"description": "The details of the swap that this payment was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -458,7 +458,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this payment collection is associated with.",
"optional": false,
"defaultValue": "",
@@ -475,7 +475,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "countries",
"type": "[`Country`](Country.mdx)[]",
"type": "[Country](Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -493,7 +493,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -520,7 +520,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "fulfillment_providers",
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]",
"type": "[FulfillmentProvider](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": "",
@@ -557,7 +557,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -575,7 +575,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "payment_providers",
"type": "[`PaymentProvider`](PaymentProvider.mdx)[]",
"type": "[PaymentProvider](PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -593,7 +593,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "tax_provider",
"type": "[`TaxProvider`](TaxProvider.mdx)",
"type": "[TaxProvider](TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
@@ -620,7 +620,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](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -649,7 +649,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/PaymentCollectionStatus.mdx)",
"description": "The type of the payment collection",
"optional": false,
"defaultValue": "",
@@ -704,7 +704,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/PaymentCollectionType.mdx#order_edit)",
"description": "The type of the payment collection",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/PaymentProvider.mdx
+1 -1
View File
@@ -23,7 +23,7 @@ A payment provider represents a payment service installed in the Medusa backend,
{
"name": "is_installed",
"type": "`boolean`",
"description": "Whether the payment service is installed in the current version. If a payment service is no longer installed, the `is_installed` attribute is set to `false`.",
"description": "Whether the payment service is installed in the current version. If a payment service is no longer installed, the `is\\_installed` attribute is set to `false`.",
"optional": false,
"defaultValue": "true",
"expandable": false,
www/apps/docs/content/references/entities/classes/PaymentSession.mdx
+18 -18
View File
@@ -22,7 +22,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the payment session was created for.",
"optional": false,
"defaultValue": "",
@@ -30,7 +30,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](Address.mdx)",
"description": "The details of the billing address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -57,7 +57,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "context",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The context of the cart which can include info like IP or user agent.",
"optional": false,
"defaultValue": "",
@@ -75,7 +75,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer the cart belongs to.",
"optional": false,
"defaultValue": "",
@@ -111,7 +111,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "discounts",
"type": "[`Discount`](Discount.mdx)[]",
"type": "[Discount](Discount.mdx)[]",
"description": "An array of details of all discounts applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "gift_cards",
"type": "[`GiftCard`](GiftCard.mdx)[]",
"type": "[GiftCard](GiftCard.mdx)[]",
"description": "An array of details of all gift cards applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -183,7 +183,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The line items added to the cart.",
"optional": false,
"defaultValue": "",
@@ -192,7 +192,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -210,7 +210,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "payment",
"type": "[`Payment`](Payment.mdx)",
"type": "[Payment](Payment.mdx)",
"description": "The details of the payment associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -237,7 +237,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](PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -246,7 +246,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "payment_sessions",
"type": "[`PaymentSession`](PaymentSession.mdx)[]",
"type": "[PaymentSession](PaymentSession.mdx)[]",
"description": "The details of all payment sessions created on the cart.",
"optional": false,
"defaultValue": "",
@@ -282,7 +282,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -300,7 +300,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "sales_channel",
"type": "[`SalesChannel`](SalesChannel.mdx)",
"type": "[SalesChannel](SalesChannel.mdx)",
"description": "The details of the sales channel associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -318,7 +318,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](Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -336,7 +336,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods added to the cart.",
"optional": false,
"defaultValue": "",
@@ -390,7 +390,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/CartType.mdx)",
"description": "The cart's type.",
"optional": false,
"defaultValue": "default",
@@ -428,7 +428,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.",
"optional": false,
"defaultValue": "",
@@ -492,7 +492,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
{
"name": "status",
"type": "`string`",
"description": "Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires_more` to indicate that further actions are to be completed by the Customer.",
"description": "Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires\\_more` to indicate that further actions are to be completed by the Customer.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/entities/classes/PriceList.mdx
+12 -12
View File
@@ -22,7 +22,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](CustomerGroup.mdx)[]",
"description": "The details of the customer groups that the Price List can apply to.",
"optional": false,
"defaultValue": "",
@@ -39,7 +39,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "customers",
"type": "[`Customer`](Customer.mdx)[]",
"type": "[Customer](Customer.mdx)[]",
"description": "The details of the customers that belong to the customer group.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,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](PriceList.mdx)[]",
"description": "The price lists that are associated with the customer group.",
"optional": false,
"defaultValue": "",
@@ -159,7 +159,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "prices",
"type": "[`MoneyAmount`](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](MoneyAmount.mdx)[]",
"description": "The prices that belong to the price list, represented as a Money Amount.",
"optional": false,
"defaultValue": "",
@@ -185,7 +185,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency that the money amount may belong to.",
"optional": true,
"defaultValue": "",
@@ -239,7 +239,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](PriceList.mdx)",
"description": "The details of the price list that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -257,7 +257,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region that the money amount may belong to.",
"optional": true,
"defaultValue": "",
@@ -284,7 +284,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -302,7 +302,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -322,7 +322,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](../enums/PriceListStatus.mdx)",
"description": "The status of the Price List",
"optional": false,
"defaultValue": "draft",
@@ -350,7 +350,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](../enums/PriceListType.mdx)",
"description": "The type of Price List. This can be one of either `sale` or `override`.",
"optional": false,
"defaultValue": "sale",
www/apps/docs/content/references/entities/classes/Product.mdx
+43 -43
View File
@@ -13,7 +13,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](ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -22,7 +22,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](ProductCategory.mdx)[]",
"description": "The details of the category's children.",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,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](../index.mdx#boolean)",
"description": "A flag to make product category visible/hidden in the store front",
"optional": false,
"defaultValue": "false",
@@ -76,7 +76,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](../index.mdx#boolean)",
"description": "A flag to make product category an internal category for admins",
"optional": false,
"defaultValue": "false",
@@ -94,7 +94,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](ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
@@ -112,7 +112,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "The details of the products that belong to this category.",
"optional": false,
"defaultValue": "",
@@ -159,7 +159,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "collection",
"type": "[`ProductCollection`](ProductCollection.mdx)",
"type": "[ProductCollection](ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -203,7 +203,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -212,7 +212,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "The details of the products that belong to this product collection.",
"optional": false,
"defaultValue": "",
@@ -331,7 +331,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "images",
"type": "[`Image`](Image.mdx)[]",
"type": "[Image](Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -366,7 +366,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -422,7 +422,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -440,7 +440,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "options",
"type": "[`ProductOption`](ProductOption.mdx)[]",
"type": "[ProductOption](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": "",
@@ -475,7 +475,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -484,7 +484,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product that this product option belongs to.",
"optional": false,
"defaultValue": "",
@@ -520,7 +520,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "values",
"type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"description": "The details of the values of the product option.",
"optional": false,
"defaultValue": "",
@@ -540,7 +540,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "profile",
"type": "[`ShippingProfile`](ShippingProfile.mdx)",
"type": "[ShippingProfile](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": "",
@@ -575,7 +575,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -593,7 +593,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](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": "",
@@ -602,7 +602,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](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": "",
@@ -611,8 +611,8 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "type",
"type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift_card` or `custom`.",
"type": "[ShippingProfileType](../enums/ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift\\_card` or `custom`.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -640,7 +640,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "profiles",
"type": "[`ShippingProfile`](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -675,7 +675,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -693,7 +693,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](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": "",
@@ -702,7 +702,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](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": "",
@@ -711,8 +711,8 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "type",
"type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift_card` or `custom`.",
"type": "[ShippingProfileType](../enums/ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift\\_card` or `custom`.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -731,7 +731,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](SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -784,7 +784,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "locations",
"type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]",
"type": "[SalesChannelLocation](SalesChannelLocation.mdx)[]",
"description": "The details of the stock locations related to the sales channel.",
"optional": false,
"defaultValue": "",
@@ -793,7 +793,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -822,7 +822,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/ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -877,7 +877,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -912,7 +912,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -959,7 +959,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "type",
"type": "[`ProductType`](ProductType.mdx)",
"type": "[ProductType](ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -994,7 +994,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1041,7 +1041,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](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": "",
@@ -1050,7 +1050,7 @@ A product is a saleable item that holds general information such as name or desc
{
"name": "allow_backorder",
"type": "`boolean`",
"description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.",
"description": "Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -1121,7 +1121,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](ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -1166,7 +1166,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1184,7 +1184,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "options",
"type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -1202,7 +1202,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "prices",
"type": "[`MoneyAmount`](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](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": "",
@@ -1211,7 +1211,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductCategory.mdx
+22 -22
View File
@@ -13,7 +13,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](ProductCategory.mdx)[]",
"description": "The details of the category's children.",
"optional": false,
"defaultValue": "",
@@ -21,7 +21,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](ProductCategory.mdx)[]",
"description": "The details of the category's children.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,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](../index.mdx#boolean)",
"description": "A flag to make product category visible/hidden in the store front",
"optional": false,
"defaultValue": "false",
@@ -75,7 +75,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](../index.mdx#boolean)",
"description": "A flag to make product category an internal category for admins",
"optional": false,
"defaultValue": "false",
@@ -93,7 +93,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](ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
@@ -111,7 +111,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "The details of the products that belong to this category.",
"optional": false,
"defaultValue": "",
@@ -194,7 +194,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](../index.mdx#boolean)",
"description": "A flag to make product category visible/hidden in the store front",
"optional": false,
"defaultValue": "false",
@@ -203,7 +203,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](../index.mdx#boolean)",
"description": "A flag to make product category an internal category for admins",
"optional": false,
"defaultValue": "false",
@@ -221,7 +221,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](ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
@@ -239,7 +239,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "The details of the products that belong to this category.",
"optional": false,
"defaultValue": "",
@@ -247,7 +247,7 @@ A product category can be used to categorize products into a hierarchy of catego
"children": [
{
"name": "categories",
"type": "[`ProductCategory`](ProductCategory.mdx)[]",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -257,7 +257,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "collection",
"type": "[`ProductCollection`](ProductCollection.mdx)",
"type": "[ProductCollection](ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -356,7 +356,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "images",
"type": "[`Image`](Image.mdx)[]",
"type": "[Image](Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -392,7 +392,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -410,7 +410,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "options",
"type": "[`ProductOption`](ProductOption.mdx)[]",
"type": "[ProductOption](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": "",
@@ -428,7 +428,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "profile",
"type": "[`ShippingProfile`](ShippingProfile.mdx)",
"type": "[ShippingProfile](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": "",
@@ -446,7 +446,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "profiles",
"type": "[`ShippingProfile`](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -455,7 +455,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "sales_channels",
"type": "[`SalesChannel`](SalesChannel.mdx)[]",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -464,7 +464,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/ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -482,7 +482,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -509,7 +509,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "type",
"type": "[`ProductType`](ProductType.mdx)",
"type": "[ProductType](ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -536,7 +536,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](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": "",
www/apps/docs/content/references/entities/classes/ProductCollection.mdx
+14 -14
View File
@@ -49,7 +49,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -58,7 +58,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "The details of the products that belong to this product collection.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,7 @@ A Product Collection allows grouping together products for promotional purposes.
"children": [
{
"name": "categories",
"type": "[`ProductCategory`](ProductCategory.mdx)[]",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "collection",
"type": "[`ProductCollection`](ProductCollection.mdx)",
"type": "[ProductCollection](ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -175,7 +175,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "images",
"type": "[`Image`](Image.mdx)[]",
"type": "[Image](Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -211,7 +211,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -229,7 +229,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "options",
"type": "[`ProductOption`](ProductOption.mdx)[]",
"type": "[ProductOption](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 +247,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "profile",
"type": "[`ShippingProfile`](ShippingProfile.mdx)",
"type": "[ShippingProfile](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 +265,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "profiles",
"type": "[`ShippingProfile`](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -274,7 +274,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "sales_channels",
"type": "[`SalesChannel`](SalesChannel.mdx)[]",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -283,7 +283,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "status",
"type": "[`ProductStatus`](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -301,7 +301,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -328,7 +328,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "type",
"type": "[`ProductType`](ProductType.mdx)",
"type": "[ProductType](ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -355,7 +355,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](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": "",
www/apps/docs/content/references/entities/classes/ProductOption.mdx
+18 -18
View File
@@ -40,7 +40,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -49,7 +49,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product that this product option belongs to.",
"optional": false,
"defaultValue": "",
@@ -57,7 +57,7 @@ A Product Option defines properties that may vary between different variants of
"children": [
{
"name": "categories",
"type": "[`ProductCategory`](ProductCategory.mdx)[]",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "collection",
"type": "[`ProductCollection`](ProductCollection.mdx)",
"type": "[ProductCollection](ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -166,7 +166,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "images",
"type": "[`Image`](Image.mdx)[]",
"type": "[Image](Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -202,7 +202,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -220,7 +220,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "options",
"type": "[`ProductOption`](ProductOption.mdx)[]",
"type": "[ProductOption](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 +238,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "profile",
"type": "[`ShippingProfile`](ShippingProfile.mdx)",
"type": "[ShippingProfile](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 +256,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "profiles",
"type": "[`ShippingProfile`](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -265,7 +265,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "sales_channels",
"type": "[`SalesChannel`](SalesChannel.mdx)[]",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -274,7 +274,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "status",
"type": "[`ProductStatus`](../enums/ProductStatus.mdx)",
"type": "[ProductStatus](../enums/ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -292,7 +292,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -319,7 +319,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "type",
"type": "[`ProductType`](ProductType.mdx)",
"type": "[ProductType](ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -346,7 +346,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](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 +402,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "values",
"type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"description": "The details of the values of the product option.",
"optional": false,
"defaultValue": "",
@@ -437,7 +437,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -446,7 +446,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "option",
"type": "[`ProductOption`](ProductOption.mdx)",
"type": "[ProductOption](ProductOption.mdx)",
"description": "The details of the product option that the Product Option Value belongs to.",
"optional": false,
"defaultValue": "",
@@ -482,7 +482,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant that uses this product option value.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductOptionValue.mdx
+12 -12
View File
@@ -40,7 +40,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -49,7 +49,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "option",
"type": "[`ProductOption`](ProductOption.mdx)",
"type": "[ProductOption](ProductOption.mdx)",
"description": "The details of the product option that the Product Option Value belongs to.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product that this product option belongs to.",
"optional": false,
"defaultValue": "",
@@ -129,7 +129,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "values",
"type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"description": "The details of the values of the product option.",
"optional": false,
"defaultValue": "",
@@ -167,7 +167,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant that uses this product option value.",
"optional": false,
"defaultValue": "",
@@ -176,7 +176,7 @@ An option value is one of the possible values of a Product Option. Product Varia
{
"name": "allow_backorder",
"type": "`boolean`",
"description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.",
"description": "Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -247,7 +247,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](ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -292,7 +292,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -310,7 +310,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "options",
"type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -328,7 +328,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "prices",
"type": "[`MoneyAmount`](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](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 +337,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductTag.mdx
+1 -1
View File
@@ -40,7 +40,7 @@ A Product Tag can be added to Products for easy filtering and grouping.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductTaxRate.mdx
+20 -20
View File
@@ -22,7 +22,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -31,7 +31,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product.",
"optional": true,
"defaultValue": "",
@@ -39,7 +39,7 @@ This represents the association between a tax rate and a product to indicate tha
"children": [
{
"name": "categories",
"type": "[`ProductCategory`](ProductCategory.mdx)[]",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -49,7 +49,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "collection",
"type": "[`ProductCollection`](ProductCollection.mdx)",
"type": "[ProductCollection](ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -148,7 +148,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "images",
"type": "[`Image`](Image.mdx)[]",
"type": "[Image](Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -184,7 +184,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -202,7 +202,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "options",
"type": "[`ProductOption`](ProductOption.mdx)[]",
"type": "[ProductOption](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 +220,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "profile",
"type": "[`ShippingProfile`](ShippingProfile.mdx)",
"type": "[ShippingProfile](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 +238,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "profiles",
"type": "[`ShippingProfile`](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -247,7 +247,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "sales_channels",
"type": "[`SalesChannel`](SalesChannel.mdx)[]",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -256,7 +256,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/ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -274,7 +274,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -301,7 +301,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "type",
"type": "[`ProductType`](ProductType.mdx)",
"type": "[ProductType](ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -328,7 +328,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](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 +375,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "tax_rate",
"type": "[`TaxRate`](TaxRate.mdx)",
"type": "[TaxRate](TaxRate.mdx)",
"description": "The details of the tax rate.",
"optional": true,
"defaultValue": "",
@@ -410,7 +410,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -446,7 +446,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "product_types",
"type": "[`ProductType`](ProductType.mdx)[]",
"type": "[ProductType](ProductType.mdx)[]",
"description": "The details of the product types that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -455,7 +455,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "The details of the products that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -473,7 +473,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region that the rate belongs to.",
"optional": false,
"defaultValue": "",
@@ -500,7 +500,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "shipping_options",
"type": "[`ShippingOption`](ShippingOption.mdx)[]",
"type": "[ShippingOption](ShippingOption.mdx)[]",
"description": "The details of the shipping options that belong to this tax rate.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductType.mdx
+1 -1
View File
@@ -40,7 +40,7 @@ A Product Type can be added to Products for filtering and reporting purposes.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductTypeTaxRate.mdx
+9 -9
View File
@@ -22,7 +22,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -31,7 +31,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "product_type",
"type": "[`ProductType`](ProductType.mdx)",
"type": "[ProductType](ProductType.mdx)",
"description": "The details of the product type.",
"optional": true,
"defaultValue": "",
@@ -66,7 +66,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -113,7 +113,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "tax_rate",
"type": "[`TaxRate`](TaxRate.mdx)",
"type": "[TaxRate](TaxRate.mdx)",
"description": "The details of the tax rate.",
"optional": true,
"defaultValue": "",
@@ -148,7 +148,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -184,7 +184,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "product_types",
"type": "[`ProductType`](ProductType.mdx)[]",
"type": "[ProductType](ProductType.mdx)[]",
"description": "The details of the product types that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -193,7 +193,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "The details of the products that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -211,7 +211,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region that the rate belongs to.",
"optional": false,
"defaultValue": "",
@@ -238,7 +238,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "shipping_options",
"type": "[`ShippingOption`](ShippingOption.mdx)[]",
"type": "[ShippingOption](ShippingOption.mdx)[]",
"description": "The details of the shipping options that belong to this tax rate.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductVariant.mdx
+27 -27
View File
@@ -14,7 +14,7 @@ A Product Variant represents a Product with a specific set of Product Option con
{
"name": "allow_backorder",
"type": "`boolean`",
"description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.",
"description": "Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -85,7 +85,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "inventory_items",
"type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]",
"type": "[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant.",
"optional": false,
"defaultValue": "",
@@ -203,7 +203,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -221,7 +221,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "options",
"type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -256,7 +256,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -265,7 +265,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "option",
"type": "[`ProductOption`](ProductOption.mdx)",
"type": "[ProductOption](ProductOption.mdx)",
"description": "The details of the product option that the Product Option Value belongs to.",
"optional": false,
"defaultValue": "",
@@ -301,7 +301,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant that uses this product option value.",
"optional": false,
"defaultValue": "",
@@ -330,7 +330,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "prices",
"type": "[`MoneyAmount`](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](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 +356,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency that the money amount may belong to.",
"optional": true,
"defaultValue": "",
@@ -410,7 +410,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](PriceList.mdx)",
"description": "The details of the price list that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -428,7 +428,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region that the money amount may belong to.",
"optional": true,
"defaultValue": "",
@@ -455,7 +455,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -473,7 +473,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](ProductVariant.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -484,7 +484,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
@@ -492,7 +492,7 @@ A Product Variant represents a Product with a specific set of Product Option con
"children": [
{
"name": "categories",
"type": "[`ProductCategory`](ProductCategory.mdx)[]",
"type": "[ProductCategory](ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -502,7 +502,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "collection",
"type": "[`ProductCollection`](ProductCollection.mdx)",
"type": "[ProductCollection](ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -601,7 +601,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "images",
"type": "[`Image`](Image.mdx)[]",
"type": "[Image](Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -637,7 +637,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -655,7 +655,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "options",
"type": "[`ProductOption`](ProductOption.mdx)[]",
"type": "[ProductOption](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 +673,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "profile",
"type": "[`ShippingProfile`](ShippingProfile.mdx)",
"type": "[ShippingProfile](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 +691,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "profiles",
"type": "[`ShippingProfile`](ShippingProfile.mdx)[]",
"type": "[ShippingProfile](ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -700,7 +700,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "sales_channels",
"type": "[`SalesChannel`](SalesChannel.mdx)[]",
"type": "[SalesChannel](SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -709,7 +709,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/ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -727,7 +727,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "tags",
"type": "[`ProductTag`](ProductTag.mdx)[]",
"type": "[ProductTag](ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -754,7 +754,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "type",
"type": "[`ProductType`](ProductType.mdx)",
"type": "[ProductType](ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -781,7 +781,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "variants",
"type": "[`ProductVariant`](ProductVariant.mdx)[]",
"type": "[ProductVariant](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": "",
www/apps/docs/content/references/entities/classes/ProductVariantInventoryItem.mdx
+7 -7
View File
@@ -67,7 +67,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "variant",
"type": "[`ProductVariant`](ProductVariant.mdx)",
"type": "[ProductVariant](ProductVariant.mdx)",
"description": "The details of the product variant.",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
{
"name": "allow_backorder",
"type": "`boolean`",
"description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.",
"description": "Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -147,7 +147,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "inventory_items",
"type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]",
"type": "[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -192,7 +192,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -210,7 +210,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "options",
"type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -228,7 +228,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "prices",
"type": "[`MoneyAmount`](MoneyAmount.mdx)[]",
"type": "[MoneyAmount](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 +237,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "product",
"type": "[`Product`](Product.mdx)",
"type": "[Product](Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Refund.mdx
+34 -34
View File
@@ -49,7 +49,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order this refund was created for.",
"optional": false,
"defaultValue": "",
@@ -75,7 +75,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](Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -120,7 +120,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "claims",
"type": "[`ClaimOrder`](ClaimOrder.mdx)[]",
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -156,7 +156,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -183,7 +183,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "discounts",
"type": "[`Discount`](Discount.mdx)[]",
"type": "[Discount](Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -201,7 +201,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](DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -219,7 +219,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "edits",
"type": "[`OrderEdit`](OrderEdit.mdx)[]",
"type": "[OrderEdit](OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -246,7 +246,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/FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -255,7 +255,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -282,7 +282,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](GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -291,7 +291,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](GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -327,7 +327,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -336,7 +336,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -372,7 +372,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/PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -381,7 +381,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "payments",
"type": "[`Payment`](Payment.mdx)[]",
"type": "[Payment](Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -417,7 +417,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "refunds",
"type": "[`Refund`](Refund.mdx)[]",
"type": "[Refund](Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -426,7 +426,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -444,7 +444,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](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 +453,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "returns",
"type": "[`Return`](Return.mdx)[]",
"type": "[Return](Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -462,7 +462,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](SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -480,7 +480,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](Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -498,7 +498,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](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -525,7 +525,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/OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -543,7 +543,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "swaps",
"type": "[`Swap`](Swap.mdx)[]",
"type": "[Swap](Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
@@ -599,7 +599,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "payment",
"type": "[`Payment`](Payment.mdx)",
"type": "[Payment](Payment.mdx)",
"description": "The details of the payment associated with the refund.",
"optional": false,
"defaultValue": "",
@@ -643,7 +643,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -670,7 +670,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency of the payment.",
"optional": false,
"defaultValue": "",
@@ -688,7 +688,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.",
"optional": false,
"defaultValue": "",
@@ -715,7 +715,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -724,7 +724,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -751,7 +751,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "swap",
"type": "[`Swap`](Swap.mdx)",
"type": "[Swap](Swap.mdx)",
"description": "The details of the swap that this payment was potentially created for.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Region.mdx
+11 -11
View File
@@ -22,7 +22,7 @@ A region holds settings specific to a geographical location, including the curre
},
{
"name": "countries",
"type": "[`Country`](Country.mdx)[]",
"type": "[Country](Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ A region holds settings specific to a geographical location, including the curre
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region the country is associated with.",
"optional": false,
"defaultValue": "",
@@ -113,7 +113,7 @@ A region holds settings specific to a geographical location, including the curre
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -187,7 +187,7 @@ A region holds settings specific to a geographical location, including the curre
},
{
"name": "fulfillment_providers",
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]",
"type": "[FulfillmentProvider](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": "",
@@ -205,7 +205,7 @@ A region holds settings specific to a geographical location, including the curre
{
"name": "is_installed",
"type": "`boolean`",
"description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is_installed` attribute is set to `false`.",
"description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is\\_installed` attribute is set to `false`.",
"optional": false,
"defaultValue": "true",
"expandable": false,
@@ -243,7 +243,7 @@ A region holds settings specific to a geographical location, including the curre
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -261,7 +261,7 @@ A region holds settings specific to a geographical location, including the curre
},
{
"name": "payment_providers",
"type": "[`PaymentProvider`](PaymentProvider.mdx)[]",
"type": "[PaymentProvider](PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -279,7 +279,7 @@ A region holds settings specific to a geographical location, including the curre
{
"name": "is_installed",
"type": "`boolean`",
"description": "Whether the payment service is installed in the current version. If a payment service is no longer installed, the `is_installed` attribute is set to `false`.",
"description": "Whether the payment service is installed in the current version. If a payment service is no longer installed, the `is\\_installed` attribute is set to `false`.",
"optional": false,
"defaultValue": "true",
"expandable": false,
@@ -298,7 +298,7 @@ A region holds settings specific to a geographical location, including the curre
},
{
"name": "tax_provider",
"type": "[`TaxProvider`](TaxProvider.mdx)",
"type": "[TaxProvider](TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
@@ -316,7 +316,7 @@ A region holds settings specific to a geographical location, including the curre
{
"name": "is_installed",
"type": "`boolean`",
"description": "Whether the tax service is installed in the current version. If a tax service is no longer installed, the `is_installed` attribute is set to `false`.",
"description": "Whether the tax service is installed in the current version. If a tax service is no longer installed, the `is\\_installed` attribute is set to `false`.",
"optional": false,
"defaultValue": "true",
"expandable": false,
@@ -344,7 +344,7 @@ A region holds settings specific to a geographical location, including the curre
},
{
"name": "tax_rates",
"type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]",
"type": "``null`` \\| [TaxRate](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Return.mdx
+68 -68
View File
@@ -13,7 +13,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](ClaimOrder.mdx)",
"description": "The details of the claim that the return may belong to.",
"optional": false,
"defaultValue": "",
@@ -21,7 +21,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](LineItem.mdx)[]",
"description": "The details of the new items to be shipped when the claim's type is `replace`",
"optional": false,
"defaultValue": "",
@@ -39,7 +39,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "claim_items",
"type": "[`ClaimItem`](ClaimItem.mdx)[]",
"type": "[ClaimItem](ClaimItem.mdx)[]",
"description": "The details of the items that should be replaced or refunded.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,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/ClaimFulfillmentStatus.mdx)",
"description": "The claim's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -75,7 +75,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The fulfillments of the new items to be shipped",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -120,7 +120,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that this claim was created for.",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,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/ClaimPaymentStatus.mdx)",
"description": "The status of the claim's payment",
"optional": false,
"defaultValue": "na",
@@ -156,7 +156,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "return_order",
"type": "[`Return`](Return.mdx)",
"type": "[Return](Return.mdx)",
"description": "The details of the return associated with the claim if the claim's type is `replace`.",
"optional": false,
"defaultValue": "",
@@ -165,7 +165,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "shipping_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the address that new items should be shipped to.",
"optional": false,
"defaultValue": "",
@@ -183,7 +183,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods that the claim order will be shipped with.",
"optional": false,
"defaultValue": "",
@@ -192,7 +192,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/ClaimType.mdx)",
"description": "The claim's type",
"optional": false,
"defaultValue": "",
@@ -248,7 +248,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "items",
"type": "[`ReturnItem`](ReturnItem.mdx)[]",
"type": "[ReturnItem](ReturnItem.mdx)[]",
"description": "The details of the items that the customer is returning.",
"optional": false,
"defaultValue": "",
@@ -265,7 +265,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "item",
"type": "[`LineItem`](LineItem.mdx)",
"type": "[LineItem](LineItem.mdx)",
"description": "The details of the line item in the original order to be returned.",
"optional": false,
"defaultValue": "",
@@ -283,7 +283,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -310,7 +310,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "reason",
"type": "[`ReturnReason`](ReturnReason.mdx)",
"type": "[ReturnReason](ReturnReason.mdx)",
"description": "The details of the reason for returning the item.",
"optional": false,
"defaultValue": "",
@@ -355,7 +355,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "return_order",
"type": "[`Return`](Return.mdx)",
"type": "[Return](Return.mdx)",
"description": "Details of the Return that the Return Item belongs to.",
"optional": false,
"defaultValue": "",
@@ -375,7 +375,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -393,7 +393,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the return was created for.",
"optional": false,
"defaultValue": "",
@@ -401,7 +401,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](Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -428,7 +428,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -446,7 +446,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "claims",
"type": "[`ClaimOrder`](ClaimOrder.mdx)[]",
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -464,7 +464,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -482,7 +482,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "customer",
"type": "[`Customer`](Customer.mdx)",
"type": "[Customer](Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -509,7 +509,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "discounts",
"type": "[`Discount`](Discount.mdx)[]",
"type": "[Discount](Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -527,7 +527,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "draft_order",
"type": "[`DraftOrder`](DraftOrder.mdx)",
"type": "[DraftOrder](DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -545,7 +545,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "edits",
"type": "[`OrderEdit`](OrderEdit.mdx)[]",
"type": "[OrderEdit](OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -572,7 +572,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/FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -581,7 +581,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -608,7 +608,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](GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -617,7 +617,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "gift_cards",
"type": "[`GiftCard`](GiftCard.mdx)[]",
"type": "[GiftCard](GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -653,7 +653,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -662,7 +662,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -698,7 +698,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/PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -707,7 +707,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "payments",
"type": "[`Payment`](Payment.mdx)[]",
"type": "[Payment](Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -743,7 +743,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "refunds",
"type": "[`Refund`](Refund.mdx)[]",
"type": "[Refund](Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -752,7 +752,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -770,7 +770,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "returnable_items",
"type": "[`LineItem`](LineItem.mdx)[]",
"type": "[LineItem](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 +779,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "returns",
"type": "[`Return`](Return.mdx)[]",
"type": "[Return](Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -788,7 +788,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "sales_channel",
"type": "[`SalesChannel`](SalesChannel.mdx)",
"type": "[SalesChannel](SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -806,7 +806,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "shipping_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -824,7 +824,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -851,7 +851,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/OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -869,7 +869,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "swaps",
"type": "[`Swap`](Swap.mdx)[]",
"type": "[Swap](Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
@@ -943,7 +943,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "shipping_data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.",
"optional": false,
"defaultValue": "",
@@ -952,7 +952,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "shipping_method",
"type": "[`ShippingMethod`](ShippingMethod.mdx)",
"type": "[ShippingMethod](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 +960,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
"children": [
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -978,7 +978,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "claim_order",
"type": "[`ClaimOrder`](ClaimOrder.mdx)",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"description": "The details of the claim that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -996,7 +996,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.",
"optional": false,
"defaultValue": "",
@@ -1024,7 +1024,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -1060,7 +1060,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "return_order",
"type": "[`Return`](Return.mdx)",
"type": "[Return](Return.mdx)",
"description": "The details of the return that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -1069,7 +1069,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "shipping_option",
"type": "[`ShippingOption`](ShippingOption.mdx)",
"type": "[ShippingOption](ShippingOption.mdx)",
"description": "The details of the shipping option the method was created from.",
"optional": false,
"defaultValue": "",
@@ -1096,7 +1096,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "swap",
"type": "[`Swap`](Swap.mdx)",
"type": "[Swap](Swap.mdx)",
"description": "The details of the swap that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -1114,7 +1114,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "tax_lines",
"type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]",
"type": "[ShippingMethodTaxLine](ShippingMethodTaxLine.mdx)[]",
"description": "The details of the tax lines applied on the shipping method.",
"optional": false,
"defaultValue": "",
@@ -1143,7 +1143,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/ReturnStatus.mdx)",
"description": "Status of the Return.",
"optional": false,
"defaultValue": "requested",
@@ -1189,7 +1189,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "swap",
"type": "[`Swap`](Swap.mdx)",
"type": "[Swap](Swap.mdx)",
"description": "The details of the swap that the return may belong to.",
"optional": false,
"defaultValue": "",
@@ -1197,7 +1197,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](LineItem.mdx)[]",
"description": "The details of the new products to send to the customer, represented as line items.",
"optional": false,
"defaultValue": "",
@@ -1224,7 +1224,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the customer uses to complete the swap.",
"optional": false,
"defaultValue": "",
@@ -1278,7 +1278,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/SwapFulfillmentStatus.mdx)",
"description": "The status of the Fulfillment of the Swap.",
"optional": false,
"defaultValue": "",
@@ -1287,7 +1287,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The details of the fulfillments that are used to send the new items to the customer.",
"optional": false,
"defaultValue": "",
@@ -1314,7 +1314,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1332,7 +1332,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the swap belongs to.",
"optional": false,
"defaultValue": "",
@@ -1350,8 +1350,8 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "payment",
"type": "[`Payment`](Payment.mdx)",
"description": "The details of the additional payment authorized by the customer when `difference_due` is positive.",
"type": "[Payment](Payment.mdx)",
"description": "The details of the additional payment authorized by the customer when `difference\\_due` is positive.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -1359,7 +1359,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/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 +1368,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "return_order",
"type": "[`Return`](Return.mdx)",
"type": "[Return](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 +1377,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "shipping_address",
"type": "[`Address`](Address.mdx)",
"type": "[Address](Address.mdx)",
"description": "The details of the shipping address that the new items should be sent to.",
"optional": false,
"defaultValue": "",
@@ -1395,7 +1395,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used to fulfill the additional items purchased.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ReturnItem.mdx
+25 -25
View File
@@ -22,7 +22,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](LineItem.mdx)",
"description": "The details of the line item in the original order to be returned.",
"optional": false,
"defaultValue": "",
@@ -30,7 +30,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](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 +48,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](Cart.mdx)",
"description": "The details of the cart that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,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](ClaimOrder.mdx)",
"description": "The details of the claim that the line item may belong to.",
"optional": false,
"defaultValue": "",
@@ -148,7 +148,7 @@ A return item represents a line item in an order that is to be returned. It incl
{
"name": "includes_tax",
"type": "`boolean`",
"description": "Indicates if the line item unit_price include tax",
"description": "Indicates if the line item unit\\_price include tax",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -175,7 +175,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -184,7 +184,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](Order.mdx)",
"description": "The details of the order that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -193,7 +193,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](OrderEdit.mdx)",
"description": "The details of the order edit.",
"optional": true,
"defaultValue": "",
@@ -319,7 +319,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](Swap.mdx)",
"description": "The details of the swap that the line item may belong to.",
"optional": false,
"defaultValue": "",
@@ -337,7 +337,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](LineItemTaxLine.mdx)[]",
"description": "The details of the item's tax lines.",
"optional": false,
"defaultValue": "",
@@ -400,7 +400,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](ProductVariant.mdx)",
"description": "The details of the product variant that this item was created from.",
"optional": false,
"defaultValue": "",
@@ -429,7 +429,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -456,7 +456,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](ReturnReason.mdx)",
"description": "The details of the reason for returning the item.",
"optional": false,
"defaultValue": "",
@@ -509,7 +509,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -518,7 +518,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](ReturnReason.mdx)",
"description": "The details of the parent reason.",
"optional": false,
"defaultValue": "",
@@ -536,7 +536,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](ReturnReason.mdx)[]",
"description": "The details of the child reasons.",
"optional": false,
"defaultValue": "",
@@ -601,7 +601,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](Return.mdx)",
"description": "Details of the Return that the Return Item belongs to.",
"optional": false,
"defaultValue": "",
@@ -609,7 +609,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](ClaimOrder.mdx)",
"description": "The details of the claim that the return may belong to.",
"optional": false,
"defaultValue": "",
@@ -654,7 +654,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](ReturnItem.mdx)[]",
"description": "The details of the items that the customer is returning.",
"optional": false,
"defaultValue": "",
@@ -672,7 +672,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -690,7 +690,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](Order.mdx)",
"description": "The details of the order that the return was created for.",
"optional": false,
"defaultValue": "",
@@ -726,7 +726,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "shipping_data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.",
"optional": false,
"defaultValue": "",
@@ -735,7 +735,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](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 +744,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/ReturnStatus.mdx)",
"description": "Status of the Return.",
"optional": false,
"defaultValue": "requested",
@@ -753,7 +753,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](Swap.mdx)",
"description": "The details of the swap that the return may belong to.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ReturnReason.mdx
+6 -6
View File
@@ -58,7 +58,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,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](ReturnReason.mdx)",
"description": "The details of the parent reason.",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,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](ReturnReason.mdx)[]",
"description": "The details of the child reasons.",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,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](ReturnReason.mdx)",
"description": "The details of the parent reason.",
"optional": false,
"defaultValue": "",
@@ -165,7 +165,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](ReturnReason.mdx)[]",
"description": "The details of the child reasons.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/SalesChannel.mdx
+3 -3
View File
@@ -58,7 +58,7 @@ A Sales Channel is a method a business offers its products for purchase for the
},
{
"name": "locations",
"type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]",
"type": "[SalesChannelLocation](SalesChannelLocation.mdx)[]",
"description": "The details of the stock locations related to the sales channel.",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,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](SalesChannel.mdx)",
"description": "The details of the sales channel the location is associated with.",
"optional": false,
"defaultValue": "",
@@ -131,7 +131,7 @@ A Sales Channel is a method a business offers its products for purchase for the
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/SalesChannelLocation.mdx
+3 -3
View File
@@ -49,7 +49,7 @@ This represents the association between a sales channel and a stock locations.
},
{
"name": "sales_channel",
"type": "[`SalesChannel`](SalesChannel.mdx)",
"type": "[SalesChannel](SalesChannel.mdx)",
"description": "The details of the sales channel the location is associated with.",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ This represents the association between a sales channel and a stock locations.
},
{
"name": "locations",
"type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]",
"type": "[SalesChannelLocation](SalesChannelLocation.mdx)[]",
"description": "The details of the stock locations related to the sales channel.",
"optional": false,
"defaultValue": "",
@@ -111,7 +111,7 @@ This represents the association between a sales channel and a stock locations.
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ShippingMethod.mdx
+90 -90
View File
@@ -13,7 +13,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](Cart.mdx)",
"description": "The details of the cart that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -21,7 +21,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](Address.mdx)",
"description": "The details of the billing address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -48,7 +48,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "context",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The context of the cart which can include info like IP or user agent.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,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](Customer.mdx)",
"description": "The details of the customer the cart belongs to.",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,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](Discount.mdx)[]",
"description": "An array of details of all discounts applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,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](GiftCard.mdx)[]",
"description": "An array of details of all gift cards applied to the cart.",
"optional": false,
"defaultValue": "",
@@ -174,7 +174,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](LineItem.mdx)[]",
"description": "The line items added to the cart.",
"optional": false,
"defaultValue": "",
@@ -183,7 +183,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -201,7 +201,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](Payment.mdx)",
"description": "The details of the payment associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -228,7 +228,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](PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -237,7 +237,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](PaymentSession.mdx)[]",
"description": "The details of all payment sessions created on the cart.",
"optional": false,
"defaultValue": "",
@@ -273,7 +273,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](Region.mdx)",
"description": "The details of the region associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -291,7 +291,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](SalesChannel.mdx)",
"description": "The details of the sales channel associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -309,7 +309,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](Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -327,7 +327,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](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods added to the cart.",
"optional": false,
"defaultValue": "",
@@ -381,7 +381,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/CartType.mdx)",
"description": "The cart's type.",
"optional": false,
"defaultValue": "default",
@@ -410,7 +410,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](ClaimOrder.mdx)",
"description": "The details of the claim that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -418,7 +418,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](LineItem.mdx)[]",
"description": "The details of the new items to be shipped when the claim's type is `replace`",
"optional": false,
"defaultValue": "",
@@ -436,7 +436,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](ClaimItem.mdx)[]",
"description": "The details of the items that should be replaced or refunded.",
"optional": false,
"defaultValue": "",
@@ -463,7 +463,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/ClaimFulfillmentStatus.mdx)",
"description": "The claim's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -472,7 +472,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](Fulfillment.mdx)[]",
"description": "The fulfillments of the new items to be shipped",
"optional": false,
"defaultValue": "",
@@ -499,7 +499,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -517,7 +517,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](Order.mdx)",
"description": "The details of the order that this claim was created for.",
"optional": false,
"defaultValue": "",
@@ -535,7 +535,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/ClaimPaymentStatus.mdx)",
"description": "The status of the claim's payment",
"optional": false,
"defaultValue": "na",
@@ -553,7 +553,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](Return.mdx)",
"description": "The details of the return associated with the claim if the claim's type is `replace`.",
"optional": false,
"defaultValue": "",
@@ -562,7 +562,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](Address.mdx)",
"description": "The details of the address that new items should be shipped to.",
"optional": false,
"defaultValue": "",
@@ -580,7 +580,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](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods that the claim order will be shipped with.",
"optional": false,
"defaultValue": "",
@@ -589,7 +589,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/ClaimType.mdx)",
"description": "The claim's type",
"optional": false,
"defaultValue": "",
@@ -618,7 +618,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.",
"optional": false,
"defaultValue": "",
@@ -646,7 +646,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](Order.mdx)",
"description": "The details of the order that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -654,7 +654,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](Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -681,7 +681,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](Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
@@ -699,7 +699,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](ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
@@ -717,7 +717,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](Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
@@ -735,7 +735,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](Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
@@ -762,7 +762,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](Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
@@ -780,7 +780,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](DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
@@ -798,7 +798,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](OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
@@ -825,7 +825,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/FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
@@ -834,7 +834,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](Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
@@ -861,7 +861,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](GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
@@ -870,7 +870,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](GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
@@ -906,7 +906,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](LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
@@ -915,7 +915,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -951,7 +951,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/PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
@@ -960,7 +960,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](Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
@@ -996,7 +996,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](Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
@@ -1005,7 +1005,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](Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
@@ -1023,7 +1023,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](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 +1032,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](Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
@@ -1041,7 +1041,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](SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -1059,7 +1059,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](Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
@@ -1077,7 +1077,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](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
@@ -1104,7 +1104,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/OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
@@ -1122,7 +1122,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](Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
@@ -1196,7 +1196,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](Return.mdx)",
"description": "The details of the return that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -1204,7 +1204,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](ClaimOrder.mdx)",
"description": "The details of the claim that the return may belong to.",
"optional": false,
"defaultValue": "",
@@ -1249,7 +1249,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](ReturnItem.mdx)[]",
"description": "The details of the items that the customer is returning.",
"optional": false,
"defaultValue": "",
@@ -1267,7 +1267,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1285,7 +1285,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](Order.mdx)",
"description": "The details of the order that the return was created for.",
"optional": false,
"defaultValue": "",
@@ -1321,7 +1321,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "shipping_data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.",
"optional": false,
"defaultValue": "",
@@ -1330,7 +1330,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](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 +1339,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/ReturnStatus.mdx)",
"description": "Status of the Return.",
"optional": false,
"defaultValue": "requested",
@@ -1348,7 +1348,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](Swap.mdx)",
"description": "The details of the swap that the return may belong to.",
"optional": false,
"defaultValue": "",
@@ -1377,7 +1377,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](ShippingOption.mdx)",
"description": "The details of the shipping option the method was created from.",
"optional": false,
"defaultValue": "",
@@ -1395,7 +1395,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
{
"name": "amount",
"type": "``null`` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat_rate`.",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -1412,7 +1412,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data needed for the Fulfillment Provider to identify the Shipping Option.",
"optional": false,
"defaultValue": "",
@@ -1458,7 +1458,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1476,8 +1476,8 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "price_type",
"type": "[`ShippingOptionPriceType`](../enums/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.",
"type": "[ShippingOptionPriceType](../enums/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": "",
"expandable": false,
@@ -1485,7 +1485,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](ShippingProfile.mdx)",
"description": "The details of the shipping profile that the shipping option belongs to.",
"optional": false,
"defaultValue": "",
@@ -1503,7 +1503,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](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 +1521,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](Region.mdx)",
"description": "The details of the region this shipping option can be used in.",
"optional": false,
"defaultValue": "",
@@ -1539,7 +1539,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](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 +1577,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](Swap.mdx)",
"description": "The details of the swap that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -1585,7 +1585,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](LineItem.mdx)[]",
"description": "The details of the new products to send to the customer, represented as line items.",
"optional": false,
"defaultValue": "",
@@ -1612,7 +1612,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](Cart.mdx)",
"description": "The details of the cart that the customer uses to complete the swap.",
"optional": false,
"defaultValue": "",
@@ -1666,7 +1666,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/SwapFulfillmentStatus.mdx)",
"description": "The status of the Fulfillment of the Swap.",
"optional": false,
"defaultValue": "",
@@ -1675,7 +1675,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](Fulfillment.mdx)[]",
"description": "The details of the fulfillments that are used to send the new items to the customer.",
"optional": false,
"defaultValue": "",
@@ -1702,7 +1702,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1720,7 +1720,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](Order.mdx)",
"description": "The details of the order that the swap belongs to.",
"optional": false,
"defaultValue": "",
@@ -1738,8 +1738,8 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "payment",
"type": "[`Payment`](Payment.mdx)",
"description": "The details of the additional payment authorized by the customer when `difference_due` is positive.",
"type": "[Payment](Payment.mdx)",
"description": "The details of the additional payment authorized by the customer when `difference\\_due` is positive.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -1747,7 +1747,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/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 +1756,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](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 +1765,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](Address.mdx)",
"description": "The details of the shipping address that the new items should be sent to.",
"optional": false,
"defaultValue": "",
@@ -1783,7 +1783,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](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used to fulfill the additional items purchased.",
"optional": false,
"defaultValue": "",
@@ -1812,7 +1812,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](ShippingMethodTaxLine.mdx)[]",
"description": "The details of the tax lines applied on the shipping method.",
"optional": false,
"defaultValue": "",
@@ -1847,7 +1847,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1874,7 +1874,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](ShippingMethod.mdx)",
"description": "The details of the associated shipping method.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ShippingMethodTaxLine.mdx
+10 -10
View File
@@ -40,7 +40,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
},
{
"name": "shipping_method",
"type": "[`ShippingMethod`](ShippingMethod.mdx)",
"type": "[ShippingMethod](ShippingMethod.mdx)",
"description": "The details of the associated shipping method.",
"optional": false,
"defaultValue": "",
@@ -75,7 +75,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
"children": [
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
},
{
"name": "claim_order",
"type": "[`ClaimOrder`](ClaimOrder.mdx)",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"description": "The details of the claim that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -111,7 +111,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.",
"optional": false,
"defaultValue": "",
@@ -139,7 +139,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -175,7 +175,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
},
{
"name": "return_order",
"type": "[`Return`](Return.mdx)",
"type": "[Return](Return.mdx)",
"description": "The details of the return that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -184,7 +184,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
},
{
"name": "shipping_option",
"type": "[`ShippingOption`](ShippingOption.mdx)",
"type": "[ShippingOption](ShippingOption.mdx)",
"description": "The details of the shipping option the method was created from.",
"optional": false,
"defaultValue": "",
@@ -211,7 +211,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
},
{
"name": "swap",
"type": "[`Swap`](Swap.mdx)",
"type": "[Swap](Swap.mdx)",
"description": "The details of the swap that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -229,7 +229,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
},
{
"name": "tax_lines",
"type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]",
"type": "[ShippingMethodTaxLine](ShippingMethodTaxLine.mdx)[]",
"description": "The details of the tax lines applied on the shipping method.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ShippingOption.mdx
+25 -25
View File
@@ -23,7 +23,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
{
"name": "amount",
"type": "``null`` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat_rate`.",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -40,7 +40,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data needed for the Fulfillment Provider to identify the Shipping Option.",
"optional": false,
"defaultValue": "",
@@ -86,7 +86,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -104,8 +104,8 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "price_type",
"type": "[`ShippingOptionPriceType`](../enums/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.",
"type": "[ShippingOptionPriceType](../enums/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": "",
"expandable": false,
@@ -132,7 +132,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](ShippingProfile.mdx)",
"description": "The details of the shipping profile that the shipping option belongs to.",
"optional": false,
"defaultValue": "",
@@ -167,7 +167,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -185,7 +185,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](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 +194,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](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,8 +203,8 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "type",
"type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift_card` or `custom`.",
"type": "[ShippingProfileType](../enums/ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift\\_card` or `custom`.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -232,7 +232,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](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": "",
@@ -250,7 +250,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
{
"name": "is_installed",
"type": "`boolean`",
"description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is_installed` attribute is set to `false`.",
"description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is\\_installed` attribute is set to `false`.",
"optional": false,
"defaultValue": "true",
"expandable": false,
@@ -269,7 +269,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](Region.mdx)",
"description": "The details of the region this shipping option can be used in.",
"optional": false,
"defaultValue": "",
@@ -286,7 +286,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](Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -304,7 +304,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](Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -331,7 +331,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](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": "",
@@ -368,7 +368,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -386,7 +386,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](PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -404,7 +404,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](TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
@@ -431,7 +431,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](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -460,7 +460,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](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 +495,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](ShippingOption.mdx)",
"description": "The details of the shipping option that the requirements belong to.",
"optional": false,
"defaultValue": "",
@@ -513,8 +513,8 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "type",
"type": "[`RequirementType`](../enums/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.",
"type": "[RequirementType](../enums/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": "",
"expandable": false,
www/apps/docs/content/references/entities/classes/ShippingOptionRequirement.mdx
+12 -12
View File
@@ -40,7 +40,7 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
},
{
"name": "shipping_option",
"type": "[`ShippingOption`](ShippingOption.mdx)",
"type": "[ShippingOption](ShippingOption.mdx)",
"description": "The details of the shipping option that the requirements belong to.",
"optional": false,
"defaultValue": "",
@@ -58,7 +58,7 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
{
"name": "amount",
"type": "``null`` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat_rate`.",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -75,7 +75,7 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data needed for the Fulfillment Provider to identify the Shipping Option.",
"optional": false,
"defaultValue": "",
@@ -121,7 +121,7 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -139,8 +139,8 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
},
{
"name": "price_type",
"type": "[`ShippingOptionPriceType`](../enums/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.",
"type": "[ShippingOptionPriceType](../enums/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": "",
"expandable": false,
@@ -148,7 +148,7 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
},
{
"name": "profile",
"type": "[`ShippingProfile`](ShippingProfile.mdx)",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"description": "The details of the shipping profile that the shipping option belongs to.",
"optional": false,
"defaultValue": "",
@@ -166,7 +166,7 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
},
{
"name": "provider",
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)",
"type": "[FulfillmentProvider](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 +184,7 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this shipping option can be used in.",
"optional": false,
"defaultValue": "",
@@ -202,7 +202,7 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
},
{
"name": "requirements",
"type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]",
"type": "[ShippingOptionRequirement](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,8 +231,8 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
},
{
"name": "type",
"type": "[`RequirementType`](../enums/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.",
"type": "[RequirementType](../enums/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": "",
"expandable": false,
www/apps/docs/content/references/entities/classes/ShippingProfile.mdx
+27 -27
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ShippingProfile
A Shipping Profile has a set of defined Shipping Options that can be used to fulfill a given set of Products. For example, gift cards are shipped differently than physical products, so a shipping profile with the type `gift_card` groups together the shipping options that can only be used for gift cards.
A Shipping Profile has a set of defined Shipping Options that can be used to fulfill a given set of Products. For example, gift cards are shipped differently than physical products, so a shipping profile with the type `gift\_card` groups together the shipping options that can only be used for gift cards.
## Properties
@@ -40,7 +40,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -58,7 +58,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](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 +66,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](ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,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](ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -175,7 +175,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](Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -211,7 +211,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -229,7 +229,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](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 +247,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](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 +265,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](ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -274,7 +274,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](SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -283,7 +283,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/ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -301,7 +301,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](ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -328,7 +328,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](ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -355,7 +355,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](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 +384,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](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": "",
@@ -402,7 +402,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
{
"name": "amount",
"type": "``null`` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat_rate`.",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -419,7 +419,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data needed for the Fulfillment Provider to identify the Shipping Option.",
"optional": false,
"defaultValue": "",
@@ -465,7 +465,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -483,8 +483,8 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "price_type",
"type": "[`ShippingOptionPriceType`](../enums/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.",
"type": "[ShippingOptionPriceType](../enums/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": "",
"expandable": false,
@@ -492,7 +492,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](ShippingProfile.mdx)",
"description": "The details of the shipping profile that the shipping option belongs to.",
"optional": false,
"defaultValue": "",
@@ -510,7 +510,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](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 +528,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](Region.mdx)",
"description": "The details of the region this shipping option can be used in.",
"optional": false,
"defaultValue": "",
@@ -546,7 +546,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](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,8 +566,8 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "type",
"type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift_card` or `custom`.",
"type": "[ShippingProfileType](../enums/ShippingProfileType.mdx)",
"description": "The type of the Shipping Profile, may be `default`, `gift\\_card` or `custom`.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/entities/classes/ShippingTaxRate.mdx
+17 -17
View File
@@ -22,7 +22,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -40,7 +40,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "shipping_option",
"type": "[`ShippingOption`](ShippingOption.mdx)",
"type": "[ShippingOption](ShippingOption.mdx)",
"description": "The details of the shipping option.",
"optional": true,
"defaultValue": "",
@@ -58,7 +58,7 @@ This represents the tax rates applied on a shipping option.
{
"name": "amount",
"type": "``null`` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat_rate`.",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -75,7 +75,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data needed for the Fulfillment Provider to identify the Shipping Option.",
"optional": false,
"defaultValue": "",
@@ -121,7 +121,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -139,8 +139,8 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "price_type",
"type": "[`ShippingOptionPriceType`](../enums/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.",
"type": "[ShippingOptionPriceType](../enums/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": "",
"expandable": false,
@@ -148,7 +148,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "profile",
"type": "[`ShippingProfile`](ShippingProfile.mdx)",
"type": "[ShippingProfile](ShippingProfile.mdx)",
"description": "The details of the shipping profile that the shipping option belongs to.",
"optional": false,
"defaultValue": "",
@@ -166,7 +166,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "provider",
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)",
"type": "[FulfillmentProvider](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 +184,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this shipping option can be used in.",
"optional": false,
"defaultValue": "",
@@ -202,7 +202,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "requirements",
"type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]",
"type": "[ShippingOptionRequirement](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 +231,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "tax_rate",
"type": "[`TaxRate`](TaxRate.mdx)",
"type": "[TaxRate](TaxRate.mdx)",
"description": "The details of the associated tax rate.",
"optional": true,
"defaultValue": "",
@@ -266,7 +266,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -302,7 +302,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "product_types",
"type": "[`ProductType`](ProductType.mdx)[]",
"type": "[ProductType](ProductType.mdx)[]",
"description": "The details of the product types that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -311,7 +311,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "products",
"type": "[`Product`](Product.mdx)[]",
"type": "[Product](Product.mdx)[]",
"description": "The details of the products that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -329,7 +329,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region that the rate belongs to.",
"optional": false,
"defaultValue": "",
@@ -356,7 +356,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "shipping_options",
"type": "[`ShippingOption`](ShippingOption.mdx)[]",
"type": "[ShippingOption](ShippingOption.mdx)[]",
"description": "The details of the shipping options that belong to this tax rate.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/StagedJob.mdx
+2 -2
View File
@@ -13,7 +13,7 @@ A staged job resource
<ParameterTypes parameters={[
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "Data necessary for the job",
"optional": false,
"defaultValue": "",
@@ -40,7 +40,7 @@ A staged job resource
},
{
"name": "options",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Store.mdx
+8 -8
View File
@@ -22,7 +22,7 @@ A store holds the main settings of the commerce shop. By default, only one store
},
{
"name": "currencies",
"type": "[`Currency`](Currency.mdx)[]",
"type": "[Currency](Currency.mdx)[]",
"description": "The details of the enabled currencies in the store.",
"optional": false,
"defaultValue": "",
@@ -78,7 +78,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](Currency.mdx)",
"description": "The details of the store's default currency.",
"optional": false,
"defaultValue": "usd",
@@ -152,7 +152,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](SalesChannel.mdx)",
"description": "The details of the store's default sales channel.",
"optional": false,
"defaultValue": "",
@@ -205,7 +205,7 @@ A store holds the main settings of the commerce shop. By default, only one store
},
{
"name": "locations",
"type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]",
"type": "[SalesChannelLocation](SalesChannelLocation.mdx)[]",
"description": "The details of the stock locations related to the sales channel.",
"optional": false,
"defaultValue": "",
@@ -214,7 +214,7 @@ A store holds the main settings of the commerce shop. By default, only one store
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -270,7 +270,7 @@ A store holds the main settings of the commerce shop. By default, only one store
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -289,7 +289,7 @@ A store holds the main settings of the commerce shop. By default, only one store
{
"name": "payment_link_template",
"type": "``null`` \\| `string`",
"description": "A template to generate Payment links from. Use {{cart_id}} to include the payment's `cart_id` in the link.",
"description": "A template to generate Payment links from. Use &#123;&#123;cart\\_id&#125;&#125; to include the payment's `cart\\_id` in the link.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -298,7 +298,7 @@ A store holds the main settings of the commerce shop. By default, only one store
{
"name": "swap_link_template",
"type": "``null`` \\| `string`",
"description": "A template to generate Swap links from. Use {{cart_id}} to include the Swap's `cart_id` in the link.",
"description": "A template to generate Swap links from. Use &#123;&#123;cart\\_id&#125;&#125; to include the Swap's `cart\\_id` in the link.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/entities/classes/Swap.mdx
+12 -12
View File
@@ -13,7 +13,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](LineItem.mdx)[]",
"description": "The details of the new products to send to the customer, represented as line items.",
"optional": false,
"defaultValue": "",
@@ -40,7 +40,7 @@ A swap can be created when a Customer wishes to exchange Products that they have
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the customer uses to complete the swap.",
"optional": false,
"defaultValue": "",
@@ -94,7 +94,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/SwapFulfillmentStatus.mdx)",
"description": "The status of the Fulfillment of the Swap.",
"optional": false,
"defaultValue": "",
@@ -103,7 +103,7 @@ A swap can be created when a Customer wishes to exchange Products that they have
},
{
"name": "fulfillments",
"type": "[`Fulfillment`](Fulfillment.mdx)[]",
"type": "[Fulfillment](Fulfillment.mdx)[]",
"description": "The details of the fulfillments that are used to send the new items to the customer.",
"optional": false,
"defaultValue": "",
@@ -130,7 +130,7 @@ A swap can be created when a Customer wishes to exchange Products that they have
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -148,7 +148,7 @@ A swap can be created when a Customer wishes to exchange Products that they have
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the swap belongs to.",
"optional": false,
"defaultValue": "",
@@ -166,8 +166,8 @@ A swap can be created when a Customer wishes to exchange Products that they have
},
{
"name": "payment",
"type": "[`Payment`](Payment.mdx)",
"description": "The details of the additional payment authorized by the customer when `difference_due` is positive.",
"type": "[Payment](Payment.mdx)",
"description": "The details of the additional payment authorized by the customer when `difference\\_due` is positive.",
"optional": false,
"defaultValue": "",
"expandable": true,
@@ -175,7 +175,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/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 +184,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](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 +193,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](Address.mdx)",
"description": "The details of the shipping address that the new items should be sent to.",
"optional": false,
"defaultValue": "",
@@ -211,7 +211,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](ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used to fulfill the additional items purchased.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/TaxLine.mdx
+1 -1
View File
@@ -40,7 +40,7 @@ A tax line represents the taxes amount applied to a line item.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/TaxProvider.mdx
+1 -1
View File
@@ -23,7 +23,7 @@ A tax provider represents a tax service installed in the Medusa backend, either
{
"name": "is_installed",
"type": "`boolean`",
"description": "Whether the tax service is installed in the current version. If a tax service is no longer installed, the `is_installed` attribute is set to `false`.",
"description": "Whether the tax service is installed in the current version. If a tax service is no longer installed, the `is\\_installed` attribute is set to `false`.",
"optional": false,
"defaultValue": "true",
"expandable": false,
www/apps/docs/content/references/entities/classes/TaxRate.mdx
+34 -34
View File
@@ -40,7 +40,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,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](ProductType.mdx)[]",
"description": "The details of the product types that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -111,7 +111,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -140,7 +140,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](Product.mdx)[]",
"description": "The details of the products that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -148,7 +148,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](ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
@@ -158,7 +158,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](ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -257,7 +257,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](Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
@@ -293,7 +293,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -311,7 +311,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](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 +329,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](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 +347,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](ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
@@ -356,7 +356,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](SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
@@ -365,7 +365,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/ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
@@ -383,7 +383,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](ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
@@ -410,7 +410,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](ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -437,7 +437,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](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 +475,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](Region.mdx)",
"description": "The details of the region that the rate belongs to.",
"optional": false,
"defaultValue": "",
@@ -492,7 +492,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](Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -510,7 +510,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](Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -537,7 +537,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](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": "",
@@ -574,7 +574,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -592,7 +592,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](PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -610,7 +610,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](TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
@@ -637,7 +637,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](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -675,7 +675,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](ShippingOption.mdx)[]",
"description": "The details of the shipping options that belong to this tax rate.",
"optional": false,
"defaultValue": "",
@@ -693,7 +693,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
{
"name": "amount",
"type": "``null`` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat_rate`.",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -710,7 +710,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data needed for the Fulfillment Provider to identify the Shipping Option.",
"optional": false,
"defaultValue": "",
@@ -756,7 +756,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -774,8 +774,8 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "price_type",
"type": "[`ShippingOptionPriceType`](../enums/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.",
"type": "[ShippingOptionPriceType](../enums/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": "",
"expandable": false,
@@ -783,7 +783,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](ShippingProfile.mdx)",
"description": "The details of the shipping profile that the shipping option belongs to.",
"optional": false,
"defaultValue": "",
@@ -801,7 +801,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](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 +819,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](Region.mdx)",
"description": "The details of the region this shipping option can be used in.",
"optional": false,
"defaultValue": "",
@@ -837,7 +837,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](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": "",
www/apps/docs/content/references/entities/classes/TrackingLink.mdx
+10 -10
View File
@@ -31,7 +31,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac
},
{
"name": "fulfillment",
"type": "[`Fulfillment`](Fulfillment.mdx)",
"type": "[Fulfillment](Fulfillment.mdx)",
"description": "The details of the fulfillment that the tracking link belongs to.",
"optional": false,
"defaultValue": "",
@@ -48,7 +48,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac
},
{
"name": "claim_order",
"type": "[`ClaimOrder`](ClaimOrder.mdx)",
"type": "[ClaimOrder](ClaimOrder.mdx)",
"description": "The details of the claim that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -75,7 +75,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac
},
{
"name": "items",
"type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]",
"type": "[FulfillmentItem](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 +120,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -156,7 +156,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac
},
{
"name": "provider",
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)",
"description": "The details of the fulfillment provider responsible for handling the fulfillment.",
"optional": false,
"defaultValue": "",
@@ -183,7 +183,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac
},
{
"name": "swap",
"type": "[`Swap`](Swap.mdx)",
"type": "[Swap](Swap.mdx)",
"description": "The details of the swap that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
@@ -201,7 +201,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac
},
{
"name": "tracking_links",
"type": "[`TrackingLink`](TrackingLink.mdx)[]",
"type": "[TrackingLink](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": "",
@@ -257,7 +257,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/User.mdx
+2 -2
View File
@@ -76,7 +76,7 @@ A User is an administrator who can manage store settings and data.
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -94,7 +94,7 @@ A User is an administrator who can manage store settings and data.
},
{
"name": "role",
"type": "[`UserRoles`](../enums/UserRoles.mdx)",
"type": "[UserRoles](../enums/UserRoles.mdx)",
"description": "The user's role. These roles don't provide any different privileges.",
"optional": false,
"defaultValue": "member",
www/apps/docs/content/references/entities/enums/AllocationType.mdx
+2 -2
View File
@@ -12,7 +12,7 @@ The scope that the discount should apply to.
### ITEM
**ITEM** = ``"item"``
**ITEM** = `"item"`
The discount should be applied to applicable items in the cart.
@@ -20,6 +20,6 @@ ___
### TOTAL
**TOTAL** = ``"total"``
**TOTAL** = `"total"`
The discount should be applied to the checkout total.
www/apps/docs/content/references/entities/enums/BatchJobStatus.mdx
+7 -7
View File
@@ -10,40 +10,40 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### CANCELED
**CANCELED** = ``"canceled"``
**CANCELED** = `"canceled"`
___
### COMPLETED
**COMPLETED** = ``"completed"``
**COMPLETED** = `"completed"`
___
### CONFIRMED
**CONFIRMED** = ``"confirmed"``
**CONFIRMED** = `"confirmed"`
___
### CREATED
**CREATED** = ``"created"``
**CREATED** = `"created"`
___
### FAILED
**FAILED** = ``"failed"``
**FAILED** = `"failed"`
___
### PRE\_PROCESSED
**PRE\_PROCESSED** = ``"pre_processed"``
**PRE\_PROCESSED** = `"pre_processed"`
___
### PROCESSING
**PROCESSING** = ``"processing"``
**PROCESSING** = `"processing"`
www/apps/docs/content/references/entities/enums/CartType.mdx
+5 -5
View File
@@ -10,28 +10,28 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### CLAIM
**CLAIM** = ``"claim"``
**CLAIM** = `"claim"`
___
### DEFAULT
**DEFAULT** = ``"default"``
**DEFAULT** = `"default"`
___
### DRAFT\_ORDER
**DRAFT\_ORDER** = ``"draft_order"``
**DRAFT\_ORDER** = `"draft_order"`
___
### PAYMENT\_LINK
**PAYMENT\_LINK** = ``"payment_link"``
**PAYMENT\_LINK** = `"payment_link"`
___
### SWAP
**SWAP** = ``"swap"``
**SWAP** = `"swap"`
www/apps/docs/content/references/entities/enums/ClaimFulfillmentStatus.mdx
+9 -9
View File
@@ -12,7 +12,7 @@ The claim's fulfillment status.
### CANCELED
**CANCELED** = ``"canceled"``
**CANCELED** = `"canceled"`
The claim's fulfillments are canceled.
@@ -20,7 +20,7 @@ ___
### FULFILLED
**FULFILLED** = ``"fulfilled"``
**FULFILLED** = `"fulfilled"`
The claim's replacement items are fulfilled.
@@ -28,7 +28,7 @@ ___
### NOT\_FULFILLED
**NOT\_FULFILLED** = ``"not_fulfilled"``
**NOT\_FULFILLED** = `"not_fulfilled"`
The claim's replacement items are not fulfilled.
@@ -36,7 +36,7 @@ ___
### PARTIALLY\_FULFILLED
**PARTIALLY\_FULFILLED** = ``"partially_fulfilled"``
**PARTIALLY\_FULFILLED** = `"partially_fulfilled"`
Some of the claim's replacement items, but not all, are fulfilled.
@@ -44,7 +44,7 @@ ___
### PARTIALLY\_RETURNED
**PARTIALLY\_RETURNED** = ``"partially_returned"``
**PARTIALLY\_RETURNED** = `"partially_returned"`
Some of the claim's items, but not all, are returned.
@@ -52,7 +52,7 @@ ___
### PARTIALLY\_SHIPPED
**PARTIALLY\_SHIPPED** = ``"partially_shipped"``
**PARTIALLY\_SHIPPED** = `"partially_shipped"`
Some of the claim's replacement items, but not all, are shipped.
@@ -60,7 +60,7 @@ ___
### REQUIRES\_ACTION
**REQUIRES\_ACTION** = ``"requires_action"``
**REQUIRES\_ACTION** = `"requires_action"`
The claim's fulfillment requires action.
@@ -68,7 +68,7 @@ ___
### RETURNED
**RETURNED** = ``"returned"``
**RETURNED** = `"returned"`
The claim's items are returned.
@@ -76,6 +76,6 @@ ___
### SHIPPED
**SHIPPED** = ``"shipped"``
**SHIPPED** = `"shipped"`
The claim's replacement items are shipped.
www/apps/docs/content/references/entities/enums/ClaimPaymentStatus.mdx
+3 -3
View File
@@ -12,7 +12,7 @@ The claim's payment status
### NA
**NA** = ``"na"``
**NA** = `"na"`
The payment status isn't set, which is typically used when the claim's type is `replace`.
@@ -20,7 +20,7 @@ ___
### NOT\_REFUNDED
**NOT\_REFUNDED** = ``"not_refunded"``
**NOT\_REFUNDED** = `"not_refunded"`
The payment isn't refunded.
@@ -28,6 +28,6 @@ ___
### REFUNDED
**REFUNDED** = ``"refunded"``
**REFUNDED** = `"refunded"`
The payment is refunded.
www/apps/docs/content/references/entities/enums/ClaimReason.mdx
+4 -4
View File
@@ -10,22 +10,22 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### MISSING\_ITEM
**MISSING\_ITEM** = ``"missing_item"``
**MISSING\_ITEM** = `"missing_item"`
___
### OTHER
**OTHER** = ``"other"``
**OTHER** = `"other"`
___
### PRODUCTION\_FAILURE
**PRODUCTION\_FAILURE** = ``"production_failure"``
**PRODUCTION\_FAILURE** = `"production_failure"`
___
### WRONG\_ITEM
**WRONG\_ITEM** = ``"wrong_item"``
**WRONG\_ITEM** = `"wrong_item"`
www/apps/docs/content/references/entities/enums/ClaimType.mdx
+2 -2
View File
@@ -12,7 +12,7 @@ The claim's type.
### REFUND
**REFUND** = ``"refund"``
**REFUND** = `"refund"`
The claim refunds an amount to the customer.
@@ -20,6 +20,6 @@ ___
### REPLACE
**REPLACE** = ``"replace"``
**REPLACE** = `"replace"`
The claim replaces the returned item with a new one.
www/apps/docs/content/references/entities/enums/DiscountConditionOperator.mdx
+2 -2
View File
@@ -12,7 +12,7 @@ The possible operators used for a discount condition.
### IN
**IN** = ``"in"``
**IN** = `"in"`
The discountable resources are within the specified resources.
@@ -20,6 +20,6 @@ ___
### NOT\_IN
**NOT\_IN** = ``"not_in"``
**NOT\_IN** = `"not_in"`
The discountable resources are everything but the specified resources.
www/apps/docs/content/references/entities/enums/DiscountConditionType.mdx
+5 -5
View File
@@ -12,7 +12,7 @@ The discount condition's type.
### CUSTOMER\_GROUPS
**CUSTOMER\_GROUPS** = ``"customer_groups"``
**CUSTOMER\_GROUPS** = `"customer_groups"`
The discount condition is used for customer groups.
@@ -20,7 +20,7 @@ ___
### PRODUCTS
**PRODUCTS** = ``"products"``
**PRODUCTS** = `"products"`
The discount condition is used for products.
@@ -28,7 +28,7 @@ ___
### PRODUCT\_COLLECTIONS
**PRODUCT\_COLLECTIONS** = ``"product_collections"``
**PRODUCT\_COLLECTIONS** = `"product_collections"`
The discount condition is used for product collections.
@@ -36,7 +36,7 @@ ___
### PRODUCT\_TAGS
**PRODUCT\_TAGS** = ``"product_tags"``
**PRODUCT\_TAGS** = `"product_tags"`
The discount condition is used for product tags.
@@ -44,6 +44,6 @@ ___
### PRODUCT\_TYPES
**PRODUCT\_TYPES** = ``"product_types"``
**PRODUCT\_TYPES** = `"product_types"`
The discount condition is used for product types.
www/apps/docs/content/references/entities/enums/DiscountRuleType.mdx
+3 -3
View File
@@ -12,7 +12,7 @@ The possible types of discount rules.
### FIXED
**FIXED** = ``"fixed"``
**FIXED** = `"fixed"`
Discounts that reduce the price by a fixed amount.
@@ -20,7 +20,7 @@ ___
### FREE\_SHIPPING
**FREE\_SHIPPING** = ``"free_shipping"``
**FREE\_SHIPPING** = `"free_shipping"`
Discounts that sets the shipping price to `0`.
@@ -28,6 +28,6 @@ ___
### PERCENTAGE
**PERCENTAGE** = ``"percentage"``
**PERCENTAGE** = `"percentage"`
Discounts that reduce the price by a percentage reduction.
www/apps/docs/content/references/entities/enums/DraftOrderStatus.mdx
+2 -2
View File
@@ -12,7 +12,7 @@ The draft order's status.
### COMPLETED
**COMPLETED** = ``"completed"``
**COMPLETED** = `"completed"`
The draft order is completed, and an order has been created from it.
@@ -20,6 +20,6 @@ ___
### OPEN
**OPEN** = ``"open"``
**OPEN** = `"open"`
The draft order is open.
www/apps/docs/content/references/entities/enums/FulfillmentStatus.mdx
+9 -9
View File
@@ -12,7 +12,7 @@ The order's fulfillment status.
### CANCELED
**CANCELED** = ``"canceled"``
**CANCELED** = `"canceled"`
The order's fulfillments are canceled.
@@ -20,7 +20,7 @@ ___
### FULFILLED
**FULFILLED** = ``"fulfilled"``
**FULFILLED** = `"fulfilled"`
The order's items are fulfilled.
@@ -28,7 +28,7 @@ ___
### NOT\_FULFILLED
**NOT\_FULFILLED** = ``"not_fulfilled"``
**NOT\_FULFILLED** = `"not_fulfilled"`
The order's items are not fulfilled.
@@ -36,7 +36,7 @@ ___
### PARTIALLY\_FULFILLED
**PARTIALLY\_FULFILLED** = ``"partially_fulfilled"``
**PARTIALLY\_FULFILLED** = `"partially_fulfilled"`
Some of the order's items, but not all, are fulfilled.
@@ -44,7 +44,7 @@ ___
### PARTIALLY\_RETURNED
**PARTIALLY\_RETURNED** = ``"partially_returned"``
**PARTIALLY\_RETURNED** = `"partially_returned"`
Some of the order's items, but not all, are returned.
@@ -52,7 +52,7 @@ ___
### PARTIALLY\_SHIPPED
**PARTIALLY\_SHIPPED** = ``"partially_shipped"``
**PARTIALLY\_SHIPPED** = `"partially_shipped"`
Some of the order's items, but not all, are shipped.
@@ -60,7 +60,7 @@ ___
### REQUIRES\_ACTION
**REQUIRES\_ACTION** = ``"requires_action"``
**REQUIRES\_ACTION** = `"requires_action"`
The order's fulfillment requires action.
@@ -68,7 +68,7 @@ ___
### RETURNED
**RETURNED** = ``"returned"``
**RETURNED** = `"returned"`
The order's items are returned.
@@ -76,6 +76,6 @@ ___
### SHIPPED
**SHIPPED** = ``"shipped"``
**SHIPPED** = `"shipped"`
The order's items are shipped.
www/apps/docs/content/references/entities/enums/OrderEditItemChangeType.mdx
+3 -3
View File
@@ -12,7 +12,7 @@ The type of the order edit item change.
### ITEM\_ADD
**ITEM\_ADD** = ``"item_add"``
**ITEM\_ADD** = `"item_add"`
A new item to be added to the original order.
@@ -20,7 +20,7 @@ ___
### ITEM\_REMOVE
**ITEM\_REMOVE** = ``"item_remove"``
**ITEM\_REMOVE** = `"item_remove"`
An existing item to be removed from the original order.
@@ -28,6 +28,6 @@ ___
### ITEM\_UPDATE
**ITEM\_UPDATE** = ``"item_update"``
**ITEM\_UPDATE** = `"item_update"`
An existing item to be updated in the original order.
www/apps/docs/content/references/entities/enums/OrderEditStatus.mdx
+5 -5
View File
@@ -12,7 +12,7 @@ The order edit's status.
### CANCELED
**CANCELED** = ``"canceled"``
**CANCELED** = `"canceled"`
The order edit is canceled.
@@ -20,7 +20,7 @@ ___
### CONFIRMED
**CONFIRMED** = ``"confirmed"``
**CONFIRMED** = `"confirmed"`
The order edit is confirmed.
@@ -28,7 +28,7 @@ ___
### CREATED
**CREATED** = ``"created"``
**CREATED** = `"created"`
The order edit is created.
@@ -36,7 +36,7 @@ ___
### DECLINED
**DECLINED** = ``"declined"``
**DECLINED** = `"declined"`
The order edit is declined.
@@ -44,6 +44,6 @@ ___
### REQUESTED
**REQUESTED** = ``"requested"``
**REQUESTED** = `"requested"`
The order edit is requested.
www/apps/docs/content/references/entities/enums/OrderStatus.mdx
+5 -5
View File
@@ -12,7 +12,7 @@ The order's status.
### ARCHIVED
**ARCHIVED** = ``"archived"``
**ARCHIVED** = `"archived"`
The order is archived.
@@ -20,7 +20,7 @@ ___
### CANCELED
**CANCELED** = ``"canceled"``
**CANCELED** = `"canceled"`
The order is canceled.
@@ -28,7 +28,7 @@ ___
### COMPLETED
**COMPLETED** = ``"completed"``
**COMPLETED** = `"completed"`
The order is completed, meaning that
the items have been fulfilled and the payment
@@ -38,7 +38,7 @@ ___
### PENDING
**PENDING** = ``"pending"``
**PENDING** = `"pending"`
The order is pending.
@@ -46,6 +46,6 @@ ___
### REQUIRES\_ACTION
**REQUIRES\_ACTION** = ``"requires_action"``
**REQUIRES\_ACTION** = `"requires_action"`
The order requires action.
www/apps/docs/content/references/entities/enums/PaymentCollectionStatus.mdx
+5 -5
View File
@@ -12,7 +12,7 @@ The payment collection's status.
### AUTHORIZED
**AUTHORIZED** = ``"authorized"``
**AUTHORIZED** = `"authorized"`
The payment colleciton is authorized.
@@ -20,7 +20,7 @@ ___
### AWAITING
**AWAITING** = ``"awaiting"``
**AWAITING** = `"awaiting"`
The payment collection is awaiting payment.
@@ -28,7 +28,7 @@ ___
### CANCELED
**CANCELED** = ``"canceled"``
**CANCELED** = `"canceled"`
The payment collection is canceled.
@@ -36,7 +36,7 @@ ___
### NOT\_PAID
**NOT\_PAID** = ``"not_paid"``
**NOT\_PAID** = `"not_paid"`
The payment collection isn't paid.
@@ -44,6 +44,6 @@ ___
### PARTIALLY\_AUTHORIZED
**PARTIALLY\_AUTHORIZED** = ``"partially_authorized"``
**PARTIALLY\_AUTHORIZED** = `"partially_authorized"`
Some of the payments in the payment collection are authorized.
www/apps/docs/content/references/entities/enums/PaymentCollectionType.mdx
+1 -1
View File
@@ -12,6 +12,6 @@ The payment collection's type.
### ORDER\_EDIT
**ORDER\_EDIT** = ``"order_edit"``
**ORDER\_EDIT** = `"order_edit"`
The payment collection is used for an order edit.
www/apps/docs/content/references/entities/enums/PaymentSessionStatus.mdx
+5 -5
View File
@@ -10,28 +10,28 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### AUTHORIZED
**AUTHORIZED** = ``"authorized"``
**AUTHORIZED** = `"authorized"`
___
### CANCELED
**CANCELED** = ``"canceled"``
**CANCELED** = `"canceled"`
___
### ERROR
**ERROR** = ``"error"``
**ERROR** = `"error"`
___
### PENDING
**PENDING** = ``"pending"``
**PENDING** = `"pending"`
___
### REQUIRES\_MORE
**REQUIRES\_MORE** = ``"requires_more"``
**REQUIRES\_MORE** = `"requires_more"`
www/apps/docs/content/references/entities/enums/PaymentStatus.mdx
+7 -7
View File
@@ -12,7 +12,7 @@ The order's payment status.
### AWAITING
**AWAITING** = ``"awaiting"``
**AWAITING** = `"awaiting"`
The order's payment is awaiting capturing.
@@ -20,7 +20,7 @@ ___
### CANCELED
**CANCELED** = ``"canceled"``
**CANCELED** = `"canceled"`
The order's payment is canceled.
@@ -28,7 +28,7 @@ ___
### CAPTURED
**CAPTURED** = ``"captured"``
**CAPTURED** = `"captured"`
The order's payment is captured.
@@ -36,7 +36,7 @@ ___
### NOT\_PAID
**NOT\_PAID** = ``"not_paid"``
**NOT\_PAID** = `"not_paid"`
The order's payment is not paid.
@@ -44,7 +44,7 @@ ___
### PARTIALLY\_REFUNDED
**PARTIALLY\_REFUNDED** = ``"partially_refunded"``
**PARTIALLY\_REFUNDED** = `"partially_refunded"`
Some of the order's payment amount is refunded.
@@ -52,7 +52,7 @@ ___
### REFUNDED
**REFUNDED** = ``"refunded"``
**REFUNDED** = `"refunded"`
The order's payment amount is refunded.
@@ -60,6 +60,6 @@ ___
### REQUIRES\_ACTION
**REQUIRES\_ACTION** = ``"requires_action"``
**REQUIRES\_ACTION** = `"requires_action"`
The order's payment requires action.
www/apps/docs/content/references/entities/enums/PriceListStatus.mdx
+2 -2
View File
@@ -12,7 +12,7 @@ The status of a price list.
### ACTIVE
**ACTIVE** = ``"active"``
**ACTIVE** = `"active"`
The price list is active, meaning its prices are applied to customers.
@@ -20,6 +20,6 @@ ___
### DRAFT
**DRAFT** = ``"draft"``
**DRAFT** = `"draft"`
The price list is a draft, meaning its not yet applied to customers.
www/apps/docs/content/references/entities/enums/PriceListType.mdx
+2 -2
View File
@@ -12,7 +12,7 @@ The type of price list.
### OVERRIDE
**OVERRIDE** = ``"override"``
**OVERRIDE** = `"override"`
The price list is used to override original prices for specific conditions.
@@ -20,6 +20,6 @@ ___
### SALE
**SALE** = ``"sale"``
**SALE** = `"sale"`
The price list is used for a sale.
www/apps/docs/content/references/entities/enums/ProductStatus.mdx
+4 -4
View File
@@ -12,7 +12,7 @@ The status of a product.
### DRAFT
**DRAFT** = ``"draft"``
**DRAFT** = `"draft"`
The product is a draft. It's not viewable by customers.
@@ -20,7 +20,7 @@ ___
### PROPOSED
**PROPOSED** = ``"proposed"``
**PROPOSED** = `"proposed"`
The product is proposed, but not yet published.
@@ -28,7 +28,7 @@ ___
### PUBLISHED
**PUBLISHED** = ``"published"``
**PUBLISHED** = `"published"`
The product is published.
@@ -36,6 +36,6 @@ ___
### REJECTED
**REJECTED** = ``"rejected"``
**REJECTED** = `"rejected"`
The product is rejected. It's not viewable by customers.
www/apps/docs/content/references/entities/enums/RefundReason.mdx
+5 -5
View File
@@ -12,7 +12,7 @@ The reason of the refund.
### CLAIM
**CLAIM** = ``"claim"``
**CLAIM** = `"claim"`
The refund is applied because of a created claim.
@@ -20,7 +20,7 @@ ___
### DISCOUNT
**DISCOUNT** = ``"discount"``
**DISCOUNT** = `"discount"`
The refund is applied as a discount.
@@ -28,7 +28,7 @@ ___
### OTHER
**OTHER** = ``"other"``
**OTHER** = `"other"`
The refund is created for a custom reason.
@@ -36,7 +36,7 @@ ___
### RETURN
**RETURN** = ``"return"``
**RETURN** = `"return"`
The refund is applied because of a created return.
@@ -44,6 +44,6 @@ ___
### SWAP
**SWAP** = ``"swap"``
**SWAP** = `"swap"`
The refund is applied because of a created swap.
www/apps/docs/content/references/entities/enums/RequirementType.mdx
+2 -2
View File
@@ -12,7 +12,7 @@ The type of shipping option requirement.
### MAX\_SUBTOTAL
**MAX\_SUBTOTAL** = ``"max_subtotal"``
**MAX\_SUBTOTAL** = `"max_subtotal"`
The shipping option can only be applied if the subtotal is less than the requirement's amont.
@@ -20,6 +20,6 @@ ___
### MIN\_SUBTOTAL
**MIN\_SUBTOTAL** = ``"min_subtotal"``
**MIN\_SUBTOTAL** = `"min_subtotal"`
The shipping option can only be applied if the subtotal is greater than the requirement's amount.
Loaded 100 of 2265 files, more files were not shown because too many files have changed in this diff. Show more