docs: enhance how references are generated (#5805)
* adjusted configurations * enhancements to tool and configurations * change reference in docs * fixed issue in workflows reference * added project name * more optimizations * fix context error * added a types reference * resolved missing types * fix reference reflection types not having children * add an expand url parameter * added new option to the README * added details about new option
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
a418e6cebc
commit
892d737c1f
4358 files changed
+947876
-534760
No files matched your search
@@ -1 +0,0 @@
|
||||
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
|
||||
@@ -1,180 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Fulfillment Provider Reference
|
||||
|
||||
## Enumerations
|
||||
|
||||
- [AllocationType](enums/AllocationType.mdx)
|
||||
- [CartType](enums/CartType.mdx)
|
||||
- [ClaimFulfillmentStatus](enums/ClaimFulfillmentStatus.mdx)
|
||||
- [ClaimPaymentStatus](enums/ClaimPaymentStatus.mdx)
|
||||
- [ClaimReason](enums/ClaimReason.mdx)
|
||||
- [ClaimType](enums/ClaimType.mdx)
|
||||
- [DiscountConditionOperator](enums/DiscountConditionOperator.mdx)
|
||||
- [DiscountConditionType](enums/DiscountConditionType.mdx)
|
||||
- [DiscountRuleType](enums/DiscountRuleType.mdx)
|
||||
- [DraftOrderStatus](enums/DraftOrderStatus.mdx)
|
||||
- [FulfillmentStatus](enums/FulfillmentStatus.mdx)
|
||||
- [OrderEditItemChangeType](enums/OrderEditItemChangeType.mdx)
|
||||
- [OrderEditStatus](enums/OrderEditStatus.mdx)
|
||||
- [OrderStatus](enums/OrderStatus.mdx)
|
||||
- [PaymentCollectionStatus](enums/PaymentCollectionStatus.mdx)
|
||||
- [PaymentStatus](enums/PaymentStatus.mdx)
|
||||
- [PriceListStatus](enums/PriceListStatus.mdx)
|
||||
- [PriceListType](enums/PriceListType.mdx)
|
||||
- [ProductStatus](enums/ProductStatus.mdx)
|
||||
- [RequirementType](enums/RequirementType.mdx)
|
||||
- [ReturnStatus](enums/ReturnStatus.mdx)
|
||||
- [ShippingOptionPriceType](enums/ShippingOptionPriceType.mdx)
|
||||
- [ShippingProfileType](enums/ShippingProfileType.mdx)
|
||||
- [SwapFulfillmentStatus](enums/SwapFulfillmentStatus.mdx)
|
||||
- [SwapPaymentStatus](enums/SwapPaymentStatus.mdx)
|
||||
|
||||
## Classes
|
||||
|
||||
- [AbstractFulfillmentService](classes/AbstractFulfillmentService.mdx)
|
||||
- [Address](classes/Address.mdx)
|
||||
- [BaseEntity](classes/BaseEntity.mdx)
|
||||
- [Cart](classes/Cart.mdx)
|
||||
- [ClaimImage](classes/ClaimImage.mdx)
|
||||
- [ClaimItem](classes/ClaimItem.mdx)
|
||||
- [ClaimOrder](classes/ClaimOrder.mdx)
|
||||
- [ClaimTag](classes/ClaimTag.mdx)
|
||||
- [Country](classes/Country.mdx)
|
||||
- [Currency](classes/Currency.mdx)
|
||||
- [Customer](classes/Customer.mdx)
|
||||
- [CustomerGroup](classes/CustomerGroup.mdx)
|
||||
- [Discount](classes/Discount.mdx)
|
||||
- [DiscountCondition](classes/DiscountCondition.mdx)
|
||||
- [DiscountRule](classes/DiscountRule.mdx)
|
||||
- [DraftOrder](classes/DraftOrder.mdx)
|
||||
- [Fulfillment](classes/Fulfillment.mdx)
|
||||
- [FulfillmentItem](classes/FulfillmentItem.mdx)
|
||||
- [FulfillmentProvider](classes/FulfillmentProvider.mdx)
|
||||
- [GiftCard](classes/GiftCard.mdx)
|
||||
- [GiftCardTransaction](classes/GiftCardTransaction.mdx)
|
||||
- [Image](classes/Image.mdx)
|
||||
- [LineItem](classes/LineItem.mdx)
|
||||
- [LineItemAdjustment](classes/LineItemAdjustment.mdx)
|
||||
- [LineItemTaxLine](classes/LineItemTaxLine.mdx)
|
||||
- [MoneyAmount](classes/MoneyAmount.mdx)
|
||||
- [Order](classes/Order.mdx)
|
||||
- [OrderEdit](classes/OrderEdit.mdx)
|
||||
- [OrderItemChange](classes/OrderItemChange.mdx)
|
||||
- [Payment](classes/Payment.mdx)
|
||||
- [PaymentCollection](classes/PaymentCollection.mdx)
|
||||
- [PaymentProvider](classes/PaymentProvider.mdx)
|
||||
- [PaymentSession](classes/PaymentSession.mdx)
|
||||
- [PriceList](classes/PriceList.mdx)
|
||||
- [Product](classes/Product.mdx)
|
||||
- [ProductCategory](classes/ProductCategory.mdx)
|
||||
- [ProductCollection](classes/ProductCollection.mdx)
|
||||
- [ProductOption](classes/ProductOption.mdx)
|
||||
- [ProductOptionValue](classes/ProductOptionValue.mdx)
|
||||
- [ProductTag](classes/ProductTag.mdx)
|
||||
- [ProductType](classes/ProductType.mdx)
|
||||
- [ProductVariant](classes/ProductVariant.mdx)
|
||||
- [ProductVariantInventoryItem](classes/ProductVariantInventoryItem.mdx)
|
||||
- [Refund](classes/Refund.mdx)
|
||||
- [Region](classes/Region.mdx)
|
||||
- [Return](classes/Return.mdx)
|
||||
- [ReturnItem](classes/ReturnItem.mdx)
|
||||
- [ReturnReason](classes/ReturnReason.mdx)
|
||||
- [SalesChannel](classes/SalesChannel.mdx)
|
||||
- [SalesChannelLocation](classes/SalesChannelLocation.mdx)
|
||||
- [ShippingMethod](classes/ShippingMethod.mdx)
|
||||
- [ShippingMethodTaxLine](classes/ShippingMethodTaxLine.mdx)
|
||||
- [ShippingOption](classes/ShippingOption.mdx)
|
||||
- [ShippingOptionRequirement](classes/ShippingOptionRequirement.mdx)
|
||||
- [ShippingProfile](classes/ShippingProfile.mdx)
|
||||
- [SoftDeletableEntity](classes/SoftDeletableEntity.mdx)
|
||||
- [Swap](classes/Swap.mdx)
|
||||
- [TaxLine](classes/TaxLine.mdx)
|
||||
- [TaxProvider](classes/TaxProvider.mdx)
|
||||
- [TaxRate](classes/TaxRate.mdx)
|
||||
- [TrackingLink](classes/TrackingLink.mdx)
|
||||
|
||||
## Interfaces
|
||||
|
||||
- [Boolean](interfaces/Boolean.mdx)
|
||||
- [FulfillmentService](interfaces/FulfillmentService.mdx)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
- [CreateReturnType](types/CreateReturnType.mdx)
|
||||
- [Exclude](types/Exclude.mdx)
|
||||
- [FulfillmentProviderData](types/FulfillmentProviderData.mdx)
|
||||
- [MedusaContainer](types/MedusaContainer.mdx)
|
||||
- [Omit](types/Omit.mdx)
|
||||
- [Pick](types/Pick.mdx)
|
||||
- [Record](types/Record.mdx)
|
||||
- [ShippingMethodData](types/ShippingMethodData.mdx)
|
||||
- [ShippingOptionData](types/ShippingOptionData.mdx)
|
||||
|
||||
## References
|
||||
|
||||
### default
|
||||
|
||||
Renames and re-exports [AbstractFulfillmentService](classes/AbstractFulfillmentService.mdx)
|
||||
|
||||
___
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### ORDER\_EDIT
|
||||
|
||||
**ORDER\_EDIT**: `"order_edit"`
|
||||
|
||||
The payment collection is used for an order edit.
|
||||
|
||||
___
|
||||
|
||||
## Functions
|
||||
|
||||
### Boolean
|
||||
|
||||
#### Type Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`T`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "boolean",
|
||||
"type": "`boolean`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Address
|
||||
|
||||
An address is used across the Medusa backend within other schemas and object types. For example, a customer's billing and shipping addresses both use the Address entity.
|
||||
|
||||
## constructor
|
||||
|
||||
An address is used across the Medusa backend within other schemas and object types. For example, a customer's billing and shipping addresses both use the Address entity.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,11 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# BaseEntity
|
||||
|
||||
Base abstract entity for all entities
|
||||
|
||||
## constructor
|
||||
@@ -1,51 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Cart
|
||||
|
||||
A cart represents a virtual shopping bag. It can be used to complete an order, a swap, or a claim.
|
||||
|
||||
## constructor
|
||||
|
||||
A cart represents a virtual shopping bag. It can be used to complete an order, a swap, or a claim.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### afterLoad
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ClaimImage
|
||||
|
||||
The details of an image attached to a claim.
|
||||
|
||||
## constructor
|
||||
|
||||
The details of an image attached to a claim.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ClaimItem
|
||||
|
||||
A claim item is an item created as part of a claim. It references an item in the order that should be exchanged or refunded.
|
||||
|
||||
## constructor
|
||||
|
||||
A claim item is an item created as part of a claim. It references an item in the order that should be exchanged or refunded.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ClaimOrder
|
||||
|
||||
A Claim represents a group of faulty or missing items. It consists of claim items that refer to items in the original order that should be replaced or refunded. It also includes details related to shipping and fulfillment.
|
||||
|
||||
## constructor
|
||||
|
||||
A Claim represents a group of faulty or missing items. It consists of claim items that refer to items in the original order that should be replaced or refunded. It also includes details related to shipping and fulfillment.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ClaimTag
|
||||
|
||||
Claim Tags are user defined tags that can be assigned to claim items for easy filtering and grouping.
|
||||
|
||||
## constructor
|
||||
|
||||
Claim Tags are user defined tags that can be assigned to claim items for easy filtering and grouping.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Country
|
||||
|
||||
Country details
|
||||
|
||||
## constructor
|
||||
|
||||
Country details
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Currency
|
||||
|
||||
Currency
|
||||
|
||||
## constructor
|
||||
|
||||
Currency
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Customer
|
||||
|
||||
A customer can make purchases in your store and manage their profile.
|
||||
|
||||
## constructor
|
||||
|
||||
A customer can make purchases in your store and manage their profile.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CustomerGroup
|
||||
|
||||
A customer group that can be used to organize customers into groups of similar traits.
|
||||
|
||||
## constructor
|
||||
|
||||
A customer group that can be used to organize customers into groups of similar traits.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Discount
|
||||
|
||||
A discount can be applied to a cart for promotional purposes.
|
||||
|
||||
## constructor
|
||||
|
||||
A discount can be applied to a cart for promotional purposes.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### upperCaseCodeAndTrim
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# DiscountCondition
|
||||
|
||||
Holds rule conditions for when a discount is applicable
|
||||
|
||||
## constructor
|
||||
|
||||
Holds rule conditions for when a discount is applicable
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# DiscountRule
|
||||
|
||||
A discount rule defines how a Discount is calculated when applied to a Cart.
|
||||
|
||||
## constructor
|
||||
|
||||
A discount rule defines how a Discount is calculated when applied to a Cart.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# DraftOrder
|
||||
|
||||
A draft order is created by an admin without direct involvement of the customer. Once its payment is marked as captured, it is transformed into an order.
|
||||
|
||||
## constructor
|
||||
|
||||
A draft order is created by an admin without direct involvement of the customer. Once its payment is marked as captured, it is transformed into an order.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<void>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Fulfillment
|
||||
|
||||
A Fulfillment is created once an admin can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a fulfillment provider, which typically integrates a third-party shipping service. Fulfillments can be associated with orders, claims, swaps, and returns.
|
||||
|
||||
## constructor
|
||||
|
||||
A Fulfillment is created once an admin can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a fulfillment provider, which typically integrates a third-party shipping service. Fulfillments can be associated with orders, claims, swaps, and returns.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FulfillmentItem
|
||||
|
||||
This represents the association between a Line Item and a Fulfillment.
|
||||
|
||||
## constructor
|
||||
|
||||
This represents the association between a Line Item and a Fulfillment.
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FulfillmentProvider
|
||||
|
||||
A fulfillment provider represents a fulfillment service installed in the Medusa backend, either through a plugin or backend customizations. It holds the fulfillment service's installation status.
|
||||
|
||||
## constructor
|
||||
|
||||
A fulfillment provider represents a fulfillment service installed in the Medusa backend, either through a plugin or backend customizations. It holds the fulfillment service's installation status.
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# GiftCard
|
||||
|
||||
Gift Cards are redeemable and represent a value that can be used towards the payment of an Order.
|
||||
|
||||
## constructor
|
||||
|
||||
Gift Cards are redeemable and represent a value that can be used towards the payment of an Order.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# GiftCardTransaction
|
||||
|
||||
Gift Card Transactions are created once a Customer uses a Gift Card to pay for their Order.
|
||||
|
||||
## constructor
|
||||
|
||||
Gift Card Transactions are created once a Customer uses a Gift Card to pay for their Order.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Image
|
||||
|
||||
An Image is used to store details about uploaded images. Images are uploaded by the File Service, and the URL is provided by the File Service.
|
||||
|
||||
## constructor
|
||||
|
||||
An Image is used to store details about uploaded images. Images are uploaded by the File Service, and the URL is provided by the File Service.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,69 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# LineItem
|
||||
|
||||
Line Items are created when a product is added to a Cart. When Line Items are purchased they will get copied to the resulting order, swap, or claim, and can eventually be referenced in Fulfillments and Returns. Line items may also be used for order edits.
|
||||
|
||||
## constructor
|
||||
|
||||
Line Items are created when a product is added to a Cart. When Line Items are purchased they will get copied to the resulting order, swap, or claim, and can eventually be referenced in Fulfillments and Returns. Line items may also be used for order edits.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### afterUpdateOrLoad
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### beforeUpdate
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# LineItemAdjustment
|
||||
|
||||
A Line Item Adjustment includes details on discounts applied on a line item.
|
||||
|
||||
## constructor
|
||||
|
||||
A Line Item Adjustment includes details on discounts applied on a line item.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# LineItemTaxLine
|
||||
|
||||
A Line Item Tax Line represents the taxes applied on a line item.
|
||||
|
||||
## constructor
|
||||
|
||||
A Line Item Tax Line represents the taxes applied on a line item.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,69 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# MoneyAmount
|
||||
|
||||
A Money Amount represent a price amount, for example, a product variant's price or a price in a price list. Each Money Amount either has a Currency or Region associated with it to indicate the pricing in a given Currency or, for fully region-based pricing, the given price in a specific Region. If region-based pricing is used, the amount will be in the currency defined for the Region.
|
||||
|
||||
## constructor
|
||||
|
||||
A Money Amount represent a price amount, for example, a product variant's price or a price in a price list. Each Money Amount either has a Currency or Region associated with it to indicate the pricing in a given Currency or, for fully region-based pricing, the given price in a specific Region. If region-based pricing is used, the amount will be in the currency defined for the Region.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### afterLoad
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "undefined \\| void",
|
||||
"type": "`undefined` \\| `void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### beforeUpdate
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Order
|
||||
|
||||
An order is a purchase made by a customer. It holds details about payment and fulfillment of the order. An order may also be created from a draft order, which is created by an admin user.
|
||||
|
||||
## constructor
|
||||
|
||||
An order is a purchase made by a customer. It holds details about payment and fulfillment of the order. An order may also be created from a draft order, which is created by an admin user.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<void>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,51 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# OrderEdit
|
||||
|
||||
Order edit allows modifying items in an order, such as adding, updating, or deleting items from the original order. Once the order edit is confirmed, the changes are reflected on the original order.
|
||||
|
||||
## constructor
|
||||
|
||||
Order edit allows modifying items in an order, such as adding, updating, or deleting items from the original order. Once the order edit is confirmed, the changes are reflected on the original order.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### loadStatus
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# OrderItemChange
|
||||
|
||||
An order item change is a change made within an order edit to an order's items. These changes are not reflected on the original order until the order edit is confirmed.
|
||||
|
||||
## constructor
|
||||
|
||||
An order item change is a change made within an order edit to an order's items. These changes are not reflected on the original order until the order edit is confirmed.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Payment
|
||||
|
||||
A payment is originally created from a payment session. Once a payment session is authorized, the payment is created to represent the authorized amount with a given payment method. Payments can be captured, canceled or refunded. Payments can be made towards orders, swaps, order edits, or other resources.
|
||||
|
||||
## constructor
|
||||
|
||||
A payment is originally created from a payment session. Once a payment session is authorized, the payment is created to represent the authorized amount with a given payment method. Payments can be captured, canceled or refunded. Payments can be made towards orders, swaps, order edits, or other resources.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# PaymentCollection
|
||||
|
||||
A payment collection allows grouping and managing a list of payments at one. This can be helpful when making additional payment for order edits or integrating installment payments.
|
||||
|
||||
## constructor
|
||||
|
||||
A payment collection allows grouping and managing a list of payments at one. This can be helpful when making additional payment for order edits or integrating installment payments.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# PaymentProvider
|
||||
|
||||
A payment provider represents a payment service installed in the Medusa backend, either through a plugin or backend customizations. It holds the payment service's installation status.
|
||||
|
||||
## constructor
|
||||
|
||||
A payment provider represents a payment service installed in the Medusa backend, either through a plugin or backend customizations. It holds the payment service's installation status.
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# PaymentSession
|
||||
|
||||
A Payment Session is created when a Customer initilizes the checkout flow, and can be used to hold the state of a payment flow. Each Payment Session is controlled by a Payment Provider, which is responsible for the communication with external payment services. Authorized Payment Sessions will eventually get promoted to Payments to indicate that they are authorized for payment processing such as capture or refund. Payment sessions can also be used as part of payment collections.
|
||||
|
||||
## constructor
|
||||
|
||||
A Payment Session is created when a Customer initilizes the checkout flow, and can be used to hold the state of a payment flow. Each Payment Session is controlled by a Payment Provider, which is responsible for the communication with external payment services. Authorized Payment Sessions will eventually get promoted to Payments to indicate that they are authorized for payment processing such as capture or refund. Payment sessions can also be used as part of payment collections.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# PriceList
|
||||
|
||||
A Price List represents a set of prices that override the default price for one or more product variants.
|
||||
|
||||
## constructor
|
||||
|
||||
A Price List represents a set of prices that override the default price for one or more product variants.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "undefined \\| void",
|
||||
"type": "`undefined` \\| `void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,69 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Product
|
||||
|
||||
A product is a saleable item that holds general information such as name or description. It must include at least one Product Variant, where each product variant defines different options to purchase the product with (for example, different sizes or colors). The prices and inventory of the product are defined on the variant level.
|
||||
|
||||
## constructor
|
||||
|
||||
A product is a saleable item that holds general information such as name or description. It must include at least one Product Variant, where each product variant defines different options to purchase the product with (for example, different sizes or colors). The prices and inventory of the product are defined on the variant level.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### afterLoad
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### beforeUpdate
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ProductCategory
|
||||
|
||||
A product category can be used to categorize products into a hierarchy of categories.
|
||||
|
||||
## constructor
|
||||
|
||||
A product category can be used to categorize products into a hierarchy of categories.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ProductCollection
|
||||
|
||||
A Product Collection allows grouping together products for promotional purposes. For example, an admin can create a Summer collection, add products to it, and showcase it on the storefront.
|
||||
|
||||
## constructor
|
||||
|
||||
A Product Collection allows grouping together products for promotional purposes. For example, an admin can create a Summer collection, add products to it, and showcase it on the storefront.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### createHandleIfNotProvided
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ProductOption
|
||||
|
||||
A Product Option defines properties that may vary between different variants of a Product. Common Product Options are "Size" and "Color". Admins are free to create any product options.
|
||||
|
||||
## constructor
|
||||
|
||||
A Product Option defines properties that may vary between different variants of a Product. Common Product Options are "Size" and "Color". Admins are free to create any product options.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ProductOptionValue
|
||||
|
||||
An option value is one of the possible values of a Product Option. Product Variants specify a unique combination of product option values.
|
||||
|
||||
## constructor
|
||||
|
||||
An option value is one of the possible values of a Product Option. Product Variants specify a unique combination of product option values.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ProductTag
|
||||
|
||||
A Product Tag can be added to Products for easy filtering and grouping.
|
||||
|
||||
## constructor
|
||||
|
||||
A Product Tag can be added to Products for easy filtering and grouping.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ProductType
|
||||
|
||||
A Product Type can be added to Products for filtering and reporting purposes.
|
||||
|
||||
## constructor
|
||||
|
||||
A Product Type can be added to Products for filtering and reporting purposes.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ProductVariant
|
||||
|
||||
A Product Variant represents a Product with a specific set of Product Option configurations. The maximum number of Product Variants that a Product can have is given by the number of available Product Option combinations. A product must at least have one product variant.
|
||||
|
||||
## constructor
|
||||
|
||||
A Product Variant represents a Product with a specific set of Product Option configurations. The maximum number of Product Variants that a Product can have is given by the number of available Product Option combinations. A product must at least have one product variant.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ProductVariantInventoryItem
|
||||
|
||||
A Product Variant Inventory Item links variants with inventory items and denotes the required quantity of the variant.
|
||||
|
||||
## constructor
|
||||
|
||||
A Product Variant Inventory Item links variants with inventory items and denotes the required quantity of the variant.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Refund
|
||||
|
||||
A refund represents an amount of money transfered back to the customer for a given reason. Refunds may occur in relation to Returns, Swaps and Claims, but can also be initiated by an admin for an order.
|
||||
|
||||
## constructor
|
||||
|
||||
A refund represents an amount of money transfered back to the customer for a given reason. Refunds may occur in relation to Returns, Swaps and Claims, but can also be initiated by an admin for an order.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Region
|
||||
|
||||
A region holds settings specific to a geographical location, including the currency, tax rates, and fulfillment and payment providers. A Region can consist of multiple countries to accomodate common shopping settings across countries.
|
||||
|
||||
## constructor
|
||||
|
||||
A region holds settings specific to a geographical location, including the currency, tax rates, and fulfillment and payment providers. A Region can consist of multiple countries to accomodate common shopping settings across countries.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Return
|
||||
|
||||
A Return holds information about Line Items that a Customer wishes to send back, along with how the items will be returned. Returns can also be used as part of a Swap or a Claim.
|
||||
|
||||
## constructor
|
||||
|
||||
A Return holds information about Line Items that a Customer wishes to send back, along with how the items will be returned. Returns can also be used as part of a Swap or a Claim.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ReturnItem
|
||||
|
||||
A return item represents a line item in an order that is to be returned. It includes details related to the return and the reason behind it.
|
||||
|
||||
## constructor
|
||||
|
||||
A return item represents a line item in an order that is to be returned. It includes details related to the return and the reason behind it.
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ReturnReason
|
||||
|
||||
A Return Reason is a value defined by an admin. It can be used on Return Items in order to indicate why a Line Item was returned.
|
||||
|
||||
## constructor
|
||||
|
||||
A Return Reason is a value defined by an admin. It can be used on Return Items in order to indicate why a Line Item was returned.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SalesChannel
|
||||
|
||||
A Sales Channel is a method a business offers its products for purchase for the customers. For example, a Webshop can be a sales channel, and a mobile app can be another.
|
||||
|
||||
## constructor
|
||||
|
||||
A Sales Channel is a method a business offers its products for purchase for the customers. For example, a Webshop can be a sales channel, and a mobile app can be another.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SalesChannelLocation
|
||||
|
||||
This represents the association between a sales channel and a stock locations.
|
||||
|
||||
## constructor
|
||||
|
||||
This represents the association between a sales channel and a stock locations.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ShippingMethod
|
||||
|
||||
A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of.
|
||||
|
||||
## constructor
|
||||
|
||||
A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ShippingMethodTaxLine
|
||||
|
||||
A Shipping Method Tax Line represents the taxes applied on a shipping method in a cart.
|
||||
|
||||
## constructor
|
||||
|
||||
A Shipping Method Tax Line represents the taxes applied on a shipping method in a cart.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ShippingOption
|
||||
|
||||
A Shipping Option represents a way in which an Order or Return can be shipped. Shipping Options have an associated Fulfillment Provider that will be used when the fulfillment of an Order is initiated. Shipping Options themselves cannot be added to Carts, but serve as a template for Shipping Methods. This distinction makes it possible to customize individual Shipping Methods with additional information.
|
||||
|
||||
## constructor
|
||||
|
||||
A Shipping Option represents a way in which an Order or Return can be shipped. Shipping Options have an associated Fulfillment Provider that will be used when the fulfillment of an Order is initiated. Shipping Options themselves cannot be added to Carts, but serve as a template for Shipping Methods. This distinction makes it possible to customize individual Shipping Methods with additional information.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ShippingOptionRequirement
|
||||
|
||||
A shipping option requirement defines conditions that a Cart must satisfy for the Shipping Option to be available for usage in the Cart.
|
||||
|
||||
## constructor
|
||||
|
||||
A shipping option requirement defines conditions that a Cart must satisfy for the Shipping Option to be available for usage in the Cart.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
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.
|
||||
|
||||
## constructor
|
||||
|
||||
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.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,11 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SoftDeletableEntity
|
||||
|
||||
Base abstract entity for all entities
|
||||
|
||||
## constructor
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Swap
|
||||
|
||||
A swap can be created when a Customer wishes to exchange Products that they have purchased with different Products. It consists of a Return of previously purchased Products and a Fulfillment of new Products. It also includes information on any additional payment or refund required based on the difference between the exchanged products.
|
||||
|
||||
## constructor
|
||||
|
||||
A swap can be created when a Customer wishes to exchange Products that they have purchased with different Products. It consists of a Return of previously purchased Products and a Fulfillment of new Products. It also includes information on any additional payment or refund required based on the difference between the exchanged products.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# TaxLine
|
||||
|
||||
A tax line represents the taxes amount applied to a line item.
|
||||
|
||||
## constructor
|
||||
|
||||
A tax line represents the taxes amount applied to a line item.
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# TaxProvider
|
||||
|
||||
A tax provider represents a tax service installed in the Medusa backend, either through a plugin or backend customizations. It holds the tax service's installation status.
|
||||
|
||||
## constructor
|
||||
|
||||
A tax provider represents a tax service installed in the Medusa backend, either through a plugin or backend customizations. It holds the tax service's installation status.
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# TaxRate
|
||||
|
||||
A Tax Rate can be used to define a custom rate to charge on specified products, product types, and shipping options within a given region.
|
||||
|
||||
## constructor
|
||||
|
||||
A Tax Rate can be used to define a custom rate to charge on specified products, product types, and shipping options within a given region.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# TrackingLink
|
||||
|
||||
A tracking link holds information about tracking numbers for a Fulfillment. Tracking Links can optionally contain a URL that can be visited to see the status of the shipment. Typically, the tracking link is provided from the third-party service integrated through the used fulfillment provider.
|
||||
|
||||
## constructor
|
||||
|
||||
A tracking link holds information about tracking numbers for a Fulfillment. Tracking Links can optionally contain a URL that can be visited to see the status of the shipment. Typically, the tracking link is provided from the third-party service integrated through the used fulfillment provider.
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "void",
|
||||
"type": "`void`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+96
-96
@@ -65,7 +65,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "container",
|
||||
"type": "[MedusaContainer](../types/MedusaContainer.mdx)",
|
||||
"type": "[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1.mdx)",
|
||||
"description": "An instance of `MedusaContainer` that allows you to access other resources, such as services, in your Medusa backend.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -73,7 +73,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
"children": [
|
||||
{
|
||||
"name": "createScope",
|
||||
"type": "() => [MedusaContainer](../types/MedusaContainer.mdx)",
|
||||
"type": "() => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -82,7 +82,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "registerAdd",
|
||||
"type": "`<T>`(`name`: `string`, `registration`: `T`) => [MedusaContainer](../types/MedusaContainer.mdx)",
|
||||
"type": "`<T>`(`name`: `string`, `registration`: `T`) => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -151,7 +151,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "optionData",
|
||||
"type": "[ShippingOptionData](../types/ShippingOptionData.mdx)",
|
||||
"type": "[ShippingOptionData](../../medusa/types/medusa.ShippingOptionData.mdx)",
|
||||
"description": "The `data` object of the selected shipping option.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -160,8 +160,8 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[FulfillmentProviderData](../types/FulfillmentProviderData.mdx)",
|
||||
"description": "A `data` object that is different based on the context it's used in:\n\n1. If the price is being calculated for the list of shipping options available for a cart, it's the `data` object of the shipping option.\n2. If the price is being calculated when the shipping method is being created, it's the data returned by the [validateFulfillmentData](../interfaces/FulfillmentService.mdx#validatefulfillmentdata) method used during the shipping method creation.\n3. If the price is being calculated while calculating the cart's totals, it will be the data object of the cart's shipping method.",
|
||||
"type": "[FulfillmentProviderData](../../medusa/types/medusa.FulfillmentProviderData.mdx)",
|
||||
"description": "A `data` object that is different based on the context it's used in:\n\n1. If the price is being calculated for the list of shipping options available for a cart, it's the `data` object of the shipping option.\n2. If the price is being calculated when the shipping method is being created, it's the data returned by the [validateFulfillmentData](fulfillment.AbstractFulfillmentService.mdx#validatefulfillmentdata) method used during the shipping method creation.\n3. If the price is being calculated while calculating the cart's totals, it will be the data object of the cart's shipping method.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -169,15 +169,15 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "cart",
|
||||
"type": "[Cart](Cart.mdx)",
|
||||
"description": "A cart represents a virtual shopping bag. It can be used to complete an order, a swap, or a claim.",
|
||||
"type": "[Cart](../../entities/classes/entities.Cart.mdx)",
|
||||
"description": "Either the Cart or the Order object.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "billing_address",
|
||||
"type": "[Address](Address.mdx)",
|
||||
"type": "[Address](../../entities/classes/entities.Address.mdx)",
|
||||
"description": "The details of the billing address associated with the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -222,7 +222,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "customer",
|
||||
"type": "[Customer](Customer.mdx)",
|
||||
"type": "[Customer](../../entities/classes/entities.Customer.mdx)",
|
||||
"description": "The details of the customer the cart belongs to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -258,7 +258,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "discounts",
|
||||
"type": "[Discount](Discount.mdx)[]",
|
||||
"type": "[Discount](../../entities/classes/entities.Discount.mdx)[]",
|
||||
"description": "An array of details of all discounts applied to the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -294,7 +294,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "gift_cards",
|
||||
"type": "[GiftCard](GiftCard.mdx)[]",
|
||||
"type": "[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]",
|
||||
"description": "An array of details of all gift cards applied to the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -330,7 +330,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "items",
|
||||
"type": "[LineItem](LineItem.mdx)[]",
|
||||
"type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
|
||||
"description": "The line items added to the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -357,7 +357,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "payment",
|
||||
"type": "[Payment](Payment.mdx)",
|
||||
"type": "[Payment](../../entities/classes/entities.Payment.mdx)",
|
||||
"description": "The details of the payment associated with the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -384,7 +384,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "payment_session",
|
||||
"type": "`null` \\| [PaymentSession](PaymentSession.mdx)",
|
||||
"type": "`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)",
|
||||
"description": "The details of the selected payment session in the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -393,7 +393,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "payment_sessions",
|
||||
"type": "[PaymentSession](PaymentSession.mdx)[]",
|
||||
"type": "[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]",
|
||||
"description": "The details of all payment sessions created on the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -429,7 +429,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "region",
|
||||
"type": "[Region](Region.mdx)",
|
||||
"type": "[Region](../../entities/classes/entities.Region.mdx)",
|
||||
"description": "The details of the region associated with the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -447,7 +447,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "sales_channel",
|
||||
"type": "[SalesChannel](SalesChannel.mdx)",
|
||||
"type": "[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)",
|
||||
"description": "The details of the sales channel associated with the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -465,7 +465,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "shipping_address",
|
||||
"type": "`null` \\| [Address](Address.mdx)",
|
||||
"type": "`null` \\| [Address](../../entities/classes/entities.Address.mdx)",
|
||||
"description": "The details of the shipping address associated with the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -483,7 +483,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "shipping_methods",
|
||||
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
|
||||
"type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]",
|
||||
"description": "The details of the shipping methods added to the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -537,7 +537,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"type": "[CartType](../enums/CartType.mdx)",
|
||||
"type": "[CartType](../../entities/enums/entities.CartType.mdx)",
|
||||
"description": "The cart's type.",
|
||||
"optional": false,
|
||||
"defaultValue": "default",
|
||||
@@ -605,7 +605,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[ShippingOptionData](../types/ShippingOptionData.mdx)",
|
||||
"type": "[ShippingOptionData](../../medusa/types/medusa.ShippingOptionData.mdx)",
|
||||
"description": "The `data` object of the shipping option being created. You can use this data to determine whether the shipping option should be calculated or not.\nThis is useful if the fulfillment provider you are integrating has both flat rate and dynamically priced fulfillment options.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -622,7 +622,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
"type": "Promise<boolean>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "If this method returns `true`, that means that the price can be calculated dynamically and the shipping option can have the `price_type` set to calculated.\nThe amount property of the shipping option will then be set to null. The amount will be created later when the shipping method is created on checkout using the [calculatePrice](../interfaces/FulfillmentService.mdx#calculateprice) method.\nIf the method returns `false`, an error is thrown as it means the selected shipping option is invalid and it can only have the `flat_rate` price type.",
|
||||
"description": "If this method returns `true`, that means that the price can be calculated dynamically and the shipping option can have the `price_type` set to calculated.\nThe amount property of the shipping option will then be set to null. The amount will be created later when the shipping method is created on checkout using the [calculatePrice](fulfillment.AbstractFulfillmentService.mdx#calculateprice) method.\nIf the method returns `false`, an error is thrown as it means the selected shipping option is invalid and it can only have the `flat_rate` price type.",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
@@ -664,7 +664,7 @@ class MyFulfillmentService extends FulfillmentService {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "fulfillment",
|
||||
"type": "[FulfillmentProviderData](../types/FulfillmentProviderData.mdx)",
|
||||
"type": "[FulfillmentProviderData](../../medusa/types/medusa.FulfillmentProviderData.mdx)",
|
||||
"description": "The `data` attribute of the fulfillment being canceled",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -728,7 +728,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[ShippingMethodData](../types/ShippingMethodData.mdx)",
|
||||
"type": "[ShippingMethodData](../../medusa/types/medusa.ShippingMethodData.mdx)",
|
||||
"description": "The `data` object of the shipping method associated with the resource, such as the order.\nYou can use it to access the data specific to the shipping option. This is based on your implementation of previous methods.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -737,7 +737,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "items",
|
||||
"type": "[LineItem](LineItem.mdx)[]",
|
||||
"type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
|
||||
"description": "The line items in the order to be fulfilled. The admin can choose all or some of the items to fulfill.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -745,7 +745,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
"children": [
|
||||
{
|
||||
"name": "adjustments",
|
||||
"type": "[LineItemAdjustment](LineItemAdjustment.mdx)[]",
|
||||
"type": "[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[]",
|
||||
"description": "The details of the item's adjustments, which are available when a discount is applied on the item.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -763,7 +763,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "cart",
|
||||
"type": "[Cart](Cart.mdx)",
|
||||
"type": "[Cart](../../entities/classes/entities.Cart.mdx)",
|
||||
"description": "The details of the cart that the line item may belongs to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -781,7 +781,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "claim_order",
|
||||
"type": "[ClaimOrder](ClaimOrder.mdx)",
|
||||
"type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)",
|
||||
"description": "The details of the claim that the line item may belong to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -899,7 +899,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "order",
|
||||
"type": "[Order](Order.mdx)",
|
||||
"type": "[Order](../../entities/classes/entities.Order.mdx)",
|
||||
"description": "The details of the order that the line item may belongs to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -908,7 +908,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "order_edit",
|
||||
"type": "`null` \\| [OrderEdit](OrderEdit.mdx)",
|
||||
"type": "`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)",
|
||||
"description": "The details of the order edit.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -1034,7 +1034,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "swap",
|
||||
"type": "[Swap](Swap.mdx)",
|
||||
"type": "[Swap](../../entities/classes/entities.Swap.mdx)",
|
||||
"description": "The details of the swap that the line item may belong to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1052,7 +1052,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "tax_lines",
|
||||
"type": "[LineItemTaxLine](LineItemTaxLine.mdx)[]",
|
||||
"type": "[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]",
|
||||
"description": "The details of the item's tax lines.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1115,7 +1115,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "variant",
|
||||
"type": "[ProductVariant](ProductVariant.mdx)",
|
||||
"type": "[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)",
|
||||
"description": "The details of the product variant that this item was created from.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1135,15 +1135,15 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "order",
|
||||
"type": "[Order](Order.mdx)",
|
||||
"description": "An order is a purchase made by a customer. It holds details about payment and fulfillment of the order. An order may also be created from a draft order, which is created by an admin user.",
|
||||
"type": "[Order](../../entities/classes/entities.Order.mdx)",
|
||||
"description": "The details of the created resource, which is either an order, a claim, or a swap:\n- If the resource the fulfillment is being created for is a claim, the `is_claim` property in the object will be `true`.\n- If the resource the fulfillment is being created for is a swap, the `is_swap` property in the object will be `true`.\n- Otherwise, the resource is an order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "billing_address",
|
||||
"type": "[Address](Address.mdx)",
|
||||
"type": "[Address](../../entities/classes/entities.Address.mdx)",
|
||||
"description": "The details of the billing address associated with the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1170,7 +1170,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "cart",
|
||||
"type": "[Cart](Cart.mdx)",
|
||||
"type": "[Cart](../../entities/classes/entities.Cart.mdx)",
|
||||
"description": "The details of the cart associated with the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1188,7 +1188,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "claims",
|
||||
"type": "[ClaimOrder](ClaimOrder.mdx)[]",
|
||||
"type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]",
|
||||
"description": "The details of the claims created for the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1206,7 +1206,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[Currency](Currency.mdx)",
|
||||
"type": "[Currency](../../entities/classes/entities.Currency.mdx)",
|
||||
"description": "The details of the currency used in the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1224,7 +1224,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "customer",
|
||||
"type": "[Customer](Customer.mdx)",
|
||||
"type": "[Customer](../../entities/classes/entities.Customer.mdx)",
|
||||
"description": "The details of the customer associated with the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1251,7 +1251,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "discounts",
|
||||
"type": "[Discount](Discount.mdx)[]",
|
||||
"type": "[Discount](../../entities/classes/entities.Discount.mdx)[]",
|
||||
"description": "The details of the discounts applied on the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1269,7 +1269,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "draft_order",
|
||||
"type": "[DraftOrder](DraftOrder.mdx)",
|
||||
"type": "[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)",
|
||||
"description": "The details of the draft order this order was created from.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1287,7 +1287,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "edits",
|
||||
"type": "[OrderEdit](OrderEdit.mdx)[]",
|
||||
"type": "[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]",
|
||||
"description": "The details of the order edits done on the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1314,7 +1314,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "fulfillment_status",
|
||||
"type": "[FulfillmentStatus](../enums/FulfillmentStatus.mdx)",
|
||||
"type": "[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)",
|
||||
"description": "The order's fulfillment status",
|
||||
"optional": false,
|
||||
"defaultValue": "not_fulfilled",
|
||||
@@ -1323,7 +1323,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "fulfillments",
|
||||
"type": "[Fulfillment](Fulfillment.mdx)[]",
|
||||
"type": "[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]",
|
||||
"description": "The details of the fulfillments created for the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1350,7 +1350,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "gift_card_transactions",
|
||||
"type": "[GiftCardTransaction](GiftCardTransaction.mdx)[]",
|
||||
"type": "[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]",
|
||||
"description": "The gift card transactions made in the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1359,7 +1359,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "gift_cards",
|
||||
"type": "[GiftCard](GiftCard.mdx)[]",
|
||||
"type": "[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]",
|
||||
"description": "The details of the gift card used in the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1395,7 +1395,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "items",
|
||||
"type": "[LineItem](LineItem.mdx)[]",
|
||||
"type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
|
||||
"description": "The details of the line items that belong to the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1440,7 +1440,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "payment_status",
|
||||
"type": "[PaymentStatus](../enums/PaymentStatus.mdx)",
|
||||
"type": "[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)",
|
||||
"description": "The order's payment status",
|
||||
"optional": false,
|
||||
"defaultValue": "not_paid",
|
||||
@@ -1449,7 +1449,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "payments",
|
||||
"type": "[Payment](Payment.mdx)[]",
|
||||
"type": "[Payment](../../entities/classes/entities.Payment.mdx)[]",
|
||||
"description": "The details of the payments used in the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1485,7 +1485,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "refunds",
|
||||
"type": "[Refund](Refund.mdx)[]",
|
||||
"type": "[Refund](../../entities/classes/entities.Refund.mdx)[]",
|
||||
"description": "The details of the refunds created for the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1494,7 +1494,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "region",
|
||||
"type": "[Region](Region.mdx)",
|
||||
"type": "[Region](../../entities/classes/entities.Region.mdx)",
|
||||
"description": "The details of the region this order was created in.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1512,7 +1512,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "returnable_items",
|
||||
"type": "[LineItem](LineItem.mdx)[]",
|
||||
"type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
|
||||
"description": "The details of the line items that are returnable as part of the order, swaps, or claims",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -1521,7 +1521,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "returns",
|
||||
"type": "[Return](Return.mdx)[]",
|
||||
"type": "[Return](../../entities/classes/entities.Return.mdx)[]",
|
||||
"description": "The details of the returns created for the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1530,7 +1530,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "sales_channel",
|
||||
"type": "[SalesChannel](SalesChannel.mdx)",
|
||||
"type": "[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)",
|
||||
"description": "The details of the sales channel this order belongs to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1548,7 +1548,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "shipping_address",
|
||||
"type": "[Address](Address.mdx)",
|
||||
"type": "[Address](../../entities/classes/entities.Address.mdx)",
|
||||
"description": "The details of the shipping address associated with the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1566,7 +1566,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "shipping_methods",
|
||||
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
|
||||
"type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]",
|
||||
"description": "The details of the shipping methods used in the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1593,7 +1593,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "status",
|
||||
"type": "[OrderStatus](../enums/OrderStatus.mdx)",
|
||||
"type": "[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)",
|
||||
"description": "The order's status",
|
||||
"optional": false,
|
||||
"defaultValue": "pending",
|
||||
@@ -1611,7 +1611,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "swaps",
|
||||
"type": "[Swap](Swap.mdx)[]",
|
||||
"type": "[Swap](../../entities/classes/entities.Swap.mdx)[]",
|
||||
"description": "The details of the swaps created for the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1658,8 +1658,8 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "fulfillment",
|
||||
"type": "[Fulfillment](Fulfillment.mdx)",
|
||||
"description": "A Fulfillment is created once an admin can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a fulfillment provider, which typically integrates a third-party shipping service. Fulfillments can be associated with orders, claims, swaps, and returns.",
|
||||
"type": "[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)",
|
||||
"description": "The fulfillment being created.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -1675,7 +1675,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "claim_order",
|
||||
"type": "[ClaimOrder](ClaimOrder.mdx)",
|
||||
"type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)",
|
||||
"description": "The details of the claim that the fulfillment may belong to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1729,7 +1729,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "items",
|
||||
"type": "[FulfillmentItem](FulfillmentItem.mdx)[]",
|
||||
"type": "[FulfillmentItem](../../entities/classes/entities.FulfillmentItem.mdx)[]",
|
||||
"description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1765,7 +1765,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "order",
|
||||
"type": "[Order](Order.mdx)",
|
||||
"type": "[Order](../../entities/classes/entities.Order.mdx)",
|
||||
"description": "The details of the order that the fulfillment may belong to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1783,7 +1783,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "provider",
|
||||
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)",
|
||||
"type": "[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)",
|
||||
"description": "The details of the fulfillment provider responsible for handling the fulfillment.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1810,7 +1810,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "swap",
|
||||
"type": "[Swap](Swap.mdx)",
|
||||
"type": "[Swap](../../entities/classes/entities.Swap.mdx)",
|
||||
"description": "The details of the swap that the fulfillment may belong to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1828,7 +1828,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "tracking_links",
|
||||
"type": "[TrackingLink](TrackingLink.mdx)[]",
|
||||
"type": "[TrackingLink](../../entities/classes/entities.TrackingLink.mdx)[]",
|
||||
"description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1862,7 +1862,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[FulfillmentProviderData](../types/FulfillmentProviderData.mdx)>",
|
||||
"type": "Promise<[FulfillmentProviderData](../../medusa/types/medusa.FulfillmentProviderData.mdx)>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The data that will be stored in the `data` attribute of the created fulfillment.",
|
||||
@@ -1910,7 +1910,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "returnOrder",
|
||||
"type": "[CreateReturnType](../types/CreateReturnType.mdx)",
|
||||
"type": "[CreateReturnType](../../medusa/types/medusa.CreateReturnType.mdx)",
|
||||
"description": "the return that the fulfillment is being created for.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1918,7 +1918,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
"children": [
|
||||
{
|
||||
"name": "claim_order",
|
||||
"type": "[ClaimOrder](ClaimOrder.mdx)",
|
||||
"type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)",
|
||||
"description": "The details of the claim that the return may belong to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1963,7 +1963,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "items",
|
||||
"type": "[ReturnItem](ReturnItem.mdx)[]",
|
||||
"type": "[ReturnItem](../../entities/classes/entities.ReturnItem.mdx)[]",
|
||||
"description": "The details of the items that the customer is returning.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1999,7 +1999,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "order",
|
||||
"type": "[Order](Order.mdx)",
|
||||
"type": "[Order](../../entities/classes/entities.Order.mdx)",
|
||||
"description": "The details of the order that the return was created for.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2044,7 +2044,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "shipping_method",
|
||||
"type": "[ShippingMethod](ShippingMethod.mdx)",
|
||||
"type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)",
|
||||
"description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2053,7 +2053,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "status",
|
||||
"type": "[ReturnStatus](../enums/ReturnStatus.mdx)",
|
||||
"type": "[ReturnStatus](../../entities/enums/entities.ReturnStatus.mdx)",
|
||||
"description": "Status of the Return.",
|
||||
"optional": false,
|
||||
"defaultValue": "requested",
|
||||
@@ -2062,7 +2062,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "swap",
|
||||
"type": "[Swap](Swap.mdx)",
|
||||
"type": "[Swap](../../entities/classes/entities.Swap.mdx)",
|
||||
"description": "The details of the swap that the return may belong to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2141,7 +2141,7 @@ class MyFulfillmentService extends FulfillmentService {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[FulfillmentProviderData](../types/FulfillmentProviderData.mdx)",
|
||||
"type": "[FulfillmentProviderData](../../medusa/types/medusa.FulfillmentProviderData.mdx)",
|
||||
"description": "The `data` attribute of the fulfillment that you're retrieving the documents for.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2449,7 +2449,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "optionData",
|
||||
"type": "[ShippingOptionData](../types/ShippingOptionData.mdx)",
|
||||
"type": "[ShippingOptionData](../../medusa/types/medusa.ShippingOptionData.mdx)",
|
||||
"description": "The data object of the shipping option selected when creating the shipping method.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2458,7 +2458,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[FulfillmentProviderData](../types/FulfillmentProviderData.mdx)",
|
||||
"type": "[FulfillmentProviderData](../../medusa/types/medusa.FulfillmentProviderData.mdx)",
|
||||
"description": "The `data` object passed in the body of the request.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2467,15 +2467,15 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "cart",
|
||||
"type": "[Cart](Cart.mdx)",
|
||||
"description": "A cart represents a virtual shopping bag. It can be used to complete an order, a swap, or a claim.",
|
||||
"type": "[Cart](../../entities/classes/entities.Cart.mdx)",
|
||||
"description": "The customer's cart details. It may be empty if the shipping method isn't associated with a cart, such as when it's associated with a claim.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "billing_address",
|
||||
"type": "[Address](Address.mdx)",
|
||||
"type": "[Address](../../entities/classes/entities.Address.mdx)",
|
||||
"description": "The details of the billing address associated with the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2520,7 +2520,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "customer",
|
||||
"type": "[Customer](Customer.mdx)",
|
||||
"type": "[Customer](../../entities/classes/entities.Customer.mdx)",
|
||||
"description": "The details of the customer the cart belongs to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2556,7 +2556,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "discounts",
|
||||
"type": "[Discount](Discount.mdx)[]",
|
||||
"type": "[Discount](../../entities/classes/entities.Discount.mdx)[]",
|
||||
"description": "An array of details of all discounts applied to the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2592,7 +2592,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "gift_cards",
|
||||
"type": "[GiftCard](GiftCard.mdx)[]",
|
||||
"type": "[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]",
|
||||
"description": "An array of details of all gift cards applied to the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2628,7 +2628,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "items",
|
||||
"type": "[LineItem](LineItem.mdx)[]",
|
||||
"type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
|
||||
"description": "The line items added to the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2655,7 +2655,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "payment",
|
||||
"type": "[Payment](Payment.mdx)",
|
||||
"type": "[Payment](../../entities/classes/entities.Payment.mdx)",
|
||||
"description": "The details of the payment associated with the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2682,7 +2682,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "payment_session",
|
||||
"type": "`null` \\| [PaymentSession](PaymentSession.mdx)",
|
||||
"type": "`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)",
|
||||
"description": "The details of the selected payment session in the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2691,7 +2691,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "payment_sessions",
|
||||
"type": "[PaymentSession](PaymentSession.mdx)[]",
|
||||
"type": "[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]",
|
||||
"description": "The details of all payment sessions created on the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2727,7 +2727,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "region",
|
||||
"type": "[Region](Region.mdx)",
|
||||
"type": "[Region](../../entities/classes/entities.Region.mdx)",
|
||||
"description": "The details of the region associated with the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2745,7 +2745,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "sales_channel",
|
||||
"type": "[SalesChannel](SalesChannel.mdx)",
|
||||
"type": "[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)",
|
||||
"description": "The details of the sales channel associated with the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2763,7 +2763,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "shipping_address",
|
||||
"type": "`null` \\| [Address](Address.mdx)",
|
||||
"type": "`null` \\| [Address](../../entities/classes/entities.Address.mdx)",
|
||||
"description": "The details of the shipping address associated with the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2781,7 +2781,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "shipping_methods",
|
||||
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
|
||||
"type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]",
|
||||
"description": "The details of the shipping methods added to the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2835,7 +2835,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"type": "[CartType](../enums/CartType.mdx)",
|
||||
"type": "[CartType](../../entities/enums/entities.CartType.mdx)",
|
||||
"description": "The cart's type.",
|
||||
"optional": false,
|
||||
"defaultValue": "default",
|
||||
@@ -2863,7 +2863,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
"type": "Promise<Record<string, unknown>>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The data that will be stored in the `data` property of the shipping method to be created.\nMake sure the value you return contains everything you need to fulfill the shipment later on. The returned value may also be used to calculate the price of the shipping method\nif it doesn't have a set price. It will be passed along to the [calculatePrice](../interfaces/FulfillmentService.mdx#calculateprice) method.",
|
||||
"description": "The data that will be stored in the `data` property of the shipping method to be created.\nMake sure the value you return contains everything you need to fulfill the shipment later on. The returned value may also be used to calculate the price of the shipping method\nif it doesn't have a set price. It will be passed along to the [calculatePrice](fulfillment.AbstractFulfillmentService.mdx#calculateprice) method.",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
@@ -2905,7 +2905,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[ShippingOptionData](../types/ShippingOptionData.mdx)",
|
||||
"type": "[ShippingOptionData](../../medusa/types/medusa.ShippingOptionData.mdx)",
|
||||
"description": "the data object that is sent in the body of the request, basically, the data object of the shipping option. You can use this data to validate the shipping option before it is saved.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1,25 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AllocationType
|
||||
|
||||
The scope that the discount should apply to.
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### ITEM
|
||||
|
||||
**ITEM** = `"item"`
|
||||
|
||||
The discount should be applied to applicable items in the cart.
|
||||
|
||||
___
|
||||
|
||||
### TOTAL
|
||||
|
||||
**TOTAL** = `"total"`
|
||||
|
||||
The discount should be applied to the checkout total.
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CartType
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### CLAIM
|
||||
|
||||
**CLAIM** = `"claim"`
|
||||
|
||||
___
|
||||
|
||||
### DEFAULT
|
||||
|
||||
**DEFAULT** = `"default"`
|
||||
|
||||
___
|
||||
|
||||
### DRAFT\_ORDER
|
||||
|
||||
**DRAFT\_ORDER** = `"draft_order"`
|
||||
|
||||
___
|
||||
|
||||
### PAYMENT\_LINK
|
||||
|
||||
**PAYMENT\_LINK** = `"payment_link"`
|
||||
|
||||
___
|
||||
|
||||
### SWAP
|
||||
|
||||
**SWAP** = `"swap"`
|
||||
@@ -1,81 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ClaimFulfillmentStatus
|
||||
|
||||
The claim's fulfillment status.
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### CANCELED
|
||||
|
||||
**CANCELED** = `"canceled"`
|
||||
|
||||
The claim's fulfillments are canceled.
|
||||
|
||||
___
|
||||
|
||||
### FULFILLED
|
||||
|
||||
**FULFILLED** = `"fulfilled"`
|
||||
|
||||
The claim's replacement items are fulfilled.
|
||||
|
||||
___
|
||||
|
||||
### NOT\_FULFILLED
|
||||
|
||||
**NOT\_FULFILLED** = `"not_fulfilled"`
|
||||
|
||||
The claim's replacement items are not fulfilled.
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_FULFILLED
|
||||
|
||||
**PARTIALLY\_FULFILLED** = `"partially_fulfilled"`
|
||||
|
||||
Some of the claim's replacement items, but not all, are fulfilled.
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_RETURNED
|
||||
|
||||
**PARTIALLY\_RETURNED** = `"partially_returned"`
|
||||
|
||||
Some of the claim's items, but not all, are returned.
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_SHIPPED
|
||||
|
||||
**PARTIALLY\_SHIPPED** = `"partially_shipped"`
|
||||
|
||||
Some of the claim's replacement items, but not all, are shipped.
|
||||
|
||||
___
|
||||
|
||||
### REQUIRES\_ACTION
|
||||
|
||||
**REQUIRES\_ACTION** = `"requires_action"`
|
||||
|
||||
The claim's fulfillment requires action.
|
||||
|
||||
___
|
||||
|
||||
### RETURNED
|
||||
|
||||
**RETURNED** = `"returned"`
|
||||
|
||||
The claim's items are returned.
|
||||
|
||||
___
|
||||
|
||||
### SHIPPED
|
||||
|
||||
**SHIPPED** = `"shipped"`
|
||||
|
||||
The claim's replacement items are shipped.
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ClaimPaymentStatus
|
||||
|
||||
The claim's payment status
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### NA
|
||||
|
||||
**NA** = `"na"`
|
||||
|
||||
The payment status isn't set, which is typically used when the claim's type is `replace`.
|
||||
|
||||
___
|
||||
|
||||
### NOT\_REFUNDED
|
||||
|
||||
**NOT\_REFUNDED** = `"not_refunded"`
|
||||
|
||||
The payment isn't refunded.
|
||||
|
||||
___
|
||||
|
||||
### REFUNDED
|
||||
|
||||
**REFUNDED** = `"refunded"`
|
||||
|
||||
The payment is refunded.
|
||||
@@ -1,31 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ClaimReason
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### MISSING\_ITEM
|
||||
|
||||
**MISSING\_ITEM** = `"missing_item"`
|
||||
|
||||
___
|
||||
|
||||
### OTHER
|
||||
|
||||
**OTHER** = `"other"`
|
||||
|
||||
___
|
||||
|
||||
### PRODUCTION\_FAILURE
|
||||
|
||||
**PRODUCTION\_FAILURE** = `"production_failure"`
|
||||
|
||||
___
|
||||
|
||||
### WRONG\_ITEM
|
||||
|
||||
**WRONG\_ITEM** = `"wrong_item"`
|
||||
@@ -1,25 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ClaimType
|
||||
|
||||
The claim's type.
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### REFUND
|
||||
|
||||
**REFUND** = `"refund"`
|
||||
|
||||
The claim refunds an amount to the customer.
|
||||
|
||||
___
|
||||
|
||||
### REPLACE
|
||||
|
||||
**REPLACE** = `"replace"`
|
||||
|
||||
The claim replaces the returned item with a new one.
|
||||
@@ -1,25 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# DiscountConditionOperator
|
||||
|
||||
The possible operators used for a discount condition.
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### IN
|
||||
|
||||
**IN** = `"in"`
|
||||
|
||||
The discountable resources are within the specified resources.
|
||||
|
||||
___
|
||||
|
||||
### NOT\_IN
|
||||
|
||||
**NOT\_IN** = `"not_in"`
|
||||
|
||||
The discountable resources are everything but the specified resources.
|
||||
@@ -1,49 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# DiscountConditionType
|
||||
|
||||
The discount condition's type.
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### CUSTOMER\_GROUPS
|
||||
|
||||
**CUSTOMER\_GROUPS** = `"customer_groups"`
|
||||
|
||||
The discount condition is used for customer groups.
|
||||
|
||||
___
|
||||
|
||||
### PRODUCTS
|
||||
|
||||
**PRODUCTS** = `"products"`
|
||||
|
||||
The discount condition is used for products.
|
||||
|
||||
___
|
||||
|
||||
### PRODUCT\_COLLECTIONS
|
||||
|
||||
**PRODUCT\_COLLECTIONS** = `"product_collections"`
|
||||
|
||||
The discount condition is used for product collections.
|
||||
|
||||
___
|
||||
|
||||
### PRODUCT\_TAGS
|
||||
|
||||
**PRODUCT\_TAGS** = `"product_tags"`
|
||||
|
||||
The discount condition is used for product tags.
|
||||
|
||||
___
|
||||
|
||||
### PRODUCT\_TYPES
|
||||
|
||||
**PRODUCT\_TYPES** = `"product_types"`
|
||||
|
||||
The discount condition is used for product types.
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# DiscountRuleType
|
||||
|
||||
The possible types of discount rules.
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### FIXED
|
||||
|
||||
**FIXED** = `"fixed"`
|
||||
|
||||
Discounts that reduce the price by a fixed amount.
|
||||
|
||||
___
|
||||
|
||||
### FREE\_SHIPPING
|
||||
|
||||
**FREE\_SHIPPING** = `"free_shipping"`
|
||||
|
||||
Discounts that sets the shipping price to `0`.
|
||||
|
||||
___
|
||||
|
||||
### PERCENTAGE
|
||||
|
||||
**PERCENTAGE** = `"percentage"`
|
||||
|
||||
Discounts that reduce the price by a percentage reduction.
|
||||
@@ -1,25 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# DraftOrderStatus
|
||||
|
||||
The draft order's status.
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### COMPLETED
|
||||
|
||||
**COMPLETED** = `"completed"`
|
||||
|
||||
The draft order is completed, and an order has been created from it.
|
||||
|
||||
___
|
||||
|
||||
### OPEN
|
||||
|
||||
**OPEN** = `"open"`
|
||||
|
||||
The draft order is open.
|
||||
@@ -1,81 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FulfillmentStatus
|
||||
|
||||
The order's fulfillment status.
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### CANCELED
|
||||
|
||||
**CANCELED** = `"canceled"`
|
||||
|
||||
The order's fulfillments are canceled.
|
||||
|
||||
___
|
||||
|
||||
### FULFILLED
|
||||
|
||||
**FULFILLED** = `"fulfilled"`
|
||||
|
||||
The order's items are fulfilled.
|
||||
|
||||
___
|
||||
|
||||
### NOT\_FULFILLED
|
||||
|
||||
**NOT\_FULFILLED** = `"not_fulfilled"`
|
||||
|
||||
The order's items are not fulfilled.
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_FULFILLED
|
||||
|
||||
**PARTIALLY\_FULFILLED** = `"partially_fulfilled"`
|
||||
|
||||
Some of the order's items, but not all, are fulfilled.
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_RETURNED
|
||||
|
||||
**PARTIALLY\_RETURNED** = `"partially_returned"`
|
||||
|
||||
Some of the order's items, but not all, are returned.
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_SHIPPED
|
||||
|
||||
**PARTIALLY\_SHIPPED** = `"partially_shipped"`
|
||||
|
||||
Some of the order's items, but not all, are shipped.
|
||||
|
||||
___
|
||||
|
||||
### REQUIRES\_ACTION
|
||||
|
||||
**REQUIRES\_ACTION** = `"requires_action"`
|
||||
|
||||
The order's fulfillment requires action.
|
||||
|
||||
___
|
||||
|
||||
### RETURNED
|
||||
|
||||
**RETURNED** = `"returned"`
|
||||
|
||||
The order's items are returned.
|
||||
|
||||
___
|
||||
|
||||
### SHIPPED
|
||||
|
||||
**SHIPPED** = `"shipped"`
|
||||
|
||||
The order's items are shipped.
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# OrderEditItemChangeType
|
||||
|
||||
The type of the order edit item change.
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### ITEM\_ADD
|
||||
|
||||
**ITEM\_ADD** = `"item_add"`
|
||||
|
||||
A new item to be added to the original order.
|
||||
|
||||
___
|
||||
|
||||
### ITEM\_REMOVE
|
||||
|
||||
**ITEM\_REMOVE** = `"item_remove"`
|
||||
|
||||
An existing item to be removed from the original order.
|
||||
|
||||
___
|
||||
|
||||
### ITEM\_UPDATE
|
||||
|
||||
**ITEM\_UPDATE** = `"item_update"`
|
||||
|
||||
An existing item to be updated in the original order.
|
||||
@@ -1,49 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# OrderEditStatus
|
||||
|
||||
The order edit's status.
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### CANCELED
|
||||
|
||||
**CANCELED** = `"canceled"`
|
||||
|
||||
The order edit is canceled.
|
||||
|
||||
___
|
||||
|
||||
### CONFIRMED
|
||||
|
||||
**CONFIRMED** = `"confirmed"`
|
||||
|
||||
The order edit is confirmed.
|
||||
|
||||
___
|
||||
|
||||
### CREATED
|
||||
|
||||
**CREATED** = `"created"`
|
||||
|
||||
The order edit is created.
|
||||
|
||||
___
|
||||
|
||||
### DECLINED
|
||||
|
||||
**DECLINED** = `"declined"`
|
||||
|
||||
The order edit is declined.
|
||||
|
||||
___
|
||||
|
||||
### REQUESTED
|
||||
|
||||
**REQUESTED** = `"requested"`
|
||||
|
||||
The order edit is requested.
|
||||
@@ -1,51 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# OrderStatus
|
||||
|
||||
The order's status.
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### ARCHIVED
|
||||
|
||||
**ARCHIVED** = `"archived"`
|
||||
|
||||
The order is archived.
|
||||
|
||||
___
|
||||
|
||||
### CANCELED
|
||||
|
||||
**CANCELED** = `"canceled"`
|
||||
|
||||
The order is canceled.
|
||||
|
||||
___
|
||||
|
||||
### COMPLETED
|
||||
|
||||
**COMPLETED** = `"completed"`
|
||||
|
||||
The order is completed, meaning that
|
||||
the items have been fulfilled and the payment
|
||||
has been captured.
|
||||
|
||||
___
|
||||
|
||||
### PENDING
|
||||
|
||||
**PENDING** = `"pending"`
|
||||
|
||||
The order is pending.
|
||||
|
||||
___
|
||||
|
||||
### REQUIRES\_ACTION
|
||||
|
||||
**REQUIRES\_ACTION** = `"requires_action"`
|
||||
|
||||
The order requires action.
|
||||
@@ -1,49 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# PaymentCollectionStatus
|
||||
|
||||
The payment collection's status.
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### AUTHORIZED
|
||||
|
||||
**AUTHORIZED** = `"authorized"`
|
||||
|
||||
The payment colleciton is authorized.
|
||||
|
||||
___
|
||||
|
||||
### AWAITING
|
||||
|
||||
**AWAITING** = `"awaiting"`
|
||||
|
||||
The payment collection is awaiting payment.
|
||||
|
||||
___
|
||||
|
||||
### CANCELED
|
||||
|
||||
**CANCELED** = `"canceled"`
|
||||
|
||||
The payment collection is canceled.
|
||||
|
||||
___
|
||||
|
||||
### NOT\_PAID
|
||||
|
||||
**NOT\_PAID** = `"not_paid"`
|
||||
|
||||
The payment collection isn't paid.
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_AUTHORIZED
|
||||
|
||||
**PARTIALLY\_AUTHORIZED** = `"partially_authorized"`
|
||||
|
||||
Some of the payments in the payment collection are authorized.
|
||||
@@ -1,65 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# PaymentStatus
|
||||
|
||||
The order's payment status.
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### AWAITING
|
||||
|
||||
**AWAITING** = `"awaiting"`
|
||||
|
||||
The order's payment is awaiting capturing.
|
||||
|
||||
___
|
||||
|
||||
### CANCELED
|
||||
|
||||
**CANCELED** = `"canceled"`
|
||||
|
||||
The order's payment is canceled.
|
||||
|
||||
___
|
||||
|
||||
### CAPTURED
|
||||
|
||||
**CAPTURED** = `"captured"`
|
||||
|
||||
The order's payment is captured.
|
||||
|
||||
___
|
||||
|
||||
### NOT\_PAID
|
||||
|
||||
**NOT\_PAID** = `"not_paid"`
|
||||
|
||||
The order's payment is not paid.
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_REFUNDED
|
||||
|
||||
**PARTIALLY\_REFUNDED** = `"partially_refunded"`
|
||||
|
||||
Some of the order's payment amount is refunded.
|
||||
|
||||
___
|
||||
|
||||
### REFUNDED
|
||||
|
||||
**REFUNDED** = `"refunded"`
|
||||
|
||||
The order's payment amount is refunded.
|
||||
|
||||
___
|
||||
|
||||
### REQUIRES\_ACTION
|
||||
|
||||
**REQUIRES\_ACTION** = `"requires_action"`
|
||||
|
||||
The order's payment requires action.
|
||||
@@ -1,19 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# PriceListStatus
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### ACTIVE
|
||||
|
||||
**ACTIVE** = `"active"`
|
||||
|
||||
___
|
||||
|
||||
### DRAFT
|
||||
|
||||
**DRAFT** = `"draft"`
|
||||
@@ -1,19 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# PriceListType
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### OVERRIDE
|
||||
|
||||
**OVERRIDE** = `"override"`
|
||||
|
||||
___
|
||||
|
||||
### SALE
|
||||
|
||||
**SALE** = `"sale"`
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ProductStatus
|
||||
|
||||
The status of a product.
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### DRAFT
|
||||
|
||||
**DRAFT** = `"draft"`
|
||||
|
||||
The product is a draft. It's not viewable by customers.
|
||||
|
||||
___
|
||||
|
||||
### PROPOSED
|
||||
|
||||
**PROPOSED** = `"proposed"`
|
||||
|
||||
The product is proposed, but not yet published.
|
||||
|
||||
___
|
||||
|
||||
### PUBLISHED
|
||||
|
||||
**PUBLISHED** = `"published"`
|
||||
|
||||
The product is published.
|
||||
|
||||
___
|
||||
|
||||
### REJECTED
|
||||
|
||||
**REJECTED** = `"rejected"`
|
||||
|
||||
The product is rejected. It's not viewable by customers.
|
||||
@@ -1,25 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# RequirementType
|
||||
|
||||
The type of shipping option requirement.
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### MAX\_SUBTOTAL
|
||||
|
||||
**MAX\_SUBTOTAL** = `"max_subtotal"`
|
||||
|
||||
The shipping option can only be applied if the subtotal is less than the requirement's amont.
|
||||
|
||||
___
|
||||
|
||||
### MIN\_SUBTOTAL
|
||||
|
||||
**MIN\_SUBTOTAL** = `"min_subtotal"`
|
||||
|
||||
The shipping option can only be applied if the subtotal is greater than the requirement's amount.
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ReturnStatus
|
||||
|
||||
The return's status.
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### CANCELED
|
||||
|
||||
**CANCELED** = `"canceled"`
|
||||
|
||||
The return is canceled.
|
||||
|
||||
___
|
||||
|
||||
### RECEIVED
|
||||
|
||||
**RECEIVED** = `"received"`
|
||||
|
||||
The return is received.
|
||||
|
||||
___
|
||||
|
||||
### REQUESTED
|
||||
|
||||
**REQUESTED** = `"requested"`
|
||||
|
||||
The return is requested.
|
||||
|
||||
___
|
||||
|
||||
### REQUIRES\_ACTION
|
||||
|
||||
**REQUIRES\_ACTION** = `"requires_action"`
|
||||
|
||||
The return is awaiting action.
|
||||
@@ -1,25 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ShippingOptionPriceType
|
||||
|
||||
The type of the shipping option price.
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### CALCULATED
|
||||
|
||||
**CALCULATED** = `"calculated"`
|
||||
|
||||
The shipping option's price is calculated. In this case, the `amount` field is typically `null`.
|
||||
|
||||
___
|
||||
|
||||
### FLAT\_RATE
|
||||
|
||||
**FLAT\_RATE** = `"flat_rate"`
|
||||
|
||||
The shipping option's price is a flat rate.
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ShippingProfileType
|
||||
|
||||
The shipping profile's type.
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### CUSTOM
|
||||
|
||||
**CUSTOM** = `"custom"`
|
||||
|
||||
The profile used to ship custom items.
|
||||
|
||||
___
|
||||
|
||||
### DEFAULT
|
||||
|
||||
**DEFAULT** = `"default"`
|
||||
|
||||
The default profile used to ship item.
|
||||
|
||||
___
|
||||
|
||||
### GIFT\_CARD
|
||||
|
||||
**GIFT\_CARD** = `"gift_card"`
|
||||
|
||||
The profile used to ship gift cards.
|
||||
@@ -1,57 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SwapFulfillmentStatus
|
||||
|
||||
The swap's fulfillment status.
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### CANCELED
|
||||
|
||||
**CANCELED** = `"canceled"`
|
||||
|
||||
The swap's fulfillments are canceled.
|
||||
|
||||
___
|
||||
|
||||
### FULFILLED
|
||||
|
||||
**FULFILLED** = `"fulfilled"`
|
||||
|
||||
The swap's items are fulfilled.
|
||||
|
||||
___
|
||||
|
||||
### NOT\_FULFILLED
|
||||
|
||||
**NOT\_FULFILLED** = `"not_fulfilled"`
|
||||
|
||||
The swap's items aren't fulfilled.
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_SHIPPED
|
||||
|
||||
**PARTIALLY\_SHIPPED** = `"partially_shipped"`
|
||||
|
||||
Some of the swap's items are shipped.
|
||||
|
||||
___
|
||||
|
||||
### REQUIRES\_ACTION
|
||||
|
||||
**REQUIRES\_ACTION** = `"requires_action"`
|
||||
|
||||
The swap's fulfillments require an action.
|
||||
|
||||
___
|
||||
|
||||
### SHIPPED
|
||||
|
||||
**SHIPPED** = `"shipped"`
|
||||
|
||||
The swap's items are shipped.
|
||||
@@ -1,81 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SwapPaymentStatus
|
||||
|
||||
The swap's payment status.
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### AWAITING
|
||||
|
||||
**AWAITING** = `"awaiting"`
|
||||
|
||||
The swap is additional awaiting payment.
|
||||
|
||||
___
|
||||
|
||||
### CANCELED
|
||||
|
||||
**CANCELED** = `"canceled"`
|
||||
|
||||
The swap's additional payment is canceled.
|
||||
|
||||
___
|
||||
|
||||
### CAPTURED
|
||||
|
||||
**CAPTURED** = `"captured"`
|
||||
|
||||
The swap's additional payment is captured.
|
||||
|
||||
___
|
||||
|
||||
### CONFIRMED
|
||||
|
||||
**CONFIRMED** = `"confirmed"`
|
||||
|
||||
The swap's additional payment is confirmed.
|
||||
|
||||
___
|
||||
|
||||
### DIFFERENCE\_REFUNDED
|
||||
|
||||
**DIFFERENCE\_REFUNDED** = `"difference_refunded"`
|
||||
|
||||
The negative difference amount between the returned item(s) and the new one(s) has been refuneded.
|
||||
|
||||
___
|
||||
|
||||
### NOT\_PAID
|
||||
|
||||
**NOT\_PAID** = `"not_paid"`
|
||||
|
||||
The swap's additional payment isn't paid.
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_REFUNDED
|
||||
|
||||
**PARTIALLY\_REFUNDED** = `"partially_refunded"`
|
||||
|
||||
Some of the negative difference amount between the returned item(s) and the new one(s) has been refuneded.
|
||||
|
||||
___
|
||||
|
||||
### REFUNDED
|
||||
|
||||
**REFUNDED** = `"refunded"`
|
||||
|
||||
The amount in the associated order has been refunded.
|
||||
|
||||
___
|
||||
|
||||
### REQUIRES\_ACTION
|
||||
|
||||
**REQUIRES\_ACTION** = `"requires_action"`
|
||||
|
||||
The swap's payment requires an action.
|
||||
@@ -1,27 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Boolean
|
||||
|
||||
## Methods
|
||||
|
||||
### valueOf
|
||||
|
||||
Returns the primitive value of the specified object.
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "boolean",
|
||||
"type": "`boolean`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+90
-90
@@ -88,7 +88,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "optionData",
|
||||
"type": "[ShippingOptionData](../types/ShippingOptionData.mdx)",
|
||||
"type": "[ShippingOptionData](../../medusa/types/medusa.ShippingOptionData.mdx)",
|
||||
"description": "The `data` object of the selected shipping option.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -97,8 +97,8 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[FulfillmentProviderData](../types/FulfillmentProviderData.mdx)",
|
||||
"description": "A `data` object that is different based on the context it's used in:\n\n1. If the price is being calculated for the list of shipping options available for a cart, it's the `data` object of the shipping option.\n2. If the price is being calculated when the shipping method is being created, it's the data returned by the [validateFulfillmentData](FulfillmentService.mdx#validatefulfillmentdata) method used during the shipping method creation.\n3. If the price is being calculated while calculating the cart's totals, it will be the data object of the cart's shipping method.",
|
||||
"type": "[FulfillmentProviderData](../../medusa/types/medusa.FulfillmentProviderData.mdx)",
|
||||
"description": "A `data` object that is different based on the context it's used in:\n\n1. If the price is being calculated for the list of shipping options available for a cart, it's the `data` object of the shipping option.\n2. If the price is being calculated when the shipping method is being created, it's the data returned by the [validateFulfillmentData](fulfillment.FulfillmentService.mdx#validatefulfillmentdata) method used during the shipping method creation.\n3. If the price is being calculated while calculating the cart's totals, it will be the data object of the cart's shipping method.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
@@ -106,7 +106,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "cart",
|
||||
"type": "[Cart](../classes/Cart.mdx)",
|
||||
"type": "[Cart](../../entities/classes/entities.Cart.mdx)",
|
||||
"description": "Either the Cart or the Order object.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -114,7 +114,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
"children": [
|
||||
{
|
||||
"name": "billing_address",
|
||||
"type": "[Address](../classes/Address.mdx)",
|
||||
"type": "[Address](../../entities/classes/entities.Address.mdx)",
|
||||
"description": "The details of the billing address associated with the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -159,7 +159,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "customer",
|
||||
"type": "[Customer](../classes/Customer.mdx)",
|
||||
"type": "[Customer](../../entities/classes/entities.Customer.mdx)",
|
||||
"description": "The details of the customer the cart belongs to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -195,7 +195,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "discounts",
|
||||
"type": "[Discount](../classes/Discount.mdx)[]",
|
||||
"type": "[Discount](../../entities/classes/entities.Discount.mdx)[]",
|
||||
"description": "An array of details of all discounts applied to the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -231,7 +231,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "gift_cards",
|
||||
"type": "[GiftCard](../classes/GiftCard.mdx)[]",
|
||||
"type": "[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]",
|
||||
"description": "An array of details of all gift cards applied to the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -267,7 +267,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "items",
|
||||
"type": "[LineItem](../classes/LineItem.mdx)[]",
|
||||
"type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
|
||||
"description": "The line items added to the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -294,7 +294,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "payment",
|
||||
"type": "[Payment](../classes/Payment.mdx)",
|
||||
"type": "[Payment](../../entities/classes/entities.Payment.mdx)",
|
||||
"description": "The details of the payment associated with the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -321,7 +321,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "payment_session",
|
||||
"type": "`null` \\| [PaymentSession](../classes/PaymentSession.mdx)",
|
||||
"type": "`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)",
|
||||
"description": "The details of the selected payment session in the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -330,7 +330,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "payment_sessions",
|
||||
"type": "[PaymentSession](../classes/PaymentSession.mdx)[]",
|
||||
"type": "[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]",
|
||||
"description": "The details of all payment sessions created on the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -366,7 +366,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "region",
|
||||
"type": "[Region](../classes/Region.mdx)",
|
||||
"type": "[Region](../../entities/classes/entities.Region.mdx)",
|
||||
"description": "The details of the region associated with the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -384,7 +384,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "sales_channel",
|
||||
"type": "[SalesChannel](../classes/SalesChannel.mdx)",
|
||||
"type": "[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)",
|
||||
"description": "The details of the sales channel associated with the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -402,7 +402,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "shipping_address",
|
||||
"type": "`null` \\| [Address](../classes/Address.mdx)",
|
||||
"type": "`null` \\| [Address](../../entities/classes/entities.Address.mdx)",
|
||||
"description": "The details of the shipping address associated with the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -420,7 +420,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "shipping_methods",
|
||||
"type": "[ShippingMethod](../classes/ShippingMethod.mdx)[]",
|
||||
"type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]",
|
||||
"description": "The details of the shipping methods added to the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -474,7 +474,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"type": "[CartType](../enums/CartType.mdx)",
|
||||
"type": "[CartType](../../entities/enums/entities.CartType.mdx)",
|
||||
"description": "The cart's type.",
|
||||
"optional": false,
|
||||
"defaultValue": "default",
|
||||
@@ -542,7 +542,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[ShippingOptionData](../types/ShippingOptionData.mdx)",
|
||||
"type": "[ShippingOptionData](../../medusa/types/medusa.ShippingOptionData.mdx)",
|
||||
"description": "The `data` object of the shipping option being created. You can use this data to determine whether the shipping option should be calculated or not.\nThis is useful if the fulfillment provider you are integrating has both flat rate and dynamically priced fulfillment options.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -559,7 +559,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
"type": "Promise<boolean>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "If this method returns `true`, that means that the price can be calculated dynamically and the shipping option can have the `price_type` set to calculated.\nThe amount property of the shipping option will then be set to null. The amount will be created later when the shipping method is created on checkout using the [calculatePrice](FulfillmentService.mdx#calculateprice) method.\nIf the method returns `false`, an error is thrown as it means the selected shipping option is invalid and it can only have the `flat_rate` price type.",
|
||||
"description": "If this method returns `true`, that means that the price can be calculated dynamically and the shipping option can have the `price_type` set to calculated.\nThe amount property of the shipping option will then be set to null. The amount will be created later when the shipping method is created on checkout using the [calculatePrice](fulfillment.FulfillmentService.mdx#calculateprice) method.\nIf the method returns `false`, an error is thrown as it means the selected shipping option is invalid and it can only have the `flat_rate` price type.",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
@@ -601,7 +601,7 @@ class MyFulfillmentService extends FulfillmentService {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "fulfillmentData",
|
||||
"type": "[FulfillmentProviderData](../types/FulfillmentProviderData.mdx)",
|
||||
"type": "[FulfillmentProviderData](../../medusa/types/medusa.FulfillmentProviderData.mdx)",
|
||||
"description": "The `data` attribute of the fulfillment being canceled",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -665,7 +665,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[ShippingMethodData](../types/ShippingMethodData.mdx)",
|
||||
"type": "[ShippingMethodData](../../medusa/types/medusa.ShippingMethodData.mdx)",
|
||||
"description": "The `data` object of the shipping method associated with the resource, such as the order.\nYou can use it to access the data specific to the shipping option. This is based on your implementation of previous methods.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -674,7 +674,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "items",
|
||||
"type": "[LineItem](../classes/LineItem.mdx)[]",
|
||||
"type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
|
||||
"description": "The line items in the order to be fulfilled. The admin can choose all or some of the items to fulfill.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -682,7 +682,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
"children": [
|
||||
{
|
||||
"name": "adjustments",
|
||||
"type": "[LineItemAdjustment](../classes/LineItemAdjustment.mdx)[]",
|
||||
"type": "[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[]",
|
||||
"description": "The details of the item's adjustments, which are available when a discount is applied on the item.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -700,7 +700,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "cart",
|
||||
"type": "[Cart](../classes/Cart.mdx)",
|
||||
"type": "[Cart](../../entities/classes/entities.Cart.mdx)",
|
||||
"description": "The details of the cart that the line item may belongs to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -718,7 +718,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "claim_order",
|
||||
"type": "[ClaimOrder](../classes/ClaimOrder.mdx)",
|
||||
"type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)",
|
||||
"description": "The details of the claim that the line item may belong to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -836,7 +836,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "order",
|
||||
"type": "[Order](../classes/Order.mdx)",
|
||||
"type": "[Order](../../entities/classes/entities.Order.mdx)",
|
||||
"description": "The details of the order that the line item may belongs to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -845,7 +845,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "order_edit",
|
||||
"type": "`null` \\| [OrderEdit](../classes/OrderEdit.mdx)",
|
||||
"type": "`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)",
|
||||
"description": "The details of the order edit.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -971,7 +971,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "swap",
|
||||
"type": "[Swap](../classes/Swap.mdx)",
|
||||
"type": "[Swap](../../entities/classes/entities.Swap.mdx)",
|
||||
"description": "The details of the swap that the line item may belong to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -989,7 +989,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "tax_lines",
|
||||
"type": "[LineItemTaxLine](../classes/LineItemTaxLine.mdx)[]",
|
||||
"type": "[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]",
|
||||
"description": "The details of the item's tax lines.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1052,7 +1052,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "variant",
|
||||
"type": "[ProductVariant](../classes/ProductVariant.mdx)",
|
||||
"type": "[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)",
|
||||
"description": "The details of the product variant that this item was created from.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1072,7 +1072,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "order",
|
||||
"type": "[Order](../classes/Order.mdx)",
|
||||
"type": "[Order](../../entities/classes/entities.Order.mdx)",
|
||||
"description": "The details of the created resource, which is either an order, a claim, or a swap:\n- If the resource the fulfillment is being created for is a claim, the `is_claim` property in the object will be `true`.\n- If the resource the fulfillment is being created for is a swap, the `is_swap` property in the object will be `true`.\n- Otherwise, the resource is an order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1080,7 +1080,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
"children": [
|
||||
{
|
||||
"name": "billing_address",
|
||||
"type": "[Address](../classes/Address.mdx)",
|
||||
"type": "[Address](../../entities/classes/entities.Address.mdx)",
|
||||
"description": "The details of the billing address associated with the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1107,7 +1107,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "cart",
|
||||
"type": "[Cart](../classes/Cart.mdx)",
|
||||
"type": "[Cart](../../entities/classes/entities.Cart.mdx)",
|
||||
"description": "The details of the cart associated with the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1125,7 +1125,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "claims",
|
||||
"type": "[ClaimOrder](../classes/ClaimOrder.mdx)[]",
|
||||
"type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]",
|
||||
"description": "The details of the claims created for the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1143,7 +1143,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[Currency](../classes/Currency.mdx)",
|
||||
"type": "[Currency](../../entities/classes/entities.Currency.mdx)",
|
||||
"description": "The details of the currency used in the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1161,7 +1161,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "customer",
|
||||
"type": "[Customer](../classes/Customer.mdx)",
|
||||
"type": "[Customer](../../entities/classes/entities.Customer.mdx)",
|
||||
"description": "The details of the customer associated with the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1188,7 +1188,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "discounts",
|
||||
"type": "[Discount](../classes/Discount.mdx)[]",
|
||||
"type": "[Discount](../../entities/classes/entities.Discount.mdx)[]",
|
||||
"description": "The details of the discounts applied on the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1206,7 +1206,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "draft_order",
|
||||
"type": "[DraftOrder](../classes/DraftOrder.mdx)",
|
||||
"type": "[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)",
|
||||
"description": "The details of the draft order this order was created from.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1224,7 +1224,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "edits",
|
||||
"type": "[OrderEdit](../classes/OrderEdit.mdx)[]",
|
||||
"type": "[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]",
|
||||
"description": "The details of the order edits done on the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1251,7 +1251,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "fulfillment_status",
|
||||
"type": "[FulfillmentStatus](../enums/FulfillmentStatus.mdx)",
|
||||
"type": "[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)",
|
||||
"description": "The order's fulfillment status",
|
||||
"optional": false,
|
||||
"defaultValue": "not_fulfilled",
|
||||
@@ -1260,7 +1260,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "fulfillments",
|
||||
"type": "[Fulfillment](../classes/Fulfillment.mdx)[]",
|
||||
"type": "[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]",
|
||||
"description": "The details of the fulfillments created for the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1287,7 +1287,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "gift_card_transactions",
|
||||
"type": "[GiftCardTransaction](../classes/GiftCardTransaction.mdx)[]",
|
||||
"type": "[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]",
|
||||
"description": "The gift card transactions made in the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1296,7 +1296,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "gift_cards",
|
||||
"type": "[GiftCard](../classes/GiftCard.mdx)[]",
|
||||
"type": "[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]",
|
||||
"description": "The details of the gift card used in the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1332,7 +1332,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "items",
|
||||
"type": "[LineItem](../classes/LineItem.mdx)[]",
|
||||
"type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
|
||||
"description": "The details of the line items that belong to the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1377,7 +1377,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "payment_status",
|
||||
"type": "[PaymentStatus](../enums/PaymentStatus.mdx)",
|
||||
"type": "[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)",
|
||||
"description": "The order's payment status",
|
||||
"optional": false,
|
||||
"defaultValue": "not_paid",
|
||||
@@ -1386,7 +1386,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "payments",
|
||||
"type": "[Payment](../classes/Payment.mdx)[]",
|
||||
"type": "[Payment](../../entities/classes/entities.Payment.mdx)[]",
|
||||
"description": "The details of the payments used in the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1422,7 +1422,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "refunds",
|
||||
"type": "[Refund](../classes/Refund.mdx)[]",
|
||||
"type": "[Refund](../../entities/classes/entities.Refund.mdx)[]",
|
||||
"description": "The details of the refunds created for the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1431,7 +1431,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "region",
|
||||
"type": "[Region](../classes/Region.mdx)",
|
||||
"type": "[Region](../../entities/classes/entities.Region.mdx)",
|
||||
"description": "The details of the region this order was created in.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1449,7 +1449,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "returnable_items",
|
||||
"type": "[LineItem](../classes/LineItem.mdx)[]",
|
||||
"type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
|
||||
"description": "The details of the line items that are returnable as part of the order, swaps, or claims",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -1458,7 +1458,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "returns",
|
||||
"type": "[Return](../classes/Return.mdx)[]",
|
||||
"type": "[Return](../../entities/classes/entities.Return.mdx)[]",
|
||||
"description": "The details of the returns created for the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1467,7 +1467,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "sales_channel",
|
||||
"type": "[SalesChannel](../classes/SalesChannel.mdx)",
|
||||
"type": "[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)",
|
||||
"description": "The details of the sales channel this order belongs to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1485,7 +1485,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "shipping_address",
|
||||
"type": "[Address](../classes/Address.mdx)",
|
||||
"type": "[Address](../../entities/classes/entities.Address.mdx)",
|
||||
"description": "The details of the shipping address associated with the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1503,7 +1503,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "shipping_methods",
|
||||
"type": "[ShippingMethod](../classes/ShippingMethod.mdx)[]",
|
||||
"type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]",
|
||||
"description": "The details of the shipping methods used in the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1530,7 +1530,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "status",
|
||||
"type": "[OrderStatus](../enums/OrderStatus.mdx)",
|
||||
"type": "[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)",
|
||||
"description": "The order's status",
|
||||
"optional": false,
|
||||
"defaultValue": "pending",
|
||||
@@ -1548,7 +1548,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "swaps",
|
||||
"type": "[Swap](../classes/Swap.mdx)[]",
|
||||
"type": "[Swap](../../entities/classes/entities.Swap.mdx)[]",
|
||||
"description": "The details of the swaps created for the order.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1595,7 +1595,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "fulfillment",
|
||||
"type": "[Fulfillment](../classes/Fulfillment.mdx)",
|
||||
"type": "[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)",
|
||||
"description": "The fulfillment being created.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1612,7 +1612,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "claim_order",
|
||||
"type": "[ClaimOrder](../classes/ClaimOrder.mdx)",
|
||||
"type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)",
|
||||
"description": "The details of the claim that the fulfillment may belong to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1666,7 +1666,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "items",
|
||||
"type": "[FulfillmentItem](../classes/FulfillmentItem.mdx)[]",
|
||||
"type": "[FulfillmentItem](../../entities/classes/entities.FulfillmentItem.mdx)[]",
|
||||
"description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1702,7 +1702,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "order",
|
||||
"type": "[Order](../classes/Order.mdx)",
|
||||
"type": "[Order](../../entities/classes/entities.Order.mdx)",
|
||||
"description": "The details of the order that the fulfillment may belong to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1720,7 +1720,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "provider",
|
||||
"type": "[FulfillmentProvider](../classes/FulfillmentProvider.mdx)",
|
||||
"type": "[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)",
|
||||
"description": "The details of the fulfillment provider responsible for handling the fulfillment.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1747,7 +1747,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "swap",
|
||||
"type": "[Swap](../classes/Swap.mdx)",
|
||||
"type": "[Swap](../../entities/classes/entities.Swap.mdx)",
|
||||
"description": "The details of the swap that the fulfillment may belong to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1765,7 +1765,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "tracking_links",
|
||||
"type": "[TrackingLink](../classes/TrackingLink.mdx)[]",
|
||||
"type": "[TrackingLink](../../entities/classes/entities.TrackingLink.mdx)[]",
|
||||
"description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1799,7 +1799,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<[FulfillmentProviderData](../types/FulfillmentProviderData.mdx)>",
|
||||
"type": "Promise<[FulfillmentProviderData](../../medusa/types/medusa.FulfillmentProviderData.mdx)>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The data that will be stored in the `data` attribute of the created fulfillment.",
|
||||
@@ -1847,7 +1847,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "returnOrder",
|
||||
"type": "[CreateReturnType](../types/CreateReturnType.mdx)",
|
||||
"type": "[CreateReturnType](../../medusa/types/medusa.CreateReturnType.mdx)",
|
||||
"description": "the return that the fulfillment is being created for.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1855,7 +1855,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
"children": [
|
||||
{
|
||||
"name": "claim_order",
|
||||
"type": "[ClaimOrder](../classes/ClaimOrder.mdx)",
|
||||
"type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)",
|
||||
"description": "The details of the claim that the return may belong to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1900,7 +1900,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "items",
|
||||
"type": "[ReturnItem](../classes/ReturnItem.mdx)[]",
|
||||
"type": "[ReturnItem](../../entities/classes/entities.ReturnItem.mdx)[]",
|
||||
"description": "The details of the items that the customer is returning.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1936,7 +1936,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "order",
|
||||
"type": "[Order](../classes/Order.mdx)",
|
||||
"type": "[Order](../../entities/classes/entities.Order.mdx)",
|
||||
"description": "The details of the order that the return was created for.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1981,7 +1981,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "shipping_method",
|
||||
"type": "[ShippingMethod](../classes/ShippingMethod.mdx)",
|
||||
"type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)",
|
||||
"description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1990,7 +1990,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "status",
|
||||
"type": "[ReturnStatus](../enums/ReturnStatus.mdx)",
|
||||
"type": "[ReturnStatus](../../entities/enums/entities.ReturnStatus.mdx)",
|
||||
"description": "Status of the Return.",
|
||||
"optional": false,
|
||||
"defaultValue": "requested",
|
||||
@@ -1999,7 +1999,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "swap",
|
||||
"type": "[Swap](../classes/Swap.mdx)",
|
||||
"type": "[Swap](../../entities/classes/entities.Swap.mdx)",
|
||||
"description": "The details of the swap that the return may belong to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2078,7 +2078,7 @@ class MyFulfillmentService extends FulfillmentService {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[FulfillmentProviderData](../types/FulfillmentProviderData.mdx)",
|
||||
"type": "[FulfillmentProviderData](../../medusa/types/medusa.FulfillmentProviderData.mdx)",
|
||||
"description": "The `data` attribute of the fulfillment that you're retrieving the documents for.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2306,7 +2306,7 @@ class MyFulfillmentService extends FulfillmentService {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "fulfillmentData",
|
||||
"type": "[FulfillmentProviderData](../types/FulfillmentProviderData.mdx)",
|
||||
"type": "[FulfillmentProviderData](../../medusa/types/medusa.FulfillmentProviderData.mdx)",
|
||||
"description": "The `data` attribute of the order's fulfillment.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2386,7 +2386,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "optionData",
|
||||
"type": "[ShippingOptionData](../types/ShippingOptionData.mdx)",
|
||||
"type": "[ShippingOptionData](../../medusa/types/medusa.ShippingOptionData.mdx)",
|
||||
"description": "The data object of the shipping option selected when creating the shipping method.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2395,7 +2395,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[FulfillmentProviderData](../types/FulfillmentProviderData.mdx)",
|
||||
"type": "[FulfillmentProviderData](../../medusa/types/medusa.FulfillmentProviderData.mdx)",
|
||||
"description": "The `data` object passed in the body of the request.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2404,7 +2404,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "cart",
|
||||
"type": "[Cart](../classes/Cart.mdx)",
|
||||
"type": "[Cart](../../entities/classes/entities.Cart.mdx)",
|
||||
"description": "The customer's cart details. It may be empty if the shipping method isn't associated with a cart, such as when it's associated with a claim.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2412,7 +2412,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
"children": [
|
||||
{
|
||||
"name": "billing_address",
|
||||
"type": "[Address](../classes/Address.mdx)",
|
||||
"type": "[Address](../../entities/classes/entities.Address.mdx)",
|
||||
"description": "The details of the billing address associated with the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2457,7 +2457,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "customer",
|
||||
"type": "[Customer](../classes/Customer.mdx)",
|
||||
"type": "[Customer](../../entities/classes/entities.Customer.mdx)",
|
||||
"description": "The details of the customer the cart belongs to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2493,7 +2493,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "discounts",
|
||||
"type": "[Discount](../classes/Discount.mdx)[]",
|
||||
"type": "[Discount](../../entities/classes/entities.Discount.mdx)[]",
|
||||
"description": "An array of details of all discounts applied to the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2529,7 +2529,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "gift_cards",
|
||||
"type": "[GiftCard](../classes/GiftCard.mdx)[]",
|
||||
"type": "[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]",
|
||||
"description": "An array of details of all gift cards applied to the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2565,7 +2565,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "items",
|
||||
"type": "[LineItem](../classes/LineItem.mdx)[]",
|
||||
"type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
|
||||
"description": "The line items added to the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2592,7 +2592,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "payment",
|
||||
"type": "[Payment](../classes/Payment.mdx)",
|
||||
"type": "[Payment](../../entities/classes/entities.Payment.mdx)",
|
||||
"description": "The details of the payment associated with the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2619,7 +2619,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "payment_session",
|
||||
"type": "`null` \\| [PaymentSession](../classes/PaymentSession.mdx)",
|
||||
"type": "`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)",
|
||||
"description": "The details of the selected payment session in the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2628,7 +2628,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "payment_sessions",
|
||||
"type": "[PaymentSession](../classes/PaymentSession.mdx)[]",
|
||||
"type": "[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]",
|
||||
"description": "The details of all payment sessions created on the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2664,7 +2664,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "region",
|
||||
"type": "[Region](../classes/Region.mdx)",
|
||||
"type": "[Region](../../entities/classes/entities.Region.mdx)",
|
||||
"description": "The details of the region associated with the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2682,7 +2682,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "sales_channel",
|
||||
"type": "[SalesChannel](../classes/SalesChannel.mdx)",
|
||||
"type": "[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)",
|
||||
"description": "The details of the sales channel associated with the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2700,7 +2700,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "shipping_address",
|
||||
"type": "`null` \\| [Address](../classes/Address.mdx)",
|
||||
"type": "`null` \\| [Address](../../entities/classes/entities.Address.mdx)",
|
||||
"description": "The details of the shipping address associated with the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2718,7 +2718,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "shipping_methods",
|
||||
"type": "[ShippingMethod](../classes/ShippingMethod.mdx)[]",
|
||||
"type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]",
|
||||
"description": "The details of the shipping methods added to the cart.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -2772,7 +2772,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"type": "[CartType](../enums/CartType.mdx)",
|
||||
"type": "[CartType](../../entities/enums/entities.CartType.mdx)",
|
||||
"description": "The cart's type.",
|
||||
"optional": false,
|
||||
"defaultValue": "default",
|
||||
@@ -2800,7 +2800,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
"type": "Promise<Record<string, unknown>>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "The data that will be stored in the `data` property of the shipping method to be created.\nMake sure the value you return contains everything you need to fulfill the shipment later on. The returned value may also be used to calculate the price of the shipping method\nif it doesn't have a set price. It will be passed along to the [calculatePrice](FulfillmentService.mdx#calculateprice) method.",
|
||||
"description": "The data that will be stored in the `data` property of the shipping method to be created.\nMake sure the value you return contains everything you need to fulfill the shipment later on. The returned value may also be used to calculate the price of the shipping method\nif it doesn't have a set price. It will be passed along to the [calculatePrice](fulfillment.FulfillmentService.mdx#calculateprice) method.",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
@@ -2842,7 +2842,7 @@ class MyFulfillmentService extends AbstractFulfillmentService {
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[ShippingOptionData](../types/ShippingOptionData.mdx)",
|
||||
"type": "[ShippingOptionData](../../medusa/types/medusa.ShippingOptionData.mdx)",
|
||||
"description": "the data object that is sent in the body of the request, basically, the data object of the shipping option. You can use this data to validate the shipping option before it is saved.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1,9 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreateReturnType
|
||||
|
||||
**CreateReturnType**: [Omit](Omit.mdx)<[Return](../classes/Return.mdx), "beforeInsert">
|
||||
@@ -1,34 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Exclude
|
||||
|
||||
**Exclude**: `T` extends `U` ? `never` : `T`
|
||||
|
||||
Exclude from T those types that are assignable to U
|
||||
|
||||
## Type Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "U",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,9 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FulfillmentProviderData
|
||||
|
||||
**FulfillmentProviderData**: `Record<string, unknown>`
|
||||
@@ -1,9 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# MedusaContainer
|
||||
|
||||
**MedusaContainer**: `AwilixContainer` & ``{ createScope: () => [MedusaContainer](MedusaContainer.mdx) ; registerAdd: <T>(name: string, registration: T) => [MedusaContainer](MedusaContainer.mdx) }``
|
||||
@@ -1,34 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Omit
|
||||
|
||||
**Omit**: [Pick](Pick.mdx)<T, [Exclude](Exclude.mdx)<keyof T, K>>
|
||||
|
||||
Construct a type with the properties of T except for those in type K.
|
||||
|
||||
## Type Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "K",
|
||||
"type": "keyof `any`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,34 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Pick
|
||||
|
||||
**Pick**: { [P in K]: T[P] }
|
||||
|
||||
From T, pick a set of properties whose keys are in the union K
|
||||
|
||||
## Type Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "K",
|
||||
"type": "keyof `T`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,34 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Record
|
||||
|
||||
**Record**: { [P in K]: T }
|
||||
|
||||
Construct a type with a set of properties K of type T
|
||||
|
||||
## Type Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "K",
|
||||
"type": "keyof `any`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "T",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,9 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ShippingMethodData
|
||||
|
||||
**ShippingMethodData**: `Record<string, unknown>`
|
||||
@@ -1,9 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: modules
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ShippingOptionData
|
||||
|
||||
**ShippingOptionData**: `Record<string, unknown>`
|
||||
Reference in new issue
Block a user