docs: [9/n] generate core-flows reference (#8790)
This commit is contained in:
1 parent
587984de6e
commit
842c26cb46
71 files changed
+1287
No files matched your search
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/createPriceListPricesStep
|
||||
sidebar_label: createPriceListPricesStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createPriceListPricesStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createPriceListPricesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step creates prices for a price list.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreatePriceListPricesWorkflowStepDTO","type":"`CreatePriceListPricesWorkflowStepDTO`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPriceListPricesStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"PriceDTO[]","type":"[PriceDTO](../../../../../pricing/interfaces/pricing.PriceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PriceDTO","type":"[PriceDTO](../../../../../pricing/interfaces/pricing.PriceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this price.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"min_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"max_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_set","type":"[PriceSetDTO](../../../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)","description":"The price set associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmountDTO](../../../../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)[]","description":"The prices that belong to this price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_price","type":"[CalculatedPriceSet](../../../../../pricing/interfaces/pricing.CalculatedPriceSet/page.mdx)","description":"The calculated price based on the context.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_list","type":"[PriceListDTO](../../../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","description":"The price list associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starLine truncated
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/createPriceListsStep
|
||||
sidebar_label: createPriceListsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createPriceListsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createPriceListsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step creates a price list.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreatePriceListsWorkflowStepDTO","type":"`CreatePriceListsWorkflowStepDTO`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPriceListsStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"PriceListDTO[]","type":"[PriceListDTO](../../../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PriceListDTO","type":"[PriceListDTO](../../../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price list's details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../../../pricing/types/pricing.PriceListType/page.mdx)","description":"The price list's type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules associated with this price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[PriceDTO](../../../../../pricing/interfaces/pricing.PriceDTO/page.mdx)[]","description":"The associated price list money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of a price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"[PriceSetDTO](../../../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)","description":"The price set associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list","type":"[PriceListDTO](../../../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","description":"The price list associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the associated price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_rules","type":"[PriceRuleDTO](../../../../../pricing/interfaces/pricing.PriceRuleDTO/page.mdx)[]","description":"The price rules associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"money_amounts","type":"[MoneyAmountDTO](../../../../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)[]","description":"The associated money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When theLine truncated
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/deletePriceListsStep
|
||||
sidebar_label: deletePriceListsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deletePriceListsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deletePriceListsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step deletes one or more price lists.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deletePriceListsStep"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/getExistingPriceListsPriceIdsStep
|
||||
sidebar_label: getExistingPriceListsPriceIdsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# getExistingPriceListsPriceIdsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `getExistingPriceListsPriceIdsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step retrieves prices of price lists.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"price_list_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="getExistingPriceListsPriceIdsStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"Record","type":"`Record<string, string[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getExistingPriceListsPriceIdsStep"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/removePriceListPricesStep
|
||||
sidebar_label: removePriceListPricesStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# removePriceListPricesStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `removePriceListPricesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step removes prices from a price list.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removePriceListPricesStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removePriceListPricesStep"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/updatePriceListPricesStep
|
||||
sidebar_label: updatePriceListPricesStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updatePriceListPricesStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `updatePriceListPricesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step updates a price list's prices.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdatePriceListPriceWorkflowStepDTO","type":"`UpdatePriceListPriceWorkflowStepDTO`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePriceListPricesStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"PriceDTO[]","type":"[PriceDTO](../../../../../pricing/interfaces/pricing.PriceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PriceDTO","type":"[PriceDTO](../../../../../pricing/interfaces/pricing.PriceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this price.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"min_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"max_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_set","type":"[PriceSetDTO](../../../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)","description":"The price set associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmountDTO](../../../../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)[]","description":"The prices that belong to this price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_price","type":"[CalculatedPriceSet](../../../../../pricing/interfaces/pricing.CalculatedPriceSet/page.mdx)","description":"The calculated price based on the context.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_list","type":"[PriceListDTO](../../../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","description":"The price list associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starLine truncated
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/updatePriceListsStep
|
||||
sidebar_label: updatePriceListsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updatePriceListsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `updatePriceListsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step updates one or more price lists.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdatePriceListDTO[]","type":"[UpdatePriceListDTO](../../../../../pricing/interfaces/pricing.UpdatePriceListDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdatePriceListDTO","type":"[UpdatePriceListDTO](../../../../../pricing/interfaces/pricing.UpdatePriceListDTO/page.mdx)","optional":false,"defaultValue":"","description":"The attributes to update in a price list.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the price list to update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The price list's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceListRules](../../../../../pricing/interfaces/pricing.CreatePriceListRules/page.mdx)","description":"The rules to be created and associated with the price list.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePriceListsStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"PriceListDTO[]","type":"[PriceListDTO](../../../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PriceListDTO","type":"[PriceListDTO](../../../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price list's details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../../../pricing/types/pricing.PriceListType/page.mdx)","description":"The price list's type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules associated with this price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[PriceDTO](../../../../../pricing/interfaces/pricing.PriceDTO/page.mdx)[]","description":"The associated price list money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of a price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"[PriceSetDTO](../../../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)","description":"The price set associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list","type":"[PriceListDTO](../../../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","description":"The price list associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the associated price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_rules","type":"[PriceRuleDTO](../../../../../pricing/interfaces/pricing.PriceRuleDTO/page.mdx)[]","description":"The price rules associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"money_amounts","type":"[MoneyAmountDTO](../../../../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)[]","description":"The associated money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When theLine truncated
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/validatePriceListsStep
|
||||
sidebar_label: validatePriceListsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# validatePriceListsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `validatePriceListsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step validates that the specified price lists exist.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"Pick<UpdatePriceListDTO, \"id\">[]","type":"Pick<[UpdatePriceListDTO](../../../../../pricing/interfaces/pricing.UpdatePriceListDTO/page.mdx), \"id\">[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Pick","type":"Pick<[UpdatePriceListDTO](../../../../../pricing/interfaces/pricing.UpdatePriceListDTO/page.mdx), \"id\">","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdatePriceListDTO","type":"`object`","description":"The attributes to update in a price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"\"id\"","type":"`\"id\"`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validatePriceListsStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"Record","type":"`Record<string, [PriceListDTO](../../../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"PriceListDTO","type":"[PriceListDTO](../../../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price list's details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../../../pricing/types/pricing.PriceListType/page.mdx)","description":"The price list's type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules associated with this price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[PriceDTO](../../../../../pricing/interfaces/pricing.PriceDTO/page.mdx)[]","description":"The associated price list money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of a price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"[PriceSetDTO](../../../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)","description":"The price set associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list","type":"[PriceListDTO](../../../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","description":"The price list associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the associated price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_rules","type":"[PriceRuleDTO](../../../../../pricing/interfaces/pricing.PriceRuleDTO/page.mdx)[]","description":"The price rules associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"money_amounts","type":"[MoneyAmountDTO](../../../../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)[]","description":"The associated money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the money amount.",Line truncated
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/validateVariantPriceLinksStep
|
||||
sidebar_label: validateVariantPriceLinksStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# validateVariantPriceLinksStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `validateVariantPriceLinksStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step validates that the specified variants have prices.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"object[]","type":"`object`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"prices","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"variant_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="validateVariantPriceLinksStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"Record","type":"`Record<string, string>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validateVariantPriceLinksStep"/>
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createPriceListPricesStepId
|
||||
|
||||
`Const` **createPriceListPricesStepId**: `"create-price-list-prices"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createPriceListsStepId
|
||||
|
||||
`Const` **createPriceListsStepId**: `"create-price-lists"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deletePriceListsStepId
|
||||
|
||||
`Const` **deletePriceListsStepId**: `"delete-price-lists"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# getExistingPriceListsPriceIdsStepId
|
||||
|
||||
`Const` **getExistingPriceListsPriceIdsStepId**: `"get-existing-price-lists-prices"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# removePriceListPricesStepId
|
||||
|
||||
`Const` **removePriceListPricesStepId**: `"remove-price-list-prices"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updatePriceListPricesStepId
|
||||
|
||||
`Const` **updatePriceListPricesStepId**: `"update-price-list-prices"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updatePriceListsStepId
|
||||
|
||||
`Const` **updatePriceListsStepId**: `"update-price-lists"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# validatePriceListsStepId
|
||||
|
||||
`Const` **validatePriceListsStepId**: `"validate-price-lists"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# validateVariantPriceLinksStepId
|
||||
|
||||
`Const` **validateVariantPriceLinksStepId**: `"validate-variant-price-links"`
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/batchPriceListPricesWorkflow
|
||||
sidebar_label: batchPriceListPricesWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# batchPriceListPricesWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `batchPriceListPricesWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow manages price lists' prices by creating, updating, or removing them.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"batchPriceListPricesWorkflow","steps":[{"type":"workflow","name":"createPriceListPricesWorkflow","description":"This workflow creates prices in price lists.","link":"../../../../core_flows.Workflows_Price_List/page.mdx#createpricelistpricesworkflow","depth":1},{"type":"workflow","name":"updatePriceListPricesWorkflow","description":"This workflow update price lists' prices.","link":"../../../../core_flows.Workflows_Price_List/page.mdx#updatepricelistpricesworkflow","depth":1},{"type":"workflow","name":"removePriceListPricesWorkflow","description":"This workflow removes price lists' prices.","link":"../../../../core_flows.Workflows_Price_List/page.mdx#removepricelistpricesworkflow","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"data","type":"`BatchPriceListPricesWorkflowDTO`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchPriceListPricesWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"BatchPriceListPricesWorkflowResult","type":"`BatchPriceListPricesWorkflowResult`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchPriceListPricesWorkflow"/>
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/createPriceListPricesWorkflow
|
||||
sidebar_label: createPriceListPricesWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createPriceListPricesWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createPriceListPricesWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow creates prices in price lists.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createPriceListPricesWorkflow","steps":[{"type":"step","name":"validatePriceListsStep","description":"This step validates that the specified price lists exist.","link":"../../../../core_flows.Steps_Price_List/page.mdx#validatepricelistsstep","depth":1},{"type":"step","name":"validateVariantPriceLinksStep","description":"This step validates that the specified variants have prices.","link":"../../../../core_flows.Steps_Price_List/page.mdx#validatevariantpricelinksstep","depth":1},{"type":"step","name":"createPriceListPricesStep","description":"This step creates prices for a price list.","link":"../../../../core_flows.Steps_Price_List/page.mdx#createpricelistpricesstep","depth":2}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"data","type":"`CreatePriceListPricesWorkflowDTO`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPriceListPricesWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"PriceDTO[]","type":"[PriceDTO](../../../../../pricing/interfaces/pricing.PriceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PriceDTO","type":"[PriceDTO](../../../../../pricing/interfaces/pricing.PriceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this price.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"min_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"max_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_set","type":"[PriceSetDTO](../../../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)","description":"The price set associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmountDTO](../../../../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)[]","description":"The prices that belong to this price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_price","type":"[CalculatedPriceSet](../../../../../pricing/interfaces/pricing.CalculatedPriceSet/page.mdx)","description":"The calculated price based on the context.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_list","type":"[PriceListDTO](../../../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","description":"The price list associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starLine truncated
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/createPriceListsWorkflow
|
||||
sidebar_label: createPriceListsWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createPriceListsWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createPriceListsWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow creates one or more price lists.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createPriceListsWorkflow","steps":[{"type":"step","name":"validateVariantPriceLinksStep","description":"This step validates that the specified variants have prices.","link":"../../../../core_flows.Steps_Price_List/page.mdx#validatevariantpricelinksstep","depth":1},{"type":"step","name":"createPriceListsStep","description":"This step creates a price list.","link":"../../../../core_flows.Steps_Price_List/page.mdx#createpricelistsstep","depth":2}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreatePriceListsWorkflowInput","type":"[CreatePriceListsWorkflowInput](../../../../types/core_flows.CreatePriceListsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"price_lists_data","type":"`CreatePriceListWorkflowInputDTO`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPriceListsWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"PriceListDTO[]","type":"[PriceListDTO](../../../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PriceListDTO","type":"[PriceListDTO](../../../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price list's details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../../../pricing/types/pricing.PriceListType/page.mdx)","description":"The price list's type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules associated with this price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[PriceDTO](../../../../../pricing/interfaces/pricing.PriceDTO/page.mdx)[]","description":"The associated price list money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of a price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"[PriceSetDTO](../../../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)","description":"The price set associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list","type":"[PriceListDTO](../../../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","description":"The price list associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the associated price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_rules","type":"[PriceRuleDTO](../../../../../pricing/interfaces/pricing.PriceRuleDTO/page.mdx)[]","description":"The price rules associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"money_amounts","type":"[MoneyAmountDTO](../../../../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)[]","description":"The associated money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When theLine truncated
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/deletePriceListsWorkflow
|
||||
sidebar_label: deletePriceListsWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deletePriceListsWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deletePriceListsWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow deletes one or more price lists.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"deletePriceListsWorkflow","steps":[{"type":"step","name":"deletePriceListsStep","description":"This step deletes one or more price lists.","link":"../../../../core_flows.Steps_Price_List/page.mdx#deletepricelistsstep","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"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="deletePriceListsWorkflow"/>
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/removePriceListPricesWorkflow
|
||||
sidebar_label: removePriceListPricesWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# removePriceListPricesWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `removePriceListPricesWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow removes price lists' prices.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"removePriceListPricesWorkflow","steps":[{"type":"step","name":"removePriceListPricesStep","description":"This step removes prices from a price list.","link":"../../../../core_flows.Steps_Price_List/page.mdx#removepricelistpricesstep","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"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="removePriceListPricesWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removePriceListPricesWorkflow"/>
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/updatePriceListPricesWorkflow
|
||||
sidebar_label: updatePriceListPricesWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updatePriceListPricesWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `updatePriceListPricesWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow update price lists' prices.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"updatePriceListPricesWorkflow","steps":[{"type":"step","name":"validatePriceListsStep","description":"This step validates that the specified price lists exist.","link":"../../../../core_flows.Steps_Price_List/page.mdx#validatepricelistsstep","depth":1},{"type":"step","name":"validateVariantPriceLinksStep","description":"This step validates that the specified variants have prices.","link":"../../../../core_flows.Steps_Price_List/page.mdx#validatevariantpricelinksstep","depth":1},{"type":"step","name":"updatePriceListPricesStep","description":"This step updates a price list's prices.","link":"../../../../core_flows.Steps_Price_List/page.mdx#updatepricelistpricesstep","depth":2}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"data","type":"`UpdatePriceListPricesWorkflowDTO`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePriceListPricesWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"PriceDTO[]","type":"[PriceDTO](../../../../../pricing/interfaces/pricing.PriceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PriceDTO","type":"[PriceDTO](../../../../../pricing/interfaces/pricing.PriceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this price.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"min_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"max_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_set","type":"[PriceSetDTO](../../../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)","description":"The price set associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmountDTO](../../../../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)[]","description":"The prices that belong to this price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_price","type":"[CalculatedPriceSet](../../../../../pricing/interfaces/pricing.CalculatedPriceSet/page.mdx)","description":"The calculated price based on the context.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_list","type":"[PriceListDTO](../../../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","description":"The price list associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starLine truncated
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/updatePriceListsWorkflow
|
||||
sidebar_label: updatePriceListsWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updatePriceListsWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `updatePriceListsWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow updates one or more price lists.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"updatePriceListsWorkflow","steps":[{"type":"step","name":"validatePriceListsStep","description":"This step validates that the specified price lists exist.","link":"../../../../core_flows.Steps_Price_List/page.mdx#validatepricelistsstep","depth":1},{"type":"step","name":"updatePriceListsStep","description":"This step updates one or more price lists.","link":"../../../../core_flows.Steps_Price_List/page.mdx#updatepricelistsstep","depth":2}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"price_lists_data","type":"`UpdatePriceListWorkflowInputDTO`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePriceListsWorkflow"/>
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# batchPriceListPricesWorkflowId
|
||||
|
||||
`Const` **batchPriceListPricesWorkflowId**: `"batch-price-list-prices"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createPriceListPricesWorkflowId
|
||||
|
||||
`Const` **createPriceListPricesWorkflowId**: `"create-price-list-prices"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createPriceListsWorkflowId
|
||||
|
||||
`Const` **createPriceListsWorkflowId**: `"create-price-lists"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deletePriceListsWorkflowId
|
||||
|
||||
`Const` **deletePriceListsWorkflowId**: `"delete-price-lists"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# removePriceListPricesWorkflowId
|
||||
|
||||
`Const` **removePriceListPricesWorkflowId**: `"remove-price-list-prices"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updatePriceListPricesWorkflowId
|
||||
|
||||
`Const` **updatePriceListPricesWorkflowId**: `"update-price-list-prices"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updatePriceListsWorkflowId
|
||||
|
||||
`Const` **updatePriceListsWorkflowId**: `"update-price-lists"`
|
||||
+123
@@ -0,0 +1,123 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Steps\_Price List
|
||||
|
||||
## createPriceListPricesStep
|
||||
|
||||
This step creates prices for a price list.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreatePriceListPricesWorkflowStepDTO","type":"`CreatePriceListPricesWorkflowStepDTO`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPriceListPricesStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"PriceDTO[]","type":"[PriceDTO](../../../pricing/interfaces/pricing.PriceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PriceDTO","type":"[PriceDTO](../../../pricing/interfaces/pricing.PriceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this price.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"min_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"max_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_set","type":"[PriceSetDTO](../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)","description":"The price set associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmountDTO](../../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)[]","description":"The prices that belong to this price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_price","type":"[CalculatedPriceSet](../../../pricing/interfaces/pricing.CalculatedPriceSet/page.mdx)","description":"The calculated price based on the context.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_list","type":"[PriceListDTO](../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","description":"The price list associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":falLine truncated
|
||||
|
||||
___
|
||||
|
||||
## createPriceListsStep
|
||||
|
||||
This step creates a price list.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreatePriceListsWorkflowStepDTO","type":"`CreatePriceListsWorkflowStepDTO`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPriceListsStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"PriceListDTO[]","type":"[PriceListDTO](../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PriceListDTO","type":"[PriceListDTO](../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price list's details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../pricing/types/pricing.PriceListType/page.mdx)","description":"The price list's type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules associated with this price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[PriceDTO](../../../pricing/interfaces/pricing.PriceDTO/page.mdx)[]","description":"The associated price list money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of a price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"[PriceSetDTO](../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)","description":"The price set associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list","type":"[PriceListDTO](../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","description":"The price list associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the associated price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_rules","type":"[PriceRuleDTO](../../../pricing/interfaces/pricing.PriceRuleDTO/page.mdx)[]","description":"The price rules associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"money_amounts","type":"[MoneyAmountDTO](../../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)[]","description":"The associated money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the money\\_amount was created.","optional":false,"defaultValue":"","expandLine truncated
|
||||
|
||||
___
|
||||
|
||||
## deletePriceListsStep
|
||||
|
||||
This step deletes one or more price lists.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deletePriceListsStep"/>
|
||||
|
||||
___
|
||||
|
||||
## getExistingPriceListsPriceIdsStep
|
||||
|
||||
This step retrieves prices of price lists.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"price_list_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="getExistingPriceListsPriceIdsStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"Record","type":"`Record<string, string[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getExistingPriceListsPriceIdsStep"/>
|
||||
|
||||
___
|
||||
|
||||
## removePriceListPricesStep
|
||||
|
||||
This step removes prices from a price list.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removePriceListPricesStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removePriceListPricesStep"/>
|
||||
|
||||
___
|
||||
|
||||
## updatePriceListPricesStep
|
||||
|
||||
This step updates a price list's prices.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"UpdatePriceListPriceWorkflowStepDTO","type":"`UpdatePriceListPriceWorkflowStepDTO`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePriceListPricesStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"PriceDTO[]","type":"[PriceDTO](../../../pricing/interfaces/pricing.PriceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PriceDTO","type":"[PriceDTO](../../../pricing/interfaces/pricing.PriceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this price.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"min_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"max_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_set","type":"[PriceSetDTO](../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)","description":"The price set associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmountDTO](../../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)[]","description":"The prices that belong to this price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_price","type":"[CalculatedPriceSet](../../../pricing/interfaces/pricing.CalculatedPriceSet/page.mdx)","description":"The calculated price based on the context.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_list","type":"[PriceListDTO](../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","description":"The price list associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":falLine truncated
|
||||
|
||||
___
|
||||
|
||||
## updatePriceListsStep
|
||||
|
||||
This step updates one or more price lists.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"UpdatePriceListDTO[]","type":"[UpdatePriceListDTO](../../../pricing/interfaces/pricing.UpdatePriceListDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdatePriceListDTO","type":"[UpdatePriceListDTO](../../../pricing/interfaces/pricing.UpdatePriceListDTO/page.mdx)","optional":false,"defaultValue":"","description":"The attributes to update in a price list.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the price list to update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The price list's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceListRules](../../../pricing/interfaces/pricing.CreatePriceListRules/page.mdx)","description":"The rules to be created and associated with the price list.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePriceListsStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"PriceListDTO[]","type":"[PriceListDTO](../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PriceListDTO","type":"[PriceListDTO](../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price list's details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../pricing/types/pricing.PriceListType/page.mdx)","description":"The price list's type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules associated with this price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[PriceDTO](../../../pricing/interfaces/pricing.PriceDTO/page.mdx)[]","description":"The associated price list money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of a price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"[PriceSetDTO](../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)","description":"The price set associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list","type":"[PriceListDTO](../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","description":"The price list associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the associated price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_rules","type":"[PriceRuleDTO](../../../pricing/interfaces/pricing.PriceRuleDTO/page.mdx)[]","description":"The price rules associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"money_amounts","type":"[MoneyAmountDTO](../../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)[]","description":"The associated money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the money\\_amount was created.","optional":false,"defaultValue":"","expandLine truncated
|
||||
|
||||
___
|
||||
|
||||
## validatePriceListsStep
|
||||
|
||||
This step validates that the specified price lists exist.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"Pick<UpdatePriceListDTO, \"id\">[]","type":"Pick<[UpdatePriceListDTO](../../../pricing/interfaces/pricing.UpdatePriceListDTO/page.mdx), \"id\">[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"Pick","type":"Pick<[UpdatePriceListDTO](../../../pricing/interfaces/pricing.UpdatePriceListDTO/page.mdx), \"id\">","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdatePriceListDTO","type":"`object`","description":"The attributes to update in a price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"\"id\"","type":"`\"id\"`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validatePriceListsStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"Record","type":"`Record<string, [PriceListDTO](../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"PriceListDTO","type":"[PriceListDTO](../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price list's details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../pricing/types/pricing.PriceListType/page.mdx)","description":"The price list's type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules associated with this price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[PriceDTO](../../../pricing/interfaces/pricing.PriceDTO/page.mdx)[]","description":"The associated price list money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of a price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"[PriceSetDTO](../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)","description":"The price set associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list","type":"[PriceListDTO](../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","description":"The price list associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the associated price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_rules","type":"[PriceRuleDTO](../../../pricing/interfaces/pricing.PriceRuleDTO/page.mdx)[]","description":"The price rules associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"money_amounts","type":"[MoneyAmountDTO](../../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)[]","description":"The associated money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"nLine truncated
|
||||
|
||||
___
|
||||
|
||||
## validateVariantPriceLinksStep
|
||||
|
||||
This step validates that the specified variants have prices.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"object[]","type":"`object`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"prices","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"variant_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="validateVariantPriceLinksStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"Record","type":"`Record<string, string>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validateVariantPriceLinksStep"/>
|
||||
+119
@@ -0,0 +1,119 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Workflows\_Price List
|
||||
|
||||
## batchPriceListPricesWorkflow
|
||||
|
||||
This workflow manages price lists' prices by creating, updating, or removing them.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"batchPriceListPricesWorkflow","steps":[{"type":"workflow","name":"createPriceListPricesWorkflow","description":"This workflow creates prices in price lists.","link":"../../core_flows.Workflows_Price_List/page.mdx#createpricelistpricesworkflow","depth":1},{"type":"workflow","name":"updatePriceListPricesWorkflow","description":"This workflow update price lists' prices.","link":"../../core_flows.Workflows_Price_List/page.mdx#updatepricelistpricesworkflow","depth":1},{"type":"workflow","name":"removePriceListPricesWorkflow","description":"This workflow removes price lists' prices.","link":"../../core_flows.Workflows_Price_List/page.mdx#removepricelistpricesworkflow","depth":1}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"data","type":"`BatchPriceListPricesWorkflowDTO`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchPriceListPricesWorkflow"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"BatchPriceListPricesWorkflowResult","type":"`BatchPriceListPricesWorkflowResult`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchPriceListPricesWorkflow"/>
|
||||
|
||||
___
|
||||
|
||||
## createPriceListPricesWorkflow
|
||||
|
||||
This workflow creates prices in price lists.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createPriceListPricesWorkflow","steps":[{"type":"step","name":"validatePriceListsStep","description":"This step validates that the specified price lists exist.","link":"../../core_flows.Steps_Price_List/page.mdx#validatepricelistsstep","depth":1},{"type":"step","name":"validateVariantPriceLinksStep","description":"This step validates that the specified variants have prices.","link":"../../core_flows.Steps_Price_List/page.mdx#validatevariantpricelinksstep","depth":1},{"type":"step","name":"createPriceListPricesStep","description":"This step creates prices for a price list.","link":"../../core_flows.Steps_Price_List/page.mdx#createpricelistpricesstep","depth":2}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"data","type":"`CreatePriceListPricesWorkflowDTO`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPriceListPricesWorkflow"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"PriceDTO[]","type":"[PriceDTO](../../../pricing/interfaces/pricing.PriceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PriceDTO","type":"[PriceDTO](../../../pricing/interfaces/pricing.PriceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this price.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"min_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"max_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_set","type":"[PriceSetDTO](../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)","description":"The price set associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmountDTO](../../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)[]","description":"The prices that belong to this price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_price","type":"[CalculatedPriceSet](../../../pricing/interfaces/pricing.CalculatedPriceSet/page.mdx)","description":"The calculated price based on the context.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_list","type":"[PriceListDTO](../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","description":"The price list associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":falLine truncated
|
||||
|
||||
___
|
||||
|
||||
## createPriceListsWorkflow
|
||||
|
||||
This workflow creates one or more price lists.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createPriceListsWorkflow","steps":[{"type":"step","name":"validateVariantPriceLinksStep","description":"This step validates that the specified variants have prices.","link":"../../core_flows.Steps_Price_List/page.mdx#validatevariantpricelinksstep","depth":1},{"type":"step","name":"createPriceListsStep","description":"This step creates a price list.","link":"../../core_flows.Steps_Price_List/page.mdx#createpricelistsstep","depth":2}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreatePriceListsWorkflowInput","type":"[CreatePriceListsWorkflowInput](../../types/core_flows.CreatePriceListsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"price_lists_data","type":"`CreatePriceListWorkflowInputDTO`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPriceListsWorkflow"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"PriceListDTO[]","type":"[PriceListDTO](../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PriceListDTO","type":"[PriceListDTO](../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price list's details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../pricing/types/pricing.PriceListType/page.mdx)","description":"The price list's type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules associated with this price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[PriceDTO](../../../pricing/interfaces/pricing.PriceDTO/page.mdx)[]","description":"The associated price list money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of a price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"[PriceSetDTO](../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)","description":"The price set associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list","type":"[PriceListDTO](../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","description":"The price list associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the associated price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_rules","type":"[PriceRuleDTO](../../../pricing/interfaces/pricing.PriceRuleDTO/page.mdx)[]","description":"The price rules associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"money_amounts","type":"[MoneyAmountDTO](../../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)[]","description":"The associated money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the money\\_amount was created.","optional":false,"defaultValue":"","expandLine truncated
|
||||
|
||||
___
|
||||
|
||||
## deletePriceListsWorkflow
|
||||
|
||||
This workflow deletes one or more price lists.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"deletePriceListsWorkflow","steps":[{"type":"step","name":"deletePriceListsStep","description":"This step deletes one or more price lists.","link":"../../core_flows.Steps_Price_List/page.mdx#deletepricelistsstep","depth":1}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"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="deletePriceListsWorkflow"/>
|
||||
|
||||
___
|
||||
|
||||
## removePriceListPricesWorkflow
|
||||
|
||||
This workflow removes price lists' prices.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"removePriceListPricesWorkflow","steps":[{"type":"step","name":"removePriceListPricesStep","description":"This step removes prices from a price list.","link":"../../core_flows.Steps_Price_List/page.mdx#removepricelistpricesstep","depth":1}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"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="removePriceListPricesWorkflow"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removePriceListPricesWorkflow"/>
|
||||
|
||||
___
|
||||
|
||||
## updatePriceListPricesWorkflow
|
||||
|
||||
This workflow update price lists' prices.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"updatePriceListPricesWorkflow","steps":[{"type":"step","name":"validatePriceListsStep","description":"This step validates that the specified price lists exist.","link":"../../core_flows.Steps_Price_List/page.mdx#validatepricelistsstep","depth":1},{"type":"step","name":"validateVariantPriceLinksStep","description":"This step validates that the specified variants have prices.","link":"../../core_flows.Steps_Price_List/page.mdx#validatevariantpricelinksstep","depth":1},{"type":"step","name":"updatePriceListPricesStep","description":"This step updates a price list's prices.","link":"../../core_flows.Steps_Price_List/page.mdx#updatepricelistpricesstep","depth":2}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"data","type":"`UpdatePriceListPricesWorkflowDTO`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePriceListPricesWorkflow"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"PriceDTO[]","type":"[PriceDTO](../../../pricing/interfaces/pricing.PriceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PriceDTO","type":"[PriceDTO](../../../pricing/interfaces/pricing.PriceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this price.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"min_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"max_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_set","type":"[PriceSetDTO](../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)","description":"The price set associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmountDTO](../../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)[]","description":"The prices that belong to this price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_price","type":"[CalculatedPriceSet](../../../pricing/interfaces/pricing.CalculatedPriceSet/page.mdx)","description":"The calculated price based on the context.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_list","type":"[PriceListDTO](../../../pricing/interfaces/pricing.PriceListDTO/page.mdx)","description":"The price list associated with the price.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":falLine truncated
|
||||
|
||||
___
|
||||
|
||||
## updatePriceListsWorkflow
|
||||
|
||||
This workflow updates one or more price lists.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"updatePriceListsWorkflow","steps":[{"type":"step","name":"validatePriceListsStep","description":"This step validates that the specified price lists exist.","link":"../../core_flows.Steps_Price_List/page.mdx#validatepricelistsstep","depth":1},{"type":"step","name":"updatePriceListsStep","description":"This step updates one or more price lists.","link":"../../core_flows.Steps_Price_List/page.mdx#updatepricelistsstep","depth":2}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"price_lists_data","type":"`UpdatePriceListWorkflowInputDTO`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePriceListsWorkflow"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/createPricePreferencesStep
|
||||
sidebar_label: createPricePreferencesStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createPricePreferencesStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createPricePreferencesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step creates one or more price preferences.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreatePricePreferencesWorkflowInput[]","type":"`CreatePricePreferencesWorkflowInput`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreatePricePreferencesWorkflowInput","type":"`CreatePricePreferencesWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPricePreferencesStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"PricePreferenceDTO[]","type":"[PricePreferenceDTO](../../../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"[PricePreferenceDTO](../../../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price preference's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPricePreferencesStep"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/createPriceSetsStep
|
||||
sidebar_label: createPriceSetsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createPriceSetsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createPriceSetsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step creates one or more price sets.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreatePriceSetDTO[]","type":"[CreatePriceSetDTO](../../../../../pricing/interfaces/pricing.CreatePriceSetDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreatePriceSetDTO","type":"[CreatePriceSetDTO](../../../../../pricing/interfaces/pricing.CreatePriceSetDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price set to create.","expandable":false,"children":[{"name":"prices","type":"[CreatePricesDTO](../../../../../pricing/interfaces/pricing.CreatePricesDTO/page.mdx)[]","description":"The prices to create and add to this price set.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| [BigNumberInput](../../../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| [BigNumberInput](../../../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceSetPriceRules](../../../../../pricing/interfaces/pricing.CreatePriceSetPriceRules/page.mdx)","description":"The rules to add to the price. The object's keys are the attribute, and values are the value of that rule associated with this price.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPriceSetsStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"PriceSetDTO[]","type":"[PriceSetDTO](../../../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PriceSetDTO","type":"[PriceSetDTO](../../../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price set's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmountDTO](../../../../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)[]","description":"The prices that belong to this price set.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the money\\_amount was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules that apply to this price","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_rules","type":"[PriceRuleDTO](../../../../../pricing/interfaces/pricing.PriceRuleDTO/page.mdx)[]","description":"The price rules that apply to this price","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"calculated_price","type":"[CalculatedPriceSet](../../../../../pricing/interfaces/pricing.CalculatedPriceSet/page.mdx)","description":"The calculated price based on the context.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_amount","type":"`null` \\| [BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The amount of the calculated price, or `null` if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_calculated_amount","type":"`null` \\| [BigNumberRawValue](../../../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_amount","type":"`null` \\| [BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The amount of the original price, or `null` if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_amount","type":"`null` \\| [BigNumberRawValue](../../../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"The currency code of the calculated price, or null if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_calculated_price_price_list","type":"`boolean`","description":"Whether the calculated price is associated with a price list. During the calculation process, if no valid price list is found,\nthe calculated price is set to the original price, which doesn't belong to a price list. In that case, the value of this property is `false`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_calculated_price_tax_inclusive","type":"`boolean`","description":"Whether the calculated price is tax inclusive or not.","optional":true,"defaultValue":"","expLine truncated
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/deletePricePreferencesStep
|
||||
sidebar_label: deletePricePreferencesStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deletePricePreferencesStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deletePricePreferencesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step deletes one or more price preferences.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deletePricePreferencesStep"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/updatePricePreferencesAsArrayStep
|
||||
sidebar_label: updatePricePreferencesAsArrayStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updatePricePreferencesAsArrayStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `updatePricePreferencesAsArrayStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step updates price preferences.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdatePricePreferencesAsArrayStepInput","type":"[UpdatePricePreferencesAsArrayStepInput](../../../../types/core_flows.UpdatePricePreferencesAsArrayStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdatePricePreferencesAsArrayStepInput","type":"`PricingWorkflow.UpdatePricePreferencesWorkflowInput`[`\"update\"`][]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferencesAsArrayStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"PricePreferenceDTO[]","type":"[PricePreferenceDTO](../../../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"[PricePreferenceDTO](../../../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price preference's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferencesAsArrayStep"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/updatePricePreferencesStep
|
||||
sidebar_label: updatePricePreferencesStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updatePricePreferencesStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `updatePricePreferencesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step updates price preferences matching the specified filters.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdatePricePreferencesWorkflowInput","type":"`UpdatePricePreferencesWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferencesStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"PricePreferenceDTO[]","type":"[PricePreferenceDTO](../../../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"[PricePreferenceDTO](../../../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price preference's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferencesStep"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/updatePriceSetsStep
|
||||
sidebar_label: updatePriceSetsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updatePriceSetsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `updatePriceSetsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step updates price sets.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdatePriceSetsStepInput","type":"[UpdatePriceSetsStepInput](../../../../types/core_flows.UpdatePriceSetsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"price_sets","type":"[UpsertPriceSetDTO](../../../../../pricing/interfaces/pricing.UpsertPriceSetDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"A string indicating the ID of the price set to update.\nIf not provided, a price set is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[CreatePricesDTO](../../../../../pricing/interfaces/pricing.CreatePricesDTO/page.mdx)[]","description":"The prices to create and add to this price set.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| [BigNumberInput](../../../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| [BigNumberInput](../../../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceSetPriceRules](../../../../../pricing/interfaces/pricing.CreatePriceSetPriceRules/page.mdx)","description":"The rules to add to the price. The object's keys are the attribute, and values are the value of that rule associated with this price.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"selector","type":"[FilterablePriceSetProps](../../../../../pricing/interfaces/pricing.FilterablePriceSetProps/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterablePriceSetProps](../../../../../pricing/interfaces/pricing.FilterablePriceSetProps/page.mdx) \\| [BaseFilterable](../../../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<[FilterablePriceSetProps](../../../../../pricing/interfaces/pricing.FilterablePriceSetProps/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":"([FilterablePriceSetProps](../../../../../pricing/interfaces/pricing.FilterablePriceSetProps/page.mdx) \\| [BaseFilterable](../../../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<[FilterablePriceSetProps](../../../../../pricing/interfaces/pricing.FilterablePriceSetProps/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":"([FilterablePriceSetProps](../../../../../pricing/interfaces/pricing.FilterablePriceSetProps/page.mdx) \\| [BaseFilterable](../../../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<[FilterablePriceSetProps](../../../../../pricing/interfaces/pricing.FilterablePriceSetProps/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":"context","type":"`Record<string, [BigNumberInput](../../../../../pricing/types/pricing.BigNumberInput/page.mdx)>`","description":"an object whose keys are the name of the context attribute. Its value can be a string or a BigNumberInput. For example, you can pass the `currency_code` property with its value being the currency code to calculate the price in.\nAnother example is passing the `quantity` property to calculate the price for that specified quantity, which finds a price set whose `min_quantity` and `max_quantity` conditions match the specified quantity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter price sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[FilterableMoneyAmountProps](../../../../../priciLine truncated
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"PriceSetDTO[]","type":"[PriceSetDTO](../../../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PriceSetDTO","type":"[PriceSetDTO](../../../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price set's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmountDTO](../../../../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)[]","description":"The prices that belong to this price set.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the money\\_amount was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"[BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules that apply to this price","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_rules","type":"[PriceRuleDTO](../../../../../pricing/interfaces/pricing.PriceRuleDTO/page.mdx)[]","description":"The price rules that apply to this price","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"calculated_price","type":"[CalculatedPriceSet](../../../../../pricing/interfaces/pricing.CalculatedPriceSet/page.mdx)","description":"The calculated price based on the context.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_amount","type":"`null` \\| [BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The amount of the calculated price, or `null` if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_calculated_amount","type":"`null` \\| [BigNumberRawValue](../../../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_amount","type":"`null` \\| [BigNumberValue](../../../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The amount of the original price, or `null` if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_amount","type":"`null` \\| [BigNumberRawValue](../../../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"The currency code of the calculated price, or null if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_calculated_price_price_list","type":"`boolean`","description":"Whether the calculated price is associated with a price list. During the calculation process, if no valid price list is found,\nthe calculated price is set to the original price, which doesn't belong to a price list. In that case, the value of this property is `false`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_calculated_price_tax_inclusive","type":"`boolean`","description":"Whether the calculated price is tax inclusive or not.","optional":true,"defaultValue":"","expLine truncated
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createPricePreferencesStepId
|
||||
|
||||
`Const` **createPricePreferencesStepId**: `"create-price-preferences"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createPriceSetsStepId
|
||||
|
||||
`Const` **createPriceSetsStepId**: `"create-price-sets"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deletePricePreferencesStepId
|
||||
|
||||
`Const` **deletePricePreferencesStepId**: `"delete-price-preferences"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updatePricePreferencesAsArrayStepId
|
||||
|
||||
`Const` **updatePricePreferencesAsArrayStepId**: `"update-price-preferences-as-array"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updatePricePreferencesStepId
|
||||
|
||||
`Const` **updatePricePreferencesStepId**: `"update-price-preferences"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updatePriceSetsStepId
|
||||
|
||||
`Const` **updatePriceSetsStepId**: `"update-price-sets"`
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/createPricePreferencesWorkflow
|
||||
sidebar_label: createPricePreferencesWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createPricePreferencesWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createPricePreferencesWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow creates one or more price preferences.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createPricePreferencesWorkflow","steps":[{"type":"step","name":"createPricePreferencesStep","description":"This step creates one or more price preferences.","link":"../../../../core_flows.Steps_Pricing/page.mdx#createpricepreferencesstep","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreatePricePreferencesWorkflowInput[]","type":"`CreatePricePreferencesWorkflowInput`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreatePricePreferencesWorkflowInput","type":"`CreatePricePreferencesWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPricePreferencesWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"PricePreferenceDTO[]","type":"[PricePreferenceDTO](../../../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"[PricePreferenceDTO](../../../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price preference's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPricePreferencesWorkflow"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/deletePricePreferencesWorkflow
|
||||
sidebar_label: deletePricePreferencesWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deletePricePreferencesWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deletePricePreferencesWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow deletes one or more price preferences.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"deletePricePreferencesWorkflow","steps":[{"type":"step","name":"deletePricePreferencesStep","description":"This step deletes one or more price preferences.","link":"../../../../core_flows.Steps_Pricing/page.mdx#deletepricepreferencesstep","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deletePricePreferencesWorkflow"/>
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/updatePricePreferencesWorkflow
|
||||
sidebar_label: updatePricePreferencesWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updatePricePreferencesWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `updatePricePreferencesWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow updates one or more price preferences.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"updatePricePreferencesWorkflow","steps":[{"type":"step","name":"updatePricePreferencesStep","description":"This step updates price preferences matching the specified filters.","link":"../../../../core_flows.Steps_Pricing/page.mdx#updatepricepreferencesstep","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdatePricePreferencesWorkflowInput","type":"`UpdatePricePreferencesWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferencesWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"PricePreferenceDTO[]","type":"[PricePreferenceDTO](../../../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"[PricePreferenceDTO](../../../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price preference's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferencesWorkflow"/>
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createPricePreferencesWorkflowId
|
||||
|
||||
`Const` **createPricePreferencesWorkflowId**: `"create-price-preferences"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deletePricePreferencesWorkflowId
|
||||
|
||||
`Const` **deletePricePreferencesWorkflowId**: `"delete-price-preferences"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updatePricePreferencesWorkflowId
|
||||
|
||||
`Const` **updatePricePreferencesWorkflowId**: `"update-price-preferences"`
|
||||
+81
@@ -0,0 +1,81 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Steps\_Pricing
|
||||
|
||||
## createPricePreferencesStep
|
||||
|
||||
This step creates one or more price preferences.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreatePricePreferencesWorkflowInput[]","type":"`CreatePricePreferencesWorkflowInput`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreatePricePreferencesWorkflowInput","type":"`CreatePricePreferencesWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPricePreferencesStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"PricePreferenceDTO[]","type":"[PricePreferenceDTO](../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"[PricePreferenceDTO](../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price preference's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPricePreferencesStep"/>
|
||||
|
||||
___
|
||||
|
||||
## createPriceSetsStep
|
||||
|
||||
This step creates one or more price sets.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreatePriceSetDTO[]","type":"[CreatePriceSetDTO](../../../pricing/interfaces/pricing.CreatePriceSetDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreatePriceSetDTO","type":"[CreatePriceSetDTO](../../../pricing/interfaces/pricing.CreatePriceSetDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price set to create.","expandable":false,"children":[{"name":"prices","type":"[CreatePricesDTO](../../../pricing/interfaces/pricing.CreatePricesDTO/page.mdx)[]","description":"The prices to create and add to this price set.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| [BigNumberInput](../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| [BigNumberInput](../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceSetPriceRules](../../../pricing/interfaces/pricing.CreatePriceSetPriceRules/page.mdx)","description":"The rules to add to the price. The object's keys are the attribute, and values are the value of that rule associated with this price.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPriceSetsStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"PriceSetDTO[]","type":"[PriceSetDTO](../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PriceSetDTO","type":"[PriceSetDTO](../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price set's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmountDTO](../../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)[]","description":"The prices that belong to this price set.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the money\\_amount was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules that apply to this price","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_rules","type":"[PriceRuleDTO](../../../pricing/interfaces/pricing.PriceRuleDTO/page.mdx)[]","description":"The price rules that apply to this price","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"calculated_price","type":"[CalculatedPriceSet](../../../pricing/interfaces/pricing.CalculatedPriceSet/page.mdx)","description":"The calculated price based on the context.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_amount","type":"`null` \\| [BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The amount of the calculated price, or `null` if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_calculated_amount","type":"`null` \\| [BigNumberRawValue](../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_amount","type":"`null` \\| [BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The amount of the original price, or `null` if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_amount","type":"`null` \\| [BigNumberRawValue](../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"The currency code of the calculated price, or null if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_calculated_price_price_list","type":"`boolean`","description":"Whether the calculated price is associated with a price list. During the calculation process, if no valid price list is found,\nthe calculated price is set to the original price, which doesn't belong to a price list. In that case, the value of this property is `false`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_calculated_price_tax_inclusive","type":"`boolean`","description":"Whether the calculated price is tax inclusive or not.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_original_price_price_list","tyLine truncated
|
||||
|
||||
___
|
||||
|
||||
## deletePricePreferencesStep
|
||||
|
||||
This step deletes one or more price preferences.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deletePricePreferencesStep"/>
|
||||
|
||||
___
|
||||
|
||||
## updatePricePreferencesAsArrayStep
|
||||
|
||||
This step updates price preferences.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"UpdatePricePreferencesAsArrayStepInput","type":"[UpdatePricePreferencesAsArrayStepInput](../../types/core_flows.UpdatePricePreferencesAsArrayStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdatePricePreferencesAsArrayStepInput","type":"`PricingWorkflow.UpdatePricePreferencesWorkflowInput`[`\"update\"`][]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferencesAsArrayStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"PricePreferenceDTO[]","type":"[PricePreferenceDTO](../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"[PricePreferenceDTO](../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price preference's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferencesAsArrayStep"/>
|
||||
|
||||
___
|
||||
|
||||
## updatePricePreferencesStep
|
||||
|
||||
This step updates price preferences matching the specified filters.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"UpdatePricePreferencesWorkflowInput","type":"`UpdatePricePreferencesWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferencesStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"PricePreferenceDTO[]","type":"[PricePreferenceDTO](../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"[PricePreferenceDTO](../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price preference's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferencesStep"/>
|
||||
|
||||
___
|
||||
|
||||
## updatePriceSetsStep
|
||||
|
||||
This step updates price sets.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"UpdatePriceSetsStepInput","type":"[UpdatePriceSetsStepInput](../../types/core_flows.UpdatePriceSetsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"price_sets","type":"[UpsertPriceSetDTO](../../../pricing/interfaces/pricing.UpsertPriceSetDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"A string indicating the ID of the price set to update.\nIf not provided, a price set is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[CreatePricesDTO](../../../pricing/interfaces/pricing.CreatePricesDTO/page.mdx)[]","description":"The prices to create and add to this price set.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| [BigNumberInput](../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| [BigNumberInput](../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceSetPriceRules](../../../pricing/interfaces/pricing.CreatePriceSetPriceRules/page.mdx)","description":"The rules to add to the price. The object's keys are the attribute, and values are the value of that rule associated with this price.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"selector","type":"[FilterablePriceSetProps](../../../pricing/interfaces/pricing.FilterablePriceSetProps/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterablePriceSetProps](../../../pricing/interfaces/pricing.FilterablePriceSetProps/page.mdx) \\| [BaseFilterable](../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<[FilterablePriceSetProps](../../../pricing/interfaces/pricing.FilterablePriceSetProps/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":"([FilterablePriceSetProps](../../../pricing/interfaces/pricing.FilterablePriceSetProps/page.mdx) \\| [BaseFilterable](../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<[FilterablePriceSetProps](../../../pricing/interfaces/pricing.FilterablePriceSetProps/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":"([FilterablePriceSetProps](../../../pricing/interfaces/pricing.FilterablePriceSetProps/page.mdx) \\| [BaseFilterable](../../../pricing/interfaces/pricing.BaseFilterable/page.mdx)<[FilterablePriceSetProps](../../../pricing/interfaces/pricing.FilterablePriceSetProps/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":"context","type":"`Record<string, [BigNumberInput](../../../pricing/types/pricing.BigNumberInput/page.mdx)>`","description":"an object whose keys are the name of the context attribute. Its value can be a string or a BigNumberInput. For example, you can pass the `currency_code` property with its value being the currency code to calculate the price in.\nAnother example is passing the `quantity` property to calculate the price for that specified quantity, which finds a price set whose `min_quantity` and `max_quantity` conditions match the specified quantity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter price sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[FilterableMoneyAmountProps](../../../pricing/interfaces/pricing.FilterableMoneyAmountProps/page.mdx)","description":"Filters to apply on a price set's assocLine truncated
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"PriceSetDTO[]","type":"[PriceSetDTO](../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PriceSetDTO","type":"[PriceSetDTO](../../../pricing/interfaces/pricing.PriceSetDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price set's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmountDTO](../../../pricing/interfaces/pricing.MoneyAmountDTO/page.mdx)[]","description":"The prices that belong to this price set.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the money\\_amount was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The price of this money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"[BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules that apply to this price","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_rules","type":"[PriceRuleDTO](../../../pricing/interfaces/pricing.PriceRuleDTO/page.mdx)[]","description":"The price rules that apply to this price","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"calculated_price","type":"[CalculatedPriceSet](../../../pricing/interfaces/pricing.CalculatedPriceSet/page.mdx)","description":"The calculated price based on the context.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_amount","type":"`null` \\| [BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The amount of the calculated price, or `null` if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_calculated_amount","type":"`null` \\| [BigNumberRawValue](../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_amount","type":"`null` \\| [BigNumberValue](../../../pricing/types/pricing.BigNumberValue/page.mdx)","description":"The amount of the original price, or `null` if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_amount","type":"`null` \\| [BigNumberRawValue](../../../pricing/types/pricing.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"The currency code of the calculated price, or null if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_calculated_price_price_list","type":"`boolean`","description":"Whether the calculated price is associated with a price list. During the calculation process, if no valid price list is found,\nthe calculated price is set to the original price, which doesn't belong to a price list. In that case, the value of this property is `false`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_calculated_price_tax_inclusive","type":"`boolean`","description":"Whether the calculated price is tax inclusive or not.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_original_price_price_list","tyLine truncated
|
||||
+51
@@ -0,0 +1,51 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Workflows\_Pricing
|
||||
|
||||
## createPricePreferencesWorkflow
|
||||
|
||||
This workflow creates one or more price preferences.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createPricePreferencesWorkflow","steps":[{"type":"step","name":"createPricePreferencesStep","description":"This step creates one or more price preferences.","link":"../../core_flows.Steps_Pricing/page.mdx#createpricepreferencesstep","depth":1}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreatePricePreferencesWorkflowInput[]","type":"`CreatePricePreferencesWorkflowInput`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreatePricePreferencesWorkflowInput","type":"`CreatePricePreferencesWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPricePreferencesWorkflow"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"PricePreferenceDTO[]","type":"[PricePreferenceDTO](../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"[PricePreferenceDTO](../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price preference's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPricePreferencesWorkflow"/>
|
||||
|
||||
___
|
||||
|
||||
## deletePricePreferencesWorkflow
|
||||
|
||||
This workflow deletes one or more price preferences.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"deletePricePreferencesWorkflow","steps":[{"type":"step","name":"deletePricePreferencesStep","description":"This step deletes one or more price preferences.","link":"../../core_flows.Steps_Pricing/page.mdx#deletepricepreferencesstep","depth":1}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deletePricePreferencesWorkflow"/>
|
||||
|
||||
___
|
||||
|
||||
## updatePricePreferencesWorkflow
|
||||
|
||||
This workflow updates one or more price preferences.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"updatePricePreferencesWorkflow","steps":[{"type":"step","name":"updatePricePreferencesStep","description":"This step updates price preferences matching the specified filters.","link":"../../core_flows.Steps_Pricing/page.mdx#updatepricepreferencesstep","depth":1}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"UpdatePricePreferencesWorkflowInput","type":"`UpdatePricePreferencesWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferencesWorkflow"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"PricePreferenceDTO[]","type":"[PricePreferenceDTO](../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PricePreferenceDTO","type":"[PricePreferenceDTO](../../../pricing/interfaces/pricing.PricePreferenceDTO/page.mdx)","optional":false,"defaultValue":"","description":"A price preference's data.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`null` \\| `string`","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferencesWorkflow"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/createReturnReasonsStep
|
||||
sidebar_label: createReturnReasonsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createReturnReasonsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createReturnReasonsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step creates one or more return reasons.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreateOrderReturnReasonDTO[]","type":"[CreateOrderReturnReasonDTO](../../../../../order/interfaces/order.CreateOrderReturnReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateOrderReturnReasonDTO","type":"[CreateOrderReturnReasonDTO](../../../../../order/interfaces/order.CreateOrderReturnReasonDTO/page.mdx)","optional":false,"defaultValue":"","description":"The return reason to be created.","expandable":false,"children":[{"name":"value","type":"`string`","description":"The unique value of the return reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The associated parent return reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createReturnReasonsStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"OrderReturnReasonDTO[]","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderReturnReasonDTO","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order return reason details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","descriptiLine truncated
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/deleteReturnReasonStep
|
||||
sidebar_label: deleteReturnReasonStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteReturnReasonStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteReturnReasonStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step deletes one or more return reasons.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteReturnReasonStep"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/updateReturnReasonsStep
|
||||
sidebar_label: updateReturnReasonsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateReturnReasonsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `updateReturnReasonsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step updates return reasons matching the specified filters.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateReturnReasonStepInput","type":"`UpdateReturnReasonStepInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateReturnReasonsStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"OrderReturnReasonDTO[]","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderReturnReasonDTO","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order return reason details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","descriptiLine truncated
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createReturnReasonsStepId
|
||||
|
||||
`Const` **createReturnReasonsStepId**: `"create-return-reasons"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteReturnReasonStepId
|
||||
|
||||
`Const` **deleteReturnReasonStepId**: `"delete-return-reasons"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateReturnReasonStepId
|
||||
|
||||
`Const` **updateReturnReasonStepId**: `"update-return-reasons"`
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/createReturnReasonsWorkflow
|
||||
sidebar_label: createReturnReasonsWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createReturnReasonsWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createReturnReasonsWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow creates one or more return reasons.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createReturnReasonsWorkflow","steps":[{"type":"step","name":"createReturnReasonsStep","description":"This step creates one or more return reasons.","link":"../../../../core_flows.Steps_Return_Reason/page.mdx#createreturnreasonsstep","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreateReturnReasonsWorkflowInput","type":"[CreateReturnReasonsWorkflowInput](../../../../types/core_flows.CreateReturnReasonsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"data","type":"[CreateOrderReturnReasonDTO](../../../../../order/interfaces/order.CreateOrderReturnReasonDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string`","description":"The unique value of the return reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The associated parent return reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createReturnReasonsWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"OrderReturnReasonDTO[]","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderReturnReasonDTO","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order return reason details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","descriptiLine truncated
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/deleteReturnReasonsWorkflow
|
||||
sidebar_label: deleteReturnReasonsWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteReturnReasonsWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteReturnReasonsWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow deletes one or more return reasons.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"deleteReturnReasonsWorkflow","steps":[{"type":"step","name":"deleteReturnReasonStep","description":"This step deletes one or more return reasons.","link":"../../../../core_flows.Steps_Return_Reason/page.mdx#deletereturnreasonstep","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"DeleteReturnReasonsWorkflowInput","type":"[DeleteReturnReasonsWorkflowInput](../../../../types/core_flows.DeleteReturnReasonsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"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="deleteReturnReasonsWorkflow"/>
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/updateReturnReasonsWorkflow
|
||||
sidebar_label: updateReturnReasonsWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateReturnReasonsWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `updateReturnReasonsWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow updates return reasons matching the specified filters.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"updateReturnReasonsWorkflow","steps":[{"type":"step","name":"updateReturnReasonsStep","description":"This step updates return reasons matching the specified filters.","link":"../../../../core_flows.Steps_Return_Reason/page.mdx#updatereturnreasonsstep","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateReturnReasonsWorkflowInput","type":"[UpdateReturnReasonsWorkflowInput](../../../../types/core_flows.UpdateReturnReasonsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableOrderReturnReasonProps](../../../../../order/interfaces/order.FilterableOrderReturnReasonProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderReturnReasonProps](../../../../../order/interfaces/order.FilterableOrderReturnReasonProps/page.mdx) \\| [BaseFilterable](../../../../../order/interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderReturnReasonProps](../../../../../order/interfaces/order.FilterableOrderReturnReasonProps/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":"([FilterableOrderReturnReasonProps](../../../../../order/interfaces/order.FilterableOrderReturnReasonProps/page.mdx) \\| [BaseFilterable](../../../../../order/interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderReturnReasonProps](../../../../../order/interfaces/order.FilterableOrderReturnReasonProps/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":"([FilterableOrderReturnReasonProps](../../../../../order/interfaces/order.FilterableOrderReturnReasonProps/page.mdx) \\| [BaseFilterable](../../../../../order/interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderReturnReasonProps](../../../../../order/interfaces/order.FilterableOrderReturnReasonProps/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":"Find return reasons through this search term","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../order/types/order.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the return reasons by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../order/types/order.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the return reason by their value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string` \\| [OperatorMap](../../../../../order/types/order.OperatorMap/page.mdx)<string>","description":"Filter the return reason by their label.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| [OperatorMap](../../../../../order/types/order.OperatorMap/page.mdx)<string>","description":"Filter the return reason by their description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../order/interfaces/order.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](../../../../../order/interfaces/order.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":"([FilterableOrderReturnReasonProps](../../../../../order/interfaces/order.FilterableOrderReturnReasonProps/page.mdx) \\| [BaseFilterable](../../../../../order/interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderReturnReasonProps](../../../../../order/interfaces/order.FilterableOrderReturnReasonProps/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":"([FilterableOrderReturnReasonProps](../../../../../order/interfaces/order.FilterableOrderReturnReasonProps/page.mdx) \\| [BaseFilterable](../../../../../order/interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderReturnReasonProps](../../../../../order/interfaces/order.FilterableOrderReturnReasonProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",Line truncated
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"OrderReturnReasonDTO[]","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderReturnReasonDTO","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order return reason details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","descriptiLine truncated
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createReturnReasonsWorkflowId
|
||||
|
||||
`Const` **createReturnReasonsWorkflowId**: `"create-return-reasons"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteReturnReasonsWorkflowId
|
||||
|
||||
`Const` **deleteReturnReasonsWorkflowId**: `"delete-return-reasons"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateReturnReasonsWorkflowId
|
||||
|
||||
`Const` **updateReturnReasonsWorkflowId**: `"update-return-reasons"`
|
||||
+39
@@ -0,0 +1,39 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Steps\_Return Reason
|
||||
|
||||
## createReturnReasonsStep
|
||||
|
||||
This step creates one or more return reasons.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreateOrderReturnReasonDTO[]","type":"[CreateOrderReturnReasonDTO](../../../order/interfaces/order.CreateOrderReturnReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateOrderReturnReasonDTO","type":"[CreateOrderReturnReasonDTO](../../../order/interfaces/order.CreateOrderReturnReasonDTO/page.mdx)","optional":false,"defaultValue":"","description":"The return reason to be created.","expandable":false,"children":[{"name":"value","type":"`string`","description":"The unique value of the return reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The associated parent return reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createReturnReasonsStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"OrderReturnReasonDTO[]","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderReturnReasonDTO","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order return reason details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updaLine truncated
|
||||
|
||||
___
|
||||
|
||||
## deleteReturnReasonStep
|
||||
|
||||
This step deletes one or more return reasons.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteReturnReasonStep"/>
|
||||
|
||||
___
|
||||
|
||||
## updateReturnReasonsStep
|
||||
|
||||
This step updates return reasons matching the specified filters.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateReturnReasonStepInput","type":"`UpdateReturnReasonStepInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateReturnReasonsStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"OrderReturnReasonDTO[]","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderReturnReasonDTO","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order return reason details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updaLine truncated
|
||||
+51
@@ -0,0 +1,51 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Workflows\_Return Reason
|
||||
|
||||
## createReturnReasonsWorkflow
|
||||
|
||||
This workflow creates one or more return reasons.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createReturnReasonsWorkflow","steps":[{"type":"step","name":"createReturnReasonsStep","description":"This step creates one or more return reasons.","link":"../../core_flows.Steps_Return_Reason/page.mdx#createreturnreasonsstep","depth":1}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreateReturnReasonsWorkflowInput","type":"[CreateReturnReasonsWorkflowInput](../../types/core_flows.CreateReturnReasonsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"data","type":"[CreateOrderReturnReasonDTO](../../../order/interfaces/order.CreateOrderReturnReasonDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string`","description":"The unique value of the return reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The associated parent return reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createReturnReasonsWorkflow"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"OrderReturnReasonDTO[]","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderReturnReasonDTO","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order return reason details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updaLine truncated
|
||||
|
||||
___
|
||||
|
||||
## deleteReturnReasonsWorkflow
|
||||
|
||||
This workflow deletes one or more return reasons.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"deleteReturnReasonsWorkflow","steps":[{"type":"step","name":"deleteReturnReasonStep","description":"This step deletes one or more return reasons.","link":"../../core_flows.Steps_Return_Reason/page.mdx#deletereturnreasonstep","depth":1}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"DeleteReturnReasonsWorkflowInput","type":"[DeleteReturnReasonsWorkflowInput](../../types/core_flows.DeleteReturnReasonsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"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="deleteReturnReasonsWorkflow"/>
|
||||
|
||||
___
|
||||
|
||||
## updateReturnReasonsWorkflow
|
||||
|
||||
This workflow updates return reasons matching the specified filters.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"updateReturnReasonsWorkflow","steps":[{"type":"step","name":"updateReturnReasonsStep","description":"This step updates return reasons matching the specified filters.","link":"../../core_flows.Steps_Return_Reason/page.mdx#updatereturnreasonsstep","depth":1}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateReturnReasonsWorkflowInput","type":"[UpdateReturnReasonsWorkflowInput](../../types/core_flows.UpdateReturnReasonsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableOrderReturnReasonProps](../../../order/interfaces/order.FilterableOrderReturnReasonProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableOrderReturnReasonProps](../../../order/interfaces/order.FilterableOrderReturnReasonProps/page.mdx) \\| [BaseFilterable](../../../order/interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderReturnReasonProps](../../../order/interfaces/order.FilterableOrderReturnReasonProps/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":"([FilterableOrderReturnReasonProps](../../../order/interfaces/order.FilterableOrderReturnReasonProps/page.mdx) \\| [BaseFilterable](../../../order/interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderReturnReasonProps](../../../order/interfaces/order.FilterableOrderReturnReasonProps/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":"([FilterableOrderReturnReasonProps](../../../order/interfaces/order.FilterableOrderReturnReasonProps/page.mdx) \\| [BaseFilterable](../../../order/interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderReturnReasonProps](../../../order/interfaces/order.FilterableOrderReturnReasonProps/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":"Find return reasons through this search term","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../order/types/order.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the return reasons by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[] \\| [OperatorMap](../../../order/types/order.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter the return reason by their value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string` \\| [OperatorMap](../../../order/types/order.OperatorMap/page.mdx)<string>","description":"Filter the return reason by their label.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| [OperatorMap](../../../order/types/order.OperatorMap/page.mdx)<string>","description":"Filter the return reason by their description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../order/interfaces/order.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](../../../order/interfaces/order.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":"([FilterableOrderReturnReasonProps](../../../order/interfaces/order.FilterableOrderReturnReasonProps/page.mdx) \\| [BaseFilterable](../../../order/interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderReturnReasonProps](../../../order/interfaces/order.FilterableOrderReturnReasonProps/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":"([FilterableOrderReturnReasonProps](../../../order/interfaces/order.FilterableOrderReturnReasonProps/page.mdx) \\| [BaseFilterable](../../../order/interfaces/order.BaseFilterable/page.mdx)<[FilterableOrderReturnReasonProps](../../../order/interfaces/order.FilterableOrderReturnReasonProps/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":"([FilterableOrderReturnReasonProps](../../../ordLine truncated
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"OrderReturnReasonDTO[]","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderReturnReasonDTO","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order return reason details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../order/interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updaLine truncated
|
||||
@@ -0,0 +1,8 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Price List
|
||||
|
||||
## Namespaces
|
||||
|
||||
- [Steps\_Price List](../core_flows.Steps_Price_List/page.mdx)
|
||||
- [Workflows\_Price List](../core_flows.Workflows_Price_List/page.mdx)
|
||||
@@ -0,0 +1,8 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Pricing
|
||||
|
||||
## Namespaces
|
||||
|
||||
- [Steps\_Pricing](../core_flows.Steps_Pricing/page.mdx)
|
||||
- [Workflows\_Pricing](../core_flows.Workflows_Pricing/page.mdx)
|
||||
@@ -0,0 +1,8 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Return Reason
|
||||
|
||||
## Namespaces
|
||||
|
||||
- [Steps\_Return Reason](../core_flows.Steps_Return_Reason/page.mdx)
|
||||
- [Workflows\_Return Reason](../core_flows.Workflows_Return_Reason/page.mdx)
|
||||
Reference in new issue
Block a user