chore(docs): Generated References (#9551)
Generated the following references: - `api_key` - `auth` - `cart` - `core_flows` - `currency` - `customer` - `fulfillment` - `inventory_next` - `modules` - `modules_sdk` - `order` - `order_models` - `payment` - `payment_provider` - `pricing` - `product` - `promotion` - `region` - `sales_channel` - `search` - `stock_location_next` - `store` - `tax` - `types` - `user` - `utils` - `workflows` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andOli Juhl authored and 
GitHub committed
1 parent
089d4af301
commit
224e530453
393 files changed
+384350
-379636
No files matched your search
@@ -335,6 +335,7 @@ import { TypeList } from "docs-ui"
|
||||
- [validateVariantPricesStepId](page.mdx#validatevariantpricesstepid)
|
||||
- [addShippingMethodToCartWorkflowId](page.mdx#addshippingmethodtocartworkflowid)
|
||||
- [addToCartWorkflowId](page.mdx#addtocartworkflowid)
|
||||
- [THREE\_DAYS](page.mdx#three_days)
|
||||
- [completeCartWorkflowId](page.mdx#completecartworkflowid)
|
||||
- [confirmVariantInventoryWorkflowId](page.mdx#confirmvariantinventoryworkflowid)
|
||||
- [createCartWorkflowId](page.mdx#createcartworkflowid)
|
||||
@@ -578,6 +579,8 @@ import { TypeList } from "docs-ui"
|
||||
- [capturePaymentStepId](page.mdx#capturepaymentstepid)
|
||||
- [refundPaymentStepId](page.mdx#refundpaymentstepid)
|
||||
- [capturePaymentWorkflowId](page.mdx#capturepaymentworkflowid)
|
||||
- [onPaymentProcessedWorkflowId](page.mdx#onpaymentprocessedworkflowid)
|
||||
- [processPaymentWorkflowId](page.mdx#processpaymentworkflowid)
|
||||
- [refundPaymentWorkflowId](page.mdx#refundpaymentworkflowid)
|
||||
- [createPriceListPricesStepId](page.mdx#createpricelistpricesstepid)
|
||||
- [createPriceListsStepId](page.mdx#createpricelistsstepid)
|
||||
@@ -821,6 +824,7 @@ import { TypeList } from "docs-ui"
|
||||
- [emitEventStep](page.mdx#emiteventstep)
|
||||
- [removeRemoteLinkStep](page.mdx#removeremotelinkstep)
|
||||
- [updateRemoteLinksStep](page.mdx#updateremotelinksstep)
|
||||
- [useQueryGraphStep](page.mdx#usequerygraphstep)
|
||||
- [useRemoteQueryStep](page.mdx#useremotequerystep)
|
||||
- [batchLinksWorkflow](page.mdx#batchlinksworkflow)
|
||||
- [createLinksWorkflow](page.mdx#createlinksworkflow)
|
||||
@@ -1117,6 +1121,8 @@ import { TypeList } from "docs-ui"
|
||||
- [capturePaymentStep](page.mdx#capturepaymentstep)
|
||||
- [refundPaymentStep](page.mdx#refundpaymentstep)
|
||||
- [capturePaymentWorkflow](page.mdx#capturepaymentworkflow)
|
||||
- [onPaymentProcessedWorkflow](page.mdx#onpaymentprocessedworkflow)
|
||||
- [processPaymentWorkflow](page.mdx#processpaymentworkflow)
|
||||
- [validateRefundStep](page.mdx#validaterefundstep)
|
||||
- [refundPaymentWorkflow](page.mdx#refundpaymentworkflow)
|
||||
- [createPriceListPricesStep](page.mdx#createpricelistpricesstep)
|
||||
@@ -1517,6 +1523,10 @@ ___
|
||||
|
||||
`Const` **addToCartWorkflowId**: `"add-to-cart"`
|
||||
|
||||
### THREE\_DAYS
|
||||
|
||||
`Const` **THREE\_DAYS**: `number`
|
||||
|
||||
### completeCartWorkflowId
|
||||
|
||||
`Const` **completeCartWorkflowId**: `"complete-cart"`
|
||||
@@ -2489,6 +2499,14 @@ ___
|
||||
|
||||
`Const` **capturePaymentWorkflowId**: `"capture-payment-workflow"`
|
||||
|
||||
### onPaymentProcessedWorkflowId
|
||||
|
||||
`Const` **onPaymentProcessedWorkflowId**: `"on-payment-processed-workflow"`
|
||||
|
||||
### processPaymentWorkflowId
|
||||
|
||||
`Const` **processPaymentWorkflowId**: `"process-payment-workflow"`
|
||||
|
||||
### refundPaymentWorkflowId
|
||||
|
||||
`Const` **refundPaymentWorkflowId**: `"refund-payment-workflow"`
|
||||
@@ -3389,7 +3407,7 @@ This step confirms for one or more variants that their inventory has a required
|
||||
|
||||
#### Input
|
||||
|
||||
<TypeList types={[{"name":"ConfirmVariantInventoryStepInput","type":"[ConfirmVariantInventoryStepInput](../../core_flows/interfaces/core_flows.ConfirmVariantInventoryStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"inventory_item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"required_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="confirmInventoryStep"/>
|
||||
<TypeList types={[{"name":"ConfirmVariantInventoryStepInput","type":"[ConfirmVariantInventoryStepInput](../../core_flows/interfaces/core_flows.ConfirmVariantInventoryStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"inventory_item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"required_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"[BigNumberInput](../../types/types/types.BigNumberInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"location_ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="confirmInventoryStep"/>
|
||||
|
||||
### createCartsStep
|
||||
|
||||
@@ -3545,7 +3563,7 @@ This step retrieves variants matching the specified filters.
|
||||
|
||||
#### Input
|
||||
|
||||
<TypeList types={[{"name":"GetVariantsStepInput","type":"[GetVariantsStepInput](../../core_flows/interfaces/core_flows.GetVariantsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"filter","type":"[FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the title and different code attributes on the variant","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product variants by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `string`[]","description":"The SKUs to filter product variants by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter the product variants by their associated products' IDs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, string>`","description":"Filter product variants by their associated options.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joinLine truncated
|
||||
<TypeList types={[{"name":"GetVariantsStepInput","type":"[GetVariantsStepInput](../../core_flows/interfaces/core_flows.GetVariantsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"filter","type":"[FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the title and different code attributes on the variant","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product variants by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `string`[]","description":"The SKUs to filter product variants by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter the product variants by their associated products' IDs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, string>`","description":"Filter product variants by their associated options.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../product/interfaces/product.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx) \\| [BaseFilterable](../../product/interfaces/product.BaseFilterable/page.mdx)<[FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joinLine truncated
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -3607,7 +3625,7 @@ variant's inventory.
|
||||
|
||||
#### Input
|
||||
|
||||
<TypeList types={[{"name":"ReserveVariantInventoryStepInput","type":"[ReserveVariantInventoryStepInput](../../core_flows/interfaces/core_flows.ReserveVariantInventoryStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"inventory_item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"required_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="reserveInventoryStep"/>
|
||||
<TypeList types={[{"name":"ReserveVariantInventoryStepInput","type":"[ReserveVariantInventoryStepInput](../../core_flows/interfaces/core_flows.ReserveVariantInventoryStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"inventory_item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"required_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"[BigNumberInput](../../types/types/types.BigNumberInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"location_ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="reserveInventoryStep"/>
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -3619,7 +3637,7 @@ This step retrieves a cart's details.
|
||||
|
||||
#### Input
|
||||
|
||||
<TypeList types={[{"name":"RetrieveCartStepInput","type":"[RetrieveCartStepInput](../../core_flows/interfaces/core_flows.RetrieveCartStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../types/CommonTypes/interfaces/types.CommonTypes.FindConfig/page.mdx)<[CartDTO](../../cart/interfaces/cart.CartDTO/page.mdx)>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieveCartStep"/>
|
||||
<TypeList types={[{"name":"RetrieveCartStepInput","type":"[RetrieveCartStepInput](../../core_flows/interfaces/core_flows.RetrieveCartStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../types/CommonTypes/interfaces/types.CommonTypes.FindConfig/page.mdx)<[CartDTO](../../cart/interfaces/cart.CartDTO/page.mdx)>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`Record<string, \"ASC\" \\| \"DESC\" \\| string & object>`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieveCartStep"/>
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -3647,7 +3665,7 @@ This step updates a cart.
|
||||
|
||||
#### Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateCartWorkflowInputDTO[]","type":"[UpdateCartWorkflowInputDTO](../../types/interfaces/types.UpdateCartWorkflowInputDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateCartWorkflowInputDTO","type":"[UpdateCartWorkflowInputDTO](../../types/interfaces/types.UpdateCartWorkflowInputDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promo_codes","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateCartsStep"/>
|
||||
<TypeList types={[{"name":"UpdateCartWorkflowInputDTO[]","type":"[UpdateCartWorkflowInputDTO](../../types/interfaces/types.UpdateCartWorkflowInputDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateCartWorkflowInputDTO","type":"[UpdateCartWorkflowInputDTO](../../types/interfaces/types.UpdateCartWorkflowInputDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promo_codes","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [UpdateAddressDTO](../../cart/interfaces/cart.UpdateAddressDTO/page.mdx) \\| [CreateAddressDTO](../../cart/interfaces/cart.CreateAddressDTO/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The ISO two country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The ISO two country code of the address.","optional":true,"defaultValue":"","expandable":false,"chLine truncated
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -3700,7 +3718,7 @@ This workflow adds shipping methods to a cart.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"addShippingMethodToWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"validateCartShippingOptionsStep","description":"This step validates shipping options to ensure they can be applied on a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatecartshippingoptionsstep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"removeShippingMethodFromCartStep","description":"This step removes shipping methods from a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#removeshippingmethodfromcartstep","depth":4},{"type":"step","name":"addShippingMethodToCartStep","description":"This step adds shipping methods to a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#addshippingmethodtocartstep","depth":5},{"type":"workflow","name":"updateTaxLinesWorkflow","description":"This workflow updates a cart's tax lines.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatetaxlinesworkflow","depth":6},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatecartpromotionsworkflow","depth":7}]}} />
|
||||
<undefined workflow={{"name":"addShippingMethodToWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"validateCartShippingOptionsStep","description":"This step validates shipping options to ensure they can be applied on a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatecartshippingoptionsstep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"removeShippingMethodFromCartStep","description":"This step removes shipping methods from a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#removeshippingmethodfromcartstep","depth":4},{"type":"step","name":"addShippingMethodToCartStep","description":"This step adds shipping methods to a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#addshippingmethodtocartstep","depth":4},{"type":"workflow","name":"updateTaxLinesWorkflow","description":"This workflow updates a cart's tax lines.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatetaxlinesworkflow","depth":5},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatecartpromotionsworkflow","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -3712,7 +3730,7 @@ This workflow adds items to a cart.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"addToCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatevariantpricesstep","depth":2},{"type":"step","name":"getLineItemActionsStep","description":"This step returns lists of cart line items to create or update based on the\nprovided input.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#getlineitemactionsstep","depth":3},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#confirmvariantinventoryworkflow","depth":4},{"type":"step","name":"createLineItemsStep","description":"This step creates line item in a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#createlineitemsstep","depth":5},{"type":"step","name":"updateLineItemsStep","description":"This step updates a cart's line items.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#updatelineitemsstep","depth":5},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":6},{"type":"step","name":"refreshCartShippingMethodsStep","description":"This step refreshes the shipping methods of a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#refreshcartshippingmethodsstep","depth":7},{"type":"workflow","name":"updateTaxLinesWorkflow","description":"This workflow updates a cart's tax lines.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatetaxlinesworkflow","depth":7},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatecartpromotionsworkflow","depth":8},{"type":"workflow","name":"refreshPaymentCollectionForCartWorkflow","description":"This workflow refreshes the payment collections of a cart.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#refreshpaymentcollectionforcartworkflow","depth":9}]}} />
|
||||
<undefined workflow={{"name":"addToCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatevariantpricesstep","depth":2},{"type":"step","name":"getLineItemActionsStep","description":"This step returns lists of cart line items to create or update based on the\nprovided input.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#getlineitemactionsstep","depth":3},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#confirmvariantinventoryworkflow","depth":4},{"type":"step","name":"createLineItemsStep","description":"This step creates line item in a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#createlineitemsstep","depth":5},{"type":"step","name":"updateLineItemsStep","description":"This step updates a cart's line items.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#updatelineitemsstep","depth":5},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":6},{"type":"step","name":"refreshCartShippingMethodsStep","description":"This step refreshes the shipping methods of a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#refreshcartshippingmethodsstep","depth":7},{"type":"workflow","name":"updateTaxLinesWorkflow","description":"This workflow updates a cart's tax lines.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatetaxlinesworkflow","depth":8},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatecartpromotionsworkflow","depth":9},{"type":"workflow","name":"refreshPaymentCollectionForCartWorkflow","description":"This workflow refreshes the payment collections of a cart.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#refreshpaymentcollectionforcartworkflow","depth":10}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -3728,7 +3746,7 @@ This workflow completes a cart.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"completeCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"validateCartPaymentsStep","description":"This step validates a cart's payment sessions. Their status must\nbe `pending` or `requires_more`.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatecartpaymentsstep","depth":2},{"type":"step","name":"authorizePaymentSessionStep","description":"This step authorizes a payment session.","link":"../../core_flows/core_flows.Steps_Payment/page.mdx#authorizepaymentsessionstep","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":4},{"type":"step","name":"createOrdersStep","description":"This step creates one or more orders.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createordersstep","depth":5},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":6},{"type":"step","name":"updateCartsStep","description":"This step updates a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#updatecartsstep","depth":6},{"type":"step","name":"reserveInventoryStep","description":"This step reserves the quantity of line items from the associated\nvariant's inventory.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#reserveinventorystep","depth":6},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":6}]}} />
|
||||
<undefined workflow={{"name":"completeCartWorkflow","steps":[{"type":"when","condition":"{\n return !orderId\n }","depth":"1","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"validateCartPaymentsStep","description":"This step validates a cart's payment sessions. Their status must\nbe `pending` or `requires_more`.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatecartpaymentsstep","depth":1},{"type":"step","name":"authorizePaymentSessionStep","description":"This step authorizes a payment session.","link":"../../core_flows/core_flows.Steps_Payment/page.mdx#authorizepaymentsessionstep","depth":1},{"type":"step","name":"createOrdersStep","description":"This step creates one or more orders.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createordersstep","depth":1},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":1},{"type":"step","name":"updateCartsStep","description":"This step updates a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#updatecartsstep","depth":1},{"type":"step","name":"reserveInventoryStep","description":"This step reserves the quantity of line items from the associated\nvariant's inventory.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#reserveinventorystep","depth":1},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":1}]}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -3736,7 +3754,7 @@ This workflow completes a cart.
|
||||
|
||||
#### Output
|
||||
|
||||
<TypeList types={[{"name":"OrderDTO","type":"[OrderDTO](../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../fulfillment/types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_total","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_subtotal","type":"[BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","descLine truncated
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="completeCartWorkflow"/>
|
||||
|
||||
### confirmVariantInventoryWorkflow
|
||||
|
||||
@@ -3752,7 +3770,7 @@ This workflow confirms for one or more variants that their inventory has a requi
|
||||
|
||||
#### Output
|
||||
|
||||
<TypeList types={[{"name":"ConfirmVariantInventoryWorkflowOutput","type":"[ConfirmVariantInventoryWorkflowOutput](../../core_flows/interfaces/core_flows.ConfirmVariantInventoryWorkflowOutput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"inventory_item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"required_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="confirmVariantInventoryWorkflow"/>
|
||||
<TypeList types={[{"name":"ConfirmVariantInventoryWorkflowOutput","type":"[ConfirmVariantInventoryWorkflowOutput](../../core_flows/interfaces/core_flows.ConfirmVariantInventoryWorkflowOutput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"items","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"inventory_item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"required_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"[BigNumberInput](../../types/types/types.BigNumberInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"location_ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="confirmVariantInventoryWorkflow"/>
|
||||
|
||||
### createCartWorkflow
|
||||
|
||||
@@ -3777,7 +3795,7 @@ This workflow creates a cart.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { createCartWorkflow } from "@medusajs/core-flows"
|
||||
import { createCartWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
createCartWorkflow.hooks.cartCreated(
|
||||
(async ({ cart, additional_data }, { container }) => {
|
||||
@@ -3854,11 +3872,11 @@ This workflow updates a cart.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"updateCartWorkflow","steps":[{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findsaleschannelstep","depth":1},{"type":"step","name":"findOneOrAnyRegionStep","description":"This step retrieves a region either by the provided ID or the first region in the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findoneoranyregionstep","depth":1},{"type":"step","name":"findOrCreateCustomerStep","description":"This step either finds a customer matching the specified ID, or finds / create a customer\nmatching the specified email. If both ID and email are provided, ID takes precedence.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findorcreatecustomerstep","depth":1},{"type":"step","name":"updateCartsStep","description":"This step updates a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#updatecartsstep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"refreshCartShippingMethodsStep","description":"This step refreshes the shipping methods of a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#refreshcartshippingmethodsstep","depth":4},{"type":"workflow","name":"updateTaxLinesWorkflow","description":"This workflow updates a cart's tax lines.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatetaxlinesworkflow","depth":4},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatecartpromotionsworkflow","depth":5},{"type":"workflow","name":"refreshPaymentCollectionForCartWorkflow","description":"This workflow refreshes the payment collections of a cart.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#refreshpaymentcollectionforcartworkflow","depth":6},{"type":"hook","name":"cartUpdated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#cartUpdated","depth":7}]}} />
|
||||
<undefined workflow={{"name":"updateCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findsaleschannelstep","depth":2},{"type":"step","name":"findOrCreateCustomerStep","description":"This step either finds a customer matching the specified ID, or finds / create a customer\nmatching the specified email. If both ID and email are provided, ID takes precedence.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findorcreatecustomerstep","depth":2},{"type":"when","condition":"{\n return !!data.input.region_id\n }","depth":"3","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3}]},{"type":"step","name":"updateCartsStep","description":"This step updates a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#updatecartsstep","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":5},{"type":"step","name":"refreshCartShippingMethodsStep","description":"This step refreshes the shipping methods of a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#refreshcartshippingmethodsstep","depth":6},{"type":"workflow","name":"updateTaxLinesWorkflow","description":"This workflow updates a cart's tax lines.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatetaxlinesworkflow","depth":7},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatecartpromotionsworkflow","depth":8},{"type":"workflow","name":"refreshPaymentCollectionForCartWorkflow","description":"This workflow refreshes the payment collections of a cart.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#refreshpaymentcollectionforcartworkflow","depth":9},{"type":"hook","name":"cartUpdated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#cartUpdated","depth":10}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateCartWorkflowInputDTO & AdditionalData","type":"[UpdateCartWorkflowInputDTO](../../types/interfaces/types.UpdateCartWorkflowInputDTO/page.mdx) & [AdditionalData](../../types/HttpTypes/types/types.HttpTypes.AdditionalData/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateCartWorkflowInputDTO","type":"[UpdateCartWorkflowInputDTO](../../types/interfaces/types.UpdateCartWorkflowInputDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promo_codes","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"AdditionalData","type":"[AdditionalData](../../types/HttpTypes/types/types.HttpTypes.AdditionalData/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"additional_data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateCartWorkflow"/>
|
||||
<TypeList types={[{"name":"UpdateCartWorkflowInputDTO & AdditionalData","type":"[UpdateCartWorkflowInputDTO](../../types/interfaces/types.UpdateCartWorkflowInputDTO/page.mdx) & [AdditionalData](../../types/HttpTypes/types/types.HttpTypes.AdditionalData/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateCartWorkflowInputDTO","type":"[UpdateCartWorkflowInputDTO](../../types/interfaces/types.UpdateCartWorkflowInputDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promo_codes","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [UpdateAddressDTO](../../cart/interfaces/cart.UpdateAddressDTO/page.mdx) \\| [CreateAddressDTO](../../cart/interfaces/cart.CreateAddressDTO/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The ISO two country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","descriptionLine truncated
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -3871,7 +3889,7 @@ This workflow updates a cart.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { updateCartWorkflow } from "@medusajs/core-flows"
|
||||
import { updateCartWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
updateCartWorkflow.hooks.cartUpdated(
|
||||
(async ({ cart, additional_data }, { container }) => {
|
||||
@@ -4071,6 +4089,20 @@ const helloWorldWorkflow = createWorkflow(
|
||||
|
||||
<TypeList types={[{"name":"LinkDefinition[]","type":"[LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"LinkDefinition","type":"[LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRemoteLinksStep"/>
|
||||
|
||||
### useQueryGraphStep
|
||||
|
||||
#### Type Parameters
|
||||
|
||||
<TypeList types={[{"name":"TEntry","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="useQueryGraphStep"/>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"[EntryStepInput](../../core_flows/interfaces/core_flows.EntryStepInput/page.mdx)<TEntry>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"The fields to retrieve in the records.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entry_point","type":"`string`","description":"The name of the data model to retrieve its records.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variables","type":"`Record<string, any>`","description":"Filters, context variables, or pagination fields to apply when retrieving the records.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throw_if_key_not_found","type":"`boolean`","description":"Throw an error if a record isn't found matching an ID specified in the filters.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throw_if_relation_not_found","type":"`boolean` \\| `string`[]","description":"Throw an error if a specified relation isn't found.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"`boolean`","description":"Whether to retrieve the records as an array. If disabled, only one record is retrieved as an object.","optional":true,"defaultValue":"true","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="useQueryGraphStep"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"data","type":"TEntry extends `never` ? [RemoteQueryEntryPoints](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)[TEntry<TEntry>][] : `any`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<TEntry extends never ? [RemoteQueryEntryPoints](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)[TEntry<TEntry>][] : any[]>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"GraphResultSet","type":"[GraphResultSet](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.GraphResultSet/page.mdx)<TEntry>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TEntry","type":"TEntry","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]},{"name":"WorkflowDataProperties","type":"[WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[GraphResultSet](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.GraphResultSet/page.mdx)<TEntry>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"GraphResultSet","type":"[GraphResultSet](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.GraphResultSet/page.mdx)<TEntry>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]},{"name":"config","type":"(`config`: ``{ name?: string }`` & Omit<TransactionStepsDefinition, \"next\" \\| \"uuid\" \\| \"action\">) => [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[GraphResultSet](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.GraphResultSet/page.mdx)<TEntry>>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"StepFunctionReturnConfig","type":"[StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[GraphResultSet](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.GraphResultSet/page.mdx)<TEntry>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"GraphResultSet","type":"[GraphResultSet](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.GraphResultSet/page.mdx)<TEntry>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]},{"name":"metadata","type":"[RemoteQueryFunctionReturnPagination](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunctionReturnPagination/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<undefined \\| [RemoteQueryFunctionReturnPagination](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunctionReturnPagination/page.mdx)>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"skip","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="useQueryGraphStep"/>
|
||||
|
||||
### useRemoteQueryStep
|
||||
|
||||
This step fetches data across modules using the remote query.
|
||||
@@ -4182,7 +4214,7 @@ This workflow manages one or more links to create, update, or dismiss them.
|
||||
|
||||
#### Output
|
||||
|
||||
<TypeList types={[{"name":"created","type":"([LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)>)[] & [LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]> & `object` & StepFunctionReturnConfig<[LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated","type":"([LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)>)[] & [LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]> & `object` & StepFunctionReturnConfig<[LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted","type":"([LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)>)[] & [LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]> & `object` & StepFunctionReturnConfig<[LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchLinksWorkflow"/>
|
||||
<TypeList types={[{"name":"created","type":"([LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)>)[] & [LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated","type":"([LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)>)[] & [LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted","type":"([LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)>)[] & [LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[] & [WorkflowDataProperties](../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<[LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]> & `object` & [StepFunctionReturnConfig](../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)<[LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchLinksWorkflow"/>
|
||||
|
||||
### createLinksWorkflow
|
||||
|
||||
@@ -4431,7 +4463,7 @@ This workflow creates one or more customer address.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { createCustomerAddressesWorkflow } from "@medusajs/core-flows"
|
||||
import { createCustomerAddressesWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
createCustomerAddressesWorkflow.hooks.addressesCreated(
|
||||
(async ({ addresses, additional_data }, { container }) => {
|
||||
@@ -4485,7 +4517,7 @@ This workflow creates one or more customers.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { createCustomersWorkflow } from "@medusajs/core-flows"
|
||||
import { createCustomersWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
createCustomersWorkflow.hooks.customersCreated(
|
||||
(async ({ customers, additional_data }, { container }) => {
|
||||
@@ -4519,7 +4551,7 @@ This workflow deletes one or more customer addresses.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { deleteCustomerAddressesWorkflow } from "@medusajs/core-flows"
|
||||
import { deleteCustomerAddressesWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
deleteCustomerAddressesWorkflow.hooks.addressesDeleted(
|
||||
(async ({ ids }, { container }) => {
|
||||
@@ -4553,7 +4585,7 @@ This workflow deletes one or more customers.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { deleteCustomersWorkflow } from "@medusajs/core-flows"
|
||||
import { deleteCustomersWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
deleteCustomersWorkflow.hooks.customersDeleted(
|
||||
(async ({ ids }, { container }) => {
|
||||
@@ -4607,7 +4639,7 @@ This workflow updates one or more customer addresses.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { updateCustomerAddressesWorkflow } from "@medusajs/core-flows"
|
||||
import { updateCustomerAddressesWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
updateCustomerAddressesWorkflow.hooks.addressesUpdated(
|
||||
(async ({ addresses, additional_data }, { container }) => {
|
||||
@@ -4645,7 +4677,7 @@ This workflow updates one or more customers.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { updateCustomersWorkflow } from "@medusajs/core-flows"
|
||||
import { updateCustomersWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
updateCustomersWorkflow.hooks.customersUpdated(
|
||||
(async ({ customers, additional_data }, { container }) => {
|
||||
@@ -5507,7 +5539,7 @@ matching the specified filters.
|
||||
|
||||
#### Input
|
||||
|
||||
<TypeList types={[{"name":"ListLineItemsStepInput","type":"[ListLineItemsStepInput](../../core_flows/interfaces/core_flows.ListLineItemsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"filters","type":"[FilterableLineItemProps](../../cart/interfaces/cart.FilterableLineItemProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"Filter the line items by their title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableLineItemProps](../../cart/interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../cart/interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../cart/interfaces/cart.FilterableLineItemProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"Filter the line items by their title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableLineItemProps](../../cart/interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../cart/interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../cart/interfaces/cart.FilterableLineItemProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableLineItemProps](../../cart/interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../cart/interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../cart/interfaces/cart.FilterableLineItemProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../cart/interfaces/cart.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../cart/interfaces/cart.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableLineItemProps](../../cart/interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../cart/interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../cart/interfaces/cart.FilterableLineItemProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]Line truncated
|
||||
<TypeList types={[{"name":"ListLineItemsStepInput","type":"[ListLineItemsStepInput](../../core_flows/interfaces/core_flows.ListLineItemsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"filters","type":"[FilterableLineItemProps](../../cart/interfaces/cart.FilterableLineItemProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"Filter the line items by their title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableLineItemProps](../../cart/interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../cart/interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../cart/interfaces/cart.FilterableLineItemProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"Filter the line items by their title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string` \\| `string`[]","description":"Filter the line items by the ID of their associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableLineItemProps](../../cart/interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../cart/interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../cart/interfaces/cart.FilterableLineItemProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableLineItemProps](../../cart/interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../cart/interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../cart/interfaces/cart.FilterableLineItemProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../cart/interfaces/cart.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../cart/interfaces/cart.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableLineItemProps](../../cart/interfaces/cart.FilterableLineItemProps/page.mdx) \\| [BaseFilterable](../../cart/interfaces/cart.BaseFilterable/page.mdx)<[FilterableLineItemProps](../../cart/interfaces/cart.FilterableLineItemProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the line items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string` \\| `string`[]Line truncated
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -6008,7 +6040,7 @@ This workflow cancels an order's fulfillment.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { cancelOrderFulfillmentWorkflow } from "@medusajs/core-flows"
|
||||
import { cancelOrderFulfillmentWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
cancelOrderFulfillmentWorkflow.hooks.orderFulfillmentCanceled(
|
||||
(async ({ fulfillment, additional_data }, { container }) => {
|
||||
@@ -6054,7 +6086,7 @@ This workflow cancels an order.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { cancelOrderWorkflow } from "@medusajs/core-flows"
|
||||
import { cancelOrderWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
cancelOrderWorkflow.hooks.orderCanceled(
|
||||
(async ({ order }, { container }) => {
|
||||
@@ -6421,7 +6453,7 @@ This workflow completes one or more orders.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { completeOrderWorkflow } from "@medusajs/core-flows"
|
||||
import { completeOrderWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
completeOrderWorkflow.hooks.ordersCompleted(
|
||||
(async ({ orders, additional_data }, { container }) => {
|
||||
@@ -6467,7 +6499,7 @@ This creates a fulfillment for an order.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { createOrderFulfillmentWorkflow } from "@medusajs/core-flows"
|
||||
import { createOrderFulfillmentWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
createOrderFulfillmentWorkflow.hooks.fulfillmentCreated(
|
||||
(async ({ fulfillment, additional_data }, { container }) => {
|
||||
@@ -6549,7 +6581,7 @@ This workflow creates an order.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { createOrdersWorkflow } from "@medusajs/core-flows"
|
||||
import { createOrdersWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
createOrdersWorkflow.hooks.orderCreated(
|
||||
(async ({ order, additional_data }, { container }) => {
|
||||
@@ -6595,7 +6627,7 @@ This workflow creates a shipment for an order.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { createOrderShipmentWorkflow } from "@medusajs/core-flows"
|
||||
import { createOrderShipmentWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
createOrderShipmentWorkflow.hooks.shipmentCreated(
|
||||
(async ({ shipment, additional_data }, { container }) => {
|
||||
@@ -7060,7 +7092,7 @@ This workflow confirms an order edit request.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"confirmOrderEditRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"confirmOrderEditRequestValidationStep","description":"This step validates that a requested order edit can be confirmed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#confirmordereditrequestvalidationstep","depth":3},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":5},{"type":"step","name":"reserveInventoryStep","description":"This step reserves the quantity of line items from the associated\nvariant's inventory.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#reserveinventorystep","depth":6}]}} />
|
||||
<undefined workflow={{"name":"confirmOrderEditRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"confirmOrderEditRequestValidationStep","description":"This step validates that a requested order edit can be confirmed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#confirmordereditrequestvalidationstep","depth":3},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":5},{"type":"step","name":"deleteReservationsByLineItemsStep","description":"This step deletes reservations by their associated line items.","link":"../../core_flows/core_flows.Steps_Reservation/page.mdx#deletereservationsbylineitemsstep","depth":6},{"type":"step","name":"reserveInventoryStep","description":"This step reserves the quantity of line items from the associated\nvariant's inventory.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#reserveinventorystep","depth":7}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7997,6 +8029,26 @@ This workflow captures a payment.
|
||||
|
||||
<TypeList types={[{"name":"PaymentDTO","type":"[PaymentDTO](../../payment/interfaces/payment.PaymentDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../payment/types/payment.BigNumberValue/page.mdx)","description":"The payment's total amount.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../payment/types/payment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"currency_code","type":"`string`","description":"The ISO 3 character currency code of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the associated payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the associated payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberValue](../../payment/types/payment.BigNumberValue/page.mdx)","description":"The raw amount of the payment.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../payment/types/payment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"authorized_amount","type":"[BigNumberValue](../../payment/types/payment.BigNumberValue/page.mdx)","description":"The authorized amount of the payment.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../payment/types/payment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_authorized_amount","type":"[BigNumberValue](../../payment/types/payment.BigNumberValue/page.mdx)","description":"The raw authorized amount of the payment.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../payment/types/payment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart_id","type":"`string`","description":"The ID of the associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit_id","type":"`string`","description":"The ID of the associated order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the associated customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data relevant for the payment provider to process the payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the payment was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"naLine truncated
|
||||
|
||||
### onPaymentProcessedWorkflow
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"onPaymentProcessedWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"when","condition":"{\n return !!cartPaymentCollection.data.length\n }","depth":"2","steps":[{"type":"workflow","name":"completeCartWorkflow","description":"This workflow completes a cart.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#completecartworkflow","depth":2}]}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
<TypeList types={[{"name":"WebhookActionResult","type":"[WebhookActionResult](../../payment/interfaces/payment.WebhookActionResult/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"action","type":"[PaymentActions](../../payment/types/payment.PaymentActions/page.mdx)","description":"Normalized events from payment provider to internal payment module events.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"[WebhookActionData](../../payment/interfaces/payment.WebhookActionData/page.mdx)","description":"The webhook action's details.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"session_id","type":"`string`","description":"The associated payment session's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../payment/types/payment.BigNumberValue/page.mdx)","description":"The amount to be captured or authorized (based on the action's type.)","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../payment/types/payment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="onPaymentProcessedWorkflow"/>
|
||||
|
||||
### processPaymentWorkflow
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"processPaymentWorkflow","steps":[{"type":"when","condition":"{\n return (\n input.action === PaymentActions.SUCCESSFUL && !!paymentData.data.length\n )\n }","depth":"1","steps":[{"type":"workflow","name":"capturePaymentWorkflow","description":"This workflow captures a payment.","link":"../../core_flows/core_flows.Workflows_Payment/page.mdx#capturepaymentworkflow","depth":1}]},{"type":"when","condition":"{\n return (\n input.action === PaymentActions.AUTHORIZED && !!input.data?.session_id\n )\n }","depth":"2","steps":[{"type":"step","name":"authorizePaymentSessionStep","description":"This step authorizes a payment session.","link":"../../core_flows/core_flows.Steps_Payment/page.mdx#authorizepaymentsessionstep","depth":2}]}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
<TypeList types={[{"name":"ProcessPaymentWorkflowInput","type":"`ProcessPaymentWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="processPaymentWorkflow"/>
|
||||
|
||||
### validateRefundStep
|
||||
|
||||
This step validates that the refund is valid for the order
|
||||
@@ -8760,7 +8812,7 @@ This workflow creates one or more collections.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { createCollectionsWorkflow } from "@medusajs/core-flows"
|
||||
import { createCollectionsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
createCollectionsWorkflow.hooks.collectionsCreated(
|
||||
(async ({ collections, additional_data }, { container }) => {
|
||||
@@ -8798,7 +8850,7 @@ This workflow creates one or more product options.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { createProductOptionsWorkflow } from "@medusajs/core-flows"
|
||||
import { createProductOptionsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
createProductOptionsWorkflow.hooks.productOptionsCreated(
|
||||
(async ({ product_options, additional_data }, { container }) => {
|
||||
@@ -8836,7 +8888,7 @@ This workflow creates one or more product tags.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { createProductTagsWorkflow } from "@medusajs/core-flows"
|
||||
import { createProductTagsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
createProductTagsWorkflow.hooks.productTagsCreated(
|
||||
(async ({ product_tags, additional_data }, { container }) => {
|
||||
@@ -8874,7 +8926,7 @@ This workflow creates one or more product types.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { createProductTypesWorkflow } from "@medusajs/core-flows"
|
||||
import { createProductTypesWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
createProductTypesWorkflow.hooks.productTypesCreated(
|
||||
(async ({ product_types, additional_data }, { container }) => {
|
||||
@@ -8912,7 +8964,7 @@ This workflow creates one or more product variants.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { createProductVariantsWorkflow } from "@medusajs/core-flows"
|
||||
import { createProductVariantsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
createProductVariantsWorkflow.hooks.productVariantsCreated(
|
||||
(async ({ product_variants, additional_data }, { container }) => {
|
||||
@@ -8950,7 +9002,7 @@ This workflow creates one or more products.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { createProductsWorkflow } from "@medusajs/core-flows"
|
||||
import { createProductsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
createProductsWorkflow.hooks.productsCreated(
|
||||
(async ({ products, additional_data }, { container }) => {
|
||||
@@ -8984,7 +9036,7 @@ This workflow deletes one or more collection.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { deleteCollectionsWorkflow } from "@medusajs/core-flows"
|
||||
import { deleteCollectionsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
deleteCollectionsWorkflow.hooks.collectionsDeleted(
|
||||
(async ({ ids }, { container }) => {
|
||||
@@ -9018,7 +9070,7 @@ This workflow deletes one or more product options.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { deleteProductOptionsWorkflow } from "@medusajs/core-flows"
|
||||
import { deleteProductOptionsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
deleteProductOptionsWorkflow.hooks.productOptionsDeleted(
|
||||
(async ({ ids }, { container }) => {
|
||||
@@ -9052,7 +9104,7 @@ This workflow deletes one or more product tags.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { deleteProductTagsWorkflow } from "@medusajs/core-flows"
|
||||
import { deleteProductTagsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
deleteProductTagsWorkflow.hooks.productTagsDeleted(
|
||||
(async ({ ids }, { container }) => {
|
||||
@@ -9086,7 +9138,7 @@ This workflow deletes one or more product types.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { deleteProductTypesWorkflow } from "@medusajs/core-flows"
|
||||
import { deleteProductTypesWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
deleteProductTypesWorkflow.hooks.productTypesDeleted(
|
||||
(async ({ ids }, { container }) => {
|
||||
@@ -9120,7 +9172,7 @@ This workflow deletes one or more product variants.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { deleteProductVariantsWorkflow } from "@medusajs/core-flows"
|
||||
import { deleteProductVariantsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
deleteProductVariantsWorkflow.hooks.productVariantsDeleted(
|
||||
(async ({ ids }, { container }) => {
|
||||
@@ -9154,7 +9206,7 @@ This workflow deletes one or more products.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { deleteProductsWorkflow } from "@medusajs/core-flows"
|
||||
import { deleteProductsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
deleteProductsWorkflow.hooks.productsDeleted(
|
||||
(async ({ ids }, { container }) => {
|
||||
@@ -9220,7 +9272,7 @@ This workflow updates collections matching the specified filters.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { updateCollectionsWorkflow } from "@medusajs/core-flows"
|
||||
import { updateCollectionsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
updateCollectionsWorkflow.hooks.collectionsUpdated(
|
||||
(async ({ additional_data, collections }, { container }) => {
|
||||
@@ -9258,7 +9310,7 @@ This workflow updates product options matching the specified filters.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { updateProductOptionsWorkflow } from "@medusajs/core-flows"
|
||||
import { updateProductOptionsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
updateProductOptionsWorkflow.hooks.productOptionsUpdated(
|
||||
(async ({ product_options, additional_data }, { container }) => {
|
||||
@@ -9296,7 +9348,7 @@ This workflow updates product tags matching the specified filters.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { updateProductTagsWorkflow } from "@medusajs/core-flows"
|
||||
import { updateProductTagsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
updateProductTagsWorkflow.hooks.productTagsUpdated(
|
||||
(async ({ product_tags, additional_data }, { container }) => {
|
||||
@@ -9334,7 +9386,7 @@ This workflow updates product types matching the specified filters.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { updateProductTypesWorkflow } from "@medusajs/core-flows"
|
||||
import { updateProductTypesWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
updateProductTypesWorkflow.hooks.productTypesUpdated(
|
||||
(async ({ product_types, additional_data }, { container }) => {
|
||||
@@ -9372,7 +9424,7 @@ This workflow updates one or more product variants.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { updateProductVariantsWorkflow } from "@medusajs/core-flows"
|
||||
import { updateProductVariantsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
updateProductVariantsWorkflow.hooks.productVariantsUpdated(
|
||||
(async ({ product_variants, additional_data }, { container }) => {
|
||||
@@ -9410,7 +9462,7 @@ This workflow updates one or more products.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { updateProductsWorkflow } from "@medusajs/core-flows"
|
||||
import { updateProductsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
updateProductsWorkflow.hooks.productsUpdated(
|
||||
(async ({ products, additional_data }, { container }) => {
|
||||
@@ -9600,7 +9652,7 @@ This workflow creates one or more campaigns.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { createCampaignsWorkflow } from "@medusajs/core-flows"
|
||||
import { createCampaignsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
createCampaignsWorkflow.hooks.campaignsCreated(
|
||||
(async ({ campaigns, additional_data }, { container }) => {
|
||||
@@ -9654,7 +9706,7 @@ This workflow creates one or more promotions.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { createPromotionsWorkflow } from "@medusajs/core-flows"
|
||||
import { createPromotionsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
createPromotionsWorkflow.hooks.promotionsCreated(
|
||||
(async ({ promotions, additional_data }, { container }) => {
|
||||
@@ -9688,7 +9740,7 @@ This workflow deletes one or more campaigns.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { deleteCampaignsWorkflow } from "@medusajs/core-flows"
|
||||
import { deleteCampaignsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
deleteCampaignsWorkflow.hooks.campaignsDeleted(
|
||||
(async ({ ids }, { container }) => {
|
||||
@@ -9734,7 +9786,7 @@ This workflow deletes one or more promotions.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { deletePromotionsWorkflow } from "@medusajs/core-flows"
|
||||
import { deletePromotionsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
deletePromotionsWorkflow.hooks.promotionsDeleted(
|
||||
(async ({ ids }, { container }) => {
|
||||
@@ -9772,7 +9824,7 @@ This workflow updates one or more campaigns.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { updateCampaignsWorkflow } from "@medusajs/core-flows"
|
||||
import { updateCampaignsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
updateCampaignsWorkflow.hooks.campaignsUpdated(
|
||||
(async ({ campaigns, additional_data }, { container }) => {
|
||||
@@ -9826,7 +9878,7 @@ This workflow updates one or more promotions.
|
||||
###### Example
|
||||
|
||||
```ts
|
||||
import { updatePromotionsWorkflow } from "@medusajs/core-flows"
|
||||
import { updatePromotionsWorkflow } from "@medusajs/medusa/core-flows"
|
||||
|
||||
updatePromotionsWorkflow.hooks.promotionsUpdated(
|
||||
(async ({ promotions, additional_data }, { container }) => {
|
||||
@@ -10239,7 +10291,7 @@ This step retrieves shipping options that can be used in the specified context.
|
||||
|
||||
#### Input
|
||||
|
||||
<TypeList types={[{"name":"ListShippingOptionsForContextStepInput","type":"[ListShippingOptionsForContextStepInput](../../core_flows/interfaces/core_flows.ListShippingOptionsForContextStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"context","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../types/CommonTypes/interfaces/types.CommonTypes.FindConfig/page.mdx)<[ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listShippingOptionsForContextStep"/>
|
||||
<TypeList types={[{"name":"ListShippingOptionsForContextStepInput","type":"[ListShippingOptionsForContextStepInput](../../core_flows/interfaces/core_flows.ListShippingOptionsForContextStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"context","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../types/CommonTypes/interfaces/types.CommonTypes.FindConfig/page.mdx)<[ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`Record<string, \"ASC\" \\| \"DESC\" \\| string & object>`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listShippingOptionsForContextStep"/>
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
@@ -15,4 +15,5 @@ This section of the documentation provides a reference to utility steps that you
|
||||
- [emitEventStep](../../helper_steps/functions/helper_steps.emitEventStep/page.mdx)
|
||||
- [removeRemoteLinkStep](../../helper_steps/functions/helper_steps.removeRemoteLinkStep/page.mdx)
|
||||
- [updateRemoteLinksStep](../../helper_steps/functions/helper_steps.updateRemoteLinksStep/page.mdx)
|
||||
- [useQueryGraphStep](../../helper_steps/functions/helper_steps.useQueryGraphStep/page.mdx)
|
||||
- [useRemoteQueryStep](../../helper_steps/functions/helper_steps.useRemoteQueryStep/page.mdx)
|
||||
@@ -32,7 +32,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Variables
|
||||
|
||||
- [MODULE\_PACKAGE\_NAMES](page.mdx#module_package_names)
|
||||
- [ModulesDefinition](page.mdx#modulesdefinition)
|
||||
- [MODULE\_DEFINITIONS](page.mdx#module_definitions)
|
||||
- [MedusaModule](page.mdx#medusamodule)
|
||||
@@ -58,14 +57,6 @@ ___
|
||||
|
||||
## Variables
|
||||
|
||||
### MODULE\_PACKAGE\_NAMES
|
||||
|
||||
`Const` **MODULE\_PACKAGE\_NAMES**: `Object`
|
||||
|
||||
#### Properties
|
||||
|
||||
<TypeList types={[{"name":"Auth","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/auth\"","expandable":false,"children":[]},{"name":"Cache","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/cache-inmemory\"","expandable":false,"children":[]},{"name":"Cart","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/cart\"","expandable":false,"children":[]},{"name":"Customer","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/customer\"","expandable":false,"children":[]},{"name":"EventBus","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/event-bus-local\"","expandable":false,"children":[]},{"name":"Inventory","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/inventory-next\"","expandable":false,"children":[]},{"name":"LinkModules","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/link-modules\"","expandable":false,"children":[]},{"name":"Payment","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/payment\"","expandable":false,"children":[]},{"name":"Pricing","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/pricing\"","expandable":false,"children":[]},{"name":"Product","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/product\"","expandable":false,"children":[]},{"name":"Promotion","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/promotion\"","expandable":false,"children":[]},{"name":"SalesChannel","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/sales-channel\"","expandable":false,"children":[]},{"name":"Fulfillment","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/fulfillment\"","expandable":false,"children":[]},{"name":"StockLocation","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/stock-location-next\"","expandable":false,"children":[]},{"name":"Tax","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/tax\"","expandable":false,"children":[]},{"name":"User","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/user\"","expandable":false,"children":[]},{"name":"Workflows","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/workflow-engine-inmemory\"","expandable":false,"children":[]},{"name":"Region","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/region\"","expandable":false,"children":[]},{"name":"Order","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/order\"","expandable":false,"children":[]},{"name":"ApiKey","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/api-key\"","expandable":false,"children":[]},{"name":"Store","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/store\"","expandable":false,"children":[]},{"name":"Currency","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/currency\"","expandable":false,"children":[]},{"name":"File","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/file\"","expandable":false,"children":[]},{"name":"Notification","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/notification\"","expandable":false,"children":[]},{"name":"Index","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/index-module\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="MODULE_PACKAGE_NAMES"/>
|
||||
|
||||
### ModulesDefinition
|
||||
|
||||
`Const` **ModulesDefinition**: `object`
|
||||
@@ -96,7 +87,7 @@ ___
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"registerAdd","type":"`<T>`(`name`: `string`, `registration`: T) => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"createScope","type":"() => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"providers","type":"[ModuleProvider](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProvider/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"resolve","type":"`string` \\| [ModuleProviderExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProviderExports/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"registerServiceFn","type":"(`klass`: `any`, `container`: [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx), `moduleDetails`: `any`) => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="moduleProviderLoader"/>
|
||||
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"registerAdd","type":"`<T>`(`name`: `string`, `registration`: T) => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"createScope","type":"() => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"providers","type":"[ModuleProvider](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProvider/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"resolve","type":"`string` \\| [ModuleProviderExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProviderExports/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"registerServiceFn","type":"(`klass`: `any`, `container`: [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx), `moduleDetails`: `any`) => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="moduleProviderLoader"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -106,7 +97,7 @@ ___
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"registerAdd","type":"`<T>`(`name`: `string`, `registration`: T) => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"createScope","type":"() => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"provider","type":"[ModuleProvider](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProvider/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"resolve","type":"`string` \\| [ModuleProviderExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProviderExports/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"services","type":"[Constructor](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor/page.mdx)<any>[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"registerServiceFn","type":"(`klass`: `any`, `container`: `any`, `moduleDetails`: `any`) => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="loadModuleProvider"/>
|
||||
<TypeList types={[{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"registerAdd","type":"`<T>`(`name`: `string`, `registration`: T) => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"createScope","type":"() => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"provider","type":"[ModuleProvider](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProvider/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"resolve","type":"`string` \\| [ModuleProviderExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProviderExports/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"services","type":"[Constructor](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor/page.mdx)<any>[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"registerServiceFn","type":"(`klass`: `any`, `container`: `any`, `moduleDetails`: `any`) => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="loadModuleProvider"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
|
||||
@@ -58,6 +58,7 @@ import { TypeList } from "docs-ui"
|
||||
- [UpdateOrderDTO](../../order/interfaces/order.UpdateOrderDTO/page.mdx)
|
||||
- [CreateOrderAdjustmentDTO](../../order/interfaces/order.CreateOrderAdjustmentDTO/page.mdx)
|
||||
- [UpdateOrderAdjustmentDTO](../../order/interfaces/order.UpdateOrderAdjustmentDTO/page.mdx)
|
||||
- [CreateOrderLineItemAdjustmentDTO](../../order/interfaces/order.CreateOrderLineItemAdjustmentDTO/page.mdx)
|
||||
- [UpsertOrderLineItemAdjustmentDTO](../../order/interfaces/order.UpsertOrderLineItemAdjustmentDTO/page.mdx)
|
||||
- [CreateOrderTaxLineDTO](../../order/interfaces/order.CreateOrderTaxLineDTO/page.mdx)
|
||||
- [UpdateOrderTaxLineDTO](../../order/interfaces/order.UpdateOrderTaxLineDTO/page.mdx)
|
||||
|
||||
@@ -39,6 +39,8 @@ import { TypeList } from "docs-ui"
|
||||
- [CreateRefundReasonDTO](../../payment/interfaces/payment.CreateRefundReasonDTO/page.mdx)
|
||||
- [UpdateRefundReasonDTO](../../payment/interfaces/payment.UpdateRefundReasonDTO/page.mdx)
|
||||
- [PaymentProviderContext](../../payment/interfaces/payment.PaymentProviderContext/page.mdx)
|
||||
- [WebhookActionData](../../payment/interfaces/payment.WebhookActionData/page.mdx)
|
||||
- [WebhookActionResult](../../payment/interfaces/payment.WebhookActionResult/page.mdx)
|
||||
- [IPaymentModuleService](../../payment/interfaces/payment.IPaymentModuleService/page.mdx)
|
||||
- [PaymentModuleOptions](../../payment/interfaces/payment.PaymentModuleOptions/page.mdx)
|
||||
- [MessageAggregatorFormat](../../payment/interfaces/payment.MessageAggregatorFormat/page.mdx)
|
||||
@@ -69,6 +71,7 @@ import { TypeList } from "docs-ui"
|
||||
- [ModuleJoinerRelationship](../../payment/types/payment.ModuleJoinerRelationship/page.mdx)
|
||||
- [PaymentCollectionStatus](../../payment/types/payment.PaymentCollectionStatus/page.mdx)
|
||||
- [PaymentSessionStatus](../../payment/types/payment.PaymentSessionStatus/page.mdx)
|
||||
- [PaymentActions](../../payment/types/payment.PaymentActions/page.mdx)
|
||||
- [BigNumberRawValue](../../payment/types/payment.BigNumberRawValue/page.mdx)
|
||||
- [BigNumberInput](../../payment/types/payment.BigNumberInput/page.mdx)
|
||||
- [BigNumberValue](../../payment/types/payment.BigNumberValue/page.mdx)
|
||||
@@ -105,6 +105,8 @@ import { TypeList } from "docs-ui"
|
||||
- [RemoteExpandProperty](../../types/interfaces/types.RemoteExpandProperty/page.mdx)
|
||||
- [ILinkMigrationsPlanner](../../types/interfaces/types.ILinkMigrationsPlanner/page.mdx)
|
||||
- [ILinkModule](../../types/interfaces/types.ILinkModule/page.mdx)
|
||||
- [ILockingProvider](../../types/interfaces/types.ILockingProvider/page.mdx)
|
||||
- [ILockingModule](../../types/interfaces/types.ILockingModule/page.mdx)
|
||||
- [FixtureEntryPoints](../../types/interfaces/types.FixtureEntryPoints-1/page.mdx)
|
||||
- [OrderWorkflowDTO](../../types/interfaces/types.OrderWorkflowDTO/page.mdx)
|
||||
- [CreatePriceListPriceWorkflowDTO](../../types/interfaces/types.CreatePriceListPriceWorkflowDTO/page.mdx)
|
||||
@@ -168,6 +170,7 @@ import { TypeList } from "docs-ui"
|
||||
- [Product](../../types/types/types.Product/page.mdx)
|
||||
- [ProductVariant](../../types/types/types.ProductVariant/page.mdx)
|
||||
- [Price](../../types/types/types.Price/page.mdx)
|
||||
- [IndexOperatorMap](../../types/types/types.IndexOperatorMap/page.mdx)
|
||||
- [ExcludedProps](../../types/types/types.ExcludedProps/page.mdx)
|
||||
- [Depth](../../types/types/types.Depth/page.mdx)
|
||||
- [CleanupObject](../../types/types/types.CleanupObject/page.mdx)
|
||||
|
||||
Reference in new issue
Block a user