docs: generate references manually for 2.1.1 (#10534)

* docs: generate references manually for 2.1.1

* re-generate for core-flows

* Revert "re-generate for core-flows"

This reverts commit ff785c80214dc6125e2da4c6e8a674a87b03e9dd.
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-12-10 18:49:30 +02:00
1 parent 482929f74d
commit ab1bfb966d
1109 files changed
+348040 -330744

No files matched your search

File diff suppressed because it is too large. Load diff
+116 -28
View File
@@ -1228,8 +1228,8 @@ export const filesMap = [
"pathname": "/references/api_key/types/api_key.Scalar" "pathname": "/references/api_key/types/api_key.Scalar"
}, },
{ {
"filePath": "/www/apps/resources/references/api_key_models/classes/api_key_models.ApiKey/page.mdx", "filePath": "/www/apps/resources/references/api_key_models/variables/api_key_models.ApiKey/page.mdx",
"pathname": "/references/api_key_models/classes/api_key_models.ApiKey" "pathname": "/references/api_key_models/variables/api_key_models.ApiKey"
}, },
{ {
"filePath": "/www/apps/resources/references/auth/IAuthModuleService/methods/auth.IAuthModuleService.authenticate/page.mdx", "filePath": "/www/apps/resources/references/auth/IAuthModuleService/methods/auth.IAuthModuleService.authenticate/page.mdx",
@@ -1643,6 +1643,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/cart/ICartModuleService/methods/cart.ICartModuleService.updateLineItems/page.mdx", "filePath": "/www/apps/resources/references/cart/ICartModuleService/methods/cart.ICartModuleService.updateLineItems/page.mdx",
"pathname": "/references/cart/ICartModuleService/methods/cart.ICartModuleService.updateLineItems" "pathname": "/references/cart/ICartModuleService/methods/cart.ICartModuleService.updateLineItems"
}, },
{
"filePath": "/www/apps/resources/references/cart/ICartModuleService/methods/cart.ICartModuleService.updateShippingMethods/page.mdx",
"pathname": "/references/cart/ICartModuleService/methods/cart.ICartModuleService.updateShippingMethods"
},
{ {
"filePath": "/www/apps/resources/references/cart/IMessageAggregator/methods/cart.IMessageAggregator.clearMessages/page.mdx", "filePath": "/www/apps/resources/references/cart/IMessageAggregator/methods/cart.IMessageAggregator.clearMessages/page.mdx",
"pathname": "/references/cart/IMessageAggregator/methods/cart.IMessageAggregator.clearMessages" "pathname": "/references/cart/IMessageAggregator/methods/cart.IMessageAggregator.clearMessages"
@@ -1867,6 +1871,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/cart/interfaces/cart.UpdateShippingMethodAdjustmentDTO/page.mdx", "filePath": "/www/apps/resources/references/cart/interfaces/cart.UpdateShippingMethodAdjustmentDTO/page.mdx",
"pathname": "/references/cart/interfaces/cart.UpdateShippingMethodAdjustmentDTO" "pathname": "/references/cart/interfaces/cart.UpdateShippingMethodAdjustmentDTO"
}, },
{
"filePath": "/www/apps/resources/references/cart/interfaces/cart.UpdateShippingMethodDTO/page.mdx",
"pathname": "/references/cart/interfaces/cart.UpdateShippingMethodDTO"
},
{ {
"filePath": "/www/apps/resources/references/cart/interfaces/cart.UpdateShippingMethodTaxLineDTO/page.mdx", "filePath": "/www/apps/resources/references/cart/interfaces/cart.UpdateShippingMethodTaxLineDTO/page.mdx",
"pathname": "/references/cart/interfaces/cart.UpdateShippingMethodTaxLineDTO" "pathname": "/references/cart/interfaces/cart.UpdateShippingMethodTaxLineDTO"
@@ -1980,36 +1988,36 @@ export const filesMap = [
"pathname": "/references/cart/types/cart.Scalar" "pathname": "/references/cart/types/cart.Scalar"
}, },
{ {
"filePath": "/www/apps/resources/references/cart_models/classes/cart_models.Address/page.mdx", "filePath": "/www/apps/resources/references/cart_models/variables/cart_models.Address/page.mdx",
"pathname": "/references/cart_models/classes/cart_models.Address" "pathname": "/references/cart_models/variables/cart_models.Address"
}, },
{ {
"filePath": "/www/apps/resources/references/cart_models/classes/cart_models.Cart/page.mdx", "filePath": "/www/apps/resources/references/cart_models/variables/cart_models.Cart/page.mdx",
"pathname": "/references/cart_models/classes/cart_models.Cart" "pathname": "/references/cart_models/variables/cart_models.Cart"
}, },
{ {
"filePath": "/www/apps/resources/references/cart_models/classes/cart_models.LineItem/page.mdx", "filePath": "/www/apps/resources/references/cart_models/variables/cart_models.LineItem/page.mdx",
"pathname": "/references/cart_models/classes/cart_models.LineItem" "pathname": "/references/cart_models/variables/cart_models.LineItem"
}, },
{ {
"filePath": "/www/apps/resources/references/cart_models/classes/cart_models.LineItemAdjustment/page.mdx", "filePath": "/www/apps/resources/references/cart_models/variables/cart_models.LineItemAdjustment/page.mdx",
"pathname": "/references/cart_models/classes/cart_models.LineItemAdjustment" "pathname": "/references/cart_models/variables/cart_models.LineItemAdjustment"
}, },
{ {
"filePath": "/www/apps/resources/references/cart_models/classes/cart_models.LineItemTaxLine/page.mdx", "filePath": "/www/apps/resources/references/cart_models/variables/cart_models.LineItemTaxLine/page.mdx",
"pathname": "/references/cart_models/classes/cart_models.LineItemTaxLine" "pathname": "/references/cart_models/variables/cart_models.LineItemTaxLine"
}, },
{ {
"filePath": "/www/apps/resources/references/cart_models/classes/cart_models.ShippingMethod/page.mdx", "filePath": "/www/apps/resources/references/cart_models/variables/cart_models.ShippingMethod/page.mdx",
"pathname": "/references/cart_models/classes/cart_models.ShippingMethod" "pathname": "/references/cart_models/variables/cart_models.ShippingMethod"
}, },
{ {
"filePath": "/www/apps/resources/references/cart_models/classes/cart_models.ShippingMethodAdjustment/page.mdx", "filePath": "/www/apps/resources/references/cart_models/variables/cart_models.ShippingMethodAdjustment/page.mdx",
"pathname": "/references/cart_models/classes/cart_models.ShippingMethodAdjustment" "pathname": "/references/cart_models/variables/cart_models.ShippingMethodAdjustment"
}, },
{ {
"filePath": "/www/apps/resources/references/cart_models/classes/cart_models.ShippingMethodTaxLine/page.mdx", "filePath": "/www/apps/resources/references/cart_models/variables/cart_models.ShippingMethodTaxLine/page.mdx",
"pathname": "/references/cart_models/classes/cart_models.ShippingMethodTaxLine" "pathname": "/references/cart_models/variables/cart_models.ShippingMethodTaxLine"
}, },
{ {
"filePath": "/www/apps/resources/references/core_flows/Api_Key/Steps_Api_Key/functions/core_flows.Api_Key.Steps_Api_Key.createApiKeysStep/page.mdx", "filePath": "/www/apps/resources/references/core_flows/Api_Key/Steps_Api_Key/functions/core_flows.Api_Key.Steps_Api_Key.createApiKeysStep/page.mdx",
@@ -10659,6 +10667,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/dml/Model_Methods/methods/dml.Model_Methods.indexes/page.mdx", "filePath": "/www/apps/resources/references/dml/Model_Methods/methods/dml.Model_Methods.indexes/page.mdx",
"pathname": "/references/dml/Model_Methods/methods/dml.Model_Methods.indexes" "pathname": "/references/dml/Model_Methods/methods/dml.Model_Methods.indexes"
}, },
{
"filePath": "/www/apps/resources/references/dml/Property/methods/dml.Property.autoincrement/page.mdx",
"pathname": "/references/dml/Property/methods/dml.Property.autoincrement"
},
{ {
"filePath": "/www/apps/resources/references/dml/Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.default/page.mdx", "filePath": "/www/apps/resources/references/dml/Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.default/page.mdx",
"pathname": "/references/dml/Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.default" "pathname": "/references/dml/Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.default"
@@ -10731,6 +10743,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/dml/dml.Model_Methods/page.mdx", "filePath": "/www/apps/resources/references/dml/dml.Model_Methods/page.mdx",
"pathname": "/references/dml/dml.Model_Methods" "pathname": "/references/dml/dml.Model_Methods"
}, },
{
"filePath": "/www/apps/resources/references/dml/dml.Property/page.mdx",
"pathname": "/references/dml/dml.Property"
},
{ {
"filePath": "/www/apps/resources/references/dml/dml.Property_Configuration_Methods/page.mdx", "filePath": "/www/apps/resources/references/dml/dml.Property_Configuration_Methods/page.mdx",
"pathname": "/references/dml/dml.Property_Configuration_Methods" "pathname": "/references/dml/dml.Property_Configuration_Methods"
@@ -18048,8 +18064,8 @@ export const filesMap = [
"pathname": "/references/sales_channel/types/sales_channel.RawMessageFormat" "pathname": "/references/sales_channel/types/sales_channel.RawMessageFormat"
}, },
{ {
"filePath": "/www/apps/resources/references/sales_channel_models/classes/sales_channel_models.SalesChannel/page.mdx", "filePath": "/www/apps/resources/references/sales_channel_models/variables/sales_channel_models.SalesChannel/page.mdx",
"pathname": "/references/sales_channel_models/classes/sales_channel_models.SalesChannel" "pathname": "/references/sales_channel_models/variables/sales_channel_models.SalesChannel"
}, },
{ {
"filePath": "/www/apps/resources/references/search/classes/search.AbstractSearchService/page.mdx", "filePath": "/www/apps/resources/references/search/classes/search.AbstractSearchService/page.mdx",
@@ -18463,6 +18479,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/store/interfaces/store.UpsertStoreDTO/page.mdx", "filePath": "/www/apps/resources/references/store/interfaces/store.UpsertStoreDTO/page.mdx",
"pathname": "/references/store/interfaces/store.UpsertStoreDTO" "pathname": "/references/store/interfaces/store.UpsertStoreDTO"
}, },
{
"filePath": "/www/apps/resources/references/store/types/store.Constructor/page.mdx",
"pathname": "/references/store/types/store.Constructor"
},
{ {
"filePath": "/www/apps/resources/references/store/types/store.Event/page.mdx", "filePath": "/www/apps/resources/references/store/types/store.Event/page.mdx",
"pathname": "/references/store/types/store.Event" "pathname": "/references/store/types/store.Event"
@@ -18471,6 +18491,26 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/store/types/store.EventMetadata/page.mdx", "filePath": "/www/apps/resources/references/store/types/store.EventMetadata/page.mdx",
"pathname": "/references/store/types/store.EventMetadata" "pathname": "/references/store/types/store.EventMetadata"
}, },
{
"filePath": "/www/apps/resources/references/store/types/store.ExpandScalar/page.mdx",
"pathname": "/references/store/types/store.ExpandScalar"
},
{
"filePath": "/www/apps/resources/references/store/types/store.FilterQuery/page.mdx",
"pathname": "/references/store/types/store.FilterQuery"
},
{
"filePath": "/www/apps/resources/references/store/types/store.FilterQueryProperties/page.mdx",
"pathname": "/references/store/types/store.FilterQueryProperties"
},
{
"filePath": "/www/apps/resources/references/store/types/store.FilterValue/page.mdx",
"pathname": "/references/store/types/store.FilterValue"
},
{
"filePath": "/www/apps/resources/references/store/types/store.FilterValue2/page.mdx",
"pathname": "/references/store/types/store.FilterValue2"
},
{ {
"filePath": "/www/apps/resources/references/store/types/store.FindConfigOrder/page.mdx", "filePath": "/www/apps/resources/references/store/types/store.FindConfigOrder/page.mdx",
"pathname": "/references/store/types/store.FindConfigOrder" "pathname": "/references/store/types/store.FindConfigOrder"
@@ -18495,17 +18535,41 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/store/types/store.ModuleJoinerRelationship/page.mdx", "filePath": "/www/apps/resources/references/store/types/store.ModuleJoinerRelationship/page.mdx",
"pathname": "/references/store/types/store.ModuleJoinerRelationship" "pathname": "/references/store/types/store.ModuleJoinerRelationship"
}, },
{
"filePath": "/www/apps/resources/references/store/types/store.OperatorMap/page.mdx",
"pathname": "/references/store/types/store.OperatorMap"
},
{
"filePath": "/www/apps/resources/references/store/types/store.PrevLimit/page.mdx",
"pathname": "/references/store/types/store.PrevLimit"
},
{
"filePath": "/www/apps/resources/references/store/types/store.Primary/page.mdx",
"pathname": "/references/store/types/store.Primary"
},
{
"filePath": "/www/apps/resources/references/store/types/store.Query/page.mdx",
"pathname": "/references/store/types/store.Query"
},
{ {
"filePath": "/www/apps/resources/references/store/types/store.RawMessageFormat/page.mdx", "filePath": "/www/apps/resources/references/store/types/store.RawMessageFormat/page.mdx",
"pathname": "/references/store/types/store.RawMessageFormat" "pathname": "/references/store/types/store.RawMessageFormat"
}, },
{ {
"filePath": "/www/apps/resources/references/store_models/classes/store_models.Store/page.mdx", "filePath": "/www/apps/resources/references/store/types/store.ReadonlyPrimary/page.mdx",
"pathname": "/references/store_models/classes/store_models.Store" "pathname": "/references/store/types/store.ReadonlyPrimary"
}, },
{ {
"filePath": "/www/apps/resources/references/store_models/classes/store_models.StoreCurrency/page.mdx", "filePath": "/www/apps/resources/references/store/types/store.Scalar/page.mdx",
"pathname": "/references/store_models/classes/store_models.StoreCurrency" "pathname": "/references/store/types/store.Scalar"
},
{
"filePath": "/www/apps/resources/references/store_models/variables/store_models.Store/page.mdx",
"pathname": "/references/store_models/variables/store_models.Store"
},
{
"filePath": "/www/apps/resources/references/store_models/variables/store_models.StoreCurrency/page.mdx",
"pathname": "/references/store_models/variables/store_models.StoreCurrency"
}, },
{ {
"filePath": "/www/apps/resources/references/tax/IBigNumber/methods/tax.IBigNumber.toJSON/page.mdx", "filePath": "/www/apps/resources/references/tax/IBigNumber/methods/tax.IBigNumber.toJSON/page.mdx",
@@ -20939,6 +21003,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.StoreAddCartShippingMethods/page.mdx", "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.StoreAddCartShippingMethods/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.StoreAddCartShippingMethods" "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.StoreAddCartShippingMethods"
}, },
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.StoreCalculatedPrice/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.StoreCalculatedPrice"
},
{ {
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.StoreCart/page.mdx", "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.StoreCart/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.StoreCart" "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.StoreCart"
@@ -21115,6 +21183,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.StorePaymentSessionFilters/page.mdx", "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.StorePaymentSessionFilters/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.StorePaymentSessionFilters" "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.StorePaymentSessionFilters"
}, },
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.StorePrice/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.StorePrice"
},
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.StorePriceRule/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.StorePriceRule"
},
{ {
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.StoreProduct/page.mdx", "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.StoreProduct/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.StoreProduct" "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.StoreProduct"
@@ -22679,6 +22755,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/interfaces/types.AdminFulfillmentDeliveryAddress/page.mdx", "filePath": "/www/apps/resources/references/types/interfaces/types.AdminFulfillmentDeliveryAddress/page.mdx",
"pathname": "/references/types/interfaces/types.AdminFulfillmentDeliveryAddress" "pathname": "/references/types/interfaces/types.AdminFulfillmentDeliveryAddress"
}, },
{
"filePath": "/www/apps/resources/references/types/interfaces/types.AdminShippingOptionPriceRulePayload/page.mdx",
"pathname": "/references/types/interfaces/types.AdminShippingOptionPriceRulePayload"
},
{
"filePath": "/www/apps/resources/references/types/interfaces/types.AdminShippingOptionPriceWithRules/page.mdx",
"pathname": "/references/types/interfaces/types.AdminShippingOptionPriceWithRules"
},
{ {
"filePath": "/www/apps/resources/references/types/interfaces/types.AdminUpdateFulfillmentSetServiceZoneCity/page.mdx", "filePath": "/www/apps/resources/references/types/interfaces/types.AdminUpdateFulfillmentSetServiceZoneCity/page.mdx",
"pathname": "/references/types/interfaces/types.AdminUpdateFulfillmentSetServiceZoneCity" "pathname": "/references/types/interfaces/types.AdminUpdateFulfillmentSetServiceZoneCity"
@@ -24187,6 +24271,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/utils/interfaces/utils.Entity/page.mdx", "filePath": "/www/apps/resources/references/utils/interfaces/utils.Entity/page.mdx",
"pathname": "/references/utils/interfaces/utils.Entity" "pathname": "/references/utils/interfaces/utils.Entity"
}, },
{
"filePath": "/www/apps/resources/references/utils/types/utils.TotalVariantAvailabilityData/page.mdx",
"pathname": "/references/utils/types/utils.TotalVariantAvailabilityData"
},
{
"filePath": "/www/apps/resources/references/utils/types/utils.VariantAvailabilityData/page.mdx",
"pathname": "/references/utils/types/utils.VariantAvailabilityData"
},
{ {
"filePath": "/www/apps/resources/references/utils/utils.CoreFlowsUitls/page.mdx", "filePath": "/www/apps/resources/references/utils/utils.CoreFlowsUitls/page.mdx",
"pathname": "/references/utils/utils.CoreFlowsUitls" "pathname": "/references/utils/utils.CoreFlowsUitls"
@@ -24267,10 +24359,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/workflows/functions/workflows.transform/page.mdx", "filePath": "/www/apps/resources/references/workflows/functions/workflows.transform/page.mdx",
"pathname": "/references/workflows/functions/workflows.transform" "pathname": "/references/workflows/functions/workflows.transform"
}, },
{
"filePath": "/www/apps/resources/references/workflows/functions/workflows.when/page.mdx",
"pathname": "/references/workflows/functions/workflows.when"
},
{ {
"filePath": "/www/apps/resources/references/workflows/interfaces/workflows.ApplyStepOptions/page.mdx", "filePath": "/www/apps/resources/references/workflows/interfaces/workflows.ApplyStepOptions/page.mdx",
"pathname": "/references/workflows/interfaces/workflows.ApplyStepOptions" "pathname": "/references/workflows/interfaces/workflows.ApplyStepOptions"
+12 -12
View File
@@ -337,7 +337,7 @@ export const generatedSidebar = [
"type": "category", "type": "category",
"title": "Data Models", "title": "Data Models",
"hasTitleStyling": true, "hasTitleStyling": true,
"autogenerate_path": "/references/api_key_models/classes", "autogenerate_path": "/references/api_key_models/variables",
"children": [ "children": [
{ {
"loaded": true, "loaded": true,
@@ -1168,6 +1168,14 @@ export const generatedSidebar = [
"path": "/references/cart/updateLineItems", "path": "/references/cart/updateLineItems",
"title": "updateLineItems", "title": "updateLineItems",
"children": [] "children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/cart/updateShippingMethods",
"title": "updateShippingMethods",
"children": []
} }
] ]
} }
@@ -1187,7 +1195,7 @@ export const generatedSidebar = [
"isPathHref": true, "isPathHref": true,
"type": "category", "type": "category",
"title": "Data Models", "title": "Data Models",
"autogenerate_path": "/references/cart_models/classes", "autogenerate_path": "/references/cart_models/variables",
"children": [ "children": [
{ {
"loaded": true, "loaded": true,
@@ -6789,7 +6797,7 @@ export const generatedSidebar = [
"isPathHref": true, "isPathHref": true,
"type": "category", "type": "category",
"title": "Data Models", "title": "Data Models",
"autogenerate_path": "/references/sales_channel_models/classes", "autogenerate_path": "/references/sales_channel_models/variables",
"children": [ "children": [
{ {
"loaded": true, "loaded": true,
@@ -7127,7 +7135,7 @@ export const generatedSidebar = [
"isPathHref": true, "isPathHref": true,
"type": "category", "type": "category",
"title": "Data Models", "title": "Data Models",
"autogenerate_path": "/references/store_models/classes", "autogenerate_path": "/references/store_models/variables",
"children": [ "children": [
{ {
"loaded": true, "loaded": true,
@@ -9574,14 +9582,6 @@ export const generatedSidebar = [
"path": "/references/workflows/transform", "path": "/references/workflows/transform",
"title": "transform", "title": "transform",
"children": [] "children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/workflows/when",
"title": "when",
"children": []
} }
] ]
} }
+29 -29
View File
@@ -50,9 +50,9 @@ export const slugChanges = [
"filePath": "/www/apps/resources/references/api_key/interfaces/api_key.IApiKeyModuleService/page.mdx" "filePath": "/www/apps/resources/references/api_key/interfaces/api_key.IApiKeyModuleService/page.mdx"
}, },
{ {
"origSlug": "/references/api_key_models/classes/api_key_models.ApiKey", "origSlug": "/references/api_key_models/variables/api_key_models.ApiKey",
"newSlug": "/references/api-key/models/ApiKey", "newSlug": "/references/api-key/models/ApiKey",
"filePath": "/www/apps/resources/references/api_key_models/classes/api_key_models.ApiKey/page.mdx" "filePath": "/www/apps/resources/references/api_key_models/variables/api_key_models.ApiKey/page.mdx"
}, },
{ {
"origSlug": "/references/auth/IAuthModuleService/methods/auth.IAuthModuleService.authenticate", "origSlug": "/references/auth/IAuthModuleService/methods/auth.IAuthModuleService.authenticate",
@@ -399,50 +399,55 @@ export const slugChanges = [
"newSlug": "/references/cart/updateLineItems", "newSlug": "/references/cart/updateLineItems",
"filePath": "/www/apps/resources/references/cart/ICartModuleService/methods/cart.ICartModuleService.updateLineItems/page.mdx" "filePath": "/www/apps/resources/references/cart/ICartModuleService/methods/cart.ICartModuleService.updateLineItems/page.mdx"
}, },
{
"origSlug": "/references/cart/ICartModuleService/methods/cart.ICartModuleService.updateShippingMethods",
"newSlug": "/references/cart/updateShippingMethods",
"filePath": "/www/apps/resources/references/cart/ICartModuleService/methods/cart.ICartModuleService.updateShippingMethods/page.mdx"
},
{ {
"origSlug": "/references/cart/interfaces/cart.ICartModuleService", "origSlug": "/references/cart/interfaces/cart.ICartModuleService",
"newSlug": "/references/cart", "newSlug": "/references/cart",
"filePath": "/www/apps/resources/references/cart/interfaces/cart.ICartModuleService/page.mdx" "filePath": "/www/apps/resources/references/cart/interfaces/cart.ICartModuleService/page.mdx"
}, },
{ {
"origSlug": "/references/cart_models/classes/cart_models.Address", "origSlug": "/references/cart_models/variables/cart_models.Address",
"newSlug": "/references/cart/models/Address", "newSlug": "/references/cart/models/Address",
"filePath": "/www/apps/resources/references/cart_models/classes/cart_models.Address/page.mdx" "filePath": "/www/apps/resources/references/cart_models/variables/cart_models.Address/page.mdx"
}, },
{ {
"origSlug": "/references/cart_models/classes/cart_models.Cart", "origSlug": "/references/cart_models/variables/cart_models.Cart",
"newSlug": "/references/cart/models/Cart", "newSlug": "/references/cart/models/Cart",
"filePath": "/www/apps/resources/references/cart_models/classes/cart_models.Cart/page.mdx" "filePath": "/www/apps/resources/references/cart_models/variables/cart_models.Cart/page.mdx"
}, },
{ {
"origSlug": "/references/cart_models/classes/cart_models.LineItem", "origSlug": "/references/cart_models/variables/cart_models.LineItem",
"newSlug": "/references/cart/models/LineItem", "newSlug": "/references/cart/models/LineItem",
"filePath": "/www/apps/resources/references/cart_models/classes/cart_models.LineItem/page.mdx" "filePath": "/www/apps/resources/references/cart_models/variables/cart_models.LineItem/page.mdx"
}, },
{ {
"origSlug": "/references/cart_models/classes/cart_models.LineItemAdjustment", "origSlug": "/references/cart_models/variables/cart_models.LineItemAdjustment",
"newSlug": "/references/cart/models/LineItemAdjustment", "newSlug": "/references/cart/models/LineItemAdjustment",
"filePath": "/www/apps/resources/references/cart_models/classes/cart_models.LineItemAdjustment/page.mdx" "filePath": "/www/apps/resources/references/cart_models/variables/cart_models.LineItemAdjustment/page.mdx"
}, },
{ {
"origSlug": "/references/cart_models/classes/cart_models.LineItemTaxLine", "origSlug": "/references/cart_models/variables/cart_models.LineItemTaxLine",
"newSlug": "/references/cart/models/LineItemTaxLine", "newSlug": "/references/cart/models/LineItemTaxLine",
"filePath": "/www/apps/resources/references/cart_models/classes/cart_models.LineItemTaxLine/page.mdx" "filePath": "/www/apps/resources/references/cart_models/variables/cart_models.LineItemTaxLine/page.mdx"
}, },
{ {
"origSlug": "/references/cart_models/classes/cart_models.ShippingMethod", "origSlug": "/references/cart_models/variables/cart_models.ShippingMethod",
"newSlug": "/references/cart/models/ShippingMethod", "newSlug": "/references/cart/models/ShippingMethod",
"filePath": "/www/apps/resources/references/cart_models/classes/cart_models.ShippingMethod/page.mdx" "filePath": "/www/apps/resources/references/cart_models/variables/cart_models.ShippingMethod/page.mdx"
}, },
{ {
"origSlug": "/references/cart_models/classes/cart_models.ShippingMethodAdjustment", "origSlug": "/references/cart_models/variables/cart_models.ShippingMethodAdjustment",
"newSlug": "/references/cart/models/ShippingMethodAdjustment", "newSlug": "/references/cart/models/ShippingMethodAdjustment",
"filePath": "/www/apps/resources/references/cart_models/classes/cart_models.ShippingMethodAdjustment/page.mdx" "filePath": "/www/apps/resources/references/cart_models/variables/cart_models.ShippingMethodAdjustment/page.mdx"
}, },
{ {
"origSlug": "/references/cart_models/classes/cart_models.ShippingMethodTaxLine", "origSlug": "/references/cart_models/variables/cart_models.ShippingMethodTaxLine",
"newSlug": "/references/cart/models/ShippingMethodTaxLine", "newSlug": "/references/cart/models/ShippingMethodTaxLine",
"filePath": "/www/apps/resources/references/cart_models/classes/cart_models.ShippingMethodTaxLine/page.mdx" "filePath": "/www/apps/resources/references/cart_models/variables/cart_models.ShippingMethodTaxLine/page.mdx"
}, },
{ {
"origSlug": "/references/core_flows/Api_Key/Steps_Api_Key/functions/core_flows.Api_Key.Steps_Api_Key.createApiKeysStep", "origSlug": "/references/core_flows/Api_Key/Steps_Api_Key/functions/core_flows.Api_Key.Steps_Api_Key.createApiKeysStep",
@@ -6520,9 +6525,9 @@ export const slugChanges = [
"filePath": "/www/apps/resources/references/sales_channel/interfaces/sales_channel.ISalesChannelModuleService/page.mdx" "filePath": "/www/apps/resources/references/sales_channel/interfaces/sales_channel.ISalesChannelModuleService/page.mdx"
}, },
{ {
"origSlug": "/references/sales_channel_models/classes/sales_channel_models.SalesChannel", "origSlug": "/references/sales_channel_models/variables/sales_channel_models.SalesChannel",
"newSlug": "/references/sales-channel/models/SalesChannel", "newSlug": "/references/sales-channel/models/SalesChannel",
"filePath": "/www/apps/resources/references/sales_channel_models/classes/sales_channel_models.SalesChannel/page.mdx" "filePath": "/www/apps/resources/references/sales_channel_models/variables/sales_channel_models.SalesChannel/page.mdx"
}, },
{ {
"origSlug": "/references/search/classes/search.AbstractSearchService", "origSlug": "/references/search/classes/search.AbstractSearchService",
@@ -6640,14 +6645,14 @@ export const slugChanges = [
"filePath": "/www/apps/resources/references/store/interfaces/store.IStoreModuleService/page.mdx" "filePath": "/www/apps/resources/references/store/interfaces/store.IStoreModuleService/page.mdx"
}, },
{ {
"origSlug": "/references/store_models/classes/store_models.Store", "origSlug": "/references/store_models/variables/store_models.Store",
"newSlug": "/references/store/models/Store", "newSlug": "/references/store/models/Store",
"filePath": "/www/apps/resources/references/store_models/classes/store_models.Store/page.mdx" "filePath": "/www/apps/resources/references/store_models/variables/store_models.Store/page.mdx"
}, },
{ {
"origSlug": "/references/store_models/classes/store_models.StoreCurrency", "origSlug": "/references/store_models/variables/store_models.StoreCurrency",
"newSlug": "/references/store/models/StoreCurrency", "newSlug": "/references/store/models/StoreCurrency",
"filePath": "/www/apps/resources/references/store_models/classes/store_models.StoreCurrency/page.mdx" "filePath": "/www/apps/resources/references/store_models/variables/store_models.StoreCurrency/page.mdx"
}, },
{ {
"origSlug": "/references/tax/ITaxModuleService/methods/tax.ITaxModuleService.createTaxRateRules", "origSlug": "/references/tax/ITaxModuleService/methods/tax.ITaxModuleService.createTaxRateRules",
@@ -6913,10 +6918,5 @@ export const slugChanges = [
"origSlug": "/references/workflows/functions/workflows.transform", "origSlug": "/references/workflows/functions/workflows.transform",
"newSlug": "/references/workflows/transform", "newSlug": "/references/workflows/transform",
"filePath": "/www/apps/resources/references/workflows/functions/workflows.transform/page.mdx" "filePath": "/www/apps/resources/references/workflows/functions/workflows.transform/page.mdx"
},
{
"origSlug": "/references/workflows/functions/workflows.when",
"newSlug": "/references/workflows/when",
"filePath": "/www/apps/resources/references/workflows/functions/workflows.when/page.mdx"
} }
] ]
@@ -1,13 +0,0 @@
---
displayed_sidebar: apiKeyModelReference
slug: /references/api-key/models/ApiKey
sidebar_label: ApiKey
---
import { TypeList } from "docs-ui"
# ApiKey - API Key Module Data Models Reference
This documentation provides a reference to the ApiKey . This belongs to the API Key Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"salt","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`\"publishable\"` \\| `\"secret\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ApiKey"/>
@@ -0,0 +1,13 @@
---
displayed_sidebar: apiKeyModelReference
slug: /references/api-key/models/ApiKey
sidebar_label: ApiKey
---
import { TypeList } from "docs-ui"
# ApiKey - API Key Module Data Models Reference
This documentation provides a reference to the ApiKey data model. It belongs to the API Key Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`TextProperty`","description":"The token of the API key","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"salt","type":"`TextProperty`","description":"Salt used to create the API key token.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`TextProperty`","description":"The redacted form of the api key's token. this is useful when showing portion of the token.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the API key","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty&#60;[\"publishable\", \"secret\"]&#62;","description":"The type of the API key. Can be `secret` or `publishable`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the API key","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`DateTimeProperty`","description":"The date the API key was last used.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`TextProperty`","description":"The ID of the user that revoked the API key","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`DateTimeProperty`","description":"The date the API key was revoked.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ApiKey"/>
@@ -20,7 +20,7 @@ This method is used to authenticate a user using a provider. The `authenticate`
underlying provider is called, passing it the `providerData` parameter as a parameter. The method underlying provider is called, passing it the `providerData` parameter as a parameter. The method
returns the data returned by the provider. returns the data returned by the provider.
Refer to [this guide](https://docs.medusajs.com/experimental/auth/auth-flows) to learn more about the authentication flows. Refer to [this guide](https://docs.medusajs.com/resources/commerce-modules/auth/authentication-route) to learn more about the authentication flows.
## Example ## Example
@@ -26,7 +26,7 @@ provider when the user finishes performing the required action.
In that API route, you can call this method to validate the third-party provider's In that API route, you can call this method to validate the third-party provider's
callback and authenticate the user. callback and authenticate the user.
Learn more about this authentication flow in [this guide](https://docs.medusajs.com/experimental/auth/auth-flows#authentication-with-third-party-service). Learn more about this authentication flow in [this guide](https://docs.medusajs.com/resources/commerce-modules/auth/authentication-route#2-third-party-service-authenticate-flow).
## Example ## Example
@@ -0,0 +1,63 @@
---
displayed_sidebar: cartReference
slug: /references/cart/updateShippingMethods
sidebar_label: updateShippingMethods
---
import { TypeList } from "docs-ui"
# updateShippingMethods - Cart Module Reference
This documentation provides a reference to the `updateShippingMethods` method. This belongs to the Cart Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## updateShippingMethods(data): Promise&#60;[CartShippingMethodDTO](../../../interfaces/cart.CartShippingMethodDTO/page.mdx)[]&#62;
This method updates existing shipping methods.
### Example
```ts
const shippingMethods = await cartModuleService.updateShippingMethods([
{
id: "casm_123",
amount: 2,
},
])
```
### Parameters
<TypeList types={[{"name":"data","type":"[UpdateShippingMethodDTO](../../../interfaces/cart.UpdateShippingMethodDTO/page.mdx)[]","description":"A list of shipping methods to update","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/cart.BigNumberInput/page.mdx)","description":"The amount of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/cart.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"The tax inclusivity setting of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[CreateTaxLineDTO](../../../interfaces/cart.CreateTaxLineDTO/page.mdx)[] \\| [UpdateTaxLineDTO](../../../interfaces/cart.UpdateTaxLineDTO/page.mdx)[]","description":"The tax lines of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the tax line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated provider's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the tax line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the tax line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated provider's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"adjustments","type":"[CreateAdjustmentDTO](../../../interfaces/cart.CreateAdjustmentDTO/page.mdx)[] \\| [UpdateAdjustmentDTO](../../../interfaces/cart.UpdateAdjustmentDTO/page.mdx)[]","description":"The adjustments of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The code of the promotion that lead to\nthis adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/cart.BigNumberInput/page.mdx)","description":"The amount to adjust the original amount with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/cart.BigNumberInput/page.mdx)","description":"The amount to adjust the original amount with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`striLine truncated
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[CartShippingMethodDTO](../../../interfaces/cart.CartShippingMethodDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated shipping methods.","expandable":false,"children":[{"name":"CartShippingMethodDTO[]","type":"[CartShippingMethodDTO](../../../interfaces/cart.CartShippingMethodDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CartShippingMethodDTO","type":"`object`","description":"The cart shipping method details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateShippingMethods"/>
## updateShippingMethods(shippingMethodId, data, sharedContext?): Promise&#60;[CartShippingMethodDTO](../../../interfaces/cart.CartShippingMethodDTO/page.mdx)&#62;
This method updates an existing shipping method.
### Example
```ts
const lineItem = await cartModuleService.updateShippingMethods(
"casm_123",
{
amount: 3000,
}
)
```
### Parameters
<TypeList types={[{"name":"shippingMethodId","type":"`string`","description":"The shipping methods's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"Partial&#60;[UpdateShippingMethodDTO](../../../interfaces/cart.UpdateShippingMethodDTO/page.mdx)&#62;","description":"The attributes to update in the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/cart.BigNumberInput/page.mdx)","description":"The amount of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/cart.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"The tax inclusivity setting of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[CreateTaxLineDTO](../../../interfaces/cart.CreateTaxLineDTO/page.mdx)[] \\| [UpdateTaxLineDTO](../../../interfaces/cart.UpdateTaxLineDTO/page.mdx)[]","description":"The tax lines of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the tax line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated provider's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the tax line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the tax line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated provider's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"adjustments","type":"[CreateAdjustmentDTO](../../../interfaces/cart.CreateAdjustmentDTO/page.mdx)[] \\| [UpdateAdjustmentDTO](../../../interfaces/cart.UpdateAdjustmentDTO/page.mdx)[]","description":"The adjustments of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The code of the promotion that lead to\nthis adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/cart.BigNumberInput/page.mdx)","description":"The amount to adjust the original amount with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/cart.BigNumberLine truncated
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[CartShippingMethodDTO](../../../interfaces/cart.CartShippingMethodDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated shipping method.","expandable":false,"children":[{"name":"CartShippingMethodDTO","type":"[CartShippingMethodDTO](../../../interfaces/cart.CartShippingMethodDTO/page.mdx)","optional":false,"defaultValue":"","description":"The cart shipping method details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the associated cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/cart.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/cart.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/cart.BigNumberValue/page.mdx)","description":"The original total of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/cart.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/cart.BigNumberValue/page.mdx)","description":"The original subtotal of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/cart.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/cart.BigNumberValue/page.mdx)","description":"The original tax total of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/cart.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"total","type":"[BigNumberValue](../../../types/cart.BigNumberValue/page.mdx)","description":"The total of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/cart.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"[BigNumberValue](../../../types/cart.BigNumberValue/page.mdx)","description":"The subtotal of the cart shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultVaLine truncated
@@ -69,3 +69,4 @@ The main service interface for the Cart Module.
- [updateAddresses](../../ICartModuleService/methods/cart.ICartModuleService.updateAddresses/page.mdx) - [updateAddresses](../../ICartModuleService/methods/cart.ICartModuleService.updateAddresses/page.mdx)
- [updateCarts](../../ICartModuleService/methods/cart.ICartModuleService.updateCarts/page.mdx) - [updateCarts](../../ICartModuleService/methods/cart.ICartModuleService.updateCarts/page.mdx)
- [updateLineItems](../../ICartModuleService/methods/cart.ICartModuleService.updateLineItems/page.mdx) - [updateLineItems](../../ICartModuleService/methods/cart.ICartModuleService.updateLineItems/page.mdx)
- [updateShippingMethods](../../ICartModuleService/methods/cart.ICartModuleService.updateShippingMethods/page.mdx)
@@ -0,0 +1,11 @@
---
displayed_sidebar: cartReference
---
import { TypeList } from "docs-ui"
# UpdateShippingMethodDTO
The attributes to update in the shipping method.
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../types/cart.BigNumberInput/page.mdx)","description":"The amount of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/cart.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"The tax inclusivity setting of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[CreateTaxLineDTO](../cart.CreateTaxLineDTO/page.mdx)[] \\| [UpdateTaxLineDTO](../cart.UpdateTaxLineDTO/page.mdx)[]","description":"The tax lines of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the tax line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated provider's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the tax line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The code of the tax line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated provider's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"adjustments","type":"[CreateAdjustmentDTO](../cart.CreateAdjustmentDTO/page.mdx)[] \\| [UpdateAdjustmentDTO](../cart.UpdateAdjustmentDTO/page.mdx)[]","description":"The adjustments of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The code of the promotion that lead to\nthis adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../types/cart.BigNumberInput/page.mdx)","description":"The amount to adjust the original amount with.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/cart.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type"Line truncated
@@ -1,13 +0,0 @@
---
displayed_sidebar: cartModelReference
slug: /references/cart/models/Address
sidebar_label: Address
---
import { TypeList } from "docs-ui"
# Address - Cart Module Data Models Reference
This documentation provides a reference to the Address . This belongs to the Cart Module.
<TypeList types={[{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Address"/>
@@ -1,13 +0,0 @@
---
displayed_sidebar: cartModelReference
slug: /references/cart/models/Cart
sidebar_label: Cart
---
import { TypeList } from "docs-ui"
# Cart - Cart Module Data Models Reference
This documentation provides a reference to the Cart . This belongs to the Cart Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../cart_models.Address/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"`null` \\| [Address](../cart_models.Address/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"","optional":false,"defauLine truncated
@@ -1,13 +0,0 @@
---
displayed_sidebar: cartModelReference
slug: /references/cart/models/LineItem
sidebar_label: LineItem
---
import { TypeList } from "docs-ui"
# LineItem - Cart Module Data Models Reference
This documentation provides a reference to the LineItem . This belongs to the Cart Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../cart_models.Cart/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../cart_models.Address/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"`null` \\| [Address](../cart_models.Address/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":falseLine truncated
@@ -1,13 +0,0 @@
---
displayed_sidebar: cartModelReference
slug: /references/cart/models/LineItemAdjustment
sidebar_label: LineItemAdjustment
---
import { TypeList } from "docs-ui"
# LineItemAdjustment - Cart Module Data Models Reference
This documentation provides a reference to the LineItemAdjustment . This belongs to the Cart Module.
<TypeList types={[{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[LineItem](../cart_models.LineItem/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../cart_models.Cart/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../cart_models.Address/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"`null` \\| [Address](../cart_models.Address/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"items","type":"Collection&#60;[LineItem](../cart_models.LineItem/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"Collection&#60;[ShippingMethod](../cart_models.ShippingMethod/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalCartProps`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"","optional":false,"defauLine truncated
@@ -1,13 +0,0 @@
---
displayed_sidebar: cartModelReference
slug: /references/cart/models/LineItemTaxLine
sidebar_label: LineItemTaxLine
---
import { TypeList } from "docs-ui"
# LineItemTaxLine - Cart Module Data Models Reference
This documentation provides a reference to the LineItemTaxLine . This belongs to the Cart Module.
<TypeList types={[{"name":"item","type":"[LineItem](../cart_models.LineItem/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../cart_models.Cart/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../cart_models.Address/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"`null` \\| [Address](../cart_models.Address/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"items","type":"Collection&#60;[LineItem](../cart_models.LineItem/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"Collection&#60;[ShippingMethod](../cart_models.ShippingMethod/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalCartProps`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_subtitle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_type","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_type_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_collection","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"product_handle","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expaLine truncated
@@ -1,13 +0,0 @@
---
displayed_sidebar: cartModelReference
slug: /references/cart/models/ShippingMethod
sidebar_label: ShippingMethod
---
import { TypeList } from "docs-ui"
# ShippingMethod - Cart Module Data Models Reference
This documentation provides a reference to the ShippingMethod . This belongs to the Cart Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../cart_models.Cart/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../cart_models.Address/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"`null` \\| [Address](../cart_models.Address/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":falseLine truncated
@@ -1,13 +0,0 @@
---
displayed_sidebar: cartModelReference
slug: /references/cart/models/ShippingMethodAdjustment
sidebar_label: ShippingMethodAdjustment
---
import { TypeList } from "docs-ui"
# ShippingMethodAdjustment - Cart Module Data Models Reference
This documentation provides a reference to the ShippingMethodAdjustment . This belongs to the Cart Module.
<TypeList types={[{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[ShippingMethod](../cart_models.ShippingMethod/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../cart_models.Cart/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../cart_models.Address/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"`null` \\| [Address](../cart_models.Address/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"items","type":"Collection&#60;[LineItem](../cart_models.LineItem/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"Collection&#60;[ShippingMethod](../cart_models.ShippingMethod/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalCartProps`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description"Line truncated
@@ -1,13 +0,0 @@
---
displayed_sidebar: cartModelReference
slug: /references/cart/models/ShippingMethodTaxLine
sidebar_label: ShippingMethodTaxLine
---
import { TypeList } from "docs-ui"
# ShippingMethodTaxLine - Cart Module Data Models Reference
This documentation provides a reference to the ShippingMethodTaxLine . This belongs to the Cart Module.
<TypeList types={[{"name":"shipping_method","type":"[ShippingMethod](../cart_models.ShippingMethod/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../cart_models.Cart/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../cart_models.Address/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"`null` \\| [Address](../cart_models.Address/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"items","type":"Collection&#60;[LineItem](../cart_models.LineItem/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"Collection&#60;[ShippingMethod](../cart_models.ShippingMethod/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalCartProps`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_tax_inclusive","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"tax_lines","type":"Collection&#60;[ShippingMethodTaxLine](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"shipping_method","type":"[ShippingMethod](../cart_models.ShippingMethod/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string`","description":"","optional":false,"defaultValue":"","exLine truncated
@@ -0,0 +1,13 @@
---
displayed_sidebar: cartModelReference
slug: /references/cart/models/Address
sidebar_label: Address
---
import { TypeList } from "docs-ui"
# Address - Cart Module Data Models Reference
This documentation provides a reference to the Address data model. It belongs to the Cart Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the customer that the address belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`TextProperty`","description":"The company of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`TextProperty`","description":"The first name of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`TextProperty`","description":"The last name of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`TextProperty`","description":"The first line of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`TextProperty`","description":"The second line of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"The city of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The ISO 2 country code of the address. For example, `us`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`TextProperty`","description":"The province of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`TextProperty`","description":"The postal code of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`TextProperty`","description":"The phone of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Address"/>
@@ -0,0 +1,13 @@
---
displayed_sidebar: cartModelReference
slug: /references/cart/models/Cart
sidebar_label: Cart
---
import { TypeList } from "docs-ui"
# Cart - Cart Module Data Models Reference
This documentation provides a reference to the Cart data model. It belongs to the Cart Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code of the cart, such as `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany&#60;[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)&#62;","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of promotion that applied the adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the external provider that the adjustment is related to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`TextProperty`","description":"The ID of the applied promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_lines","type":"HasMany&#60;[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)&#62;","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`NumberProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item tax line","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the provider used to calculate the tax line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`TextProperty`","description":"The ID of the applied tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"Line truncated
@@ -0,0 +1,13 @@
---
displayed_sidebar: cartModelReference
slug: /references/cart/models/LineItem
sidebar_label: LineItem
---
import { TypeList } from "docs-ui"
# LineItem - Cart Module Data Models Reference
This documentation provides a reference to the LineItem data model. It belongs to the Cart Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany&#60;[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)&#62;","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany&#60;[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)&#62;","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_lines","type":"HasMany&#60;[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)&#62;","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart","type":"BelongsTo&#60;[Cart](../cart_models.Cart/page.mdx)&#62;","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"subtitle","type":"`TextProperty`","description":"The subtitle of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`TextProperty`","description":"The thumbnail URL of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`TextProperty`","description":"The ID of the variant added to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`TextProperty`","description":"The ID of the product added to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"`TextProperty`","description":"The title of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"`TextProperty`","description":"The description of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"`TextProperty`","description":"The subtitle of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"`TeLine truncated
@@ -0,0 +1,13 @@
---
displayed_sidebar: cartModelReference
slug: /references/cart/models/LineItemAdjustment
sidebar_label: LineItemAdjustment
---
import { TypeList } from "docs-ui"
# LineItemAdjustment - Cart Module Data Models Reference
This documentation provides a reference to the LineItemAdjustment data model. It belongs to the Cart Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany&#60;[LineItemAdjustment](page.mdx)&#62;","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of promotion that applied the adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the external provider that the adjustment is related to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`TextProperty`","description":"The ID of the applied promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_lines","type":"HasMany&#60;[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)&#62;","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`NumberProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item tax line","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the provider used to calculate the tax line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`TextProperty`","description":"The ID of the applied tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"BelongsLine truncated
@@ -0,0 +1,13 @@
---
displayed_sidebar: cartModelReference
slug: /references/cart/models/LineItemTaxLine
sidebar_label: LineItemTaxLine
---
import { TypeList } from "docs-ui"
# LineItemTaxLine - Cart Module Data Models Reference
This documentation provides a reference to the LineItemTaxLine data model. It belongs to the Cart Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`NumberProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany&#60;[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)&#62;","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the line item adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of promotion that applied the adjustment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the external provider that the adjustment is related to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_id","type":"`TextProperty`","description":"The ID of the applied promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_lines","type":"HasMany&#60;[LineItemTaxLine](page.mdx)&#62;","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`NumberProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the line item tax line","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the provider used to calculate the tax line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`TextProperty`"Line truncated
@@ -0,0 +1,13 @@
---
displayed_sidebar: cartModelReference
slug: /references/cart/models/ShippingMethod
sidebar_label: ShippingMethod
---
import { TypeList } from "docs-ui"
# ShippingMethod - Cart Module Data Models Reference
This documentation provides a reference to the ShippingMethod data model. It belongs to the Cart Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the shipping method's amount is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"BelongsTo&#60;[Cart](../cart_models.Cart/page.mdx)&#62;","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code of the cart, such as `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`NumberProperty`","description":"The quantity of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`BooleanProperty`","description":"Whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item's price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`BigNumberProperty`","description":"The unit price of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adjustments","type":"HasMany&#60;[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)&#62;","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_lines","type":"HasMany&#60;[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)&#62;","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart","type":"BelongsTo&#60;[Cart](../cart_models.Cart/page.mdx)&#62;","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"subtitle","type":"`TextProperty`","description":"The subtitle of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`TextProperty`","description":"The thumbnail URL of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`TextProperty`","description":"The ID of the variant added to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`TextProperty`","description":"The ID of the product added to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"`TextProperty`","description":"The title of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"`TextProperty`","description":"The description of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"`TextProperty`","description":"The subtitle of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"`TextProperty`","description":"The type of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type_id","type":"`TextProperty`","description":"The ID of the type of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collection","type":"`TextProperty`","description":"The collection of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_handle","type":"Line truncated
@@ -0,0 +1,13 @@
---
displayed_sidebar: cartModelReference
slug: /references/cart/models/ShippingMethodAdjustment
sidebar_label: ShippingMethodAdjustment
---
import { TypeList } from "docs-ui"
# ShippingMethodAdjustment - Cart Module Data Models Reference
This documentation provides a reference to the ShippingMethodAdjustment data model. It belongs to the Cart Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping method adjustment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The shipping method adjustment's amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"BelongsTo&#60;[ShippingMethod](../cart_models.ShippingMethod/page.mdx)&#62;","description":"The associated shipping\\_method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the shipping method's amount is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"BelongsTo&#60;[Cart](../cart_models.Cart/page.mdx)&#62;","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code of the cart, such as `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"HasMany&#60;[ShippingMethod](../cart_models.ShippingMethod/page.mdx)&#62;","description":"The associated shipping\\_methods.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the cart's region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`TextProperty`","description":"The ID of the cart's sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the cart's customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`DateTimeProperty`","description":"The date the cart was completed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"HasOneWithForeignKey&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; customer_id?: TextProperty ; company?: TextProperty ; first_name?: TextProperty ; last_name?: TextProperty ; address_1?: TextProperty ; address_2?: TextProperty ; city?: TextProperty ; country_code?: TextProperty ; province?: TextProperty ; postal_code?: TextProperty ; phone?: TextProperty ; metadata?: JSONProperty &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; customer_id?: TextProperty ; company?: TextProperty ; first_name?: TextProperty ; last_name?: TextProperty ; address_1?: TextProperty ; address_2?: TextProperty ; city?: TextProperty ; country_code?: TextProperty ; province?: TextProperty ; postal_code?: TextProperty ; phone?: TextProperty ; metadata?: JSONProperty &#125; & {} & DMLSchemaDefaults, &#123; tableName: \"cart_address\" = \"cart_address\"; name: \"Address\" = \"Address\" &#125;&#62;&#62;","description":"The associated shipping\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address","type":"HasOneWithForeignKey&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; customer_id?: TextProperty ; company?: TextProperty ; first_name?: TextProperty ; last_name?: TextProperty ; address_1?: TextProperty ; address_2?: TextProperty ; city?: TextProperty ; country_code?: TextProperty ; province?: TextProperty ; postal_code?: TextProperty ; phone?: TextProperty ; metadata?: JSONProperty &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; customer_id?: TextProperty ; company?: TextProperty ;Line truncated
@@ -0,0 +1,13 @@
---
displayed_sidebar: cartModelReference
slug: /references/cart/models/ShippingMethodTaxLine
sidebar_label: ShippingMethodTaxLine
---
import { TypeList } from "docs-ui"
# ShippingMethodTaxLine - Cart Module Data Models Reference
This documentation provides a reference to the ShippingMethodTaxLine data model. It belongs to the Cart Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping method tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`NumberProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"BelongsTo&#60;[ShippingMethod](../cart_models.ShippingMethod/page.mdx)&#62;","description":"The associated shipping\\_method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the shipping method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the shipping method's amount is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"BelongsTo&#60;[Cart](../cart_models.Cart/page.mdx)&#62;","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code of the cart, such as `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany&#60;[LineItem](../cart_models.LineItem/page.mdx)&#62;","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"HasMany&#60;[ShippingMethod](../cart_models.ShippingMethod/page.mdx)&#62;","description":"The associated shipping\\_methods.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the cart's region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`TextProperty`","description":"The ID of the cart's sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the cart's customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`DateTimeProperty`","description":"The date the cart was completed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"HasOneWithForeignKey&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; customer_id?: TextProperty ; company?: TextProperty ; first_name?: TextProperty ; last_name?: TextProperty ; address_1?: TextProperty ; address_2?: TextProperty ; city?: TextProperty ; country_code?: TextProperty ; province?: TextProperty ; postal_code?: TextProperty ; phone?: TextProperty ; metadata?: JSONProperty &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; customer_id?: TextProperty ; company?: TextProperty ; first_name?: TextProperty ; last_name?: TextProperty ; address_1?: TextProperty ; address_2?: TextProperty ; city?: TextProperty ; country_code?: TextProperty ; province?: TextProperty ; postal_code?: TextProperty ; phone?: TextProperty ; metadata?: JSONProperty &#125; & {} & DMLSchemaDefaults, &#123; tableName: \"cart_address\" = \"cart_address\"; name: \"Address\" = \"Address\" &#125;&#62;&#62;","description":"The associated shipping\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address","type":"HasOneWithForeignKey&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; customer_id?: TextProperty ; company?: TextProperty ; first_name?: TextProperty ; last_name?: TextProperty ; address_1?: TextProperty ; address_2?: TextProperty ; city?: TextProperty ; country_code?: TextProperty ; province?: TextProperty ; postal_code?: TextProperty ; phone?: TextPropeLine truncated
@@ -5,7 +5,7 @@ sidebar_label: createApiKeysStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# createApiKeysStep - Medusa Workflows API Reference # createApiKeysStep - Medusa Core Workflows Reference
This documentation provides a reference to the `createApiKeysStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `createApiKeysStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: deleteApiKeysStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteApiKeysStep - Medusa Workflows API Reference # deleteApiKeysStep - Medusa Core Workflows Reference
This documentation provides a reference to the `deleteApiKeysStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `deleteApiKeysStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: linkSalesChannelsToApiKeyStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# linkSalesChannelsToApiKeyStep - Medusa Workflows API Reference # linkSalesChannelsToApiKeyStep - Medusa Core Workflows Reference
This documentation provides a reference to the `linkSalesChannelsToApiKeyStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `linkSalesChannelsToApiKeyStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: revokeApiKeysStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# revokeApiKeysStep - Medusa Workflows API Reference # revokeApiKeysStep - Medusa Core Workflows Reference
This documentation provides a reference to the `revokeApiKeysStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `revokeApiKeysStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: updateApiKeysStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# updateApiKeysStep - Medusa Workflows API Reference # updateApiKeysStep - Medusa Core Workflows Reference
This documentation provides a reference to the `updateApiKeysStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `updateApiKeysStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: validateSalesChannelsExistStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# validateSalesChannelsExistStep - Medusa Workflows API Reference # validateSalesChannelsExistStep - Medusa Core Workflows Reference
This documentation provides a reference to the `validateSalesChannelsExistStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `validateSalesChannelsExistStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: createApiKeysWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# createApiKeysWorkflow - Medusa Workflows API Reference # createApiKeysWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `createApiKeysWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `createApiKeysWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: deleteApiKeysWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteApiKeysWorkflow - Medusa Workflows API Reference # deleteApiKeysWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `deleteApiKeysWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `deleteApiKeysWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -13,7 +13,7 @@ This workflow deletes one or more API keys.
## Steps ## Steps
<WorkflowDiagram workflow={{"name":"deleteApiKeysWorkflow","steps":[{"type":"step","name":"deleteApiKeysStep","description":"This step deletes one or more API keys.","link":"../../../../Steps_Api_Key/functions/core_flows.Steps_Api_Key.deleteApiKeysStep/page.mdx","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/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.removeRemoteLinkStep/page.mdx","depth":2}]}} /> <WorkflowDiagram workflow={{"name":"deleteApiKeysWorkflow","steps":[{"type":"step","name":"deleteApiKeysStep","description":"This step deletes one or more API keys.","link":"../../../../Steps_Api_Key/functions/core_flows.Steps_Api_Key.deleteApiKeysStep/page.mdx","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/learn/fundamentals/module-links/remote-link#cascade-delete-linked-records)\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.removeRemoteLinkStep/page.mdx","depth":2}]}} />
## Input ## Input
@@ -5,7 +5,7 @@ sidebar_label: linkSalesChannelsToApiKeyWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# linkSalesChannelsToApiKeyWorkflow - Medusa Workflows API Reference # linkSalesChannelsToApiKeyWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `linkSalesChannelsToApiKeyWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `linkSalesChannelsToApiKeyWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: revokeApiKeysWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# revokeApiKeysWorkflow - Medusa Workflows API Reference # revokeApiKeysWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `revokeApiKeysWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `revokeApiKeysWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: updateApiKeysWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# updateApiKeysWorkflow - Medusa Workflows API Reference # updateApiKeysWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `updateApiKeysWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `updateApiKeysWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: setAuthAppMetadataStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# setAuthAppMetadataStep - Medusa Workflows API Reference # setAuthAppMetadataStep - Medusa Core Workflows Reference
This documentation provides a reference to the `setAuthAppMetadataStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `setAuthAppMetadataStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,13 +5,13 @@ sidebar_label: generateResetPasswordTokenWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# generateResetPasswordTokenWorkflow - Medusa Workflows API Reference # generateResetPasswordTokenWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `generateResetPasswordTokenWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `generateResetPasswordTokenWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
## Steps ## Steps
<WorkflowDiagram workflow={{"name":"generateResetPasswordTokenWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/advanced-development/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.emitEventStep/page.mdx","depth":2}]}} /> <WorkflowDiagram workflow={{"name":"generateResetPasswordTokenWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.emitEventStep/page.mdx","depth":2}]}} />
## Input ## Input
@@ -5,7 +5,7 @@ sidebar_label: addShippingMethodToCartStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# addShippingMethodToCartStep - Medusa Workflows API Reference # addShippingMethodToCartStep - Medusa Core Workflows Reference
This documentation provides a reference to the `addShippingMethodToCartStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `addShippingMethodToCartStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: confirmInventoryStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# confirmInventoryStep - Medusa Workflows API Reference # confirmInventoryStep - Medusa Core Workflows Reference
This documentation provides a reference to the `confirmInventoryStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `confirmInventoryStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: createCartsStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# createCartsStep - Medusa Workflows API Reference # createCartsStep - Medusa Core Workflows Reference
This documentation provides a reference to the `createCartsStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `createCartsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: createLineItemAdjustmentsStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# createLineItemAdjustmentsStep - Medusa Workflows API Reference # createLineItemAdjustmentsStep - Medusa Core Workflows Reference
This documentation provides a reference to the `createLineItemAdjustmentsStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `createLineItemAdjustmentsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: createLineItemsStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# createLineItemsStep - Medusa Workflows API Reference # createLineItemsStep - Medusa Core Workflows Reference
This documentation provides a reference to the `createLineItemsStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `createLineItemsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: createPaymentCollectionsStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# createPaymentCollectionsStep - Medusa Workflows API Reference # createPaymentCollectionsStep - Medusa Core Workflows Reference
This documentation provides a reference to the `createPaymentCollectionsStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `createPaymentCollectionsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: createShippingMethodAdjustmentsStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# createShippingMethodAdjustmentsStep - Medusa Workflows API Reference # createShippingMethodAdjustmentsStep - Medusa Core Workflows Reference
This documentation provides a reference to the `createShippingMethodAdjustmentsStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `createShippingMethodAdjustmentsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: findOneOrAnyRegionStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# findOneOrAnyRegionStep - Medusa Workflows API Reference # findOneOrAnyRegionStep - Medusa Core Workflows Reference
This documentation provides a reference to the `findOneOrAnyRegionStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `findOneOrAnyRegionStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: findOrCreateCustomerStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# findOrCreateCustomerStep - Medusa Workflows API Reference # findOrCreateCustomerStep - Medusa Core Workflows Reference
This documentation provides a reference to the `findOrCreateCustomerStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `findOrCreateCustomerStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: findSalesChannelStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# findSalesChannelStep - Medusa Workflows API Reference # findSalesChannelStep - Medusa Core Workflows Reference
This documentation provides a reference to the `findSalesChannelStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `findSalesChannelStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: getActionsToComputeFromPromotionsStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# getActionsToComputeFromPromotionsStep - Medusa Workflows API Reference # getActionsToComputeFromPromotionsStep - Medusa Core Workflows Reference
This documentation provides a reference to the `getActionsToComputeFromPromotionsStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `getActionsToComputeFromPromotionsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: getLineItemActionsStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# getLineItemActionsStep - Medusa Workflows API Reference # getLineItemActionsStep - Medusa Core Workflows Reference
This documentation provides a reference to the `getLineItemActionsStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `getLineItemActionsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: getPromotionCodesToApply
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# getPromotionCodesToApply - Medusa Workflows API Reference # getPromotionCodesToApply - Medusa Core Workflows Reference
This documentation provides a reference to the `getPromotionCodesToApply`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `getPromotionCodesToApply`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: getVariantPriceSetsStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# getVariantPriceSetsStep - Medusa Workflows API Reference # getVariantPriceSetsStep - Medusa Core Workflows Reference
This documentation provides a reference to the `getVariantPriceSetsStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `getVariantPriceSetsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: getVariantsStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# getVariantsStep - Medusa Workflows API Reference # getVariantsStep - Medusa Core Workflows Reference
This documentation provides a reference to the `getVariantsStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `getVariantsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: prepareAdjustmentsFromPromotionActionsStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# prepareAdjustmentsFromPromotionActionsStep - Medusa Workflows API Reference # prepareAdjustmentsFromPromotionActionsStep - Medusa Core Workflows Reference
This documentation provides a reference to the `prepareAdjustmentsFromPromotionActionsStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `prepareAdjustmentsFromPromotionActionsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: removeLineItemAdjustmentsStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# removeLineItemAdjustmentsStep - Medusa Workflows API Reference # removeLineItemAdjustmentsStep - Medusa Core Workflows Reference
This documentation provides a reference to the `removeLineItemAdjustmentsStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `removeLineItemAdjustmentsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: removeShippingMethodAdjustmentsStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# removeShippingMethodAdjustmentsStep - Medusa Workflows API Reference # removeShippingMethodAdjustmentsStep - Medusa Core Workflows Reference
This documentation provides a reference to the `removeShippingMethodAdjustmentsStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `removeShippingMethodAdjustmentsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: removeShippingMethodFromCartStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# removeShippingMethodFromCartStep - Medusa Workflows API Reference # removeShippingMethodFromCartStep - Medusa Core Workflows Reference
This documentation provides a reference to the `removeShippingMethodFromCartStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `removeShippingMethodFromCartStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: reserveInventoryStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# reserveInventoryStep - Medusa Workflows API Reference # reserveInventoryStep - Medusa Core Workflows Reference
This documentation provides a reference to the `reserveInventoryStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `reserveInventoryStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: retrieveCartStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# retrieveCartStep - Medusa Workflows API Reference # retrieveCartStep - Medusa Core Workflows Reference
This documentation provides a reference to the `retrieveCartStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `retrieveCartStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: setTaxLinesForItemsStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# setTaxLinesForItemsStep - Medusa Workflows API Reference # setTaxLinesForItemsStep - Medusa Core Workflows Reference
This documentation provides a reference to the `setTaxLinesForItemsStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `setTaxLinesForItemsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: updateCartPromotionsStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCartPromotionsStep - Medusa Workflows API Reference # updateCartPromotionsStep - Medusa Core Workflows Reference
This documentation provides a reference to the `updateCartPromotionsStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `updateCartPromotionsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: updateCartsStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCartsStep - Medusa Workflows API Reference # updateCartsStep - Medusa Core Workflows Reference
This documentation provides a reference to the `updateCartsStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `updateCartsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: updateLineItemsStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# updateLineItemsStep - Medusa Workflows API Reference # updateLineItemsStep - Medusa Core Workflows Reference
This documentation provides a reference to the `updateLineItemsStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `updateLineItemsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: validateCartPaymentsStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# validateCartPaymentsStep - Medusa Workflows API Reference # validateCartPaymentsStep - Medusa Core Workflows Reference
This documentation provides a reference to the `validateCartPaymentsStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `validateCartPaymentsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: validateCartShippingOptionsStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# validateCartShippingOptionsStep - Medusa Workflows API Reference # validateCartShippingOptionsStep - Medusa Core Workflows Reference
This documentation provides a reference to the `validateCartShippingOptionsStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `validateCartShippingOptionsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: validateVariantPricesStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# validateVariantPricesStep - Medusa Workflows API Reference # validateVariantPricesStep - Medusa Core Workflows Reference
This documentation provides a reference to the `validateVariantPricesStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `validateVariantPricesStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: addShippingMethodToCartWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# addShippingMethodToCartWorkflow - Medusa Workflows API Reference # addShippingMethodToCartWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `addShippingMethodToCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `addShippingMethodToCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -13,7 +13,7 @@ This workflow adds shipping methods to a cart.
## Steps ## Steps
<WorkflowDiagram workflow={{"name":"addShippingMethodToCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/advanced-development/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"validateCartShippingOptionsStep","description":"This step validates shipping options to ensure they can be applied on a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.validateCartShippingOptionsStep/page.mdx","depth":2},{"type":"workflow","name":"listShippingOptionsForCartWorkflow","description":"This workflow lists the shipping options of a cart.","link":"../../../../Workflows_Cart/functions/core_flows.Workflows_Cart.listShippingOptionsForCartWorkflow/page.mdx","depth":3},{"type":"step","name":"removeShippingMethodFromCartStep","description":"This step removes shipping methods from a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.removeShippingMethodFromCartStep/page.mdx","depth":4},{"type":"step","name":"addShippingMethodToCartStep","description":"This step adds shipping methods to a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.addShippingMethodToCartStep/page.mdx","depth":4},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.emitEventStep/page.mdx","depth":4},{"type":"workflow","name":"updateTaxLinesWorkflow","description":"This workflow updates a cart's tax lines.","link":"../../../../Workflows_Cart/functions/core_flows.Workflows_Cart.updateTaxLinesWorkflow/page.mdx","depth":5},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../../../../Workflows_Cart/functions/core_flows.Workflows_Cart.updateCartPromotionsWorkflow/page.mdx","depth":6}]}} /> <WorkflowDiagram workflow={{"name":"addShippingMethodToCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"validateCartShippingOptionsStep","description":"This step validates shipping options to ensure they can be applied on a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.validateCartShippingOptionsStep/page.mdx","depth":2},{"type":"workflow","name":"listShippingOptionsForCartWorkflow","description":"This workflow lists the shipping options of a cart.","link":"../../../../Workflows_Cart/functions/core_flows.Workflows_Cart.listShippingOptionsForCartWorkflow/page.mdx","depth":3},{"type":"step","name":"removeShippingMethodFromCartStep","description":"This step removes shipping methods from a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.removeShippingMethodFromCartStep/page.mdx","depth":4},{"type":"step","name":"addShippingMethodToCartStep","description":"This step adds shipping methods to a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.addShippingMethodToCartStep/page.mdx","depth":4},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.emitEventStep/page.mdx","depth":4},{"type":"workflow","name":"updateTaxLinesWorkflow","description":"This workflow updates a cart's tax lines.","link":"../../../../Workflows_Cart/functions/core_flows.Workflows_Cart.updateTaxLinesWorkflow/page.mdx","depth":5},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../../../../Workflows_Cart/functions/core_flows.Workflows_Cart.updateCartPromotionsWorkflow/page.mdx","depth":6}]}} />
## Input ## Input
@@ -5,7 +5,7 @@ sidebar_label: addToCartWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# addToCartWorkflow - Medusa Workflows API Reference # addToCartWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `addToCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `addToCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -13,7 +13,7 @@ This workflow adds items to a cart.
## Steps ## Steps
<WorkflowDiagram workflow={{"name":"addToCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/advanced-development/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.validateVariantPricesStep/page.mdx","depth":2},{"type":"step","name":"getLineItemActionsStep","description":"This step returns lists of cart line items to create or update based on the\nprovided input.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.getLineItemActionsStep/page.mdx","depth":3},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../../../Workflows_Cart/functions/core_flows.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx","depth":4},{"type":"step","name":"createLineItemsStep","description":"This step creates line item in a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.createLineItemsStep/page.mdx","depth":5},{"type":"step","name":"updateLineItemsStep","description":"This step updates a cart's line items.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.updateLineItemsStep/page.mdx","depth":5},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.emitEventStep/page.mdx","depth":6}]}} /> <WorkflowDiagram workflow={{"name":"addToCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.validateVariantPricesStep/page.mdx","depth":2},{"type":"step","name":"getLineItemActionsStep","description":"This step returns lists of cart line items to create or update based on the\nprovided input.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.getLineItemActionsStep/page.mdx","depth":3},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../../../Workflows_Cart/functions/core_flows.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx","depth":4},{"type":"step","name":"createLineItemsStep","description":"This step creates line item in a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.createLineItemsStep/page.mdx","depth":5},{"type":"step","name":"updateLineItemsStep","description":"This step updates a cart's line items.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.updateLineItemsStep/page.mdx","depth":5},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.emitEventStep/page.mdx","depth":6}]}} />
## Input ## Input
@@ -5,7 +5,7 @@ sidebar_label: completeCartWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# completeCartWorkflow - Medusa Workflows API Reference # completeCartWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `completeCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `completeCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: confirmVariantInventoryWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# confirmVariantInventoryWorkflow - Medusa Workflows API Reference # confirmVariantInventoryWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `confirmVariantInventoryWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `confirmVariantInventoryWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: createCartWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# createCartWorkflow - Medusa Workflows API Reference # createCartWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `createCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `createCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -13,7 +13,7 @@ This workflow creates a cart.
## Steps ## Steps
<WorkflowDiagram workflow={{"name":"createCartWorkflow","steps":[{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.findSalesChannelStep/page.mdx","depth":1},{"type":"step","name":"findOneOrAnyRegionStep","description":"This step retrieves a region either by the provided ID or the first region in the first store.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.findOneOrAnyRegionStep/page.mdx","depth":1},{"type":"step","name":"findOrCreateCustomerStep","description":"This step either finds a customer matching the specified ID, or finds / create a customer\nmatching the specified email. If both ID and email are provided, ID takes precedence.\nIf the customer is a guest, the email is updated to the provided email.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.findOrCreateCustomerStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/advanced-development/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.validateVariantPricesStep/page.mdx","depth":3},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../../../Workflows_Cart/functions/core_flows.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx","depth":4},{"type":"step","name":"getVariantPriceSetsStep","description":"This step retrieves the calculated price sets of the specified variants.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.getVariantPriceSetsStep/page.mdx","depth":5},{"type":"step","name":"createCartsStep","description":"This step creates a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.createCartsStep/page.mdx","depth":6},{"type":"workflow","name":"updateTaxLinesWorkflow","description":"This workflow updates a cart's tax lines.","link":"../../../../Workflows_Cart/functions/core_flows.Workflows_Cart.updateTaxLinesWorkflow/page.mdx","depth":7},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../../../../Workflows_Cart/functions/core_flows.Workflows_Cart.updateCartPromotionsWorkflow/page.mdx","depth":8},{"type":"workflow","name":"refreshPaymentCollectionForCartWorkflow","description":"This workflow refreshes the payment collections of a cart.","link":"../../../../Workflows_Cart/functions/core_flows.Workflows_Cart.refreshPaymentCollectionForCartWorkflow/page.mdx","depth":9},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.emitEventStep/page.mdx","depth":9},{"type":"hook","name":"cartCreated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#cartCreated","depth":10}]}} /> <WorkflowDiagram workflow={{"name":"createCartWorkflow","steps":[{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.findSalesChannelStep/page.mdx","depth":1},{"type":"step","name":"findOneOrAnyRegionStep","description":"This step retrieves a region either by the provided ID or the first region in the first store.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.findOneOrAnyRegionStep/page.mdx","depth":1},{"type":"step","name":"findOrCreateCustomerStep","description":"This step either finds a customer matching the specified ID, or finds / create a customer\nmatching the specified email. If both ID and email are provided, ID takes precedence.\nIf the customer is a guest, the email is updated to the provided email.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.findOrCreateCustomerStep/page.mdx","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":2},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.validateVariantPricesStep/page.mdx","depth":3},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../../../Workflows_Cart/functions/core_flows.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx","depth":4},{"type":"step","name":"getVariantPriceSetsStep","description":"This step retrieves the calculated price sets of the specified variants.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.getVariantPriceSetsStep/page.mdx","depth":5},{"type":"step","name":"createCartsStep","description":"This step creates a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.createCartsStep/page.mdx","depth":6},{"type":"workflow","name":"updateTaxLinesWorkflow","description":"This workflow updates a cart's tax lines.","link":"../../../../Workflows_Cart/functions/core_flows.Workflows_Cart.updateTaxLinesWorkflow/page.mdx","depth":7},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../../../../Workflows_Cart/functions/core_flows.Workflows_Cart.updateCartPromotionsWorkflow/page.mdx","depth":8},{"type":"workflow","name":"refreshPaymentCollectionForCartWorkflow","description":"This workflow refreshes the payment collections of a cart.","link":"../../../../Workflows_Cart/functions/core_flows.Workflows_Cart.refreshPaymentCollectionForCartWorkflow/page.mdx","depth":9},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.emitEventStep/page.mdx","depth":9},{"type":"hook","name":"cartCreated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#cartCreated","depth":10}]}} />
## Input ## Input
@@ -5,7 +5,7 @@ sidebar_label: createPaymentCollectionForCartWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# createPaymentCollectionForCartWorkflow - Medusa Workflows API Reference # createPaymentCollectionForCartWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `createPaymentCollectionForCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `createPaymentCollectionForCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -13,7 +13,7 @@ This workflow creates a payment collection for a cart.
## Steps ## Steps
<WorkflowDiagram workflow={{"name":"createPaymentCollectionForCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/advanced-development/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"validateExistingPaymentCollectionStep","description":"This step validates that a cart doesn't have a payment collection.","link":"../../../../Workflows_Cart/functions/core_flows.Workflows_Cart.validateExistingPaymentCollectionStep/page.mdx","depth":2},{"type":"step","name":"createPaymentCollectionsStep","description":"This step creates payment collections in a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.createPaymentCollectionsStep/page.mdx","depth":3},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#create-link).\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.createRemoteLinkStep/page.mdx","depth":4}]}} /> <WorkflowDiagram workflow={{"name":"createPaymentCollectionForCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"validateExistingPaymentCollectionStep","description":"This step validates that a cart doesn't have a payment collection.","link":"../../../../Workflows_Cart/functions/core_flows.Workflows_Cart.validateExistingPaymentCollectionStep/page.mdx","depth":2},{"type":"step","name":"createPaymentCollectionsStep","description":"This step creates payment collections in a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.createPaymentCollectionsStep/page.mdx","depth":3},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/learn/fundamentals/module-links/remote-link#create-link).\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.createRemoteLinkStep/page.mdx","depth":4}]}} />
## Input ## Input
@@ -5,7 +5,7 @@ sidebar_label: listShippingOptionsForCartWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# listShippingOptionsForCartWorkflow - Medusa Workflows API Reference # listShippingOptionsForCartWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `listShippingOptionsForCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `listShippingOptionsForCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -13,7 +13,7 @@ This workflow lists the shipping options of a cart.
## Steps ## Steps
<WorkflowDiagram workflow={{"name":"listShippingOptionsForCartWorkflow","steps":[{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/advanced-development/module-links/query).\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useQueryGraphStep/page.mdx","depth":1},{"type":"step","name":"validatePresenceOfStep","description":"This step validates the presence of attributes on an object","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.validatePresenceOfStep/page.mdx","depth":2},{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/advanced-development/module-links/query).\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useQueryGraphStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/advanced-development/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":4}]}} /> <WorkflowDiagram workflow={{"name":"listShippingOptionsForCartWorkflow","steps":[{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useQueryGraphStep/page.mdx","depth":1},{"type":"step","name":"validatePresenceOfStep","description":"This step validates the presence of attributes on an object","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.validatePresenceOfStep/page.mdx","depth":2},{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useQueryGraphStep/page.mdx","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":4}]}} />
## Input ## Input
@@ -5,7 +5,7 @@ sidebar_label: refreshPaymentCollectionForCartWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# refreshPaymentCollectionForCartWorkflow - Medusa Workflows API Reference # refreshPaymentCollectionForCartWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `refreshPaymentCollectionForCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `refreshPaymentCollectionForCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -13,7 +13,7 @@ This workflow refreshes the payment collections of a cart.
## Steps ## Steps
<WorkflowDiagram workflow={{"name":"refreshPaymentCollectionForCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/advanced-development/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"when","condition":"{\n const valueIsEqual = MathBN.eq(\n cart.payment_collection?.raw_amount ?? -1,\n cart.raw_total\n )\n\n if (valueIsEqual) {\n return cart.payment_collection.currency_code !== cart.currency_code\n }\n\n return true\n }","depth":"2","steps":[{"type":"workflow","name":"deletePaymentSessionsWorkflow","description":"This workflow deletes one or more payment sessions.","link":"../../../../Workflows_Payment_Collection/functions/core_flows.Workflows_Payment_Collection.deletePaymentSessionsWorkflow/page.mdx","depth":2},{"type":"step","name":"updatePaymentCollectionStep","description":"This step updates payment collections matching the specified filters.","link":"../../../../Steps_Payment_Collection/functions/core_flows.Steps_Payment_Collection.updatePaymentCollectionStep/page.mdx","depth":2}]}]}} /> <WorkflowDiagram workflow={{"name":"refreshPaymentCollectionForCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"when","condition":"{\n const valueIsEqual = MathBN.eq(\n cart.payment_collection?.raw_amount ?? -1,\n cart.raw_total\n )\n\n if (valueIsEqual) {\n return cart.payment_collection.currency_code !== cart.currency_code\n }\n\n return true\n }","depth":"2","steps":[{"type":"workflow","name":"deletePaymentSessionsWorkflow","description":"This workflow deletes one or more payment sessions.","link":"../../../../Workflows_Payment_Collection/functions/core_flows.Workflows_Payment_Collection.deletePaymentSessionsWorkflow/page.mdx","depth":2},{"type":"step","name":"updatePaymentCollectionStep","description":"This step updates payment collections matching the specified filters.","link":"../../../../Steps_Payment_Collection/functions/core_flows.Steps_Payment_Collection.updatePaymentCollectionStep/page.mdx","depth":2}]}]}} />
## Input ## Input
@@ -5,7 +5,7 @@ sidebar_label: transferCartCustomerWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# transferCartCustomerWorkflow - Medusa Workflows API Reference # transferCartCustomerWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `transferCartCustomerWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `transferCartCustomerWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -13,7 +13,7 @@ This workflow transfers cart's customer.
## Steps ## Steps
<WorkflowDiagram workflow={{"name":"transferCartCustomerWorkflow","steps":[{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/advanced-development/module-links/query).\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useQueryGraphStep/page.mdx","depth":1},{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/advanced-development/module-links/query).\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useQueryGraphStep/page.mdx","depth":2},{"type":"when","condition":"shouldTransfer","depth":"3","steps":[{"type":"step","name":"updateCartsStep","description":"This step updates a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.updateCartsStep/page.mdx","depth":3}]}]}} /> <WorkflowDiagram workflow={{"name":"transferCartCustomerWorkflow","steps":[{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useQueryGraphStep/page.mdx","depth":1},{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useQueryGraphStep/page.mdx","depth":2},{"type":"when","condition":"shouldTransfer","depth":"3","steps":[{"type":"step","name":"updateCartsStep","description":"This step updates a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.updateCartsStep/page.mdx","depth":3}]}]}} />
## Input ## Input
@@ -5,7 +5,7 @@ sidebar_label: updateCartPromotionsWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCartPromotionsWorkflow - Medusa Workflows API Reference # updateCartPromotionsWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `updateCartPromotionsWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `updateCartPromotionsWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -13,7 +13,7 @@ This workflow updates a cart's promotions.
## Steps ## Steps
<WorkflowDiagram workflow={{"name":"updateCartPromotionsWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/advanced-development/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"getPromotionCodesToApply","description":"This step retrieves the promotion codes to apply on a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.getPromotionCodesToApply/page.mdx","depth":2},{"type":"step","name":"getActionsToComputeFromPromotionsStep","description":"This step retrieves the actions to compute based on the promotions\napplied on a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.getActionsToComputeFromPromotionsStep/page.mdx","depth":3},{"type":"step","name":"prepareAdjustmentsFromPromotionActionsStep","description":"This step prepares the line item or shipping method adjustments using\nactions computed by the Promotion Module.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.prepareAdjustmentsFromPromotionActionsStep/page.mdx","depth":4},{"type":"step","name":"removeLineItemAdjustmentsStep","description":"This step removes line item adjustments from a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.removeLineItemAdjustmentsStep/page.mdx","depth":5},{"type":"step","name":"removeShippingMethodAdjustmentsStep","description":"This step removes shipping method adjustments from a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.removeShippingMethodAdjustmentsStep/page.mdx","depth":5},{"type":"step","name":"createLineItemAdjustmentsStep","description":"This step creates line item adjustments in a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.createLineItemAdjustmentsStep/page.mdx","depth":5},{"type":"step","name":"createShippingMethodAdjustmentsStep","description":"This step creates shipping method adjustments for a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.createShippingMethodAdjustmentsStep/page.mdx","depth":5},{"type":"step","name":"updateCartPromotionsStep","description":"This step updates the promotions applied on a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.updateCartPromotionsStep/page.mdx","depth":5}]}} /> <WorkflowDiagram workflow={{"name":"updateCartPromotionsWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"getPromotionCodesToApply","description":"This step retrieves the promotion codes to apply on a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.getPromotionCodesToApply/page.mdx","depth":2},{"type":"step","name":"getActionsToComputeFromPromotionsStep","description":"This step retrieves the actions to compute based on the promotions\napplied on a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.getActionsToComputeFromPromotionsStep/page.mdx","depth":3},{"type":"step","name":"prepareAdjustmentsFromPromotionActionsStep","description":"This step prepares the line item or shipping method adjustments using\nactions computed by the Promotion Module.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.prepareAdjustmentsFromPromotionActionsStep/page.mdx","depth":4},{"type":"step","name":"removeLineItemAdjustmentsStep","description":"This step removes line item adjustments from a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.removeLineItemAdjustmentsStep/page.mdx","depth":5},{"type":"step","name":"removeShippingMethodAdjustmentsStep","description":"This step removes shipping method adjustments from a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.removeShippingMethodAdjustmentsStep/page.mdx","depth":5},{"type":"step","name":"createLineItemAdjustmentsStep","description":"This step creates line item adjustments in a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.createLineItemAdjustmentsStep/page.mdx","depth":5},{"type":"step","name":"createShippingMethodAdjustmentsStep","description":"This step creates shipping method adjustments for a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.createShippingMethodAdjustmentsStep/page.mdx","depth":5},{"type":"step","name":"updateCartPromotionsStep","description":"This step updates the promotions applied on a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.updateCartPromotionsStep/page.mdx","depth":5}]}} />
## Input ## Input
@@ -5,7 +5,7 @@ sidebar_label: updateCartWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCartWorkflow - Medusa Workflows API Reference # updateCartWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `updateCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `updateCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -13,7 +13,7 @@ This workflow updates a cart.
## Steps ## Steps
<WorkflowDiagram workflow={{"name":"updateCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/advanced-development/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.findSalesChannelStep/page.mdx","depth":2},{"type":"step","name":"findOrCreateCustomerStep","description":"This step either finds a customer matching the specified ID, or finds / create a customer\nmatching the specified email. If both ID and email are provided, ID takes precedence.\nIf the customer is a guest, the email is updated to the provided email.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.findOrCreateCustomerStep/page.mdx","depth":2},{"type":"when","condition":"{\n return !!data.input.region_id\n }","depth":"3","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/advanced-development/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":3}]},{"type":"when","condition":"{\n return (\n isDefined(input.region_id) &&\n input.region_id !== cartToUpdate?.region?.id\n )\n }","depth":"4","steps":[{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.emitEventStep/page.mdx","depth":4}]},{"type":"step","name":"updateCartsStep","description":"This step updates a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.updateCartsStep/page.mdx","depth":5},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.emitEventStep/page.mdx","depth":5},{"type":"hook","name":"cartUpdated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#cartUpdated","depth":6}]}} /> <WorkflowDiagram workflow={{"name":"updateCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.findSalesChannelStep/page.mdx","depth":2},{"type":"step","name":"findOrCreateCustomerStep","description":"This step either finds a customer matching the specified ID, or finds / create a customer\nmatching the specified email. If both ID and email are provided, ID takes precedence.\nIf the customer is a guest, the email is updated to the provided email.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.findOrCreateCustomerStep/page.mdx","depth":2},{"type":"when","condition":"{\n return !!data.input.region_id\n }","depth":"3","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":3}]},{"type":"when","condition":"{\n return (\n isDefined(input.region_id) &&\n input.region_id !== cartToUpdate?.region?.id\n )\n }","depth":"4","steps":[{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.emitEventStep/page.mdx","depth":4}]},{"type":"step","name":"updateCartsStep","description":"This step updates a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.updateCartsStep/page.mdx","depth":5},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.emitEventStep/page.mdx","depth":5},{"type":"hook","name":"cartUpdated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#cartUpdated","depth":6}]}} />
## Input ## Input
@@ -5,7 +5,7 @@ sidebar_label: updateLineItemInCartWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# updateLineItemInCartWorkflow - Medusa Workflows API Reference # updateLineItemInCartWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `updateLineItemInCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `updateLineItemInCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -13,7 +13,7 @@ This workflow updates a cart's line item.
## Steps ## Steps
<WorkflowDiagram workflow={{"name":"updateLineItemInCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/advanced-development/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.validateVariantPricesStep/page.mdx","depth":2},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../../../Workflows_Cart/functions/core_flows.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx","depth":3},{"type":"step","name":"updateLineItemsStepWithSelector","description":"This step updates line items.","link":"../../../../Steps_Line_Item/functions/core_flows.Steps_Line_Item.updateLineItemsStepWithSelector/page.mdx","depth":4}]}} /> <WorkflowDiagram workflow={{"name":"updateLineItemInCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.validateVariantPricesStep/page.mdx","depth":2},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../../../Workflows_Cart/functions/core_flows.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx","depth":3},{"type":"step","name":"updateLineItemsStepWithSelector","description":"This step updates line items.","link":"../../../../Steps_Line_Item/functions/core_flows.Steps_Line_Item.updateLineItemsStepWithSelector/page.mdx","depth":4}]}} />
## Input ## Input
@@ -5,7 +5,7 @@ sidebar_label: updateTaxLinesWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# updateTaxLinesWorkflow - Medusa Workflows API Reference # updateTaxLinesWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `updateTaxLinesWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `updateTaxLinesWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -13,7 +13,7 @@ This workflow updates a cart's tax lines.
## Steps ## Steps
<WorkflowDiagram workflow={{"name":"updateTaxLinesWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/advanced-development/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"setTaxLinesForItemsStep","description":"This step sets the tax lines of shipping methods and line items in a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.setTaxLinesForItemsStep/page.mdx","depth":2}]}} /> <WorkflowDiagram workflow={{"name":"updateTaxLinesWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../functions/core_flows.useQueryGraphStep/page.mdx) instead.\n\n:::\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.useRemoteQueryStep/page.mdx","depth":1},{"type":"step","name":"setTaxLinesForItemsStep","description":"This step sets the tax lines of shipping methods and line items in a cart.","link":"../../../../Steps_Cart/functions/core_flows.Steps_Cart.setTaxLinesForItemsStep/page.mdx","depth":2}]}} />
## Input ## Input
@@ -5,7 +5,7 @@ sidebar_label: validateExistingPaymentCollectionStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# validateExistingPaymentCollectionStep - Medusa Workflows API Reference # validateExistingPaymentCollectionStep - Medusa Core Workflows Reference
This documentation provides a reference to the `validateExistingPaymentCollectionStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `validateExistingPaymentCollectionStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,13 +5,13 @@ sidebar_label: createRemoteLinkStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# createRemoteLinkStep - Medusa Workflows API Reference # createRemoteLinkStep - Medusa Core Workflows Reference
This documentation provides a reference to the `createRemoteLinkStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `createRemoteLinkStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step creates remote links between two records of linked data models. This step creates remote links between two records of linked data models.
Learn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#create-link). Learn more in the [Remote Link documentation.](https://docs.medusajs.com/learn/fundamentals/module-links/remote-link#create-link).
## Example ## Example
@@ -5,13 +5,13 @@ sidebar_label: dismissRemoteLinkStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# dismissRemoteLinkStep - Medusa Workflows API Reference # dismissRemoteLinkStep - Medusa Core Workflows Reference
This documentation provides a reference to the `dismissRemoteLinkStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `dismissRemoteLinkStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step removes remote links between two records of linked data models. This step removes remote links between two records of linked data models.
Learn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#dismiss-link). Learn more in the [Remote Link documentation.](https://docs.medusajs.com/learn/fundamentals/module-links/remote-link#dismiss-link).
## Example ## Example
@@ -5,7 +5,7 @@ sidebar_label: emitEventStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# emitEventStep - Medusa Workflows API Reference # emitEventStep - Medusa Core Workflows Reference
This documentation provides a reference to the `emitEventStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `emitEventStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,13 +5,13 @@ sidebar_label: removeRemoteLinkStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# removeRemoteLinkStep - Medusa Workflows API Reference # removeRemoteLinkStep - Medusa Core Workflows Reference
This documentation provides a reference to the `removeRemoteLinkStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `removeRemoteLinkStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step deletes linked records of a record. This step deletes linked records of a record.
Learn more in the [Remote Link documentation](https://docs.medusajs.com/advanced-development/modules/remote-link#cascade-delete-linked-records) Learn more in the [Remote Link documentation](https://docs.medusajs.com/learn/fundamentals/module-links/remote-link#cascade-delete-linked-records)
## Example ## Example
@@ -5,7 +5,7 @@ sidebar_label: updateRemoteLinksStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# updateRemoteLinksStep - Medusa Workflows API Reference # updateRemoteLinksStep - Medusa Core Workflows Reference
This documentation provides a reference to the `updateRemoteLinksStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `updateRemoteLinksStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,13 +5,13 @@ sidebar_label: useQueryGraphStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# useQueryGraphStep - Medusa Workflows API Reference # useQueryGraphStep - Medusa Core Workflows Reference
This documentation provides a reference to the `useQueryGraphStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `useQueryGraphStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step fetches data across modules using the Query. This step fetches data across modules using the Query.
Learn more in the [Query documentation](https://docs.medusajs.com/learn/advanced-development/module-links/query). Learn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).
## Example ## Example
@@ -5,13 +5,13 @@ sidebar_label: useRemoteQueryStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# useRemoteQueryStep - Medusa Workflows API Reference # useRemoteQueryStep - Medusa Core Workflows Reference
This documentation provides a reference to the `useRemoteQueryStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `useRemoteQueryStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step fetches data across modules using the remote query. This step fetches data across modules using the remote query.
Learn more in the [Remote Query documentation](https://docs.medusajs.com/learn/advanced-development/module-links/query). Learn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).
:::note :::note
@@ -5,7 +5,7 @@ sidebar_label: validatePresenceOfStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# validatePresenceOfStep - Medusa Workflows API Reference # validatePresenceOfStep - Medusa Core Workflows Reference
This documentation provides a reference to the `validatePresenceOfStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `validatePresenceOfStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: batchLinksWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# batchLinksWorkflow - Medusa Workflows API Reference # batchLinksWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `batchLinksWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `batchLinksWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -13,7 +13,7 @@ This workflow manages one or more links to create, update, or dismiss them.
## Steps ## Steps
<WorkflowDiagram workflow={{"name":"batchLinksWorkflow","steps":[{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#create-link).\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.createRemoteLinkStep/page.mdx","depth":1},{"type":"step","name":"updateRemoteLinksStep","description":"","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.updateRemoteLinksStep/page.mdx","depth":1},{"type":"step","name":"dismissRemoteLinkStep","description":"This step removes remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#dismiss-link).\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.dismissRemoteLinkStep/page.mdx","depth":1}]}} /> <WorkflowDiagram workflow={{"name":"batchLinksWorkflow","steps":[{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/learn/fundamentals/module-links/remote-link#create-link).\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.createRemoteLinkStep/page.mdx","depth":1},{"type":"step","name":"updateRemoteLinksStep","description":"","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.updateRemoteLinksStep/page.mdx","depth":1},{"type":"step","name":"dismissRemoteLinkStep","description":"This step removes remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/learn/fundamentals/module-links/remote-link#dismiss-link).\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.dismissRemoteLinkStep/page.mdx","depth":1}]}} />
## Input ## Input
@@ -5,7 +5,7 @@ sidebar_label: createLinksWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# createLinksWorkflow - Medusa Workflows API Reference # createLinksWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `createLinksWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `createLinksWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -13,7 +13,7 @@ This workflow creates one or more links between records.
## Steps ## Steps
<WorkflowDiagram workflow={{"name":"createLinksWorkflow","steps":[{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#create-link).\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.createRemoteLinkStep/page.mdx","depth":1}]}} /> <WorkflowDiagram workflow={{"name":"createLinksWorkflow","steps":[{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/learn/fundamentals/module-links/remote-link#create-link).\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.createRemoteLinkStep/page.mdx","depth":1}]}} />
## Input ## Input
@@ -5,7 +5,7 @@ sidebar_label: dismissLinksWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# dismissLinksWorkflow - Medusa Workflows API Reference # dismissLinksWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `dismissLinksWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `dismissLinksWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -13,7 +13,7 @@ This workflow dismisses one or more links between records.
## Steps ## Steps
<WorkflowDiagram workflow={{"name":"dismissLinksWorkflow","steps":[{"type":"step","name":"dismissRemoteLinkStep","description":"This step removes remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#dismiss-link).\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.dismissRemoteLinkStep/page.mdx","depth":1}]}} /> <WorkflowDiagram workflow={{"name":"dismissLinksWorkflow","steps":[{"type":"step","name":"dismissRemoteLinkStep","description":"This step removes remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/learn/fundamentals/module-links/remote-link#dismiss-link).\n\n","link":"../../../../Steps_Common/functions/core_flows.Steps_Common.dismissRemoteLinkStep/page.mdx","depth":1}]}} />
## Input ## Input
@@ -5,7 +5,7 @@ sidebar_label: updateLinksWorkflow
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# updateLinksWorkflow - Medusa Workflows API Reference # updateLinksWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the `updateLinksWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `updateLinksWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: createCustomerAddressesStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# createCustomerAddressesStep - Medusa Workflows API Reference # createCustomerAddressesStep - Medusa Core Workflows Reference
This documentation provides a reference to the `createCustomerAddressesStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `createCustomerAddressesStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: createCustomersStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# createCustomersStep - Medusa Workflows API Reference # createCustomersStep - Medusa Core Workflows Reference
This documentation provides a reference to the `createCustomersStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `createCustomersStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: deleteCustomerAddressesStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteCustomerAddressesStep - Medusa Workflows API Reference # deleteCustomerAddressesStep - Medusa Core Workflows Reference
This documentation provides a reference to the `deleteCustomerAddressesStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `deleteCustomerAddressesStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: deleteCustomersStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteCustomersStep - Medusa Workflows API Reference # deleteCustomersStep - Medusa Core Workflows Reference
This documentation provides a reference to the `deleteCustomersStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `deleteCustomersStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: maybeUnsetDefaultBillingAddressesStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# maybeUnsetDefaultBillingAddressesStep - Medusa Workflows API Reference # maybeUnsetDefaultBillingAddressesStep - Medusa Core Workflows Reference
This documentation provides a reference to the `maybeUnsetDefaultBillingAddressesStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `maybeUnsetDefaultBillingAddressesStep`. It belongs to the `@medusajs/medusa/core-flows` package.
@@ -5,7 +5,7 @@ sidebar_label: maybeUnsetDefaultShippingAddressesStep
import { TypeList, WorkflowDiagram } from "docs-ui" import { TypeList, WorkflowDiagram } from "docs-ui"
# maybeUnsetDefaultShippingAddressesStep - Medusa Workflows API Reference # maybeUnsetDefaultShippingAddressesStep - Medusa Core Workflows Reference
This documentation provides a reference to the `maybeUnsetDefaultShippingAddressesStep`. It belongs to the `@medusajs/medusa/core-flows` package. This documentation provides a reference to the `maybeUnsetDefaultShippingAddressesStep`. It belongs to the `@medusajs/medusa/core-flows` package.
Loaded 100 of 1109 files, more files were not shown because too many files have changed in this diff. Show more