docs: [13/n] generate core-flows reference (#8794)
This commit is contained in:
1 parent
8553cd6427
commit
e30e9a0f2b
83 files changed
+1605
No files matched your search
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/listShippingOptionsForContextStep
|
||||
sidebar_label: listShippingOptionsForContextStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# listShippingOptionsForContextStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `listShippingOptionsForContextStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step retrieves shipping options that can be used in the specified context.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"ListShippingOptionsForContextStepInput","type":"[ListShippingOptionsForContextStepInput](../../../../interfaces/core_flows.ListShippingOptionsForContextStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"context","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../../../types/CommonTypes/interfaces/types.CommonTypes.FindConfig/page.mdx)<[ShippingOptionDTO](../../../../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listShippingOptionsForContextStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"ShippingOptionDTO[]","type":"[ShippingOptionDTO](../../../../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ShippingOptionDTO","type":"[ShippingOptionDTO](../../../../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The shipping option details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../../../fulfillment/types/fulfillment.ShippingOptionPriceType/page.mdx)","description":"The type of the shipping option's price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"The associated service zone's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"The associated shipping profile's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type_id","type":"`null` \\| `string`","description":"The associated shipping option type's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"The data necessary for the associated fulfillment provider to process the shipping option\nand, later, its associated fulfillments.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"[ServiceZoneDTO](../../../../../fulfillment/interfaces/fulfillment.ServiceZoneDTO/page.mdx)","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FulfillmentSetDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentSetDTO/page.mdx)","description":"The fulfillment set assoiated with the service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set_id","type":"`string`","description":"The fulfillment set id of the service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"[GeoZoneDTO](../../../../../fulfillment/interfaces/fulfillment.GeoZoneDTO/page.mdx)[]","description":"The geo zones assoiated with the service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"[ShippingOptionDTO](../../../../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)[]","description":"The shipping options assoiated with the service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The update date of the service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_profile","type":"[ShippingProfileDTO](../../../../../fulfillment/interfaces/fulfillment.ShippingProfileDTO/page.mdx)","description":"The associated shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"The type of the shipLine truncated
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# listShippingOptionsForContextStepId
|
||||
|
||||
`Const` **listShippingOptionsForContextStepId**: `"list-shipping-options-for-context"`
|
||||
+15
@@ -0,0 +1,15 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Steps\_Shipping Options
|
||||
|
||||
## listShippingOptionsForContextStep
|
||||
|
||||
This step retrieves shipping options that can be used in the specified context.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"ListShippingOptionsForContextStepInput","type":"[ListShippingOptionsForContextStepInput](../../interfaces/core_flows.ListShippingOptionsForContextStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"context","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../types/CommonTypes/interfaces/types.CommonTypes.FindConfig/page.mdx)<[ShippingOptionDTO](../../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listShippingOptionsForContextStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"ShippingOptionDTO[]","type":"[ShippingOptionDTO](../../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ShippingOptionDTO","type":"[ShippingOptionDTO](../../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The shipping option details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../fulfillment/types/fulfillment.ShippingOptionPriceType/page.mdx)","description":"The type of the shipping option's price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"The associated service zone's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"The associated shipping profile's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type_id","type":"`null` \\| `string`","description":"The associated shipping option type's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"The data necessary for the associated fulfillment provider to process the shipping option\nand, later, its associated fulfillments.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"[ServiceZoneDTO](../../../fulfillment/interfaces/fulfillment.ServiceZoneDTO/page.mdx)","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FulfillmentSetDTO](../../../fulfillment/interfaces/fulfillment.FulfillmentSetDTO/page.mdx)","description":"The fulfillment set assoiated with the service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set_id","type":"`string`","description":"The fulfillment set id of the service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"[GeoZoneDTO](../../../fulfillment/interfaces/fulfillment.GeoZoneDTO/page.mdx)[]","description":"The geo zones assoiated with the service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"[ShippingOptionDTO](../../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)[]","description":"The shipping options assoiated with the service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The update date of the service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_profile","type":"[ShippingProfileDTO](../../../fulfillment/interfaces/fulfillment.ShippingProfileDTO/page.mdx)","description":"The associated shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"The type of the shipping profile.","optional":false,"defaultValue":"Line truncated
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/deleteShippingProfilesStep
|
||||
sidebar_label: deleteShippingProfilesStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteShippingProfilesStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteShippingProfilesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step deletes one or more shipping profiles.
|
||||
|
||||
## 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="deleteShippingProfilesStep"/>
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteShippingProfilesStepId
|
||||
|
||||
`Const` **deleteShippingProfilesStepId**: `"delete-shipping-profile"`
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/deleteShippingProfileWorkflow
|
||||
sidebar_label: deleteShippingProfileWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteShippingProfileWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteShippingProfileWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow deletes one or more shipping profiles.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"deleteShippingProfileWorkflow","steps":[{"type":"step","name":"deleteShippingProfilesStep","description":"This step deletes one or more shipping profiles.","link":"../../../../core_flows.Steps_Shipping_Profile/page.mdx#deleteshippingprofilesstep","depth":1},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../../../core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":2}]}} />
|
||||
|
||||
## 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="deleteShippingProfileWorkflow"/>
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteShippingProfileWorkflowId
|
||||
|
||||
`Const` **deleteShippingProfileWorkflowId**: `"delete-shipping-profile-workflow"`
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Steps\_Shipping Profile
|
||||
|
||||
## deleteShippingProfilesStep
|
||||
|
||||
This step deletes one or more shipping profiles.
|
||||
|
||||
### 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="deleteShippingProfilesStep"/>
|
||||
+15
@@ -0,0 +1,15 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Workflows\_Shipping Profile
|
||||
|
||||
## deleteShippingProfileWorkflow
|
||||
|
||||
This workflow deletes one or more shipping profiles.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"deleteShippingProfileWorkflow","steps":[{"type":"step","name":"deleteShippingProfilesStep","description":"This step deletes one or more shipping profiles.","link":"../../core_flows.Steps_Shipping_Profile/page.mdx#deleteshippingprofilesstep","depth":1},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":2}]}} />
|
||||
|
||||
### 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="deleteShippingProfileWorkflow"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/createStockLocations
|
||||
sidebar_label: createStockLocations
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createStockLocations - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createStockLocations`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step creates one or more stock locations.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreateStockLocationInput[]","type":"[CreateStockLocationInput](../../../../../types/StockLocationTypes/types/types.StockLocationTypes.CreateStockLocationInput/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateStockLocationInput","type":"[CreateStockLocationInput](../../../../../types/StockLocationTypes/types/types.StockLocationTypes.CreateStockLocationInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string` \\| `null`","description":"The associated address's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"`string` \\| [StockLocationAddressInput](../../../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationAddressInput/page.mdx)","description":"The associated address.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"The first line of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| `null`","description":"The second line of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| `null`","description":"The city of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string` \\| `null`","description":"The phone of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string` \\| `null`","description":"The province of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string` \\| `null`","description":"The postal code of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../types/CommonTypes/types/types.CommonTypes.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"[MetadataType](../../../../../types/CommonTypes/types/types.CommonTypes.MetadataType/page.mdx)","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="createStockLocations"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"StockLocationDTO[]","type":"[StockLocationDTO](../../../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"StockLocationDTO","type":"[StockLocationDTO](../../../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"The associated address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"[FulfillmentSetDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentSetDTO/page.mdx)[]","description":"Fulfillment sets for the location","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"The type of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[ServiceZoneDTO](../../../../../fulfillment/interfaces/fulfillment.ServiceZoneDTO/page.mdx)[]","description":"The service zones associated with the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The update date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The deletion date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[StockLocationAddressDTO](../../../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationAddressDTO/page.mdx)","description":"The address of the stock location.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"The address 1 of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The deletion date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| `null`","description":"The address 2 of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| `null`","description":"The company of the stock location address.","optional":true,"defaultValue":"","expandable":false,"chilLine truncated
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/deleteStockLocationsStep
|
||||
sidebar_label: deleteStockLocationsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteStockLocationsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteStockLocationsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step deletes one or more stock locations.
|
||||
|
||||
## 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="deleteStockLocationsStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"DeleteEntityInput","type":"[DeleteEntityInput](../../../../../modules_sdk/types/modules_sdk.DeleteEntityInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"DeleteEntityInput","type":"`object`","description":"The details of a data model's record whose linked records should be deleted. Usually used after the\ndata model's record is deleted.\n\nThe key is the data model's name. Its value is an object that has the ID of the data model's record.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteStockLocationsStep"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/updateStockLocationsStep
|
||||
sidebar_label: updateStockLocationsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateStockLocationsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `updateStockLocationsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step updates stock locations matching the specified filters.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"StepInput","type":"`StepInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateStockLocationsStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"StockLocationDTO[]","type":"[StockLocationDTO](../../../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"StockLocationDTO","type":"[StockLocationDTO](../../../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"The associated address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"[FulfillmentSetDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentSetDTO/page.mdx)[]","description":"Fulfillment sets for the location","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"The type of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[ServiceZoneDTO](../../../../../fulfillment/interfaces/fulfillment.ServiceZoneDTO/page.mdx)[]","description":"The service zones associated with the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The update date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The deletion date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[StockLocationAddressDTO](../../../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationAddressDTO/page.mdx)","description":"The address of the stock location.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"The address 1 of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The deletion date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| `null`","description":"The address 2 of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| `null`","description":"The company of the stock location address.","optional":true,"defaultValue":"","expandable":false,"chilLine truncated
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createStockLocationsStepId
|
||||
|
||||
`Const` **createStockLocationsStepId**: `"create-stock-locations"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteStockLocationsStepId
|
||||
|
||||
`Const` **deleteStockLocationsStepId**: `"delete-stock-locations-step"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateStockLocationsStepId
|
||||
|
||||
`Const` **updateStockLocationsStepId**: `"update-stock-locations-step"`
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/createLocationFulfillmentSetWorkflow
|
||||
sidebar_label: createLocationFulfillmentSetWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createLocationFulfillmentSetWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createLocationFulfillmentSetWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow creates links between location and fulfillment set records.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createLocationFulfillmentSetWorkflow","steps":[{"type":"step","name":"createFulfillmentSets","description":"This step creates one or more fulfillment sets.","link":"../../../../core_flows.Steps_Fulfillment/page.mdx#createfulfillmentsets","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreateLocationFulfillmentSetWorkflowInputDTO","type":"[CreateLocationFulfillmentSetWorkflowInputDTO](../../../../../types/interfaces/types.CreateLocationFulfillmentSetWorkflowInputDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"location_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set_data","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","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="createLocationFulfillmentSetWorkflow"/>
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/createStockLocationsWorkflow
|
||||
sidebar_label: createStockLocationsWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createStockLocationsWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createStockLocationsWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow creates one or more stock locations.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createStockLocationsWorkflow","steps":[{"type":"step","name":"createStockLocations","description":"This step creates one or more stock locations.","link":"../../../../core_flows.Steps_Stock_Location/page.mdx#createstocklocations","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreateStockLocationsWorkflowInput","type":"[CreateStockLocationsWorkflowInput](../../../../interfaces/core_flows.CreateStockLocationsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"locations","type":"[CreateStockLocationInput](../../../../../types/StockLocationTypes/types/types.StockLocationTypes.CreateStockLocationInput/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string` \\| `null`","description":"The associated address's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"`string` \\| [StockLocationAddressInput](../../../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationAddressInput/page.mdx)","description":"The associated address.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"The first line of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| `null`","description":"The second line of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| `null`","description":"The city of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string` \\| `null`","description":"The phone of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string` \\| `null`","description":"The province of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string` \\| `null`","description":"The postal code of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../types/CommonTypes/types/types.CommonTypes.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"[MetadataType](../../../../../types/CommonTypes/types/types.CommonTypes.MetadataType/page.mdx)","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="createStockLocationsWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"StockLocationDTO[]","type":"[StockLocationDTO](../../../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"StockLocationDTO","type":"[StockLocationDTO](../../../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"The associated address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"[FulfillmentSetDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentSetDTO/page.mdx)[]","description":"Fulfillment sets for the location","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"The type of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[ServiceZoneDTO](../../../../../fulfillment/interfaces/fulfillment.ServiceZoneDTO/page.mdx)[]","description":"The service zones associated with the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The update date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The deletion date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[StockLocationAddressDTO](../../../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationAddressDTO/page.mdx)","description":"The address of the stock location.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"The address 1 of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The deletion date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| `null`","description":"The address 2 of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| `null`","description":"The company of the stock location address.","optional":true,"defaultValue":"","expandable":false,"chilLine truncated
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/deleteStockLocationsWorkflow
|
||||
sidebar_label: deleteStockLocationsWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteStockLocationsWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteStockLocationsWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow deletes one or more stock locations.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"deleteStockLocationsWorkflow","steps":[{"type":"step","name":"deleteStockLocationsStep","description":"This step deletes one or more stock locations.","link":"../../../../core_flows.Steps_Stock_Location/page.mdx#deletestocklocationsstep","depth":1},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../../../core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":2}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"DeleteStockLocationWorkflowInput","type":"[DeleteStockLocationWorkflowInput](../../../../interfaces/core_flows.DeleteStockLocationWorkflowInput/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="deleteStockLocationsWorkflow"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/linkSalesChannelsToStockLocationWorkflow
|
||||
sidebar_label: linkSalesChannelsToStockLocationWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# linkSalesChannelsToStockLocationWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `linkSalesChannelsToStockLocationWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow creates and dismisses links between location and sales channel records.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"linkSalesChannelsToStockLocationWorkflow","steps":[{"type":"step","name":"associateLocationsWithSalesChannelsStep","description":"This step creates links between locations and sales channel records.","link":"../../../../core_flows.Steps_Sales_Channel/page.mdx#associatelocationswithsaleschannelsstep","depth":1},{"type":"step","name":"detachLocationsFromSalesChannelsStep","description":"This step dismisses links between location and sales channel records.","link":"../../../../core_flows.Steps_Sales_Channel/page.mdx#detachlocationsfromsaleschannelsstep","depth":2}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"LinkWorkflowInput","type":"[LinkWorkflowInput](../../../../../types/CommonTypes/types/types.CommonTypes.LinkWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"add","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remove","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="linkSalesChannelsToStockLocationWorkflow"/>
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/updateStockLocationsWorkflow
|
||||
sidebar_label: updateStockLocationsWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateStockLocationsWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `updateStockLocationsWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow updates stock locations matching the specified filters.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"updateStockLocationsWorkflow","steps":[{"type":"step","name":"updateStockLocationsStep","description":"This step updates stock locations matching the specified filters.","link":"../../../../core_flows.Steps_Stock_Location/page.mdx#updatestocklocationsstep","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateStockLocationsWorkflowInput","type":"[UpdateStockLocationsWorkflowInput](../../../../interfaces/core_flows.UpdateStockLocationsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableStockLocationProps](../../../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStockLocationProps](../../../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[FilterableStockLocationProps](../../../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/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":"([FilterableStockLocationProps](../../../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[FilterableStockLocationProps](../../../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/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":"([FilterableStockLocationProps](../../../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[FilterableStockLocationProps](../../../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search parameter for stock location names","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter stock locations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"The names to filter stock locations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.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](../../../../../types/DAL/interfaces/types.DAL.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":"([FilterableStockLocationProps](../../../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[FilterableStockLocationProps](../../../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/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":"([FilterableStockLocationProps](../../../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[FilterableStockLocationProps](../../../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/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":"([FilterableStockLocationProps](../../../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/pagLine truncated
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"StockLocationDTO[]","type":"[StockLocationDTO](../../../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"StockLocationDTO","type":"[StockLocationDTO](../../../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"The associated address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"[FulfillmentSetDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentSetDTO/page.mdx)[]","description":"Fulfillment sets for the location","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"The type of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[ServiceZoneDTO](../../../../../fulfillment/interfaces/fulfillment.ServiceZoneDTO/page.mdx)[]","description":"The service zones associated with the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The update date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The deletion date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[StockLocationAddressDTO](../../../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationAddressDTO/page.mdx)","description":"The address of the stock location.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"The address 1 of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The deletion date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| `null`","description":"The address 2 of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| `null`","description":"The company of the stock location address.","optional":true,"defaultValue":"","expandable":false,"chilLine truncated
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createLocationFulfillmentSetWorkflowId
|
||||
|
||||
`Const` **createLocationFulfillmentSetWorkflowId**: `"create-location-fulfillment-set"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createStockLocationsWorkflowId
|
||||
|
||||
`Const` **createStockLocationsWorkflowId**: `"create-stock-locations-workflow"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteStockLocationsWorkflowId
|
||||
|
||||
`Const` **deleteStockLocationsWorkflowId**: `"delete-stock-locations-workflow"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# linkSalesChannelsToStockLocationWorkflowId
|
||||
|
||||
`Const` **linkSalesChannelsToStockLocationWorkflowId**: `"link-sales-channels-to-stock-location"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateStockLocationsWorkflowId
|
||||
|
||||
`Const` **updateStockLocationsWorkflowId**: `"update-stock-locations-workflow"`
|
||||
+43
@@ -0,0 +1,43 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Steps\_Stock Location
|
||||
|
||||
## createStockLocations
|
||||
|
||||
This step creates one or more stock locations.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreateStockLocationInput[]","type":"[CreateStockLocationInput](../../../types/StockLocationTypes/types/types.StockLocationTypes.CreateStockLocationInput/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateStockLocationInput","type":"[CreateStockLocationInput](../../../types/StockLocationTypes/types/types.StockLocationTypes.CreateStockLocationInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string` \\| `null`","description":"The associated address's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"`string` \\| [StockLocationAddressInput](../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationAddressInput/page.mdx)","description":"The associated address.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"The first line of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| `null`","description":"The second line of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| `null`","description":"The city of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string` \\| `null`","description":"The phone of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string` \\| `null`","description":"The province of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string` \\| `null`","description":"The postal code of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../types/CommonTypes/types/types.CommonTypes.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"[MetadataType](../../../types/CommonTypes/types/types.CommonTypes.MetadataType/page.mdx)","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="createStockLocations"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"StockLocationDTO[]","type":"[StockLocationDTO](../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"StockLocationDTO","type":"[StockLocationDTO](../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"The associated address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"[FulfillmentSetDTO](../../../fulfillment/interfaces/fulfillment.FulfillmentSetDTO/page.mdx)[]","description":"Fulfillment sets for the location","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"The type of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[ServiceZoneDTO](../../../fulfillment/interfaces/fulfillment.ServiceZoneDTO/page.mdx)[]","description":"The service zones associated with the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The update date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The deletion date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[StockLocationAddressDTO](../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationAddressDTO/page.mdx)","description":"The address of the stock location.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"The address 1 of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The deletion date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| `null`","description":"The address 2 of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| `null`","description":"The company of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","typeLine truncated
|
||||
|
||||
___
|
||||
|
||||
## deleteStockLocationsStep
|
||||
|
||||
This step deletes one or more stock locations.
|
||||
|
||||
### 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="deleteStockLocationsStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"DeleteEntityInput","type":"[DeleteEntityInput](../../../modules_sdk/types/modules_sdk.DeleteEntityInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"DeleteEntityInput","type":"`object`","description":"The details of a data model's record whose linked records should be deleted. Usually used after the\ndata model's record is deleted.\n\nThe key is the data model's name. Its value is an object that has the ID of the data model's record.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteStockLocationsStep"/>
|
||||
|
||||
___
|
||||
|
||||
## updateStockLocationsStep
|
||||
|
||||
This step updates stock locations matching the specified filters.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"StepInput","type":"`StepInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateStockLocationsStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"StockLocationDTO[]","type":"[StockLocationDTO](../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"StockLocationDTO","type":"[StockLocationDTO](../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"The associated address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"[FulfillmentSetDTO](../../../fulfillment/interfaces/fulfillment.FulfillmentSetDTO/page.mdx)[]","description":"Fulfillment sets for the location","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"The type of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[ServiceZoneDTO](../../../fulfillment/interfaces/fulfillment.ServiceZoneDTO/page.mdx)[]","description":"The service zones associated with the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The update date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The deletion date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[StockLocationAddressDTO](../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationAddressDTO/page.mdx)","description":"The address of the stock location.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"The address 1 of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The deletion date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| `null`","description":"The address 2 of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| `null`","description":"The company of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","typeLine truncated
|
||||
+79
@@ -0,0 +1,79 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Workflows\_Stock Location
|
||||
|
||||
## createLocationFulfillmentSetWorkflow
|
||||
|
||||
This workflow creates links between location and fulfillment set records.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createLocationFulfillmentSetWorkflow","steps":[{"type":"step","name":"createFulfillmentSets","description":"This step creates one or more fulfillment sets.","link":"../../core_flows.Steps_Fulfillment/page.mdx#createfulfillmentsets","depth":1}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreateLocationFulfillmentSetWorkflowInputDTO","type":"[CreateLocationFulfillmentSetWorkflowInputDTO](../../../types/interfaces/types.CreateLocationFulfillmentSetWorkflowInputDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"location_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set_data","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","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="createLocationFulfillmentSetWorkflow"/>
|
||||
|
||||
___
|
||||
|
||||
## createStockLocationsWorkflow
|
||||
|
||||
This workflow creates one or more stock locations.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createStockLocationsWorkflow","steps":[{"type":"step","name":"createStockLocations","description":"This step creates one or more stock locations.","link":"../../core_flows.Steps_Stock_Location/page.mdx#createstocklocations","depth":1}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreateStockLocationsWorkflowInput","type":"[CreateStockLocationsWorkflowInput](../../interfaces/core_flows.CreateStockLocationsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"locations","type":"[CreateStockLocationInput](../../../types/StockLocationTypes/types/types.StockLocationTypes.CreateStockLocationInput/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string` \\| `null`","description":"The associated address's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"`string` \\| [StockLocationAddressInput](../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationAddressInput/page.mdx)","description":"The associated address.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"The first line of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| `null`","description":"The second line of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| `null`","description":"The city of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string` \\| `null`","description":"The phone of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string` \\| `null`","description":"The province of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string` \\| `null`","description":"The postal code of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../types/CommonTypes/types/types.CommonTypes.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"[MetadataType](../../../types/CommonTypes/types/types.CommonTypes.MetadataType/page.mdx)","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="createStockLocationsWorkflow"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"StockLocationDTO[]","type":"[StockLocationDTO](../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"StockLocationDTO","type":"[StockLocationDTO](../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"The associated address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"[FulfillmentSetDTO](../../../fulfillment/interfaces/fulfillment.FulfillmentSetDTO/page.mdx)[]","description":"Fulfillment sets for the location","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"The type of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[ServiceZoneDTO](../../../fulfillment/interfaces/fulfillment.ServiceZoneDTO/page.mdx)[]","description":"The service zones associated with the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The update date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The deletion date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[StockLocationAddressDTO](../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationAddressDTO/page.mdx)","description":"The address of the stock location.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"The address 1 of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The deletion date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| `null`","description":"The address 2 of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| `null`","description":"The company of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","typeLine truncated
|
||||
|
||||
___
|
||||
|
||||
## deleteStockLocationsWorkflow
|
||||
|
||||
This workflow deletes one or more stock locations.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"deleteStockLocationsWorkflow","steps":[{"type":"step","name":"deleteStockLocationsStep","description":"This step deletes one or more stock locations.","link":"../../core_flows.Steps_Stock_Location/page.mdx#deletestocklocationsstep","depth":1},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":2}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"DeleteStockLocationWorkflowInput","type":"[DeleteStockLocationWorkflowInput](../../interfaces/core_flows.DeleteStockLocationWorkflowInput/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="deleteStockLocationsWorkflow"/>
|
||||
|
||||
___
|
||||
|
||||
## linkSalesChannelsToStockLocationWorkflow
|
||||
|
||||
This workflow creates and dismisses links between location and sales channel records.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"linkSalesChannelsToStockLocationWorkflow","steps":[{"type":"step","name":"associateLocationsWithSalesChannelsStep","description":"This step creates links between locations and sales channel records.","link":"../../core_flows.Steps_Sales_Channel/page.mdx#associatelocationswithsaleschannelsstep","depth":1},{"type":"step","name":"detachLocationsFromSalesChannelsStep","description":"This step dismisses links between location and sales channel records.","link":"../../core_flows.Steps_Sales_Channel/page.mdx#detachlocationsfromsaleschannelsstep","depth":2}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"LinkWorkflowInput","type":"[LinkWorkflowInput](../../../types/CommonTypes/types/types.CommonTypes.LinkWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"add","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remove","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="linkSalesChannelsToStockLocationWorkflow"/>
|
||||
|
||||
___
|
||||
|
||||
## updateStockLocationsWorkflow
|
||||
|
||||
This workflow updates stock locations matching the specified filters.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"updateStockLocationsWorkflow","steps":[{"type":"step","name":"updateStockLocationsStep","description":"This step updates stock locations matching the specified filters.","link":"../../core_flows.Steps_Stock_Location/page.mdx#updatestocklocationsstep","depth":1}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateStockLocationsWorkflowInput","type":"[UpdateStockLocationsWorkflowInput](../../interfaces/core_flows.UpdateStockLocationsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableStockLocationProps](../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStockLocationProps](../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[FilterableStockLocationProps](../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/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":"([FilterableStockLocationProps](../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[FilterableStockLocationProps](../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/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":"([FilterableStockLocationProps](../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[FilterableStockLocationProps](../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search parameter for stock location names","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter stock locations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"The names to filter stock locations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../types/DAL/interfaces/types.DAL.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](../../../types/DAL/interfaces/types.DAL.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":"([FilterableStockLocationProps](../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[FilterableStockLocationProps](../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/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":"([FilterableStockLocationProps](../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[FilterableStockLocationProps](../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/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":"([FilterableStockLocationProps](../../../types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationProps/page.mdx) \\| [BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[FilterableStockLocationPropsLine truncated
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"StockLocationDTO[]","type":"[StockLocationDTO](../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"StockLocationDTO","type":"[StockLocationDTO](../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"The associated address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"[FulfillmentSetDTO](../../../fulfillment/interfaces/fulfillment.FulfillmentSetDTO/page.mdx)[]","description":"Fulfillment sets for the location","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"The type of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[ServiceZoneDTO](../../../fulfillment/interfaces/fulfillment.ServiceZoneDTO/page.mdx)[]","description":"The service zones associated with the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The update date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The deletion date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[StockLocationAddressDTO](../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationAddressDTO/page.mdx)","description":"The address of the stock location.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"The address 1 of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The deletion date of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| `null`","description":"The address 2 of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| `null`","description":"The company of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","typeLine truncated
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/createStoresStep
|
||||
sidebar_label: createStoresStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createStoresStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createStoresStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step creates one or more stores.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreateStoreDTO[]","type":"[CreateStoreDTO](../../../../../store/interfaces/store.CreateStoreDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateStoreDTO","type":"[CreateStoreDTO](../../../../../store/interfaces/store.CreateStoreDTO/page.mdx)","optional":false,"defaultValue":"","description":"The store to be created.","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the store.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"supported_currencies","type":"[CreateStoreCurrencyDTO](../../../../../store/interfaces/store.CreateStoreCurrencyDTO/page.mdx)[]","description":"The supported currency codes of the store.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string`","description":"The currency code of the store currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the currency is the default one for the store.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"default_sales_channel_id","type":"`string`","description":"The associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_region_id","type":"`string`","description":"The associated default region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_location_id","type":"`string`","description":"The associated default location's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, any>`","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="createStoresStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"StoreDTO[]","type":"[StoreDTO](../../../../../store/interfaces/store.StoreDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"StoreDTO","type":"[StoreDTO](../../../../../store/interfaces/store.StoreDTO/page.mdx)","optional":false,"defaultValue":"","description":"The store details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, any>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created at of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated at of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"supported_currencies","type":"[StoreCurrencyDTO](../../../../../store/interfaces/store.StoreCurrencyDTO/page.mdx)[]","description":"The supported currency codes of the store.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the store currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the store currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the currency is the default one for the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"store_id","type":"`string`","description":"The store ID associated with the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The deleted date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"default_sales_channel_id","type":"`string`","description":"The associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_region_id","type":"`string`","description":"The associated default region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_location_id","type":"`string`","description":"The associated default location's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createStoresStep"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/deleteStoresStep
|
||||
sidebar_label: deleteStoresStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteStoresStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteStoresStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step deletes one or more stores.
|
||||
|
||||
## 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="deleteStoresStep"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/updateStoresStep
|
||||
sidebar_label: updateStoresStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateStoresStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `updateStoresStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step updates stores matching the specified filters.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateStoresStepInput","type":"[UpdateStoresStepInput](../../../../types/core_flows.UpdateStoresStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableStoreProps](../../../../../store/interfaces/store.FilterableStoreProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../../../store/interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../../../store/interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../../../store/interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../../../store/interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../../../store/interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../../../store/interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../../../store/interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../../../store/interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../../../store/interfaces/store.FilterableStoreProps/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 stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../store/interfaces/store.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](../../../../../store/interfaces/store.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":"([FilterableStoreProps](../../../../../store/interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../../../store/interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../../../store/interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../../../store/interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../../../store/interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../../../store/interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../../../store/interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../../../store/interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../../../store/interfaces/store.FilterableStoreProps/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 stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":Line truncated
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"StoreDTO[]","type":"[StoreDTO](../../../../../store/interfaces/store.StoreDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"StoreDTO","type":"[StoreDTO](../../../../../store/interfaces/store.StoreDTO/page.mdx)","optional":false,"defaultValue":"","description":"The store details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, any>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created at of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated at of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"supported_currencies","type":"[StoreCurrencyDTO](../../../../../store/interfaces/store.StoreCurrencyDTO/page.mdx)[]","description":"The supported currency codes of the store.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the store currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the store currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the currency is the default one for the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"store_id","type":"`string`","description":"The store ID associated with the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The deleted date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"default_sales_channel_id","type":"`string`","description":"The associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_region_id","type":"`string`","description":"The associated default region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_location_id","type":"`string`","description":"The associated default location's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateStoresStep"/>
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createStoresStepId
|
||||
|
||||
`Const` **createStoresStepId**: `"create-stores"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteStoresStepId
|
||||
|
||||
`Const` **deleteStoresStepId**: `"delete-stores"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateStoresStepId
|
||||
|
||||
`Const` **updateStoresStepId**: `"update-stores"`
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/createStoresWorkflow
|
||||
sidebar_label: createStoresWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createStoresWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createStoresWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow creates one or more stores.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createStoresWorkflow","steps":[{"type":"step","name":"createStoresStep","description":"This step creates one or more stores.","link":"../../../../core_flows.Steps_Store/page.mdx#createstoresstep","depth":1},{"type":"step","name":"updatePricePreferencesAsArrayStep","description":"This step updates price preferences.","link":"../../../../core_flows.Steps_Pricing/page.mdx#updatepricepreferencesasarraystep","depth":2}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreateStoresWorkflowInput","type":"`CreateStoresWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createStoresWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"StoreDTO[]","type":"[StoreDTO](../../../../../store/interfaces/store.StoreDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"StoreDTO","type":"[StoreDTO](../../../../../store/interfaces/store.StoreDTO/page.mdx)","optional":false,"defaultValue":"","description":"The store details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, any>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created at of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated at of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"supported_currencies","type":"[StoreCurrencyDTO](../../../../../store/interfaces/store.StoreCurrencyDTO/page.mdx)[]","description":"The supported currency codes of the store.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the store currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the store currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the currency is the default one for the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"store_id","type":"`string`","description":"The store ID associated with the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The deleted date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"default_sales_channel_id","type":"`string`","description":"The associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_region_id","type":"`string`","description":"The associated default region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_location_id","type":"`string`","description":"The associated default location's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createStoresWorkflow"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/deleteStoresWorkflow
|
||||
sidebar_label: deleteStoresWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteStoresWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteStoresWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow deletes one or more stores.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"deleteStoresWorkflow","steps":[{"type":"step","name":"deleteStoresStep","description":"This step deletes one or more stores.","link":"../../../../core_flows.Steps_Store/page.mdx#deletestoresstep","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"DeleteStoresWorkflowInput","type":"[DeleteStoresWorkflowInput](../../../../types/core_flows.DeleteStoresWorkflowInput/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="deleteStoresWorkflow"/>
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/updateStoresWorkflow
|
||||
sidebar_label: updateStoresWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateStoresWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `updateStoresWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow updates stores matching the specified filters.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"updateStoresWorkflow","steps":[{"type":"step","name":"updateStoresStep","description":"This step updates stores matching the specified filters.","link":"../../../../core_flows.Steps_Store/page.mdx#updatestoresstep","depth":1},{"type":"when","condition":"{\n return !!data.input.update.supported_currencies?.length\n }","depth":"2","steps":[{"type":"step","name":"updatePricePreferencesAsArrayStep","description":"This step updates price preferences.","link":"../../../../core_flows.Steps_Pricing/page.mdx#updatepricepreferencesasarraystep","depth":2}]}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateStoreWorkflowInput","type":"`UpdateStoreWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateStoresWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"StoreDTO[]","type":"[StoreDTO](../../../../../store/interfaces/store.StoreDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"StoreDTO","type":"[StoreDTO](../../../../../store/interfaces/store.StoreDTO/page.mdx)","optional":false,"defaultValue":"","description":"The store details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, any>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created at of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated at of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"supported_currencies","type":"[StoreCurrencyDTO](../../../../../store/interfaces/store.StoreCurrencyDTO/page.mdx)[]","description":"The supported currency codes of the store.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the store currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the store currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the currency is the default one for the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"store_id","type":"`string`","description":"The store ID associated with the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The deleted date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"default_sales_channel_id","type":"`string`","description":"The associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_region_id","type":"`string`","description":"The associated default region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_location_id","type":"`string`","description":"The associated default location's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateStoresWorkflow"/>
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createStoresWorkflowId
|
||||
|
||||
`Const` **createStoresWorkflowId**: `"create-stores"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteStoresWorkflowId
|
||||
|
||||
`Const` **deleteStoresWorkflowId**: `"delete-stores"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateStoresWorkflowId
|
||||
|
||||
`Const` **updateStoresWorkflowId**: `"update-stores"`
|
||||
@@ -0,0 +1,39 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Steps\_Store
|
||||
|
||||
## createStoresStep
|
||||
|
||||
This step creates one or more stores.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreateStoreDTO[]","type":"[CreateStoreDTO](../../../store/interfaces/store.CreateStoreDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateStoreDTO","type":"[CreateStoreDTO](../../../store/interfaces/store.CreateStoreDTO/page.mdx)","optional":false,"defaultValue":"","description":"The store to be created.","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the store.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"supported_currencies","type":"[CreateStoreCurrencyDTO](../../../store/interfaces/store.CreateStoreCurrencyDTO/page.mdx)[]","description":"The supported currency codes of the store.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string`","description":"The currency code of the store currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the currency is the default one for the store.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"default_sales_channel_id","type":"`string`","description":"The associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_region_id","type":"`string`","description":"The associated default region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_location_id","type":"`string`","description":"The associated default location's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, any>`","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="createStoresStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"StoreDTO[]","type":"[StoreDTO](../../../store/interfaces/store.StoreDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"StoreDTO","type":"[StoreDTO](../../../store/interfaces/store.StoreDTO/page.mdx)","optional":false,"defaultValue":"","description":"The store details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, any>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created at of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated at of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"supported_currencies","type":"[StoreCurrencyDTO](../../../store/interfaces/store.StoreCurrencyDTO/page.mdx)[]","description":"The supported currency codes of the store.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the store currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the store currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the currency is the default one for the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"store_id","type":"`string`","description":"The store ID associated with the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The deleted date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"default_sales_channel_id","type":"`string`","description":"The associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_region_id","type":"`string`","description":"The associated default region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_location_id","type":"`string`","description":"The associated default location's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createStoresStep"/>
|
||||
|
||||
___
|
||||
|
||||
## deleteStoresStep
|
||||
|
||||
This step deletes one or more stores.
|
||||
|
||||
### 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="deleteStoresStep"/>
|
||||
|
||||
___
|
||||
|
||||
## updateStoresStep
|
||||
|
||||
This step updates stores matching the specified filters.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateStoresStepInput","type":"[UpdateStoresStepInput](../../types/core_flows.UpdateStoresStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableStoreProps](../../../store/interfaces/store.FilterableStoreProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../store/interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../store/interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../store/interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../store/interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../store/interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../store/interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../store/interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../store/interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../store/interfaces/store.FilterableStoreProps/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 stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../store/interfaces/store.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](../../../store/interfaces/store.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":"([FilterableStoreProps](../../../store/interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../store/interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../store/interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../store/interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../store/interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../store/interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../store/interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../store/interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../store/interfaces/store.FilterableStoreProps/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 stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../store/interfaces/store.BaseFilterable/page.mdx)<T> \\Line truncated
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"StoreDTO[]","type":"[StoreDTO](../../../store/interfaces/store.StoreDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"StoreDTO","type":"[StoreDTO](../../../store/interfaces/store.StoreDTO/page.mdx)","optional":false,"defaultValue":"","description":"The store details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, any>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created at of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated at of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"supported_currencies","type":"[StoreCurrencyDTO](../../../store/interfaces/store.StoreCurrencyDTO/page.mdx)[]","description":"The supported currency codes of the store.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the store currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the store currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the currency is the default one for the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"store_id","type":"`string`","description":"The store ID associated with the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The deleted date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"default_sales_channel_id","type":"`string`","description":"The associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_region_id","type":"`string`","description":"The associated default region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_location_id","type":"`string`","description":"The associated default location's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateStoresStep"/>
|
||||
+51
@@ -0,0 +1,51 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Workflows\_Store
|
||||
|
||||
## createStoresWorkflow
|
||||
|
||||
This workflow creates one or more stores.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createStoresWorkflow","steps":[{"type":"step","name":"createStoresStep","description":"This step creates one or more stores.","link":"../../core_flows.Steps_Store/page.mdx#createstoresstep","depth":1},{"type":"step","name":"updatePricePreferencesAsArrayStep","description":"This step updates price preferences.","link":"../../core_flows.Steps_Pricing/page.mdx#updatepricepreferencesasarraystep","depth":2}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreateStoresWorkflowInput","type":"`CreateStoresWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createStoresWorkflow"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"StoreDTO[]","type":"[StoreDTO](../../../store/interfaces/store.StoreDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"StoreDTO","type":"[StoreDTO](../../../store/interfaces/store.StoreDTO/page.mdx)","optional":false,"defaultValue":"","description":"The store details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, any>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created at of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated at of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"supported_currencies","type":"[StoreCurrencyDTO](../../../store/interfaces/store.StoreCurrencyDTO/page.mdx)[]","description":"The supported currency codes of the store.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the store currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the store currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the currency is the default one for the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"store_id","type":"`string`","description":"The store ID associated with the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The deleted date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"default_sales_channel_id","type":"`string`","description":"The associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_region_id","type":"`string`","description":"The associated default region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_location_id","type":"`string`","description":"The associated default location's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createStoresWorkflow"/>
|
||||
|
||||
___
|
||||
|
||||
## deleteStoresWorkflow
|
||||
|
||||
This workflow deletes one or more stores.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"deleteStoresWorkflow","steps":[{"type":"step","name":"deleteStoresStep","description":"This step deletes one or more stores.","link":"../../core_flows.Steps_Store/page.mdx#deletestoresstep","depth":1}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"DeleteStoresWorkflowInput","type":"[DeleteStoresWorkflowInput](../../types/core_flows.DeleteStoresWorkflowInput/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="deleteStoresWorkflow"/>
|
||||
|
||||
___
|
||||
|
||||
## updateStoresWorkflow
|
||||
|
||||
This workflow updates stores matching the specified filters.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"updateStoresWorkflow","steps":[{"type":"step","name":"updateStoresStep","description":"This step updates stores matching the specified filters.","link":"../../core_flows.Steps_Store/page.mdx#updatestoresstep","depth":1},{"type":"when","condition":"{\n return !!data.input.update.supported_currencies?.length\n }","depth":"2","steps":[{"type":"step","name":"updatePricePreferencesAsArrayStep","description":"This step updates price preferences.","link":"../../core_flows.Steps_Pricing/page.mdx#updatepricepreferencesasarraystep","depth":2}]}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateStoreWorkflowInput","type":"`UpdateStoreWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateStoresWorkflow"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"StoreDTO[]","type":"[StoreDTO](../../../store/interfaces/store.StoreDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"StoreDTO","type":"[StoreDTO](../../../store/interfaces/store.StoreDTO/page.mdx)","optional":false,"defaultValue":"","description":"The store details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, any>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created at of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated at of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"supported_currencies","type":"[StoreCurrencyDTO](../../../store/interfaces/store.StoreCurrencyDTO/page.mdx)[]","description":"The supported currency codes of the store.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the store currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the store currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the currency is the default one for the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"store_id","type":"`string`","description":"The store ID associated with the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The deleted date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"default_sales_channel_id","type":"`string`","description":"The associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_region_id","type":"`string`","description":"The associated default region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_location_id","type":"`string`","description":"The associated default location's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateStoresWorkflow"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/createTaxRateRulesStep
|
||||
sidebar_label: createTaxRateRulesStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createTaxRateRulesStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createTaxRateRulesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step creates one or more tax rate rules.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreateTaxRateRuleDTO[]","type":"[CreateTaxRateRuleDTO](../../../../../tax/interfaces/tax.CreateTaxRateRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateTaxRateRuleDTO","type":"[CreateTaxRateRuleDTO](../../../../../tax/interfaces/tax.CreateTaxRateRuleDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate rule to be created.","expandable":false,"children":[{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the\nuser that created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRateRulesStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateRuleDTO[]","type":"[TaxRateRuleDTO](../../../../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateRuleDTO","type":"[TaxRateRuleDTO](../../../../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate rule details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the user\nthat created the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"[TaxRateDTO](../../../../../tax/interfaces/tax.TaxRateDTO/page.mdx)","description":"The associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"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="createTaxRateRulesStep"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/createTaxRatesStep
|
||||
sidebar_label: createTaxRatesStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createTaxRatesStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createTaxRatesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step creates one or more tax rates.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreateTaxRateDTO[]","type":"[CreateTaxRateDTO](../../../../../tax/interfaces/tax.CreateTaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateTaxRateDTO","type":"[CreateTaxRateDTO](../../../../../tax/interfaces/tax.CreateTaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate to be created.","expandable":false,"children":[{"name":"tax_region_id","type":"`string`","description":"The associated tax region's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"Omit<[CreateTaxRateRuleDTO](../../../../../tax/interfaces/tax.CreateTaxRateRuleDTO/page.mdx), \"tax_rate_id\">[]","description":"The rules of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the\nuser that created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is default.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the tax rate. For example, the ID of the user\nthat created the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../tax/types/tax.MetadataType/page.mdx)","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="createTaxRatesStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateDTO[]","type":"[TaxRateDTO](../../../../../tax/interfaces/tax.TaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateDTO","type":"[TaxRateDTO](../../../../../tax/interfaces/tax.TaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRatesStep"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/createTaxRegionsStep
|
||||
sidebar_label: createTaxRegionsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createTaxRegionsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createTaxRegionsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step creates one or more tax regions.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreateTaxRegionDTO[]","type":"[CreateTaxRegionDTO](../../../../../tax/interfaces/tax.CreateTaxRegionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateTaxRegionDTO","type":"[CreateTaxRegionDTO](../../../../../tax/interfaces/tax.CreateTaxRegionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax region to be created.","expandable":false,"children":[{"name":"country_code","type":"`string`","description":"The ISO 3 character country code of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"The province code of the tax region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`null` \\| `string`","description":"The ID of the tax region's parent.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the tax region. For example, the ID of\nthe user that created the tax region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_tax_rate","type":"`object`","description":"The default tax rate of the tax region.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../tax/types/tax.MetadataType/page.mdx)","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="createTaxRegionsStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRegionDTO[]","type":"[TaxRegionDTO](../../../../../tax/interfaces/tax.TaxRegionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRegionDTO","type":"[TaxRegionDTO](../../../../../tax/interfaces/tax.TaxRegionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax region details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The ISO 2 character country code of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"The province code of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`null` \\| `string`","description":"The ID of the tax region's parent tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax region. For example, the ID of the user\nthat created the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRegionsStep"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/deleteTaxRateRulesStep
|
||||
sidebar_label: deleteTaxRateRulesStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteTaxRateRulesStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteTaxRateRulesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step deletes one or more tax rate rules.
|
||||
|
||||
## 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="deleteTaxRateRulesStep"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/deleteTaxRatesStep
|
||||
sidebar_label: deleteTaxRatesStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteTaxRatesStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteTaxRatesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step deletes one or more tax rates.
|
||||
|
||||
## 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="deleteTaxRatesStep"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/deleteTaxRegionsStep
|
||||
sidebar_label: deleteTaxRegionsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteTaxRegionsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteTaxRegionsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step deletes one or more tax regions.
|
||||
|
||||
## 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="deleteTaxRegionsStep"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/listTaxRateIdsStep
|
||||
sidebar_label: listTaxRateIdsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# listTaxRateIdsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `listTaxRateIdsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step retrieves the IDs of tax rates matching the specified filters.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"ListTaxRateIdsStepInput","type":"[ListTaxRateIdsStepInput](../../../../types/core_flows.ListTaxRateIdsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/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 tax rates based on name and code properties through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax rates by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string` \\| `string`[]","description":"Filter the tax rates by their associated tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| [OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<number> \\| `number`[]","description":"Filter the tax rates by their rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../tax/interfaces/tax.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](../../../../../tax/interfaces/tax.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":"([FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with Line truncated
|
||||
|
||||
## 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="listTaxRateIdsStep"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/listTaxRateRuleIdsStep
|
||||
sidebar_label: listTaxRateRuleIdsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# listTaxRateRuleIdsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `listTaxRateRuleIdsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step retrieves the IDs of tax rate rules matching the specified filters.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"ListTaxRateRuleIdsStepInput","type":"[ListTaxRateRuleIdsStepInput](../../../../types/core_flows.ListTaxRateRuleIdsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableTaxRateRuleProps](../../../../../tax/interfaces/tax.FilterableTaxRateRuleProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateRuleProps](../../../../../tax/interfaces/tax.FilterableTaxRateRuleProps/page.mdx) \\| [BaseFilterable](../../../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](../../../../../tax/interfaces/tax.FilterableTaxRateRuleProps/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":"([FilterableTaxRateRuleProps](../../../../../tax/interfaces/tax.FilterableTaxRateRuleProps/page.mdx) \\| [BaseFilterable](../../../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](../../../../../tax/interfaces/tax.FilterableTaxRateRuleProps/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":"([FilterableTaxRateRuleProps](../../../../../tax/interfaces/tax.FilterableTaxRateRuleProps/page.mdx) \\| [BaseFilterable](../../../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](../../../../../tax/interfaces/tax.FilterableTaxRateRuleProps/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":"reference","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by what it references.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by the ID of the record it references.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by the ID of their associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"[FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"Filter the tax rate rule by their associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| [OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<Record<string, unknown>> \\| `Record<string, unknown>`[]","description":"Filter the tax rate rule by what its metadata.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by its creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by its update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../tax/interfaces/tax.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](../../../../../tax/interfaces/tax.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":"([FilterableTaxRateRuleProps](../../../../../tax/interfaces/tax.FilterableTaxRateRuleProps/page.mdx) \\| [BaseFilterable](../../../../../tax/interfaces/tax.BaseFilterable/page.mdx)Line truncated
|
||||
|
||||
## 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="listTaxRateRuleIdsStep"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/updateTaxRatesStep
|
||||
sidebar_label: updateTaxRatesStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateTaxRatesStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `updateTaxRatesStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step updates tax rates matching the specified filters.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateTaxRatesStepInput","type":"[UpdateTaxRatesStepInput](../../../../types/core_flows.UpdateTaxRatesStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/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 tax rates based on name and code properties through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax rates by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string` \\| `string`[]","description":"Filter the tax rates by their associated tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| [OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<number> \\| `number`[]","description":"Filter the tax rates by their rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../tax/interfaces/tax.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](../../../../../tax/interfaces/tax.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":"([FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with Line truncated
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateDTO[]","type":"[TaxRateDTO](../../../../../tax/interfaces/tax.TaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateDTO","type":"[TaxRateDTO](../../../../../tax/interfaces/tax.TaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateTaxRatesStep"/>
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createTaxRateRulesStepId
|
||||
|
||||
`Const` **createTaxRateRulesStepId**: `"create-tax-rate-rules"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createTaxRatesStepId
|
||||
|
||||
`Const` **createTaxRatesStepId**: `"create-tax-rates"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createTaxRegionsStepId
|
||||
|
||||
`Const` **createTaxRegionsStepId**: `"create-tax-regions"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteTaxRateRulesStepId
|
||||
|
||||
`Const` **deleteTaxRateRulesStepId**: `"delete-tax-rate-rules"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteTaxRatesStepId
|
||||
|
||||
`Const` **deleteTaxRatesStepId**: `"delete-tax-rates"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteTaxRegionsStepId
|
||||
|
||||
`Const` **deleteTaxRegionsStepId**: `"delete-tax-regions"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# listTaxRateIdsStepId
|
||||
|
||||
`Const` **listTaxRateIdsStepId**: `"list-tax-rate-ids"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# listTaxRateRuleIdsStepId
|
||||
|
||||
`Const` **listTaxRateRuleIdsStepId**: `"list-tax-rate-rule-ids"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateTaxRatesStepId
|
||||
|
||||
`Const` **updateTaxRatesStepId**: `"update-tax-rates"`
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/createTaxRateRulesWorkflow
|
||||
sidebar_label: createTaxRateRulesWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createTaxRateRulesWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createTaxRateRulesWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow creates one or more tax rate rules.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createTaxRateRulesWorkflow","steps":[{"type":"step","name":"createTaxRateRulesStep","description":"This step creates one or more tax rate rules.","link":"../../../../core_flows.Steps_Tax/page.mdx#createtaxraterulesstep","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreateTaxRateRulesWorkflowInput","type":"[CreateTaxRateRulesWorkflowInput](../../../../types/core_flows.CreateTaxRateRulesWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"rules","type":"[CreateTaxRateRuleDTO](../../../../../tax/interfaces/tax.CreateTaxRateRuleDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the\nuser that created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRateRulesWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateRuleDTO[]","type":"[TaxRateRuleDTO](../../../../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateRuleDTO","type":"[TaxRateRuleDTO](../../../../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate rule details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the user\nthat created the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"[TaxRateDTO](../../../../../tax/interfaces/tax.TaxRateDTO/page.mdx)","description":"The associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"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="createTaxRateRulesWorkflow"/>
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/createTaxRatesWorkflow
|
||||
sidebar_label: createTaxRatesWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createTaxRatesWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createTaxRatesWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow creates one or more tax rates.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createTaxRatesWorkflow","steps":[{"type":"step","name":"createTaxRatesStep","description":"This step creates one or more tax rates.","link":"../../../../core_flows.Steps_Tax/page.mdx#createtaxratesstep","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreateTaxRateDTO[]","type":"[CreateTaxRateDTO](../../../../../tax/interfaces/tax.CreateTaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateTaxRateDTO","type":"[CreateTaxRateDTO](../../../../../tax/interfaces/tax.CreateTaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate to be created.","expandable":false,"children":[{"name":"tax_region_id","type":"`string`","description":"The associated tax region's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"Omit<[CreateTaxRateRuleDTO](../../../../../tax/interfaces/tax.CreateTaxRateRuleDTO/page.mdx), \"tax_rate_id\">[]","description":"The rules of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the\nuser that created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is default.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the tax rate. For example, the ID of the user\nthat created the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../tax/types/tax.MetadataType/page.mdx)","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="createTaxRatesWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateDTO[]","type":"[TaxRateDTO](../../../../../tax/interfaces/tax.TaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateDTO","type":"[TaxRateDTO](../../../../../tax/interfaces/tax.TaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRatesWorkflow"/>
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/createTaxRegionsWorkflow
|
||||
sidebar_label: createTaxRegionsWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createTaxRegionsWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createTaxRegionsWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow creates one or more tax regions.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createTaxRegionsWorkflow","steps":[{"type":"step","name":"createTaxRegionsStep","description":"This step creates one or more tax regions.","link":"../../../../core_flows.Steps_Tax/page.mdx#createtaxregionsstep","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreateTaxRegionDTO[]","type":"[CreateTaxRegionDTO](../../../../../tax/interfaces/tax.CreateTaxRegionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateTaxRegionDTO","type":"[CreateTaxRegionDTO](../../../../../tax/interfaces/tax.CreateTaxRegionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax region to be created.","expandable":false,"children":[{"name":"country_code","type":"`string`","description":"The ISO 3 character country code of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"The province code of the tax region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`null` \\| `string`","description":"The ID of the tax region's parent.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the tax region. For example, the ID of\nthe user that created the tax region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_tax_rate","type":"`object`","description":"The default tax rate of the tax region.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../tax/types/tax.MetadataType/page.mdx)","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="createTaxRegionsWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRegionDTO[]","type":"[TaxRegionDTO](../../../../../tax/interfaces/tax.TaxRegionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRegionDTO","type":"[TaxRegionDTO](../../../../../tax/interfaces/tax.TaxRegionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax region details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The ISO 2 character country code of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"The province code of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`null` \\| `string`","description":"The ID of the tax region's parent tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax region. For example, the ID of the user\nthat created the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRegionsWorkflow"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/deleteTaxRateRulesWorkflow
|
||||
sidebar_label: deleteTaxRateRulesWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteTaxRateRulesWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteTaxRateRulesWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow deletes one or more tax rate rules.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"deleteTaxRateRulesWorkflow","steps":[{"type":"step","name":"deleteTaxRateRulesStep","description":"This step deletes one or more tax rate rules.","link":"../../../../core_flows.Steps_Tax/page.mdx#deletetaxraterulesstep","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"DeleteTaxRateRulesWorkflowInput","type":"[DeleteTaxRateRulesWorkflowInput](../../../../types/core_flows.DeleteTaxRateRulesWorkflowInput/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="deleteTaxRateRulesWorkflow"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/deleteTaxRatesWorkflow
|
||||
sidebar_label: deleteTaxRatesWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteTaxRatesWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteTaxRatesWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow deletes one or more tax rates.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"deleteTaxRatesWorkflow","steps":[{"type":"step","name":"deleteTaxRatesStep","description":"This step deletes one or more tax rates.","link":"../../../../core_flows.Steps_Tax/page.mdx#deletetaxratesstep","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"DeleteTaxRatesWorkflowInput","type":"[DeleteTaxRatesWorkflowInput](../../../../types/core_flows.DeleteTaxRatesWorkflowInput/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="deleteTaxRatesWorkflow"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/deleteTaxRegionsWorkflow
|
||||
sidebar_label: deleteTaxRegionsWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteTaxRegionsWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteTaxRegionsWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow deletes one or more tax regions.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"deleteTaxRegionsWorkflow","steps":[{"type":"step","name":"deleteTaxRegionsStep","description":"This step deletes one or more tax regions.","link":"../../../../core_flows.Steps_Tax/page.mdx#deletetaxregionsstep","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"DeleteTaxRegionsWorkflowInput","type":"[DeleteTaxRegionsWorkflowInput](../../../../types/core_flows.DeleteTaxRegionsWorkflowInput/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="deleteTaxRegionsWorkflow"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/maybeListTaxRateRuleIdsStep
|
||||
sidebar_label: maybeListTaxRateRuleIdsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# maybeListTaxRateRuleIdsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `maybeListTaxRateRuleIdsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step lists the rules to update in a tax rate update object.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"MaybeListTaxRateRuleIdsStepInput","type":"[MaybeListTaxRateRuleIdsStepInput](../../../../types/core_flows.MaybeListTaxRateRuleIdsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"tax_rate_ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"update","type":"[UpdateTaxRateDTO](../../../../../tax/interfaces/tax.UpdateTaxRateDTO/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"Omit<[CreateTaxRateRuleDTO](../../../../../tax/interfaces/tax.CreateTaxRateRuleDTO/page.mdx), \"tax_rate_id\">[]","description":"The rules of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the\nuser that created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is default.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate is combinable.\n\nLearn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../tax/types/tax.MetadataType/page.mdx)","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="maybeListTaxRateRuleIdsStep"/>
|
||||
|
||||
## 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="maybeListTaxRateRuleIdsStep"/>
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/setTaxRateRulesWorkflow
|
||||
sidebar_label: setTaxRateRulesWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# setTaxRateRulesWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `setTaxRateRulesWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow sets the rules of tax rates.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"setTaxRateRulesWorkflow","steps":[{"type":"step","name":"listTaxRateRuleIdsStep","description":"This step retrieves the IDs of tax rate rules matching the specified filters.","link":"../../../../core_flows.Steps_Tax/page.mdx#listtaxrateruleidsstep","depth":1},{"type":"step","name":"deleteTaxRateRulesStep","description":"This step deletes one or more tax rate rules.","link":"../../../../core_flows.Steps_Tax/page.mdx#deletetaxraterulesstep","depth":2},{"type":"step","name":"createTaxRateRulesStep","description":"This step creates one or more tax rate rules.","link":"../../../../core_flows.Steps_Tax/page.mdx#createtaxraterulesstep","depth":3}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"SetTaxRatesRulesWorkflowInput","type":"[SetTaxRatesRulesWorkflowInput](../../../../types/core_flows.SetTaxRatesRulesWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"tax_rate_ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"Omit<[CreateTaxRateRuleDTO](../../../../../tax/interfaces/tax.CreateTaxRateRuleDTO/page.mdx), \"tax_rate_id\">[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the\nuser that created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="setTaxRateRulesWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateRuleDTO[]","type":"[TaxRateRuleDTO](../../../../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateRuleDTO","type":"[TaxRateRuleDTO](../../../../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate rule details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the user\nthat created the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"[TaxRateDTO](../../../../../tax/interfaces/tax.TaxRateDTO/page.mdx)","description":"The associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"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="setTaxRateRulesWorkflow"/>
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/updateTaxRatesWorkflow
|
||||
sidebar_label: updateTaxRatesWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateTaxRatesWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `updateTaxRatesWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow updates tax rates matching specified filters.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"updateTaxRatesWorkflow","steps":[{"type":"step","name":"updateTaxRatesStep","description":"This step updates tax rates matching the specified filters.","link":"../../../../core_flows.Steps_Tax/page.mdx#updatetaxratesstep","depth":1},{"type":"step","name":"deleteTaxRateRulesStep","description":"This step deletes one or more tax rate rules.","link":"../../../../core_flows.Steps_Tax/page.mdx#deletetaxraterulesstep","depth":2},{"type":"step","name":"createTaxRateRulesStep","description":"This step creates one or more tax rate rules.","link":"../../../../core_flows.Steps_Tax/page.mdx#createtaxraterulesstep","depth":3}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateTaxRatesWorkflowInput","type":"[UpdateTaxRatesWorkflowInput](../../../../types/core_flows.UpdateTaxRatesWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/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 tax rates based on name and code properties through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax rates by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string` \\| `string`[]","description":"Filter the tax rates by their associated tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| [OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<number> \\| `number`[]","description":"Filter the tax rates by their rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../tax/interfaces/tax.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](../../../../../tax/interfaces/tax.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":"([FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is Line truncated
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateDTO[]","type":"[TaxRateDTO](../../../../../tax/interfaces/tax.TaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateDTO","type":"[TaxRateDTO](../../../../../tax/interfaces/tax.TaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateTaxRatesWorkflow"/>
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createTaxRateRulesWorkflowId
|
||||
|
||||
`Const` **createTaxRateRulesWorkflowId**: `"create-tax-rate-rules"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createTaxRatesWorkflowId
|
||||
|
||||
`Const` **createTaxRatesWorkflowId**: `"create-tax-rates"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createTaxRegionsWorkflowId
|
||||
|
||||
`Const` **createTaxRegionsWorkflowId**: `"create-tax-regions"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteTaxRateRulesWorkflowId
|
||||
|
||||
`Const` **deleteTaxRateRulesWorkflowId**: `"delete-tax-rate-rules"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteTaxRatesWorkflowId
|
||||
|
||||
`Const` **deleteTaxRatesWorkflowId**: `"delete-tax-rates"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteTaxRegionsWorkflowId
|
||||
|
||||
`Const` **deleteTaxRegionsWorkflowId**: `"delete-tax-regions"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# setTaxRateRulesWorkflowId
|
||||
|
||||
`Const` **setTaxRateRulesWorkflowId**: `"set-tax-rate-rules"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateTaxRatesWorkflowId
|
||||
|
||||
`Const` **updateTaxRatesWorkflowId**: `"update-tax-rates"`
|
||||
@@ -0,0 +1,115 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Steps\_Tax
|
||||
|
||||
## createTaxRateRulesStep
|
||||
|
||||
This step creates one or more tax rate rules.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreateTaxRateRuleDTO[]","type":"[CreateTaxRateRuleDTO](../../../tax/interfaces/tax.CreateTaxRateRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateTaxRateRuleDTO","type":"[CreateTaxRateRuleDTO](../../../tax/interfaces/tax.CreateTaxRateRuleDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate rule to be created.","expandable":false,"children":[{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the\nuser that created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRateRulesStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateRuleDTO[]","type":"[TaxRateRuleDTO](../../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateRuleDTO","type":"[TaxRateRuleDTO](../../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate rule details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the user\nthat created the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"[TaxRateDTO](../../../tax/interfaces/tax.TaxRateDTO/page.mdx)","description":"The associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"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="createTaxRateRulesStep"/>
|
||||
|
||||
___
|
||||
|
||||
## createTaxRatesStep
|
||||
|
||||
This step creates one or more tax rates.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreateTaxRateDTO[]","type":"[CreateTaxRateDTO](../../../tax/interfaces/tax.CreateTaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateTaxRateDTO","type":"[CreateTaxRateDTO](../../../tax/interfaces/tax.CreateTaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate to be created.","expandable":false,"children":[{"name":"tax_region_id","type":"`string`","description":"The associated tax region's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"Omit<[CreateTaxRateRuleDTO](../../../tax/interfaces/tax.CreateTaxRateRuleDTO/page.mdx), \"tax_rate_id\">[]","description":"The rules of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the\nuser that created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is default.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the tax rate. For example, the ID of the user\nthat created the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../tax/types/tax.MetadataType/page.mdx)","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="createTaxRatesStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateDTO[]","type":"[TaxRateDTO](../../../tax/interfaces/tax.TaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateDTO","type":"[TaxRateDTO](../../../tax/interfaces/tax.TaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRatesStep"/>
|
||||
|
||||
___
|
||||
|
||||
## createTaxRegionsStep
|
||||
|
||||
This step creates one or more tax regions.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreateTaxRegionDTO[]","type":"[CreateTaxRegionDTO](../../../tax/interfaces/tax.CreateTaxRegionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateTaxRegionDTO","type":"[CreateTaxRegionDTO](../../../tax/interfaces/tax.CreateTaxRegionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax region to be created.","expandable":false,"children":[{"name":"country_code","type":"`string`","description":"The ISO 3 character country code of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"The province code of the tax region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`null` \\| `string`","description":"The ID of the tax region's parent.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the tax region. For example, the ID of\nthe user that created the tax region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_tax_rate","type":"`object`","description":"The default tax rate of the tax region.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../tax/types/tax.MetadataType/page.mdx)","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="createTaxRegionsStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRegionDTO[]","type":"[TaxRegionDTO](../../../tax/interfaces/tax.TaxRegionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRegionDTO","type":"[TaxRegionDTO](../../../tax/interfaces/tax.TaxRegionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax region details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The ISO 2 character country code of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"The province code of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`null` \\| `string`","description":"The ID of the tax region's parent tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax region. For example, the ID of the user\nthat created the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRegionsStep"/>
|
||||
|
||||
___
|
||||
|
||||
## deleteTaxRateRulesStep
|
||||
|
||||
This step deletes one or more tax rate rules.
|
||||
|
||||
### 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="deleteTaxRateRulesStep"/>
|
||||
|
||||
___
|
||||
|
||||
## deleteTaxRatesStep
|
||||
|
||||
This step deletes one or more tax rates.
|
||||
|
||||
### 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="deleteTaxRatesStep"/>
|
||||
|
||||
___
|
||||
|
||||
## deleteTaxRegionsStep
|
||||
|
||||
This step deletes one or more tax regions.
|
||||
|
||||
### 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="deleteTaxRegionsStep"/>
|
||||
|
||||
___
|
||||
|
||||
## listTaxRateIdsStep
|
||||
|
||||
This step retrieves the IDs of tax rates matching the specified filters.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"ListTaxRateIdsStepInput","type":"[ListTaxRateIdsStepInput](../../types/core_flows.ListTaxRateIdsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/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 tax rates based on name and code properties through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax rates by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string` \\| `string`[]","description":"Filter the tax rates by their associated tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| [OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<number> \\| `number`[]","description":"Filter the tax rates by their rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../tax/interfaces/tax.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](../../../tax/interfaces/tax.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":"([FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProLine truncated
|
||||
|
||||
### 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="listTaxRateIdsStep"/>
|
||||
|
||||
___
|
||||
|
||||
## listTaxRateRuleIdsStep
|
||||
|
||||
This step retrieves the IDs of tax rate rules matching the specified filters.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"ListTaxRateRuleIdsStepInput","type":"[ListTaxRateRuleIdsStepInput](../../types/core_flows.ListTaxRateRuleIdsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableTaxRateRuleProps](../../../tax/interfaces/tax.FilterableTaxRateRuleProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateRuleProps](../../../tax/interfaces/tax.FilterableTaxRateRuleProps/page.mdx) \\| [BaseFilterable](../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](../../../tax/interfaces/tax.FilterableTaxRateRuleProps/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":"([FilterableTaxRateRuleProps](../../../tax/interfaces/tax.FilterableTaxRateRuleProps/page.mdx) \\| [BaseFilterable](../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](../../../tax/interfaces/tax.FilterableTaxRateRuleProps/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":"([FilterableTaxRateRuleProps](../../../tax/interfaces/tax.FilterableTaxRateRuleProps/page.mdx) \\| [BaseFilterable](../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](../../../tax/interfaces/tax.FilterableTaxRateRuleProps/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":"reference","type":"`string` \\| `string`[] \\| [OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by what it references.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by the ID of the record it references.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by the ID of their associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"[FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"Filter the tax rate rule by their associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| [OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<Record<string, unknown>> \\| `Record<string, unknown>`[]","description":"Filter the tax rate rule by what its metadata.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by its creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by its update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../tax/interfaces/tax.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](../../../tax/interfaces/tax.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":"([FilterableTaxRateRuleProps](../../../tax/interfaces/tax.FilterableTaxRateRuleProps/page.mdx) \\| [BaseFilterable](../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](../../../tax/interfaces/tax.FilterableTaxRateRuleProps/page.mdx)>)[]","description":"An array of filLine truncated
|
||||
|
||||
### 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="listTaxRateRuleIdsStep"/>
|
||||
|
||||
___
|
||||
|
||||
## updateTaxRatesStep
|
||||
|
||||
This step updates tax rates matching the specified filters.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateTaxRatesStepInput","type":"[UpdateTaxRatesStepInput](../../types/core_flows.UpdateTaxRatesStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/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 tax rates based on name and code properties through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax rates by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string` \\| `string`[]","description":"Filter the tax rates by their associated tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| [OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<number> \\| `number`[]","description":"Filter the tax rates by their rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../tax/interfaces/tax.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](../../../tax/interfaces/tax.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":"([FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProLine truncated
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateDTO[]","type":"[TaxRateDTO](../../../tax/interfaces/tax.TaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateDTO","type":"[TaxRateDTO](../../../tax/interfaces/tax.TaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateTaxRatesStep"/>
|
||||
@@ -0,0 +1,147 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Workflows\_Tax
|
||||
|
||||
## createTaxRateRulesWorkflow
|
||||
|
||||
This workflow creates one or more tax rate rules.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createTaxRateRulesWorkflow","steps":[{"type":"step","name":"createTaxRateRulesStep","description":"This step creates one or more tax rate rules.","link":"../../core_flows.Steps_Tax/page.mdx#createtaxraterulesstep","depth":1}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreateTaxRateRulesWorkflowInput","type":"[CreateTaxRateRulesWorkflowInput](../../types/core_flows.CreateTaxRateRulesWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"rules","type":"[CreateTaxRateRuleDTO](../../../tax/interfaces/tax.CreateTaxRateRuleDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the\nuser that created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRateRulesWorkflow"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateRuleDTO[]","type":"[TaxRateRuleDTO](../../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateRuleDTO","type":"[TaxRateRuleDTO](../../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate rule details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the user\nthat created the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"[TaxRateDTO](../../../tax/interfaces/tax.TaxRateDTO/page.mdx)","description":"The associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"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="createTaxRateRulesWorkflow"/>
|
||||
|
||||
___
|
||||
|
||||
## createTaxRatesWorkflow
|
||||
|
||||
This workflow creates one or more tax rates.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createTaxRatesWorkflow","steps":[{"type":"step","name":"createTaxRatesStep","description":"This step creates one or more tax rates.","link":"../../core_flows.Steps_Tax/page.mdx#createtaxratesstep","depth":1}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreateTaxRateDTO[]","type":"[CreateTaxRateDTO](../../../tax/interfaces/tax.CreateTaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateTaxRateDTO","type":"[CreateTaxRateDTO](../../../tax/interfaces/tax.CreateTaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate to be created.","expandable":false,"children":[{"name":"tax_region_id","type":"`string`","description":"The associated tax region's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"Omit<[CreateTaxRateRuleDTO](../../../tax/interfaces/tax.CreateTaxRateRuleDTO/page.mdx), \"tax_rate_id\">[]","description":"The rules of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the\nuser that created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is default.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the tax rate. For example, the ID of the user\nthat created the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../tax/types/tax.MetadataType/page.mdx)","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="createTaxRatesWorkflow"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateDTO[]","type":"[TaxRateDTO](../../../tax/interfaces/tax.TaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateDTO","type":"[TaxRateDTO](../../../tax/interfaces/tax.TaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRatesWorkflow"/>
|
||||
|
||||
___
|
||||
|
||||
## createTaxRegionsWorkflow
|
||||
|
||||
This workflow creates one or more tax regions.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createTaxRegionsWorkflow","steps":[{"type":"step","name":"createTaxRegionsStep","description":"This step creates one or more tax regions.","link":"../../core_flows.Steps_Tax/page.mdx#createtaxregionsstep","depth":1}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreateTaxRegionDTO[]","type":"[CreateTaxRegionDTO](../../../tax/interfaces/tax.CreateTaxRegionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateTaxRegionDTO","type":"[CreateTaxRegionDTO](../../../tax/interfaces/tax.CreateTaxRegionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax region to be created.","expandable":false,"children":[{"name":"country_code","type":"`string`","description":"The ISO 3 character country code of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"The province code of the tax region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`null` \\| `string`","description":"The ID of the tax region's parent.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the tax region. For example, the ID of\nthe user that created the tax region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_tax_rate","type":"`object`","description":"The default tax rate of the tax region.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../tax/types/tax.MetadataType/page.mdx)","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="createTaxRegionsWorkflow"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRegionDTO[]","type":"[TaxRegionDTO](../../../tax/interfaces/tax.TaxRegionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRegionDTO","type":"[TaxRegionDTO](../../../tax/interfaces/tax.TaxRegionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax region details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The ISO 2 character country code of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"The province code of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`null` \\| `string`","description":"The ID of the tax region's parent tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax region. For example, the ID of the user\nthat created the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRegionsWorkflow"/>
|
||||
|
||||
___
|
||||
|
||||
## deleteTaxRateRulesWorkflow
|
||||
|
||||
This workflow deletes one or more tax rate rules.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"deleteTaxRateRulesWorkflow","steps":[{"type":"step","name":"deleteTaxRateRulesStep","description":"This step deletes one or more tax rate rules.","link":"../../core_flows.Steps_Tax/page.mdx#deletetaxraterulesstep","depth":1}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"DeleteTaxRateRulesWorkflowInput","type":"[DeleteTaxRateRulesWorkflowInput](../../types/core_flows.DeleteTaxRateRulesWorkflowInput/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="deleteTaxRateRulesWorkflow"/>
|
||||
|
||||
___
|
||||
|
||||
## deleteTaxRatesWorkflow
|
||||
|
||||
This workflow deletes one or more tax rates.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"deleteTaxRatesWorkflow","steps":[{"type":"step","name":"deleteTaxRatesStep","description":"This step deletes one or more tax rates.","link":"../../core_flows.Steps_Tax/page.mdx#deletetaxratesstep","depth":1}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"DeleteTaxRatesWorkflowInput","type":"[DeleteTaxRatesWorkflowInput](../../types/core_flows.DeleteTaxRatesWorkflowInput/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="deleteTaxRatesWorkflow"/>
|
||||
|
||||
___
|
||||
|
||||
## deleteTaxRegionsWorkflow
|
||||
|
||||
This workflow deletes one or more tax regions.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"deleteTaxRegionsWorkflow","steps":[{"type":"step","name":"deleteTaxRegionsStep","description":"This step deletes one or more tax regions.","link":"../../core_flows.Steps_Tax/page.mdx#deletetaxregionsstep","depth":1}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"DeleteTaxRegionsWorkflowInput","type":"[DeleteTaxRegionsWorkflowInput](../../types/core_flows.DeleteTaxRegionsWorkflowInput/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="deleteTaxRegionsWorkflow"/>
|
||||
|
||||
___
|
||||
|
||||
## setTaxRateRulesWorkflow
|
||||
|
||||
This workflow sets the rules of tax rates.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"setTaxRateRulesWorkflow","steps":[{"type":"step","name":"listTaxRateRuleIdsStep","description":"This step retrieves the IDs of tax rate rules matching the specified filters.","link":"../../core_flows.Steps_Tax/page.mdx#listtaxrateruleidsstep","depth":1},{"type":"step","name":"deleteTaxRateRulesStep","description":"This step deletes one or more tax rate rules.","link":"../../core_flows.Steps_Tax/page.mdx#deletetaxraterulesstep","depth":2},{"type":"step","name":"createTaxRateRulesStep","description":"This step creates one or more tax rate rules.","link":"../../core_flows.Steps_Tax/page.mdx#createtaxraterulesstep","depth":3}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"SetTaxRatesRulesWorkflowInput","type":"[SetTaxRatesRulesWorkflowInput](../../types/core_flows.SetTaxRatesRulesWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"tax_rate_ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"Omit<[CreateTaxRateRuleDTO](../../../tax/interfaces/tax.CreateTaxRateRuleDTO/page.mdx), \"tax_rate_id\">[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the\nuser that created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="setTaxRateRulesWorkflow"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateRuleDTO[]","type":"[TaxRateRuleDTO](../../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateRuleDTO","type":"[TaxRateRuleDTO](../../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate rule details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the user\nthat created the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"[TaxRateDTO](../../../tax/interfaces/tax.TaxRateDTO/page.mdx)","description":"The associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"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="setTaxRateRulesWorkflow"/>
|
||||
|
||||
___
|
||||
|
||||
## maybeListTaxRateRuleIdsStep
|
||||
|
||||
This step lists the rules to update in a tax rate update object.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"MaybeListTaxRateRuleIdsStepInput","type":"[MaybeListTaxRateRuleIdsStepInput](../../types/core_flows.MaybeListTaxRateRuleIdsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"tax_rate_ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"update","type":"[UpdateTaxRateDTO](../../../tax/interfaces/tax.UpdateTaxRateDTO/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"Omit<[CreateTaxRateRuleDTO](../../../tax/interfaces/tax.CreateTaxRateRuleDTO/page.mdx), \"tax_rate_id\">[]","description":"The rules of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the\nuser that created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is default.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate is combinable.\n\nLearn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../tax/types/tax.MetadataType/page.mdx)","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="maybeListTaxRateRuleIdsStep"/>
|
||||
|
||||
### 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="maybeListTaxRateRuleIdsStep"/>
|
||||
|
||||
___
|
||||
|
||||
## updateTaxRatesWorkflow
|
||||
|
||||
This workflow updates tax rates matching specified filters.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"updateTaxRatesWorkflow","steps":[{"type":"step","name":"updateTaxRatesStep","description":"This step updates tax rates matching the specified filters.","link":"../../core_flows.Steps_Tax/page.mdx#updatetaxratesstep","depth":1},{"type":"step","name":"deleteTaxRateRulesStep","description":"This step deletes one or more tax rate rules.","link":"../../core_flows.Steps_Tax/page.mdx#deletetaxraterulesstep","depth":2},{"type":"step","name":"createTaxRateRulesStep","description":"This step creates one or more tax rate rules.","link":"../../core_flows.Steps_Tax/page.mdx#createtaxraterulesstep","depth":3}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateTaxRatesWorkflowInput","type":"[UpdateTaxRatesWorkflowInput](../../types/core_flows.UpdateTaxRatesWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/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 tax rates based on name and code properties through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax rates by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string` \\| `string`[]","description":"Filter the tax rates by their associated tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| [OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<number> \\| `number`[]","description":"Filter the tax rates by their rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../tax/interfaces/tax.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](../../../tax/interfaces/tax.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":"([FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterabLine truncated
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateDTO[]","type":"[TaxRateDTO](../../../tax/interfaces/tax.TaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateDTO","type":"[TaxRateDTO](../../../tax/interfaces/tax.TaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateTaxRatesWorkflow"/>
|
||||
@@ -0,0 +1,7 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Shipping Options
|
||||
|
||||
## Namespaces
|
||||
|
||||
- [Steps\_Shipping Options](../core_flows.Steps_Shipping_Options/page.mdx)
|
||||
@@ -0,0 +1,8 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Shipping Profile
|
||||
|
||||
## Namespaces
|
||||
|
||||
- [Steps\_Shipping Profile](../core_flows.Steps_Shipping_Profile/page.mdx)
|
||||
- [Workflows\_Shipping Profile](../core_flows.Workflows_Shipping_Profile/page.mdx)
|
||||
@@ -0,0 +1,173 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Steps\_Tax
|
||||
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/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 tax rates based on name and code properties through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax rates by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string` \\| `string`[]","description":"Filter the tax rates by their associated tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<number> \\| `number`[]","description":"Filter the tax rates by their rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../tax/interfaces/tax.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](../../tax/interfaces/tax.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":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to applyLine truncated
|
||||
|
||||
___
|
||||
|
||||
## createTaxRateRulesStepId
|
||||
|
||||
`Const` **createTaxRateRulesStepId**: `"create-tax-rate-rules"`
|
||||
|
||||
___
|
||||
|
||||
## createTaxRatesStepId
|
||||
|
||||
`Const` **createTaxRatesStepId**: `"create-tax-rates"`
|
||||
|
||||
___
|
||||
|
||||
## createTaxRegionsStepId
|
||||
|
||||
`Const` **createTaxRegionsStepId**: `"create-tax-regions"`
|
||||
|
||||
___
|
||||
|
||||
## deleteTaxRateRulesStepId
|
||||
|
||||
`Const` **deleteTaxRateRulesStepId**: `"delete-tax-rate-rules"`
|
||||
|
||||
___
|
||||
|
||||
## deleteTaxRatesStepId
|
||||
|
||||
`Const` **deleteTaxRatesStepId**: `"delete-tax-rates"`
|
||||
|
||||
___
|
||||
|
||||
## deleteTaxRegionsStepId
|
||||
|
||||
`Const` **deleteTaxRegionsStepId**: `"delete-tax-regions"`
|
||||
|
||||
___
|
||||
|
||||
## listTaxRateIdsStepId
|
||||
|
||||
`Const` **listTaxRateIdsStepId**: `"list-tax-rate-ids"`
|
||||
|
||||
___
|
||||
|
||||
## listTaxRateRuleIdsStepId
|
||||
|
||||
`Const` **listTaxRateRuleIdsStepId**: `"list-tax-rate-rule-ids"`
|
||||
|
||||
___
|
||||
|
||||
## updateTaxRatesStepId
|
||||
|
||||
`Const` **updateTaxRatesStepId**: `"update-tax-rates"`
|
||||
|
||||
___
|
||||
|
||||
## createTaxRateRulesStep
|
||||
|
||||
This step creates one or more tax rate rules.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreateTaxRateRuleDTO[]","type":"[CreateTaxRateRuleDTO](../../tax/interfaces/tax.CreateTaxRateRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateTaxRateRuleDTO","type":"[CreateTaxRateRuleDTO](../../tax/interfaces/tax.CreateTaxRateRuleDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate rule to be created.","expandable":false,"children":[{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the\nuser that created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRateRulesStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateRuleDTO[]","type":"[TaxRateRuleDTO](../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateRuleDTO","type":"[TaxRateRuleDTO](../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate rule details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the user\nthat created the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)","description":"The associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"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="createTaxRateRulesStep"/>
|
||||
|
||||
___
|
||||
|
||||
## createTaxRatesStep
|
||||
|
||||
This step creates one or more tax rates.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreateTaxRateDTO[]","type":"[CreateTaxRateDTO](../../tax/interfaces/tax.CreateTaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateTaxRateDTO","type":"[CreateTaxRateDTO](../../tax/interfaces/tax.CreateTaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate to be created.","expandable":false,"children":[{"name":"tax_region_id","type":"`string`","description":"The associated tax region's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"Omit<[CreateTaxRateRuleDTO](../../tax/interfaces/tax.CreateTaxRateRuleDTO/page.mdx), \"tax_rate_id\">[]","description":"The rules of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the\nuser that created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is default.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the tax rate. For example, the ID of the user\nthat created the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../tax/types/tax.MetadataType/page.mdx)","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="createTaxRatesStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateDTO[]","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateDTO","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRatesStep"/>
|
||||
|
||||
___
|
||||
|
||||
## createTaxRegionsStep
|
||||
|
||||
This step creates one or more tax regions.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreateTaxRegionDTO[]","type":"[CreateTaxRegionDTO](../../tax/interfaces/tax.CreateTaxRegionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateTaxRegionDTO","type":"[CreateTaxRegionDTO](../../tax/interfaces/tax.CreateTaxRegionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax region to be created.","expandable":false,"children":[{"name":"country_code","type":"`string`","description":"The ISO 3 character country code of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"The province code of the tax region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`null` \\| `string`","description":"The ID of the tax region's parent.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the tax region. For example, the ID of\nthe user that created the tax region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_tax_rate","type":"`object`","description":"The default tax rate of the tax region.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../tax/types/tax.MetadataType/page.mdx)","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="createTaxRegionsStep"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRegionDTO[]","type":"[TaxRegionDTO](../../tax/interfaces/tax.TaxRegionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRegionDTO","type":"[TaxRegionDTO](../../tax/interfaces/tax.TaxRegionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax region details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The ISO 2 character country code of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"The province code of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`null` \\| `string`","description":"The ID of the tax region's parent tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax region. For example, the ID of the user\nthat created the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRegionsStep"/>
|
||||
|
||||
___
|
||||
|
||||
## deleteTaxRateRulesStep
|
||||
|
||||
This step deletes one or more tax rate rules.
|
||||
|
||||
### 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="deleteTaxRateRulesStep"/>
|
||||
|
||||
___
|
||||
|
||||
## deleteTaxRatesStep
|
||||
|
||||
This step deletes one or more tax rates.
|
||||
|
||||
### 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="deleteTaxRatesStep"/>
|
||||
|
||||
___
|
||||
|
||||
## deleteTaxRegionsStep
|
||||
|
||||
This step deletes one or more tax regions.
|
||||
|
||||
### 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="deleteTaxRegionsStep"/>
|
||||
|
||||
___
|
||||
|
||||
## listTaxRateIdsStep
|
||||
|
||||
This step retrieves the IDs of tax rates matching the specified filters.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"ListTaxRateIdsStepInput","type":"[ListTaxRateIdsStepInput](../types/core_flows.ListTaxRateIdsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/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 tax rates based on name and code properties through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax rates by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string` \\| `string`[]","description":"Filter the tax rates by their associated tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<number> \\| `number`[]","description":"Filter the tax rates by their rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../tax/interfaces/tax.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](../../tax/interfaces/tax.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":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| Line truncated
|
||||
|
||||
### 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="listTaxRateIdsStep"/>
|
||||
|
||||
___
|
||||
|
||||
## listTaxRateRuleIdsStep
|
||||
|
||||
This step retrieves the IDs of tax rate rules matching the specified filters.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"ListTaxRateRuleIdsStepInput","type":"[ListTaxRateRuleIdsStepInput](../types/core_flows.ListTaxRateRuleIdsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableTaxRateRuleProps](../../tax/interfaces/tax.FilterableTaxRateRuleProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateRuleProps](../../tax/interfaces/tax.FilterableTaxRateRuleProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](../../tax/interfaces/tax.FilterableTaxRateRuleProps/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":"([FilterableTaxRateRuleProps](../../tax/interfaces/tax.FilterableTaxRateRuleProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](../../tax/interfaces/tax.FilterableTaxRateRuleProps/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":"([FilterableTaxRateRuleProps](../../tax/interfaces/tax.FilterableTaxRateRuleProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](../../tax/interfaces/tax.FilterableTaxRateRuleProps/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":"reference","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by what it references.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by the ID of the record it references.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by the ID of their associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"Filter the tax rate rule by their associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<Record<string, unknown>> \\| `Record<string, unknown>`[]","description":"Filter the tax rate rule by what its metadata.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by its creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by its update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../tax/interfaces/tax.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](../../tax/interfaces/tax.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":"([FilterableTaxRateRuleProps](../../tax/interfaces/tax.FilterableTaxRateRuleProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](../../tax/interfaces/tax.FilterableTaxRateRuleProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined withLine truncated
|
||||
|
||||
### 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="listTaxRateRuleIdsStep"/>
|
||||
|
||||
___
|
||||
|
||||
## updateTaxRatesStep
|
||||
|
||||
This step updates tax rates matching the specified filters.
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateTaxRatesStepInput","type":"[UpdateTaxRatesStepInput](../types/core_flows.UpdateTaxRatesStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/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 tax rates based on name and code properties through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax rates by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string` \\| `string`[]","description":"Filter the tax rates by their associated tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<number> \\| `number`[]","description":"Filter the tax rates by their rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../tax/interfaces/tax.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](../../tax/interfaces/tax.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":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/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":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| Line truncated
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateDTO[]","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateDTO","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateTaxRatesStep"/>
|
||||
@@ -0,0 +1,8 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Stock Location
|
||||
|
||||
## Namespaces
|
||||
|
||||
- [Steps\_Stock Location](../core_flows.Steps_Stock_Location/page.mdx)
|
||||
- [Workflows\_Stock Location](../core_flows.Workflows_Stock_Location/page.mdx)
|
||||
@@ -0,0 +1,8 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Store
|
||||
|
||||
## Namespaces
|
||||
|
||||
- [Steps\_Store](../core_flows.Steps_Store/page.mdx)
|
||||
- [Workflows\_Store](../core_flows.Workflows_Store/page.mdx)
|
||||
Reference in new issue
Block a user