chore(docs): Generated References (automated) (#13857)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andolivermrbl authored and 
GitHub committed
1 parent
340d826e72
commit
dbf8fb9bda
237 files changed
+139748
-139260
No files matched your search
@@ -273,7 +273,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderExchangesStep/page.mdx": "2025-09-12T14:10:31.701Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createReturnsStep/page.mdx": "2025-09-18T17:04:40.223Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.previewOrderChangeStep/page.mdx": "2025-09-12T14:10:31.721Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangesStep/page.mdx": "2025-10-21T08:10:38.030Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangesStep/page.mdx": "2025-10-25T20:13:59.124Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginClaimOrderWorkflow/page.mdx": "2025-09-18T17:04:40.356Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginExchangeOrderWorkflow/page.mdx": "2025-09-18T17:04:40.788Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginOrderEditOrderWorkflow/page.mdx": "2025-09-18T17:04:41.031Z",
|
||||
@@ -363,7 +363,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateExchangeAddItemWorkflow/page.mdx": "2025-09-18T17:04:40.957Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateExchangeShippingMethodValidationStep/page.mdx": "2025-05-20T07:51:40.848Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateExchangeShippingMethodWorkflow/page.mdx": "2025-09-18T17:04:40.980Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderChangesWorkflow/page.mdx": "2025-10-21T08:10:39.259Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderChangesWorkflow/page.mdx": "2025-10-25T20:14:00.462Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderEditAddItemValidationStep/page.mdx": "2025-09-12T14:10:32.604Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderEditAddItemWorkflow/page.mdx": "2025-09-18T17:04:41.206Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderEditItemQuantityValidationStep/page.mdx": "2025-09-12T14:10:32.621Z",
|
||||
@@ -419,7 +419,7 @@ export const generatedEditDates = {
|
||||
"references/fulfillment/types/fulfillment.ChangeActionType/page.mdx": "2025-04-11T09:04:45.506Z",
|
||||
"references/helper_steps/functions/helper_steps.createRemoteLinkStep/page.mdx": "2025-01-17T16:43:22.229Z",
|
||||
"references/helper_steps/functions/helper_steps.dismissRemoteLinkStep/page.mdx": "2025-01-17T16:43:22.232Z",
|
||||
"references/helper_steps/functions/helper_steps.emitEventStep/page.mdx": "2025-01-17T16:43:22.234Z",
|
||||
"references/helper_steps/functions/helper_steps.emitEventStep/page.mdx": "2025-10-25T20:13:56.774Z",
|
||||
"references/helper_steps/functions/helper_steps.updateRemoteLinksStep/page.mdx": "2025-01-17T16:43:22.238Z",
|
||||
"references/helper_steps/types/helper_steps.DismissRemoteLinksStepInput/page.mdx": "2024-08-28T00:11:31.042Z",
|
||||
"references/modules/auth/page.mdx": "2024-11-25T17:49:28.795Z",
|
||||
@@ -624,7 +624,7 @@ export const generatedEditDates = {
|
||||
"references/types/types/types.RemovePromotionRulesWorkflowDTO/page.mdx": "2024-12-09T13:21:35.497Z",
|
||||
"references/types/types/types.UpdateFulfillmentShippingOptionRulesWorkflowDTO/page.mdx": "2024-12-09T13:21:33.129Z",
|
||||
"references/types/types/types.UpdatePromotionRulesWorkflowDTO/page.mdx": "2024-12-09T13:21:35.497Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.setTaxLinesForItemsStep/page.mdx": "2025-01-17T16:43:22.421Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.setTaxLinesForItemsStep/page.mdx": "2025-10-25T20:13:57.243Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateCartsStep/page.mdx": "2025-06-25T10:11:28.124Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateCartPaymentsStep/page.mdx": "2025-06-25T10:11:28.183Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.addToCartWorkflow/page.mdx": "2025-09-18T17:04:38.514Z",
|
||||
@@ -638,7 +638,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Cart/core_flows.Cart.Steps_Cart/page.mdx": "2025-02-11T11:36:38.987Z",
|
||||
"references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.useRemoteQueryStep/page.mdx": "2025-01-13T17:30:23.158Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingOptionRulesStep/page.mdx": "2025-10-21T08:10:37.349Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.deleteShippingOptionRulesStep/page.mdx": "2025-10-21T08:10:37.365Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.deleteShippingOptionRulesStep/page.mdx": "2025-10-25T20:13:58.381Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.cancelOrderClaimStep/page.mdx": "2025-01-17T16:43:22.988Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.cancelOrderExchangeStep/page.mdx": "2025-01-17T16:43:23.041Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.cancelOrderReturnStep/page.mdx": "2025-01-17T16:43:23.074Z",
|
||||
@@ -667,7 +667,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/core_flows.Steps_Promotion/page.mdx": "2024-12-09T13:21:49.280Z",
|
||||
"references/core_flows/core_flows.Workflows_Price_List/page.mdx": "2024-12-09T13:21:48.628Z",
|
||||
"references/core_flows/core_flows.Workflows_Promotion/page.mdx": "2024-12-09T13:21:49.320Z",
|
||||
"references/core_flows/interfaces/core_flows.SetTaxLinesForItemsStepInput/page.mdx": "2025-01-17T16:43:25.409Z",
|
||||
"references/core_flows/interfaces/core_flows.SetTaxLinesForItemsStepInput/page.mdx": "2025-10-25T20:14:02.131Z",
|
||||
"references/core_flows/interfaces/core_flows.ValidateCartPaymentsStepInput/page.mdx": "2025-01-17T16:43:25.414Z",
|
||||
"references/core_flows/types/core_flows.CancelOrdersStepInput/page.mdx": "2024-12-09T13:21:50.756Z",
|
||||
"references/core_flows/types/core_flows.ConfirmClaimRequestWorkflowInput/page.mdx": "2024-12-09T13:21:51.372Z",
|
||||
@@ -714,10 +714,10 @@ export const generatedEditDates = {
|
||||
"references/cart/interfaces/cart.LineItemAdjustmentDTO/page.mdx": "2025-06-25T10:11:34.883Z",
|
||||
"references/cart/interfaces/cart.LineItemTaxLineDTO/page.mdx": "2025-06-25T10:11:34.901Z",
|
||||
"references/cart/interfaces/cart.UpdateLineItemWithSelectorDTO/page.mdx": "2025-06-25T10:11:35.038Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.createCartsStep/page.mdx": "2025-10-21T08:10:36.195Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.createCartsStep/page.mdx": "2025-10-25T20:13:57.076Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.createLineItemsStep/page.mdx": "2025-06-25T10:11:27.966Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.getActionsToComputeFromPromotionsStep/page.mdx": "2025-05-20T07:51:40.751Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.retrieveCartStep/page.mdx": "2025-10-21T08:10:36.348Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.retrieveCartStep/page.mdx": "2025-10-25T20:13:57.237Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateLineItemsStep/page.mdx": "2025-06-25T10:11:28.156Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateCartShippingOptionsStep/page.mdx": "2025-09-18T17:04:38.450Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.validateExistingPaymentCollectionStep/page.mdx": "2025-05-20T07:51:40.757Z",
|
||||
@@ -785,11 +785,11 @@ export const generatedEditDates = {
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegionDeleteResponse/page.mdx": "2024-12-09T13:21:34.725Z",
|
||||
"references/types/HttpTypes/types/types.HttpTypes.DeleteResponse/page.mdx": "2024-12-09T13:21:33.545Z",
|
||||
"references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.validateRefundStep/page.mdx": "2025-09-12T14:10:33.138Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.addOrderTransactionStep/page.mdx": "2025-10-21T08:10:37.816Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.addOrderTransactionStep/page.mdx": "2025-10-25T20:13:58.894Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.archiveOrdersStep/page.mdx": "2025-09-12T14:10:31.586Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.completeOrdersStep/page.mdx": "2025-09-12T14:10:31.641Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrdersStep/page.mdx": "2025-09-12T14:10:31.677Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.setOrderTaxLinesForItemsStep/page.mdx": "2025-09-12T14:10:31.770Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.setOrderTaxLinesForItemsStep/page.mdx": "2025-10-25T20:13:59.110Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.archiveOrderWorkflow/page.mdx": "2025-09-18T17:04:40.321Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginClaimOrderValidationStep/page.mdx": "2025-09-12T14:10:31.862Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginOrderEditValidationStep/page.mdx": "2025-09-12T14:10:32.464Z",
|
||||
@@ -806,7 +806,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Promotion/Steps_Promotion/functions/core_flows.Promotion.Steps_Promotion.updatePromotionsStep/page.mdx": "2025-10-21T08:10:40.102Z",
|
||||
"references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.updatePromotionsWorkflow/page.mdx": "2025-10-21T08:10:40.169Z",
|
||||
"references/core_flows/core_flows.Workflows_Payment/page.mdx": "2024-12-09T13:21:48.376Z",
|
||||
"references/core_flows/interfaces/core_flows.SetOrderTaxLinesForItemsStepInput/page.mdx": "2025-09-12T14:10:34.846Z",
|
||||
"references/core_flows/interfaces/core_flows.SetOrderTaxLinesForItemsStepInput/page.mdx": "2025-10-25T20:14:02.515Z",
|
||||
"references/fulfillment/interfaces/fulfillment.OrderSummaryDTO/page.mdx": "2025-02-24T10:48:36.235Z",
|
||||
"references/fulfillment/interfaces/fulfillment.OrderTransactionDTO/page.mdx": "2025-09-12T14:10:38.660Z",
|
||||
"references/order/IOrderModuleService/methods/order.IOrderModuleService.archive/page.mdx": "2025-10-21T08:10:49.911Z",
|
||||
@@ -925,9 +925,9 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Auth/core_flows.Auth.Steps_Auth/page.mdx": "2024-12-23T12:30:23.503Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderClaimItemsFromActionsStep/page.mdx": "2025-05-20T07:51:40.780Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderExchangeItemsFromActionsStep/page.mdx": "2025-05-20T07:51:40.781Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangeActionsStep/page.mdx": "2025-10-21T08:10:38.023Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderChangeActionsWorkflow/page.mdx": "2025-10-21T08:10:38.383Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderChangeActionsWorkflow/page.mdx": "2025-10-21T08:10:39.252Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangeActionsStep/page.mdx": "2025-10-25T20:13:59.116Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderChangeActionsWorkflow/page.mdx": "2025-10-25T20:13:59.515Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderChangeActionsWorkflow/page.mdx": "2025-10-25T20:14:00.453Z",
|
||||
"references/core_flows/core_flows.Auth/page.mdx": "2024-12-23T12:30:23.503Z",
|
||||
"references/core_flows/core_flows.Steps_Auth/page.mdx": "2024-12-09T13:21:37.257Z",
|
||||
"references/core_flows/types/core_flows.CreateOrderClaimItemsFromActionsInput/page.mdx": "2025-09-12T14:10:34.808Z",
|
||||
@@ -1065,7 +1065,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Inventory/core_flows.Inventory.Steps_Inventory/page.mdx": "2024-12-23T12:30:23.988Z",
|
||||
"references/core_flows/Inventory/core_flows.Inventory.Workflows_Inventory/page.mdx": "2025-01-13T17:30:23.526Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderLineItemsStep/page.mdx": "2025-05-20T07:51:40.781Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateReturnsStep/page.mdx": "2025-10-21T08:10:38.014Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateReturnsStep/page.mdx": "2025-10-25T20:13:59.106Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.addOrderLineItemsWorkflow/page.mdx": "2025-09-18T17:04:40.302Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderWorkflow/page.mdx": "2025-09-18T17:04:40.344Z",
|
||||
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createCollectionsWorkflow/page.mdx": "2025-09-18T17:04:42.333Z",
|
||||
@@ -1154,7 +1154,7 @@ export const generatedEditDates = {
|
||||
"references/dml/entity/classes/dml.entity.DmlEntity/page.mdx": "2025-01-13T18:05:57.749Z",
|
||||
"references/dml/entity_builder/EntityBuilder/methods/dml.entity_builder.EntityBuilder.define/page.mdx": "2025-01-13T18:05:57.746Z",
|
||||
"references/dml/entity_builder/types/dml.entity_builder.ManyToManyOptions/page.mdx": "2025-05-20T07:51:40.894Z",
|
||||
"references/file/classes/file.AbstractFileProviderService/page.mdx": "2025-10-21T08:10:52.484Z",
|
||||
"references/file/classes/file.AbstractFileProviderService/page.mdx": "2025-10-25T20:14:15.162Z",
|
||||
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createFulfillmentSets/page.mdx": "2025-10-21T08:10:44.379Z",
|
||||
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createGeoZones/page.mdx": "2025-10-21T08:10:44.461Z",
|
||||
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createServiceZones/page.mdx": "2025-10-21T08:10:44.418Z",
|
||||
@@ -1562,7 +1562,7 @@ export const generatedEditDates = {
|
||||
"references/tax/ITaxModuleService/methods/tax.ITaxModuleService.deleteTaxRateRules/page.mdx": "2025-10-21T08:10:52.234Z",
|
||||
"references/tax/ITaxModuleService/methods/tax.ITaxModuleService.deleteTaxRates/page.mdx": "2025-10-21T08:10:52.198Z",
|
||||
"references/tax/ITaxModuleService/methods/tax.ITaxModuleService.deleteTaxRegions/page.mdx": "2025-10-21T08:10:52.213Z",
|
||||
"references/tax/ITaxModuleService/methods/tax.ITaxModuleService.getTaxLines/page.mdx": "2025-10-21T08:10:52.243Z",
|
||||
"references/tax/ITaxModuleService/methods/tax.ITaxModuleService.getTaxLines/page.mdx": "2025-10-25T20:14:14.883Z",
|
||||
"references/tax/ITaxModuleService/methods/tax.ITaxModuleService.listAndCountTaxRates/page.mdx": "2025-10-21T08:10:52.171Z",
|
||||
"references/tax/ITaxModuleService/methods/tax.ITaxModuleService.listTaxRateRules/page.mdx": "2025-10-21T08:10:52.240Z",
|
||||
"references/tax/ITaxModuleService/methods/tax.ITaxModuleService.listTaxRates/page.mdx": "2025-10-21T08:10:52.163Z",
|
||||
@@ -1583,12 +1583,12 @@ export const generatedEditDates = {
|
||||
"references/tax/interfaces/tax.TaxRateRuleDTO/page.mdx": "2024-12-10T14:55:13.509Z",
|
||||
"references/tax/interfaces/tax.UpdateTaxRateDTO/page.mdx": "2024-12-10T14:55:13.523Z",
|
||||
"references/tax/types/tax.JoinerRelationship/page.mdx": "2024-12-09T13:22:04.496Z",
|
||||
"references/tax_provider/interfaces/tax_provider.ITaxProvider/page.mdx": "2025-10-24T06:00:50.804Z",
|
||||
"references/tax_provider/interfaces/tax_provider.ITaxProvider/page.mdx": "2025-10-25T20:14:14.638Z",
|
||||
"references/tax_provider/types/tax_provider.ItemTaxCalculationLine/page.mdx": "2024-12-09T13:22:04.464Z",
|
||||
"references/tax_provider/types/tax_provider.ShippingTaxCalculationLine/page.mdx": "2024-12-09T13:22:04.460Z",
|
||||
"references/types/DAL/interfaces/types.DAL.RepositoryService/page.mdx": "2025-10-21T08:10:45.266Z",
|
||||
"references/types/DAL/interfaces/types.DAL.TreeRepositoryService/page.mdx": "2025-10-21T08:10:45.278Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.IFileModuleService/page.mdx": "2025-10-21T08:10:45.464Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.IFileModuleService/page.mdx": "2025-10-25T20:14:07.306Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListResponse/page.mdx": "2025-10-21T08:10:45.811Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaimResponse/page.mdx": "2025-09-12T14:10:39.438Z",
|
||||
"references/types/InventoryTypes/interfaces/types.InventoryTypes.FilterableInventoryLevelProps/page.mdx": "2025-01-13T18:05:55.187Z",
|
||||
@@ -1715,7 +1715,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.removeShippingMethodAdjustmentsStep/page.mdx": "2025-01-13T17:30:23.012Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.removeShippingMethodFromCartStep/page.mdx": "2025-01-13T17:30:23.013Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.reserveInventoryStep/page.mdx": "2025-04-11T09:04:35.568Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateCartPromotionsStep/page.mdx": "2025-10-21T08:10:36.356Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateCartPromotionsStep/page.mdx": "2025-10-25T20:13:57.246Z",
|
||||
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateVariantPricesStep/page.mdx": "2025-01-13T18:05:49.333Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refreshPaymentCollectionForCartWorkflow/page.mdx": "2025-09-18T17:04:38.678Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateCartPromotionsWorkflow/page.mdx": "2025-09-18T17:04:38.724Z",
|
||||
@@ -1726,7 +1726,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.maybeUnsetDefaultShippingAddressesStep/page.mdx": "2025-05-20T07:51:40.758Z",
|
||||
"references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.updateCustomerAddressesStep/page.mdx": "2025-05-20T07:51:40.758Z",
|
||||
"references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.updateCustomersStep/page.mdx": "2025-05-20T07:51:40.759Z",
|
||||
"references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.createCustomerGroupsStep/page.mdx": "2025-10-21T08:10:36.889Z",
|
||||
"references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.createCustomerGroupsStep/page.mdx": "2025-10-25T20:13:57.837Z",
|
||||
"references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.deleteCustomerGroupStep/page.mdx": "2025-01-13T17:30:23.255Z",
|
||||
"references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.linkCustomersToCustomerGroupStep/page.mdx": "2025-01-13T18:05:49.505Z",
|
||||
"references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.updateCustomerGroupsStep/page.mdx": "2025-05-20T07:51:40.761Z",
|
||||
@@ -1737,14 +1737,14 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Defaults/Steps_Defaults/functions/core_flows.Defaults.Steps_Defaults.createDefaultStoreStep/page.mdx": "2025-01-13T17:30:23.305Z",
|
||||
"references/core_flows/Defaults/Workflows_Defaults/functions/core_flows.Defaults.Workflows_Defaults.createDefaultsWorkflow/page.mdx": "2025-09-18T17:04:39.037Z",
|
||||
"references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.deleteFilesStep/page.mdx": "2025-04-23T16:21:18.753Z",
|
||||
"references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.uploadFilesStep/page.mdx": "2025-06-05T19:05:37.376Z",
|
||||
"references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.uploadFilesStep/page.mdx": "2025-10-25T20:13:58.240Z",
|
||||
"references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.deleteFilesWorkflow/page.mdx": "2025-09-18T17:04:39.383Z",
|
||||
"references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.uploadFilesWorkflow/page.mdx": "2025-09-18T17:04:39.379Z",
|
||||
"references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.uploadFilesWorkflow/page.mdx": "2025-10-25T20:13:58.245Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.cancelFulfillmentStep/page.mdx": "2025-01-13T17:30:23.344Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createFulfillmentSets/page.mdx": "2025-10-21T08:10:37.275Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createServiceZonesStep/page.mdx": "2025-10-21T08:10:37.338Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingOptionsPriceSetsStep/page.mdx": "2025-10-21T08:10:37.263Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingProfilesStep/page.mdx": "2025-10-21T08:10:37.355Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createFulfillmentSets/page.mdx": "2025-10-25T20:13:58.279Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createServiceZonesStep/page.mdx": "2025-10-25T20:13:58.352Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingOptionsPriceSetsStep/page.mdx": "2025-10-25T20:13:58.261Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingProfilesStep/page.mdx": "2025-10-25T20:13:58.370Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.deleteFulfillmentSetsStep/page.mdx": "2025-01-13T17:30:23.386Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.deleteServiceZonesStep/page.mdx": "2025-01-13T17:30:23.387Z",
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.deleteShippingOptionsStep/page.mdx": "2025-01-13T17:30:23.392Z",
|
||||
@@ -1768,7 +1768,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.createInventoryLevelsStep/page.mdx": "2025-04-11T09:04:36.537Z",
|
||||
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.deleteInventoryItemStep/page.mdx": "2025-01-13T17:30:23.517Z",
|
||||
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.deleteInventoryLevelsStep/page.mdx": "2025-01-13T17:30:23.519Z",
|
||||
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.updateInventoryItemsStep/page.mdx": "2025-10-21T08:10:37.633Z",
|
||||
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.updateInventoryItemsStep/page.mdx": "2025-10-25T20:13:58.694Z",
|
||||
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.updateInventoryLevelsStep/page.mdx": "2025-04-11T09:04:36.558Z",
|
||||
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryItemsForCreate/page.mdx": "2025-01-13T17:30:23.525Z",
|
||||
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryLocationsStep/page.mdx": "2025-01-13T17:30:23.524Z",
|
||||
@@ -1783,24 +1783,24 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Invite/Steps_Invite/functions/core_flows.Invite.Steps_Invite.validateTokenStep/page.mdx": "2025-01-13T17:30:23.565Z",
|
||||
"references/core_flows/Line_Item/Steps_Line_Item/functions/core_flows.Line_Item.Steps_Line_Item.deleteLineItemsStep/page.mdx": "2025-01-13T17:30:23.577Z",
|
||||
"references/core_flows/Line_Item/Workflows_Line_Item/functions/core_flows.Line_Item.Workflows_Line_Item.deleteLineItemsWorkflow/page.mdx": "2025-09-18T17:04:39.988Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.cancelOrderChangeStep/page.mdx": "2025-10-21T08:10:37.838Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.cancelOrderChangeStep/page.mdx": "2025-10-25T20:13:58.918Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.cancelOrderFulfillmentStep/page.mdx": "2025-05-20T07:51:40.777Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.declineOrderChangeStep/page.mdx": "2025-10-21T08:10:37.928Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteClaimsStep/page.mdx": "2025-10-21T08:10:37.876Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteExchangesStep/page.mdx": "2025-10-21T08:10:37.954Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderChangeActionsStep/page.mdx": "2025-10-21T08:10:37.933Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderChangesStep/page.mdx": "2025-10-21T08:10:37.936Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderLineItems/page.mdx": "2025-10-21T08:10:37.930Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderShippingMethods/page.mdx": "2025-10-21T08:10:37.938Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteReturnsStep/page.mdx": "2025-10-21T08:10:38.008Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.declineOrderChangeStep/page.mdx": "2025-10-25T20:13:59.013Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteClaimsStep/page.mdx": "2025-10-25T20:13:58.957Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteExchangesStep/page.mdx": "2025-10-25T20:13:59.042Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderChangeActionsStep/page.mdx": "2025-10-25T20:13:59.018Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderChangesStep/page.mdx": "2025-10-25T20:13:59.021Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderLineItems/page.mdx": "2025-10-25T20:13:59.015Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderShippingMethods/page.mdx": "2025-10-25T20:13:59.023Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteReturnsStep/page.mdx": "2025-10-25T20:13:59.099Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.registerOrderFulfillmentStep/page.mdx": "2025-05-20T07:51:40.785Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.registerOrderShipmentStep/page.mdx": "2025-05-20T07:51:40.785Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderShippingMethodsStep/page.mdx": "2025-10-21T08:10:38.053Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderShippingMethodsStep/page.mdx": "2025-10-25T20:13:59.150Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateReturnItemsStep/page.mdx": "2025-01-13T18:05:49.942Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelBeginOrderClaimWorkflow/page.mdx": "2025-09-18T17:04:40.369Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelBeginOrderEditWorkflow/page.mdx": "2025-09-18T17:04:41.039Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelBeginOrderExchangeWorkflow/page.mdx": "2025-09-18T17:04:40.799Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderChangeWorkflow/page.mdx": "2025-10-21T08:10:38.089Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderChangeWorkflow/page.mdx": "2025-10-25T20:13:59.188Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderClaimWorkflow/page.mdx": "2025-09-18T17:04:40.376Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderExchangeWorkflow/page.mdx": "2025-09-18T17:04:40.807Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelReturnReceiveWorkflow/page.mdx": "2025-09-18T17:04:41.291Z",
|
||||
@@ -1809,27 +1809,27 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createAndCompleteReturnOrderWorkflow/page.mdx": "2025-09-18T17:04:41.371Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createCompleteReturnValidationStep/page.mdx": "2025-05-20T07:51:40.824Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderPaymentCollectionWorkflow/page.mdx": "2025-09-18T17:04:40.739Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.declineOrderChangeWorkflow/page.mdx": "2025-10-21T08:10:38.461Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderChangeActionsWorkflow/page.mdx": "2025-10-21T08:10:38.465Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderChangeWorkflow/page.mdx": "2025-10-21T08:10:38.468Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.declineOrderChangeWorkflow/page.mdx": "2025-10-25T20:13:59.604Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderChangeActionsWorkflow/page.mdx": "2025-10-25T20:13:59.608Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderChangeWorkflow/page.mdx": "2025-10-25T20:13:59.612Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderPaymentCollections/page.mdx": "2025-09-18T17:04:40.770Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.getOrderDetailWorkflow/page.mdx": "2025-09-18T17:04:40.986Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.markPaymentCollectionAsPaid/page.mdx": "2025-09-18T17:04:41.010Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.receiveAndCompleteReturnOrderWorkflow/page.mdx": "2025-09-18T17:04:41.422Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.receiveCompleteReturnValidationStep/page.mdx": "2025-05-20T07:51:40.837Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.throwUnlessPaymentCollectionNotPaid/page.mdx": "2025-05-20T07:51:40.845Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.throwUnlessStatusIsNotPaid/page.mdx": "2025-10-21T08:10:38.471Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.throwUnlessStatusIsNotPaid/page.mdx": "2025-10-25T20:13:59.615Z",
|
||||
"references/core_flows/Payment/Steps_Payment/functions/core_flows.Payment.Steps_Payment.authorizePaymentSessionStep/page.mdx": "2025-06-25T10:11:31.118Z",
|
||||
"references/core_flows/Payment/Steps_Payment/functions/core_flows.Payment.Steps_Payment.cancelPaymentStep/page.mdx": "2025-01-13T17:30:25.526Z",
|
||||
"references/core_flows/Payment/Steps_Payment/functions/core_flows.Payment.Steps_Payment.capturePaymentStep/page.mdx": "2025-06-25T10:11:31.137Z",
|
||||
"references/core_flows/Payment/Steps_Payment/functions/core_flows.Payment.Steps_Payment.refundPaymentStep/page.mdx": "2025-06-25T10:11:31.150Z",
|
||||
"references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.capturePaymentWorkflow/page.mdx": "2025-09-18T17:04:41.817Z",
|
||||
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.createPaymentSessionStep/page.mdx": "2025-10-21T08:10:39.422Z",
|
||||
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.createPaymentSessionStep/page.mdx": "2025-10-25T20:14:00.654Z",
|
||||
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.createRefundReasonStep/page.mdx": "2025-10-21T08:10:39.425Z",
|
||||
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.deletePaymentSessionsStep/page.mdx": "2025-10-21T08:10:39.428Z",
|
||||
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.deletePaymentSessionsStep/page.mdx": "2025-10-25T20:14:00.661Z",
|
||||
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.deleteRefundReasonsStep/page.mdx": "2025-01-13T17:30:25.585Z",
|
||||
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.updatePaymentCollectionStep/page.mdx": "2025-06-25T10:11:31.275Z",
|
||||
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.updateRefundReasonsStep/page.mdx": "2025-10-21T08:10:39.450Z",
|
||||
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.updateRefundReasonsStep/page.mdx": "2025-10-25T20:14:00.683Z",
|
||||
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.validateDeletedPaymentSessionsStep/page.mdx": "2025-01-13T17:30:25.592Z",
|
||||
"references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.createPaymentSessionsWorkflow/page.mdx": "2025-09-18T17:04:41.941Z",
|
||||
"references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.createRefundReasonsWorkflow/page.mdx": "2025-10-21T08:10:39.473Z",
|
||||
@@ -1839,7 +1839,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.getExistingPriceListsPriceIdsStep/page.mdx": "2025-01-13T17:30:25.619Z",
|
||||
"references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.removePriceListPricesStep/page.mdx": "2025-01-13T17:30:25.620Z",
|
||||
"references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.updatePriceListsStep/page.mdx": "2025-04-11T09:04:40.617Z",
|
||||
"references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.validatePriceListsStep/page.mdx": "2025-10-21T08:10:39.526Z",
|
||||
"references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.validatePriceListsStep/page.mdx": "2025-10-25T20:14:00.767Z",
|
||||
"references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.validateVariantPriceLinksStep/page.mdx": "2025-01-13T17:30:25.630Z",
|
||||
"references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.deletePriceListsWorkflow/page.mdx": "2025-09-18T17:04:42.042Z",
|
||||
"references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.removePriceListPricesWorkflow/page.mdx": "2025-09-18T17:04:42.046Z",
|
||||
@@ -1853,7 +1853,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.deletePricePreferencesWorkflow/page.mdx": "2025-09-18T17:04:42.101Z",
|
||||
"references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.updatePricePreferencesWorkflow/page.mdx": "2025-10-21T08:10:39.619Z",
|
||||
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.batchLinkProductsToCollectionStep/page.mdx": "2025-01-13T18:05:52.101Z",
|
||||
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createCollectionsStep/page.mdx": "2025-10-21T08:10:39.646Z",
|
||||
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createCollectionsStep/page.mdx": "2025-10-25T20:14:00.894Z",
|
||||
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductOptionsStep/page.mdx": "2025-04-11T09:04:40.737Z",
|
||||
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductTagsStep/page.mdx": "2025-04-11T09:04:40.811Z",
|
||||
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductTypesStep/page.mdx": "2025-04-11T09:04:40.815Z",
|
||||
@@ -1927,7 +1927,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Sales_Channel/Workflows_Sales_Channel/functions/core_flows.Sales_Channel.Workflows_Sales_Channel.linkProductsToSalesChannelWorkflow/page.mdx": "2025-09-18T17:04:42.897Z",
|
||||
"references/core_flows/Shipping_Profile/Steps_Shipping_Profile/functions/core_flows.Shipping_Profile.Steps_Shipping_Profile.deleteShippingProfilesStep/page.mdx": "2025-01-13T17:30:25.996Z",
|
||||
"references/core_flows/Shipping_Profile/Workflows_Shipping_Profile/functions/core_flows.Shipping_Profile.Workflows_Shipping_Profile.deleteShippingProfileWorkflow/page.mdx": "2025-09-18T17:04:43.029Z",
|
||||
"references/core_flows/Stock_Location/Steps_Stock_Location/functions/core_flows.Stock_Location.Steps_Stock_Location.createStockLocations/page.mdx": "2025-10-21T08:10:40.452Z",
|
||||
"references/core_flows/Stock_Location/Steps_Stock_Location/functions/core_flows.Stock_Location.Steps_Stock_Location.createStockLocations/page.mdx": "2025-10-25T20:14:01.783Z",
|
||||
"references/core_flows/Stock_Location/Steps_Stock_Location/functions/core_flows.Stock_Location.Steps_Stock_Location.deleteStockLocationsStep/page.mdx": "2025-01-13T17:30:26.004Z",
|
||||
"references/core_flows/Stock_Location/Steps_Stock_Location/functions/core_flows.Stock_Location.Steps_Stock_Location.updateStockLocationsStep/page.mdx": "2025-05-20T07:51:40.869Z",
|
||||
"references/core_flows/Stock_Location/Workflows_Stock_Location/functions/core_flows.Stock_Location.Workflows_Stock_Location.createLocationFulfillmentSetWorkflow/page.mdx": "2025-09-18T17:04:43.052Z",
|
||||
@@ -2055,8 +2055,8 @@ export const generatedEditDates = {
|
||||
"references/region/interfaces/region.MessageAggregatorFormat/page.mdx": "2024-12-09T13:22:04.016Z",
|
||||
"references/region/interfaces/region.PaymentProviderDTO/page.mdx": "2024-12-09T13:22:03.956Z",
|
||||
"references/region/interfaces/region.RegionDTO/page.mdx": "2024-12-09T13:22:03.956Z",
|
||||
"references/region_models/variables/region_models.Country/page.mdx": "2025-10-21T08:10:58.345Z",
|
||||
"references/region_models/variables/region_models.Region/page.mdx": "2025-10-21T08:10:58.348Z",
|
||||
"references/region_models/variables/region_models.Country/page.mdx": "2025-10-25T20:14:21.722Z",
|
||||
"references/region_models/variables/region_models.Region/page.mdx": "2025-10-25T20:14:21.726Z",
|
||||
"references/sales_channel/IMessageAggregator/methods/sales_channel.IMessageAggregator.getMessages/page.mdx": "2025-04-11T09:04:52.240Z",
|
||||
"references/sales_channel/interfaces/sales_channel.IModuleService/page.mdx": "2024-12-09T13:22:04.060Z",
|
||||
"references/sales_channel/interfaces/sales_channel.MessageAggregatorFormat/page.mdx": "2024-12-09T13:22:04.104Z",
|
||||
@@ -2609,7 +2609,7 @@ export const generatedEditDates = {
|
||||
"references/js_sdk/modules/js_sdk.store/page.mdx": "2024-10-22T15:09:53.787Z",
|
||||
"references/js_sdk/modules/js_sdk.auth/page.mdx": "2024-10-22T15:09:53.779Z",
|
||||
"references/js_sdk/store/Store/properties/js_sdk.store.Store.collection/page.mdx": "2025-10-21T08:10:57.912Z",
|
||||
"references/js_sdk/store/Store/properties/js_sdk.store.Store.cart/page.mdx": "2025-10-21T08:10:57.955Z",
|
||||
"references/js_sdk/store/Store/properties/js_sdk.store.Store.cart/page.mdx": "2025-10-25T20:14:21.227Z",
|
||||
"references/js_sdk/store/Store/properties/js_sdk.store.Store.customer/page.mdx": "2025-10-21T08:10:58.015Z",
|
||||
"references/js_sdk/store/Store/properties/js_sdk.store.Store.fulfillment/page.mdx": "2025-10-21T08:10:57.961Z",
|
||||
"references/js_sdk/store/Store/properties/js_sdk.store.Store.order/page.mdx": "2025-10-21T08:10:57.990Z",
|
||||
@@ -2618,7 +2618,7 @@ export const generatedEditDates = {
|
||||
"references/js_sdk/store/Store/properties/js_sdk.store.Store.region/page.mdx": "2025-10-21T08:10:57.906Z",
|
||||
"references/js_sdk/store/classes/js_sdk.store.Store/page.mdx": "2024-11-25T17:49:55.112Z",
|
||||
"references/modules/js_sdk/page.mdx": "2024-10-22T15:09:52.263Z",
|
||||
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryDeleteStep/page.mdx": "2025-10-21T08:10:37.619Z",
|
||||
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryDeleteStep/page.mdx": "2025-10-25T20:13:58.683Z",
|
||||
"references/core_flows/Tax/Workflows_Tax/functions/core_flows.Tax.Workflows_Tax.updateTaxRegionsWorkflow/page.mdx": "2025-09-18T17:04:43.238Z",
|
||||
"references/core_flows/interfaces/core_flows.ValidateInventoryDeleteStepInput/page.mdx": "2024-12-09T13:21:50.648Z",
|
||||
"references/core_flows/types/core_flows.UseQueryGraphStepInput/page.mdx": "2024-12-09T13:21:50.232Z",
|
||||
@@ -2757,8 +2757,8 @@ export const generatedEditDates = {
|
||||
"references/core_flows/types/core_flows.UpdateSalesChannelsWorkflowInput/page.mdx": "2025-01-13T18:05:52.729Z",
|
||||
"references/core_flows/types/core_flows.UpdateShippingProfilesStepInput/page.mdx": "2025-01-13T18:05:52.630Z",
|
||||
"references/core_flows/types/core_flows.UpdateStoresStepInput/page.mdx": "2025-01-13T18:05:52.735Z",
|
||||
"references/core_flows/types/core_flows.UploadFilesStepInput/page.mdx": "2024-12-09T13:21:50.368Z",
|
||||
"references/core_flows/types/core_flows.UploadFilesWorkflowInput/page.mdx": "2024-12-09T13:21:50.372Z",
|
||||
"references/core_flows/types/core_flows.UploadFilesStepInput/page.mdx": "2025-10-25T20:14:02.359Z",
|
||||
"references/core_flows/types/core_flows.UploadFilesWorkflowInput/page.mdx": "2025-10-25T20:14:02.362Z",
|
||||
"references/core_flows/types/core_flows.UpsertVariantPricesWorkflowInput/page.mdx": "2024-12-09T13:21:54.716Z",
|
||||
"references/currency/interfaces/currency.ICurrencyModuleService/page.mdx": "2024-11-25T17:49:50.180Z",
|
||||
"references/currency/types/currency.Event/page.mdx": "2025-04-11T09:04:44.496Z",
|
||||
@@ -3225,7 +3225,7 @@ export const generatedEditDates = {
|
||||
"references/store/interfaces/store.IMessageAggregator/page.mdx": "2024-11-25T17:49:59.196Z",
|
||||
"references/tax/interfaces/tax.IBigNumber/page.mdx": "2024-12-09T13:22:04.668Z",
|
||||
"references/tax/interfaces/tax.IMessageAggregator/page.mdx": "2024-11-25T17:49:59.336Z",
|
||||
"references/tax/interfaces/tax.TaxCalculationContext/page.mdx": "2025-05-20T07:51:41.052Z",
|
||||
"references/tax/interfaces/tax.TaxCalculationContext/page.mdx": "2025-10-25T20:14:14.755Z",
|
||||
"references/types/DmlTypes/types/types.DmlTypes.PropertyMetadata/page.mdx": "2024-12-17T16:57:19.924Z",
|
||||
"references/types/DmlTypes/types/types.DmlTypes.RelationshipMetadata/page.mdx": "2024-12-10T14:54:55.439Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchProductRequest/page.mdx": "2025-02-24T10:48:37.908Z",
|
||||
@@ -3292,14 +3292,14 @@ export const generatedEditDates = {
|
||||
"references/pricing/types/pricing.FilterQueryProperties/page.mdx": "2024-12-23T12:30:30.704Z",
|
||||
"references/product/types/product.Constructor/page.mdx": "2024-12-09T13:22:03.168Z",
|
||||
"references/product/types/product.FilterQueryProperties/page.mdx": "2024-12-23T12:30:30.868Z",
|
||||
"references/product_models/variables/product_models.Product/page.mdx": "2025-10-21T08:10:58.270Z",
|
||||
"references/product_models/variables/product_models.ProductCategory/page.mdx": "2025-10-21T08:10:58.169Z",
|
||||
"references/product_models/variables/product_models.ProductCollection/page.mdx": "2025-10-21T08:10:58.177Z",
|
||||
"references/product_models/variables/product_models.ProductOption/page.mdx": "2025-10-21T08:10:58.206Z",
|
||||
"references/product_models/variables/product_models.ProductOptionValue/page.mdx": "2025-10-21T08:10:58.196Z",
|
||||
"references/product_models/variables/product_models.ProductTag/page.mdx": "2025-10-21T08:10:58.214Z",
|
||||
"references/product_models/variables/product_models.ProductType/page.mdx": "2025-10-21T08:10:58.230Z",
|
||||
"references/product_models/variables/product_models.ProductVariant/page.mdx": "2025-10-21T08:10:58.244Z",
|
||||
"references/product_models/variables/product_models.Product/page.mdx": "2025-10-25T20:14:21.636Z",
|
||||
"references/product_models/variables/product_models.ProductCategory/page.mdx": "2025-10-25T20:14:21.482Z",
|
||||
"references/product_models/variables/product_models.ProductCollection/page.mdx": "2025-10-25T20:14:21.492Z",
|
||||
"references/product_models/variables/product_models.ProductOption/page.mdx": "2025-10-25T20:14:21.528Z",
|
||||
"references/product_models/variables/product_models.ProductOptionValue/page.mdx": "2025-10-25T20:14:21.514Z",
|
||||
"references/product_models/variables/product_models.ProductTag/page.mdx": "2025-10-25T20:14:21.541Z",
|
||||
"references/product_models/variables/product_models.ProductType/page.mdx": "2025-10-25T20:14:21.563Z",
|
||||
"references/product_models/variables/product_models.ProductVariant/page.mdx": "2025-10-25T20:14:21.600Z",
|
||||
"references/promotion/types/promotion.Constructor/page.mdx": "2024-12-09T13:22:03.708Z",
|
||||
"references/promotion/types/promotion.FilterQueryProperties/page.mdx": "2024-12-23T12:30:31.117Z",
|
||||
"references/region/types/region.Constructor/page.mdx": "2024-12-09T13:22:03.944Z",
|
||||
@@ -3312,7 +3312,7 @@ export const generatedEditDates = {
|
||||
"references/types/DmlTypes/types/types.DmlTypes.IsNullableRelation/page.mdx": "2024-12-09T13:21:32.993Z",
|
||||
"references/types/types/types.FilterQueryProperties/page.mdx": "2024-12-23T12:30:28.129Z",
|
||||
"references/cart/types/cart.FilterQuery/page.mdx": "2024-11-27T16:33:41.056Z",
|
||||
"references/currency_models/variables/currency_models.Currency/page.mdx": "2025-10-21T08:10:52.980Z",
|
||||
"references/currency_models/variables/currency_models.Currency/page.mdx": "2025-10-25T20:14:15.737Z",
|
||||
"references/customer/types/customer.FilterQuery/page.mdx": "2024-11-27T16:33:52.327Z",
|
||||
"references/fulfillment/types/fulfillment.FilterQuery/page.mdx": "2024-11-27T16:33:52.465Z",
|
||||
"references/inventory_next/types/inventory_next.FilterQuery/page.mdx": "2024-11-27T16:33:52.961Z",
|
||||
@@ -3328,8 +3328,8 @@ export const generatedEditDates = {
|
||||
"references/types/DmlTypes/types/types.DmlTypes.InferForeignKeys/page.mdx": "2025-02-24T10:48:36.703Z",
|
||||
"references/types/DmlTypes/types/types.DmlTypes.InferSchemaFields/page.mdx": "2025-01-13T18:05:54.083Z",
|
||||
"references/types/interfaces/types.BaseRepositoryService/page.mdx": "2024-12-09T13:21:32.969Z",
|
||||
"references/auth_models/variables/auth_models.AuthIdentity/page.mdx": "2025-10-21T08:10:52.879Z",
|
||||
"references/auth_models/variables/auth_models.ProviderIdentity/page.mdx": "2025-10-21T08:10:52.886Z",
|
||||
"references/auth_models/variables/auth_models.AuthIdentity/page.mdx": "2025-10-25T20:14:15.609Z",
|
||||
"references/auth_models/variables/auth_models.ProviderIdentity/page.mdx": "2025-10-25T20:14:15.617Z",
|
||||
"references/dml/entity/DmlEntity/methods/dml.entity.DmlEntity.checks/page.mdx": "2024-12-09T13:21:55.464Z",
|
||||
"references/helper_steps/functions/helper_steps.validatePresenceOfStep/page.mdx": "2025-01-13T17:30:22.855Z",
|
||||
"references/js_sdk/admin/Order/methods/js_sdk.admin.Order.update/page.mdx": "2025-09-12T14:10:49.006Z",
|
||||
@@ -3338,13 +3338,13 @@ export const generatedEditDates = {
|
||||
"references/order/types/order.OrderChangeType/page.mdx": "2025-01-07T12:54:23.927Z",
|
||||
"references/pricing/interfaces/pricing.RuleWithOperator/page.mdx": "2025-01-13T17:30:30.399Z",
|
||||
"references/pricing/types/pricing.PricingRuleOperatorValues/page.mdx": "2024-12-04T18:29:34.568Z",
|
||||
"references/pricing_models/variables/pricing_models.Price/page.mdx": "2025-10-21T08:10:58.147Z",
|
||||
"references/pricing_models/variables/pricing_models.PriceList/page.mdx": "2025-10-21T08:10:58.125Z",
|
||||
"references/pricing_models/variables/pricing_models.PriceListRule/page.mdx": "2025-10-21T08:10:58.119Z",
|
||||
"references/pricing_models/variables/pricing_models.PricePreference/page.mdx": "2025-10-21T08:10:58.127Z",
|
||||
"references/pricing_models/variables/pricing_models.PriceRule/page.mdx": "2025-10-21T08:10:58.131Z",
|
||||
"references/pricing_models/variables/pricing_models.PriceSet/page.mdx": "2025-10-21T08:10:58.141Z",
|
||||
"references/product_models/variables/product_models.ProductImage/page.mdx": "2025-10-21T08:10:58.184Z",
|
||||
"references/pricing_models/variables/pricing_models.Price/page.mdx": "2025-10-25T20:14:21.456Z",
|
||||
"references/pricing_models/variables/pricing_models.PriceList/page.mdx": "2025-10-25T20:14:21.432Z",
|
||||
"references/pricing_models/variables/pricing_models.PriceListRule/page.mdx": "2025-10-25T20:14:21.425Z",
|
||||
"references/pricing_models/variables/pricing_models.PricePreference/page.mdx": "2025-10-25T20:14:21.434Z",
|
||||
"references/pricing_models/variables/pricing_models.PriceRule/page.mdx": "2025-10-25T20:14:21.440Z",
|
||||
"references/pricing_models/variables/pricing_models.PriceSet/page.mdx": "2025-10-25T20:14:21.447Z",
|
||||
"references/product_models/variables/product_models.ProductImage/page.mdx": "2025-10-25T20:14:21.501Z",
|
||||
"references/types/DmlTypes/types/types.DmlTypes.CheckConstraint/page.mdx": "2025-01-13T18:05:54.113Z",
|
||||
"references/types/DmlTypes/types/types.DmlTypes.InferCheckConstraintsProperties/page.mdx": "2025-01-13T18:05:54.110Z",
|
||||
"references/types/DmlTypes/types/types.DmlTypes.InferSchemaProperties/page.mdx": "2025-01-13T18:05:54.102Z",
|
||||
@@ -3352,8 +3352,8 @@ export const generatedEditDates = {
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.OrderAddress/page.mdx": "2025-05-20T07:51:41.070Z",
|
||||
"references/types/WorkflowTypes/OrderWorkflow/types/types.WorkflowTypes.OrderWorkflow.UpdateOrderShippingAddressWorkflowInput/page.mdx": "2025-09-12T14:10:42.053Z",
|
||||
"references/types/WorkflowTypes/OrderWorkflow/types/types.WorkflowTypes.OrderWorkflow.UpdateOrderWorkflowInput/page.mdx": "2025-09-12T14:10:42.051Z",
|
||||
"references/user_models/variables/user_models.Invite/page.mdx": "2025-10-21T08:10:58.397Z",
|
||||
"references/user_models/variables/user_models.User/page.mdx": "2025-10-21T08:10:58.399Z",
|
||||
"references/user_models/variables/user_models.Invite/page.mdx": "2025-10-25T20:14:21.788Z",
|
||||
"references/user_models/variables/user_models.User/page.mdx": "2025-10-25T20:14:21.790Z",
|
||||
"references/utils/PricingUtils/enums/utils.PricingUtils.PriceListStatus/page.mdx": "2024-12-04T18:29:19.807Z",
|
||||
"references/utils/PricingUtils/enums/utils.PricingUtils.PriceListType/page.mdx": "2024-12-04T18:29:19.808Z",
|
||||
"references/utils/PricingUtils/enums/utils.PricingUtils.PricingRuleOperator/page.mdx": "2024-12-04T18:29:19.806Z",
|
||||
@@ -5010,11 +5010,11 @@ export const generatedEditDates = {
|
||||
"references/tax/interfaces/tax.FilterableTaxRateProps/page.mdx": "2025-01-13T18:05:57.349Z",
|
||||
"references/tax/interfaces/tax.FilterableTaxRateRuleProps/page.mdx": "2025-01-13T18:05:57.365Z",
|
||||
"references/tax/interfaces/tax.FilterableTaxRegionProps/page.mdx": "2025-05-20T07:51:41.052Z",
|
||||
"references/tax/interfaces/tax.ItemTaxLineDTO/page.mdx": "2024-12-09T13:22:04.568Z",
|
||||
"references/tax/interfaces/tax.ItemTaxLineDTO/page.mdx": "2025-10-25T20:14:14.758Z",
|
||||
"references/tax/interfaces/tax.RestoreReturn/page.mdx": "2024-12-09T13:22:04.476Z",
|
||||
"references/tax/interfaces/tax.ShippingTaxLineDTO/page.mdx": "2024-12-09T13:22:04.568Z",
|
||||
"references/tax/interfaces/tax.ShippingTaxLineDTO/page.mdx": "2025-10-25T20:14:14.760Z",
|
||||
"references/tax/interfaces/tax.SoftDeleteReturn/page.mdx": "2024-12-09T13:22:04.476Z",
|
||||
"references/tax/interfaces/tax.TaxLineDTO/page.mdx": "2024-12-09T13:22:04.564Z",
|
||||
"references/tax/interfaces/tax.TaxLineDTO/page.mdx": "2025-10-25T20:14:14.756Z",
|
||||
"references/tax/interfaces/tax.TaxRegionDTO/page.mdx": "2025-05-20T07:51:41.052Z",
|
||||
"references/tax/interfaces/tax.TaxableShippingDTO/page.mdx": "2024-12-09T13:22:04.560Z",
|
||||
"references/tax/interfaces/tax.UpsertTaxRateDTO/page.mdx": "2024-12-09T13:22:04.572Z",
|
||||
@@ -5069,15 +5069,15 @@ export const generatedEditDates = {
|
||||
"references/types/EventBusTypes/types/types.EventBusTypes.SubscriberDescriptor/page.mdx": "2024-12-09T13:21:33.041Z",
|
||||
"references/types/FeatureFlagTypes/interfaces/types.FeatureFlagTypes.IFlagRouter/page.mdx": "2024-12-09T13:21:33.073Z",
|
||||
"references/types/FeatureFlagTypes/types/types.FeatureFlagTypes.FlagSettings/page.mdx": "2024-12-09T13:21:33.077Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.CreateFileDTO/page.mdx": "2025-04-23T07:49:49.093Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.CreateFileDTO/page.mdx": "2025-10-25T20:14:07.260Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.FileDTO/page.mdx": "2025-04-11T09:04:46.079Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.FilterableFileProps/page.mdx": "2024-12-09T13:21:33.093Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.IFileProvider/page.mdx": "2025-06-25T10:11:37.319Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.IFileProvider/page.mdx": "2025-10-25T20:14:07.282Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.LocalFileServiceOptions/page.mdx": "2024-12-09T13:21:33.109Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.ProviderDeleteFileDTO/page.mdx": "2024-12-09T13:21:33.097Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.ProviderFileResultDTO/page.mdx": "2025-02-24T10:48:36.779Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.ProviderGetFileDTO/page.mdx": "2025-05-20T07:51:41.056Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.ProviderUploadFileDTO/page.mdx": "2025-04-23T07:49:49.100Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.ProviderUploadFileDTO/page.mdx": "2025-10-25T20:14:07.268Z",
|
||||
"references/types/FileTypes/interfaces/types.FileTypes.S3FileServiceOptions/page.mdx": "2024-12-17T16:57:19.969Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddReturnItem/page.mdx": "2025-04-11T09:04:47.536Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddReturnItems/page.mdx": "2025-04-11T09:04:47.538Z",
|
||||
@@ -5521,20 +5521,20 @@ export const generatedEditDates = {
|
||||
"references/workflows/interfaces/workflows.ApplyStepOptions/page.mdx": "2025-09-12T14:10:46.875Z",
|
||||
"references/workflows/types/workflows.WorkflowData/page.mdx": "2024-12-23T13:57:08.059Z",
|
||||
"app/integrations/guides/resend/page.mdx": "2025-10-21T11:08:19.352Z",
|
||||
"references/api_key_models/variables/api_key_models.ApiKey/page.mdx": "2025-10-21T08:10:52.876Z",
|
||||
"references/api_key_models/variables/api_key_models.ApiKey/page.mdx": "2025-10-25T20:14:15.604Z",
|
||||
"references/cart/ICartModuleService/methods/cart.ICartModuleService.updateShippingMethods/page.mdx": "2025-10-21T08:10:43.389Z",
|
||||
"references/cart/interfaces/cart.UpdateShippingMethodDTO/page.mdx": "2025-06-25T10:11:35.052Z",
|
||||
"references/cart_models/variables/cart_models.Address/page.mdx": "2025-10-21T08:10:52.890Z",
|
||||
"references/cart_models/variables/cart_models.Cart/page.mdx": "2025-10-21T08:10:52.905Z",
|
||||
"references/cart_models/variables/cart_models.LineItem/page.mdx": "2025-10-21T08:10:52.951Z",
|
||||
"references/cart_models/variables/cart_models.LineItemAdjustment/page.mdx": "2025-10-21T08:10:52.925Z",
|
||||
"references/cart_models/variables/cart_models.LineItemTaxLine/page.mdx": "2025-10-21T08:10:52.932Z",
|
||||
"references/cart_models/variables/cart_models.ShippingMethod/page.mdx": "2025-10-21T08:10:52.977Z",
|
||||
"references/cart_models/variables/cart_models.ShippingMethodAdjustment/page.mdx": "2025-10-21T08:10:52.957Z",
|
||||
"references/cart_models/variables/cart_models.ShippingMethodTaxLine/page.mdx": "2025-10-21T08:10:52.962Z",
|
||||
"references/cart_models/variables/cart_models.Address/page.mdx": "2025-10-25T20:14:15.622Z",
|
||||
"references/cart_models/variables/cart_models.Cart/page.mdx": "2025-10-25T20:14:15.642Z",
|
||||
"references/cart_models/variables/cart_models.LineItem/page.mdx": "2025-10-25T20:14:15.701Z",
|
||||
"references/cart_models/variables/cart_models.LineItemAdjustment/page.mdx": "2025-10-25T20:14:15.666Z",
|
||||
"references/cart_models/variables/cart_models.LineItemTaxLine/page.mdx": "2025-10-25T20:14:15.675Z",
|
||||
"references/cart_models/variables/cart_models.ShippingMethod/page.mdx": "2025-10-25T20:14:15.733Z",
|
||||
"references/cart_models/variables/cart_models.ShippingMethodAdjustment/page.mdx": "2025-10-25T20:14:15.708Z",
|
||||
"references/cart_models/variables/cart_models.ShippingMethodTaxLine/page.mdx": "2025-10-25T20:14:15.714Z",
|
||||
"references/dml/Property/methods/dml.Property.autoincrement/page.mdx": "2024-12-10T14:55:08.589Z",
|
||||
"references/dml/dml.Property/page.mdx": "2024-12-10T14:55:08.588Z",
|
||||
"references/sales_channel_models/variables/sales_channel_models.SalesChannel/page.mdx": "2025-10-21T08:10:58.351Z",
|
||||
"references/sales_channel_models/variables/sales_channel_models.SalesChannel/page.mdx": "2025-10-25T20:14:21.729Z",
|
||||
"references/store/types/store.Constructor/page.mdx": "2024-12-10T14:55:13.404Z",
|
||||
"references/store/types/store.ExpandScalar/page.mdx": "2024-12-10T14:55:13.391Z",
|
||||
"references/store/types/store.FilterQuery/page.mdx": "2024-12-10T14:55:13.397Z",
|
||||
@@ -5547,8 +5547,8 @@ export const generatedEditDates = {
|
||||
"references/store/types/store.Query/page.mdx": "2024-12-10T14:55:13.390Z",
|
||||
"references/store/types/store.ReadonlyPrimary/page.mdx": "2024-12-10T14:55:13.392Z",
|
||||
"references/store/types/store.Scalar/page.mdx": "2024-12-10T14:55:13.391Z",
|
||||
"references/store_models/variables/store_models.Store/page.mdx": "2025-10-21T08:10:58.365Z",
|
||||
"references/store_models/variables/store_models.StoreCurrency/page.mdx": "2025-10-21T08:10:58.362Z",
|
||||
"references/store_models/variables/store_models.Store/page.mdx": "2025-10-25T20:14:21.747Z",
|
||||
"references/store_models/variables/store_models.StoreCurrency/page.mdx": "2025-10-25T20:14:21.744Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreCalculatedPrice/page.mdx": "2025-03-04T13:33:51.211Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.StorePrice/page.mdx": "2024-12-10T14:54:56.154Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.StorePriceRule/page.mdx": "2024-12-10T14:54:56.155Z",
|
||||
@@ -5569,10 +5569,10 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Fulfillment/Steps_Fulfillment/variables/core_flows.Fulfillment.Steps_Fulfillment.calculateShippingOptionsPricesStepId/page.mdx": "2024-12-17T16:57:22.226Z",
|
||||
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.calculateShippingOptionsPricesWorkflow/page.mdx": "2025-09-18T17:04:39.603Z",
|
||||
"references/core_flows/Fulfillment/Workflows_Fulfillment/variables/core_flows.Fulfillment.Workflows_Fulfillment.calculateShippingOptionsPricesWorkflowId/page.mdx": "2024-12-17T16:57:22.302Z",
|
||||
"references/customer_models/variables/customer_models.Customer/page.mdx": "2025-10-21T08:10:53.006Z",
|
||||
"references/customer_models/variables/customer_models.CustomerAddress/page.mdx": "2025-10-21T08:10:52.987Z",
|
||||
"references/customer_models/variables/customer_models.CustomerGroup/page.mdx": "2025-10-21T08:10:52.996Z",
|
||||
"references/customer_models/variables/customer_models.CustomerGroupCustomer/page.mdx": "2025-10-21T08:10:52.992Z",
|
||||
"references/customer_models/variables/customer_models.Customer/page.mdx": "2025-10-25T20:14:15.768Z",
|
||||
"references/customer_models/variables/customer_models.CustomerAddress/page.mdx": "2025-10-25T20:14:15.745Z",
|
||||
"references/customer_models/variables/customer_models.CustomerGroup/page.mdx": "2025-10-25T20:14:15.757Z",
|
||||
"references/customer_models/variables/customer_models.CustomerGroupCustomer/page.mdx": "2025-10-25T20:14:15.751Z",
|
||||
"references/dml/Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.computed/page.mdx": "2024-12-17T16:57:24.854Z",
|
||||
"references/dml/Property_Types/methods/dml.Property_Types.float/page.mdx": "2025-10-21T08:10:53.052Z",
|
||||
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.calculateShippingOptionsPrices/page.mdx": "2025-10-21T08:10:44.733Z",
|
||||
@@ -5591,28 +5591,28 @@ export const generatedEditDates = {
|
||||
"references/fulfillment/interfaces/fulfillment.ShippingMethodTaxLineDTO/page.mdx": "2025-06-25T10:11:35.926Z",
|
||||
"references/fulfillment/interfaces/fulfillment.TaxLineDTO/page.mdx": "2024-12-17T16:57:24.925Z",
|
||||
"references/fulfillment/types/fulfillment.CalculatedShippingOptionPrice/page.mdx": "2025-01-17T16:43:27.044Z",
|
||||
"references/inventory_next_models/variables/inventory_next_models.InventoryItem/page.mdx": "2025-10-21T08:10:53.660Z",
|
||||
"references/inventory_next_models/variables/inventory_next_models.InventoryLevel/page.mdx": "2025-10-21T08:10:53.669Z",
|
||||
"references/inventory_next_models/variables/inventory_next_models.ReservationItem/page.mdx": "2025-10-21T08:10:53.675Z",
|
||||
"references/payment_models/variables/payment_models.Capture/page.mdx": "2025-10-21T08:10:58.063Z",
|
||||
"references/payment_models/variables/payment_models.Payment/page.mdx": "2025-10-21T08:10:58.100Z",
|
||||
"references/payment_models/variables/payment_models.PaymentCollection/page.mdx": "2025-10-21T08:10:58.072Z",
|
||||
"references/payment_models/variables/payment_models.PaymentProvider/page.mdx": "2025-10-21T08:10:58.081Z",
|
||||
"references/payment_models/variables/payment_models.PaymentSession/page.mdx": "2025-10-21T08:10:58.089Z",
|
||||
"references/payment_models/variables/payment_models.Refund/page.mdx": "2025-10-21T08:10:58.115Z",
|
||||
"references/payment_models/variables/payment_models.RefundReason/page.mdx": "2025-10-21T08:10:58.108Z",
|
||||
"references/promotion_models/variables/promotion_models.ApplicationMethod/page.mdx": "2025-10-21T08:10:58.292Z",
|
||||
"references/promotion_models/variables/promotion_models.Campaign/page.mdx": "2025-10-21T08:10:58.307Z",
|
||||
"references/promotion_models/variables/promotion_models.CampaignBudget/page.mdx": "2025-10-21T08:10:58.300Z",
|
||||
"references/promotion_models/variables/promotion_models.Promotion/page.mdx": "2025-10-21T08:10:58.337Z",
|
||||
"references/promotion_models/variables/promotion_models.PromotionRule/page.mdx": "2025-10-21T08:10:58.327Z",
|
||||
"references/promotion_models/variables/promotion_models.PromotionRuleValue/page.mdx": "2025-10-21T08:10:58.315Z",
|
||||
"references/stock_location_next_models/variables/stock_location_next_models.StockLocation/page.mdx": "2025-10-21T08:10:58.358Z",
|
||||
"references/stock_location_next_models/variables/stock_location_next_models.StockLocationAddress/page.mdx": "2025-10-21T08:10:58.355Z",
|
||||
"references/tax_models/variables/tax_models.TaxProvider/page.mdx": "2025-10-21T08:10:58.370Z",
|
||||
"references/tax_models/variables/tax_models.TaxRate/page.mdx": "2025-10-21T08:10:58.384Z",
|
||||
"references/tax_models/variables/tax_models.TaxRateRule/page.mdx": "2025-10-21T08:10:58.378Z",
|
||||
"references/tax_models/variables/tax_models.TaxRegion/page.mdx": "2025-10-21T08:10:58.394Z",
|
||||
"references/inventory_next_models/variables/inventory_next_models.InventoryItem/page.mdx": "2025-10-25T20:14:16.501Z",
|
||||
"references/inventory_next_models/variables/inventory_next_models.InventoryLevel/page.mdx": "2025-10-25T20:14:16.508Z",
|
||||
"references/inventory_next_models/variables/inventory_next_models.ReservationItem/page.mdx": "2025-10-25T20:14:16.525Z",
|
||||
"references/payment_models/variables/payment_models.Capture/page.mdx": "2025-10-25T20:14:21.354Z",
|
||||
"references/payment_models/variables/payment_models.Payment/page.mdx": "2025-10-25T20:14:21.402Z",
|
||||
"references/payment_models/variables/payment_models.PaymentCollection/page.mdx": "2025-10-25T20:14:21.367Z",
|
||||
"references/payment_models/variables/payment_models.PaymentProvider/page.mdx": "2025-10-25T20:14:21.376Z",
|
||||
"references/payment_models/variables/payment_models.PaymentSession/page.mdx": "2025-10-25T20:14:21.387Z",
|
||||
"references/payment_models/variables/payment_models.Refund/page.mdx": "2025-10-25T20:14:21.419Z",
|
||||
"references/payment_models/variables/payment_models.RefundReason/page.mdx": "2025-10-25T20:14:21.410Z",
|
||||
"references/promotion_models/variables/promotion_models.ApplicationMethod/page.mdx": "2025-10-25T20:14:21.656Z",
|
||||
"references/promotion_models/variables/promotion_models.Campaign/page.mdx": "2025-10-25T20:14:21.676Z",
|
||||
"references/promotion_models/variables/promotion_models.CampaignBudget/page.mdx": "2025-10-25T20:14:21.667Z",
|
||||
"references/promotion_models/variables/promotion_models.Promotion/page.mdx": "2025-10-25T20:14:21.714Z",
|
||||
"references/promotion_models/variables/promotion_models.PromotionRule/page.mdx": "2025-10-25T20:14:21.700Z",
|
||||
"references/promotion_models/variables/promotion_models.PromotionRuleValue/page.mdx": "2025-10-25T20:14:21.682Z",
|
||||
"references/stock_location_next_models/variables/stock_location_next_models.StockLocation/page.mdx": "2025-10-25T20:14:21.739Z",
|
||||
"references/stock_location_next_models/variables/stock_location_next_models.StockLocationAddress/page.mdx": "2025-10-25T20:14:21.735Z",
|
||||
"references/tax_models/variables/tax_models.TaxProvider/page.mdx": "2025-10-25T20:14:21.754Z",
|
||||
"references/tax_models/variables/tax_models.TaxRate/page.mdx": "2025-10-25T20:14:21.770Z",
|
||||
"references/tax_models/variables/tax_models.TaxRateRule/page.mdx": "2025-10-25T20:14:21.763Z",
|
||||
"references/tax_models/variables/tax_models.TaxRegion/page.mdx": "2025-10-25T20:14:21.785Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreShippingOptionResponse/page.mdx": "2025-04-11T09:04:47.640Z",
|
||||
"references/types/HttpTypes/types/types.HttpTypes.StoreCalculateShippingOptionPrice/page.mdx": "2025-04-11T09:04:47.634Z",
|
||||
"references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CalculateShippingOptionsPricesWorkflowInput/page.mdx": "2024-12-17T16:57:21.219Z",
|
||||
@@ -5628,23 +5628,23 @@ export const generatedEditDates = {
|
||||
"references/types/types/types.CreateFlatShippingOptionInputBase/page.mdx": "2025-01-13T17:30:29.138Z",
|
||||
"references/types/types/types.UpdateFlatShippingOptionInputBase/page.mdx": "2025-01-13T17:30:29.143Z",
|
||||
"references/core_flows/types/core_flows.UpsertShippingOptionsStepInput/page.mdx": "2024-12-17T16:57:24.521Z",
|
||||
"references/core_flows/Tax/Steps_Tax/functions/core_flows.Tax.Steps_Tax.getItemTaxLinesStep/page.mdx": "2025-06-25T10:11:32.339Z",
|
||||
"references/core_flows/Tax/Steps_Tax/functions/core_flows.Tax.Steps_Tax.getItemTaxLinesStep/page.mdx": "2025-10-25T20:14:01.907Z",
|
||||
"references/core_flows/Tax/Steps_Tax/variables/core_flows.Tax.Steps_Tax.getItemTaxLinesStepId/page.mdx": "2024-12-23T12:30:26.520Z",
|
||||
"references/core_flows/interfaces/core_flows.GetItemTaxLinesStepInput/page.mdx": "2025-06-25T10:11:34.425Z",
|
||||
"references/dml/entity/types/dml.entity.DMLEntitySchemaBuilder/page.mdx": "2025-01-13T18:05:57.748Z",
|
||||
"references/fulfillment/interfaces/fulfillment.OrderCreditLineDTO/page.mdx": "2025-09-12T14:10:38.673Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.Fulfillment/page.mdx": "2025-10-21T08:10:53.598Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.FulfillmentAddress/page.mdx": "2025-10-21T08:10:53.564Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.FulfillmentItem/page.mdx": "2025-10-21T08:10:53.570Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.FulfillmentLabel/page.mdx": "2025-10-21T08:10:53.576Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.FulfillmentProvider/page.mdx": "2025-10-21T08:10:53.577Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.FulfillmentSet/page.mdx": "2025-10-21T08:10:53.586Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.GeoZone/page.mdx": "2025-10-21T08:10:53.604Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.ServiceZone/page.mdx": "2025-10-21T08:10:53.617Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.ShippingOption/page.mdx": "2025-10-21T08:10:53.646Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.ShippingOptionRule/page.mdx": "2025-10-21T08:10:53.623Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.ShippingOptionType/page.mdx": "2025-10-21T08:10:53.628Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.ShippingProfile/page.mdx": "2025-10-21T08:10:53.651Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.Fulfillment/page.mdx": "2025-10-25T20:14:16.424Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.FulfillmentAddress/page.mdx": "2025-10-25T20:14:16.383Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.FulfillmentItem/page.mdx": "2025-10-25T20:14:16.391Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.FulfillmentLabel/page.mdx": "2025-10-25T20:14:16.398Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.FulfillmentProvider/page.mdx": "2025-10-25T20:14:16.400Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.FulfillmentSet/page.mdx": "2025-10-25T20:14:16.409Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.GeoZone/page.mdx": "2025-10-25T20:14:16.432Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.ServiceZone/page.mdx": "2025-10-25T20:14:16.448Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.ShippingOption/page.mdx": "2025-10-25T20:14:16.483Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.ShippingOptionRule/page.mdx": "2025-10-25T20:14:16.455Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.ShippingOptionType/page.mdx": "2025-10-25T20:14:16.462Z",
|
||||
"references/fulfillment_models/variables/fulfillment_models.ShippingProfile/page.mdx": "2025-10-25T20:14:16.490Z",
|
||||
"references/js_sdk/admin/FulfillmentProvider/methods/js_sdk.admin.FulfillmentProvider.listFulfillmentOptions/page.mdx": "2025-10-21T08:10:54.424Z",
|
||||
"references/order/interfaces/order.OrderCreditLineDTO/page.mdx": "2025-09-12T14:10:42.875Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentProviderOption/page.mdx": "2024-12-23T12:30:28.566Z",
|
||||
@@ -5652,7 +5652,7 @@ export const generatedEditDates = {
|
||||
"references/types/interfaces/types.BaseFulfillmentProviderOption/page.mdx": "2024-12-23T12:30:28.304Z",
|
||||
"references/dml/modules/dml.entity/page.mdx": "2024-12-23T12:30:31.943Z",
|
||||
"references/modules/region_models/page.mdx": "2024-12-23T08:25:09.956Z",
|
||||
"references/fulfillment_models/types/fulfillment_models.GeoZoneSchema/page.mdx": "2025-10-21T08:10:53.599Z",
|
||||
"references/fulfillment_models/types/fulfillment_models.GeoZoneSchema/page.mdx": "2025-10-25T20:14:16.425Z",
|
||||
"references/medusa/types/medusa.Logger/page.mdx": "2024-12-23T12:30:31.866Z",
|
||||
"references/core_flows/core_flows.Api_Key/page.mdx": "2024-12-23T12:30:23.466Z",
|
||||
"references/core_flows/core_flows.Cart/page.mdx": "2024-12-23T12:30:23.508Z",
|
||||
@@ -5684,7 +5684,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/core_flows.Tax/page.mdx": "2024-12-23T12:30:26.503Z",
|
||||
"references/core_flows/core_flows.User/page.mdx": "2024-12-23T12:30:26.564Z",
|
||||
"references/order/types/order.ReturnStatus/page.mdx": "2024-12-23T12:30:30.107Z",
|
||||
"references/fulfillment_models/types/fulfillment_models.ServiceZoneSchema/page.mdx": "2025-10-21T08:10:53.604Z",
|
||||
"references/fulfillment_models/types/fulfillment_models.ServiceZoneSchema/page.mdx": "2025-10-25T20:14:16.433Z",
|
||||
"app/commerce-modules/api-key/admin-widget-zones/page.mdx": "2024-12-24T08:29:56.989Z",
|
||||
"app/commerce-modules/auth/admin-widget-zones/page.mdx": "2024-12-24T08:11:08.250Z",
|
||||
"app/commerce-modules/customer/admin-widget-zones/page.mdx": "2024-12-24T08:07:15.439Z",
|
||||
@@ -5702,7 +5702,7 @@ export const generatedEditDates = {
|
||||
"app/commerce-modules/user/admin-widget-zones/page.mdx": "2024-12-24T08:48:14.186Z",
|
||||
"app/commerce-modules/currency/links-to-other-modules/page.mdx": "2025-04-17T15:40:23.148Z",
|
||||
"app/commerce-modules/customer/links-to-other-modules/page.mdx": "2025-04-17T15:43:54.168Z",
|
||||
"references/core_flows/Payment/Steps_Payment/functions/core_flows.Payment.Steps_Payment.refundPaymentsStep/page.mdx": "2025-10-21T08:10:39.345Z",
|
||||
"references/core_flows/Payment/Steps_Payment/functions/core_flows.Payment.Steps_Payment.refundPaymentsStep/page.mdx": "2025-10-25T20:14:00.567Z",
|
||||
"references/core_flows/Payment/Steps_Payment/variables/core_flows.Payment.Steps_Payment.refundPaymentsStepId/page.mdx": "2025-01-07T12:54:17.422Z",
|
||||
"references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.refundPaymentsWorkflow/page.mdx": "2025-09-18T17:04:41.870Z",
|
||||
"references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.validatePaymentsRefundStep/page.mdx": "2025-06-25T10:11:31.215Z",
|
||||
@@ -5821,7 +5821,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.deleteRefundReasonsWorkflow/page.mdx": "2025-09-18T17:04:41.955Z",
|
||||
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.getVariantAvailabilityStep/page.mdx": "2025-01-17T16:43:24.975Z",
|
||||
"references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.updatePromotionsStatusWorkflow/page.mdx": "2025-10-21T08:10:40.177Z",
|
||||
"references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.updatePromotionsValidationStep/page.mdx": "2025-10-21T08:10:40.171Z",
|
||||
"references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.updatePromotionsValidationStep/page.mdx": "2025-10-25T20:14:01.457Z",
|
||||
"references/core_flows/interfaces/core_flows.ValidateCartStepInput/page.mdx": "2025-05-20T07:51:40.875Z",
|
||||
"references/core_flows/interfaces/core_flows.ValidateProductInputStepInput/page.mdx": "2025-02-24T10:48:34.257Z",
|
||||
"references/core_flows/types/core_flows.ThrowUnlessPaymentCollectionNotePaidInput/page.mdx": "2025-06-25T10:11:33.516Z",
|
||||
@@ -5830,29 +5830,29 @@ export const generatedEditDates = {
|
||||
"app/plugins/guides/wishlist/page.mdx": "2025-09-29T15:35:46.093Z",
|
||||
"app/plugins/page.mdx": "2025-02-26T11:39:25.709Z",
|
||||
"app/admin-components/components/data-table/page.mdx": "2025-03-03T14:55:58.556Z",
|
||||
"references/order_models/variables/order_models.Order/page.mdx": "2025-10-21T08:10:58.048Z",
|
||||
"references/order_models/variables/order_models.OrderAddress/page.mdx": "2025-10-21T08:10:58.019Z",
|
||||
"references/order_models/variables/order_models.OrderChange/page.mdx": "2025-10-21T08:10:58.031Z",
|
||||
"references/order_models/variables/order_models.OrderChangeAction/page.mdx": "2025-10-21T08:10:58.031Z",
|
||||
"references/order_models/variables/order_models.OrderClaim/page.mdx": "2025-10-21T08:10:58.021Z",
|
||||
"references/order_models/variables/order_models.OrderClaimItem/page.mdx": "2025-10-21T08:10:58.021Z",
|
||||
"references/order_models/variables/order_models.OrderClaimItemImage/page.mdx": "2025-10-21T08:10:58.020Z",
|
||||
"references/order_models/variables/order_models.OrderCreditLine/page.mdx": "2025-10-21T08:10:58.025Z",
|
||||
"references/order_models/variables/order_models.OrderExchange/page.mdx": "2025-10-21T08:10:58.027Z",
|
||||
"references/order_models/variables/order_models.OrderExchangeItem/page.mdx": "2025-10-21T08:10:58.026Z",
|
||||
"references/order_models/variables/order_models.OrderItem/page.mdx": "2025-10-21T08:10:58.036Z",
|
||||
"references/order_models/variables/order_models.OrderLineItem/page.mdx": "2025-10-21T08:10:58.030Z",
|
||||
"references/order_models/variables/order_models.OrderLineItemAdjustment/page.mdx": "2025-10-21T08:10:58.028Z",
|
||||
"references/order_models/variables/order_models.OrderLineItemTaxLine/page.mdx": "2025-10-21T08:10:58.029Z",
|
||||
"references/order_models/variables/order_models.OrderShipping/page.mdx": "2025-10-21T08:10:58.037Z",
|
||||
"references/order_models/variables/order_models.OrderShippingMethod/page.mdx": "2025-10-21T08:10:58.054Z",
|
||||
"references/order_models/variables/order_models.OrderShippingMethodAdjustment/page.mdx": "2025-10-21T08:10:58.052Z",
|
||||
"references/order_models/variables/order_models.OrderShippingMethodTaxLine/page.mdx": "2025-10-21T08:10:58.053Z",
|
||||
"references/order_models/variables/order_models.OrderSummary/page.mdx": "2025-10-21T08:10:58.040Z",
|
||||
"references/order_models/variables/order_models.OrderTransaction/page.mdx": "2025-10-21T08:10:58.055Z",
|
||||
"references/order_models/variables/order_models.Return/page.mdx": "2025-10-21T08:10:58.052Z",
|
||||
"references/order_models/variables/order_models.ReturnItem/page.mdx": "2025-10-21T08:10:58.049Z",
|
||||
"references/order_models/variables/order_models.ReturnReason/page.mdx": "2025-10-21T08:10:58.051Z",
|
||||
"references/order_models/variables/order_models.Order/page.mdx": "2025-10-25T20:14:21.335Z",
|
||||
"references/order_models/variables/order_models.OrderAddress/page.mdx": "2025-10-25T20:14:21.300Z",
|
||||
"references/order_models/variables/order_models.OrderChange/page.mdx": "2025-10-25T20:14:21.316Z",
|
||||
"references/order_models/variables/order_models.OrderChangeAction/page.mdx": "2025-10-25T20:14:21.315Z",
|
||||
"references/order_models/variables/order_models.OrderClaim/page.mdx": "2025-10-25T20:14:21.303Z",
|
||||
"references/order_models/variables/order_models.OrderClaimItem/page.mdx": "2025-10-25T20:14:21.302Z",
|
||||
"references/order_models/variables/order_models.OrderClaimItemImage/page.mdx": "2025-10-25T20:14:21.301Z",
|
||||
"references/order_models/variables/order_models.OrderCreditLine/page.mdx": "2025-10-25T20:14:21.308Z",
|
||||
"references/order_models/variables/order_models.OrderExchange/page.mdx": "2025-10-25T20:14:21.310Z",
|
||||
"references/order_models/variables/order_models.OrderExchangeItem/page.mdx": "2025-10-25T20:14:21.309Z",
|
||||
"references/order_models/variables/order_models.OrderItem/page.mdx": "2025-10-25T20:14:21.322Z",
|
||||
"references/order_models/variables/order_models.OrderLineItem/page.mdx": "2025-10-25T20:14:21.314Z",
|
||||
"references/order_models/variables/order_models.OrderLineItemAdjustment/page.mdx": "2025-10-25T20:14:21.311Z",
|
||||
"references/order_models/variables/order_models.OrderLineItemTaxLine/page.mdx": "2025-10-25T20:14:21.313Z",
|
||||
"references/order_models/variables/order_models.OrderShipping/page.mdx": "2025-10-25T20:14:21.323Z",
|
||||
"references/order_models/variables/order_models.OrderShippingMethod/page.mdx": "2025-10-25T20:14:21.343Z",
|
||||
"references/order_models/variables/order_models.OrderShippingMethodAdjustment/page.mdx": "2025-10-25T20:14:21.341Z",
|
||||
"references/order_models/variables/order_models.OrderShippingMethodTaxLine/page.mdx": "2025-10-25T20:14:21.342Z",
|
||||
"references/order_models/variables/order_models.OrderSummary/page.mdx": "2025-10-25T20:14:21.328Z",
|
||||
"references/order_models/variables/order_models.OrderTransaction/page.mdx": "2025-10-25T20:14:21.344Z",
|
||||
"references/order_models/variables/order_models.Return/page.mdx": "2025-10-25T20:14:21.340Z",
|
||||
"references/order_models/variables/order_models.ReturnItem/page.mdx": "2025-10-25T20:14:21.336Z",
|
||||
"references/order_models/variables/order_models.ReturnReason/page.mdx": "2025-10-25T20:14:21.339Z",
|
||||
"references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listAndCountPaymentMethods/page.mdx": "2025-10-21T08:10:50.309Z",
|
||||
"references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listPaymentMethods/page.mdx": "2025-10-21T08:10:50.306Z",
|
||||
"references/payment/interfaces/payment.FilterablePaymentMethodProps/page.mdx": "2025-02-24T10:48:40.957Z",
|
||||
@@ -5887,7 +5887,7 @@ export const generatedEditDates = {
|
||||
"references/payment/types/payment.PaymentAccountHolderDTO/page.mdx": "2025-02-11T11:36:52.944Z",
|
||||
"references/payment/types/payment.PaymentAddressDTO/page.mdx": "2025-02-11T11:36:52.940Z",
|
||||
"references/payment/types/payment.PaymentCustomerDTO/page.mdx": "2025-02-11T11:36:52.942Z",
|
||||
"references/payment_models/variables/payment_models.AccountHolder/page.mdx": "2025-10-21T08:10:58.058Z",
|
||||
"references/payment_models/variables/payment_models.AccountHolder/page.mdx": "2025-10-25T20:14:21.347Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreCartAddPromotion/page.mdx": "2025-02-11T11:36:48.999Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreCartPromotion/page.mdx": "2025-02-11T11:36:48.986Z",
|
||||
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreCartRemovePromotion/page.mdx": "2025-02-11T11:36:48.998Z",
|
||||
@@ -5996,9 +5996,9 @@ export const generatedEditDates = {
|
||||
"app/examples/guides/quote-management/page.mdx": "2025-06-26T12:37:46.148Z",
|
||||
"references/cart/interfaces/cart.CartCreditLineDTO/page.mdx": "2025-03-04T13:33:48.207Z",
|
||||
"references/cart/interfaces/cart.UpdateLineItemWithoutSelectorDTO/page.mdx": "2025-06-25T10:11:35.041Z",
|
||||
"references/cart_models/variables/cart_models.CreditLine/page.mdx": "2025-10-21T08:10:52.917Z",
|
||||
"references/cart_models/variables/cart_models.CreditLine/page.mdx": "2025-10-25T20:14:15.657Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createCartCreditLinesWorkflow/page.mdx": "2025-09-18T17:04:38.550Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.deleteCartCreditLinesWorkflow/page.mdx": "2025-10-21T08:10:36.611Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.deleteCartCreditLinesWorkflow/page.mdx": "2025-10-25T20:13:57.532Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/variables/core_flows.Cart.Workflows_Cart.createCartCreditLinesWorkflowId/page.mdx": "2025-03-04T13:33:40.515Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/variables/core_flows.Cart.Workflows_Cart.deleteCartCreditLinesWorkflowId/page.mdx": "2025-03-04T13:33:40.574Z",
|
||||
"references/fulfillment/interfaces/fulfillment.CartCreditLineDTO/page.mdx": "2025-03-04T13:33:48.973Z",
|
||||
@@ -6011,7 +6011,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/types/core_flows.RefreshCartItemsWorkflowInput/page.mdx": "2025-03-04T13:33:46.131Z",
|
||||
"references/core_flows/types/core_flows.RefreshCartShippingMethodsWorkflowInput/page.mdx": "2025-03-04T13:33:46.133Z",
|
||||
"references/core_flows/types/core_flows.ValidateExistingPaymentCollectionStepInput/page.mdx": "2025-05-20T07:51:40.885Z",
|
||||
"references/types/interfaces/types.ITaxProvider/page.mdx": "2025-05-20T07:51:41.085Z",
|
||||
"references/types/interfaces/types.ITaxProvider/page.mdx": "2025-10-25T20:14:10.471Z",
|
||||
"app/how-to-tutorials/page.mdx": "2025-03-10T09:33:49.208Z",
|
||||
"app/tools/page.mdx": "2025-03-10T12:38:56.520Z",
|
||||
"app/references-overview/page.mdx": "2025-03-10T12:55:49.803Z",
|
||||
@@ -6023,7 +6023,7 @@ export const generatedEditDates = {
|
||||
"references/modules/locking/page.mdx": "2025-03-12T12:28:30.419Z",
|
||||
"references/cache/interfaces/cache.ICacheService/page.mdx": "2025-05-20T07:51:40.736Z",
|
||||
"references/event/interfaces/event.IEventBusModuleService/page.mdx": "2025-10-21T08:10:43.967Z",
|
||||
"references/file_service/interfaces/file_service.IFileModuleService/page.mdx": "2025-10-21T08:10:43.992Z",
|
||||
"references/file_service/interfaces/file_service.IFileModuleService/page.mdx": "2025-10-25T20:14:05.694Z",
|
||||
"references/modules/cache/page.mdx": "2025-03-17T15:24:02.572Z",
|
||||
"references/modules/event/page.mdx": "2025-03-17T15:24:03.021Z",
|
||||
"references/modules/file_service/page.mdx": "2025-03-17T15:24:03.025Z",
|
||||
@@ -6168,8 +6168,8 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Draft_Order/core_flows.Draft_Order.Workflows_Draft_Order/page.mdx": "2025-06-05T19:05:37.068Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.registerOrderDeliveryStep/page.mdx": "2025-05-20T07:51:40.785Z",
|
||||
"references/core_flows/Order/Steps_Order/variables/core_flows.Order.Steps_Order.registerOrderDeliveryStepId/page.mdx": "2025-04-23T16:21:19.272Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderCreditLinesWorkflow/page.mdx": "2025-10-21T08:10:38.404Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.validateOrderCreditLinesStep/page.mdx": "2025-10-21T08:10:38.396Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderCreditLinesWorkflow/page.mdx": "2025-10-25T20:13:59.543Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.validateOrderCreditLinesStep/page.mdx": "2025-10-25T20:13:59.536Z",
|
||||
"references/core_flows/Order/Workflows_Order/variables/core_flows.Order.Workflows_Order.createOrderCreditLinesWorkflowId/page.mdx": "2025-04-23T16:21:19.783Z",
|
||||
"references/core_flows/core_flows.Draft_Order/page.mdx": "2025-04-23T16:21:18.488Z",
|
||||
"references/core_flows/interfaces/core_flows.CancelDraftOrderEditWorkflowInput/page.mdx": "2025-04-24T08:23:57.279Z",
|
||||
@@ -6180,7 +6180,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/types/core_flows.FetchShippingOptionForOrderWorkflowOutput/page.mdx": "2025-04-23T16:21:21.821Z",
|
||||
"references/core_flows/types/core_flows.RequestDraftOrderEditWorkflowInput/page.mdx": "2025-04-23T16:21:21.717Z",
|
||||
"references/core_flows/types/core_flows.GenerateProductCsvStepOutput/page.mdx": "2025-04-23T16:21:22.403Z",
|
||||
"references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.convertDraftOrderStep/page.mdx": "2025-10-21T08:10:37.059Z",
|
||||
"references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.convertDraftOrderStep/page.mdx": "2025-10-25T20:13:58.021Z",
|
||||
"references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderStep/page.mdx": "2025-09-12T14:10:30.937Z",
|
||||
"references/core_flows/interfaces/core_flows.AddDraftOrderPromotionWorkflowInput/page.mdx": "2025-04-24T08:23:57.277Z",
|
||||
"references/core_flows/interfaces/core_flows.AddDraftOrderShippingMethodsWorkflowInput/page.mdx": "2025-04-24T08:23:57.278Z",
|
||||
@@ -6232,7 +6232,7 @@ export const generatedEditDates = {
|
||||
"references/events/events.Sales_Channel/page.mdx": "2025-05-20T07:51:40.897Z",
|
||||
"references/events/events.User/page.mdx": "2025-05-20T07:51:40.897Z",
|
||||
"app/how-to-tutorials/tutorials/saved-payment-methods/page.mdx": "2025-09-11T13:03:49.152Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refundPaymentAndRecreatePaymentSessionWorkflow/page.mdx": "2025-10-21T08:10:36.664Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refundPaymentAndRecreatePaymentSessionWorkflow/page.mdx": "2025-10-25T20:13:57.600Z",
|
||||
"references/core_flows/Cart/Workflows_Cart/variables/core_flows.Cart.Workflows_Cart.refundPaymentAndRecreatePaymentSessionWorkflowId/page.mdx": "2025-05-20T07:51:40.757Z",
|
||||
"references/core_flows/Draft_Order/Workflows_Draft_Order/variables/core_flows.Draft_Order.Workflows_Draft_Order.convertDraftOrderWorkflowId/page.mdx": "2025-05-20T07:51:40.768Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.fetchShippingOptionForOrderWorkflow/page.mdx": "2025-09-18T17:04:40.776Z",
|
||||
@@ -6591,9 +6591,9 @@ export const generatedEditDates = {
|
||||
"references/workflows/functions/workflows.resolveValue/page.mdx": "2025-09-12T14:10:46.882Z",
|
||||
"references/workflows/types/workflows.FlowRetryStepOptions/page.mdx": "2025-09-12T14:10:46.852Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.listShippingOptionsForOrderWorkflow/page.mdx": "2025-10-21T08:10:39.266Z",
|
||||
"references/core_flows/Settings/Steps_Settings/functions/core_flows.Settings.Steps_Settings.setActiveViewConfigurationStep/page.mdx": "2025-10-21T08:10:40.358Z",
|
||||
"references/core_flows/Settings/Steps_Settings/functions/core_flows.Settings.Steps_Settings.updateViewConfigurationStep/page.mdx": "2025-10-21T08:10:40.355Z",
|
||||
"references/core_flows/Settings/Workflows_Settings/functions/core_flows.Settings.Workflows_Settings.updateViewConfigurationWorkflow/page.mdx": "2025-10-21T08:10:40.369Z",
|
||||
"references/core_flows/Settings/Steps_Settings/functions/core_flows.Settings.Steps_Settings.setActiveViewConfigurationStep/page.mdx": "2025-10-25T20:14:01.678Z",
|
||||
"references/core_flows/Settings/Steps_Settings/functions/core_flows.Settings.Steps_Settings.updateViewConfigurationStep/page.mdx": "2025-10-25T20:14:01.674Z",
|
||||
"references/core_flows/Settings/Workflows_Settings/functions/core_flows.Settings.Workflows_Settings.updateViewConfigurationWorkflow/page.mdx": "2025-10-25T20:14:01.690Z",
|
||||
"references/core_flows/Shipping_Options/Workflows_Shipping_Options/functions/core_flows.Shipping_Options.Workflows_Shipping_Options.createShippingOptionTypesWorkflow/page.mdx": "2025-10-21T08:10:40.416Z",
|
||||
"references/core_flows/Shipping_Options/Workflows_Shipping_Options/functions/core_flows.Shipping_Options.Workflows_Shipping_Options.deleteShippingOptionTypesWorkflow/page.mdx": "2025-10-21T08:10:40.420Z",
|
||||
"references/core_flows/Shipping_Options/Workflows_Shipping_Options/functions/core_flows.Shipping_Options.Workflows_Shipping_Options.updateShippingOptionTypesWorkflow/page.mdx": "2025-10-21T08:10:40.429Z",
|
||||
@@ -6626,11 +6626,11 @@ export const generatedEditDates = {
|
||||
"references/js_sdk/admin/RefundReason/methods/js_sdk.admin.RefundReason.update/page.mdx": "2025-10-21T08:10:56.632Z",
|
||||
"references/promotion/interfaces/promotion.CampaignBudgetUsageDTO/page.mdx": "2025-10-21T08:10:51.300Z",
|
||||
"references/promotion/types/promotion.CampaignBudgetUsageContext/page.mdx": "2025-10-21T08:10:51.298Z",
|
||||
"references/promotion_models/variables/promotion_models.CampaignBudgetUsage/page.mdx": "2025-10-21T08:10:58.296Z",
|
||||
"references/promotion_models/variables/promotion_models.CampaignBudgetUsage/page.mdx": "2025-10-25T20:14:21.660Z",
|
||||
"references/tax/ITaxModuleService/methods/tax.ITaxModuleService.getProvider/page.mdx": "2025-10-21T08:10:52.255Z",
|
||||
"references/tax/ITaxProvider/methods/tax.ITaxProvider.getIdentifier/page.mdx": "2025-10-21T08:10:52.151Z",
|
||||
"references/tax/ITaxProvider/methods/tax.ITaxProvider.getTaxLines/page.mdx": "2025-10-21T08:10:52.154Z",
|
||||
"references/tax/interfaces/tax.ITaxProvider/page.mdx": "2025-10-21T08:10:52.150Z",
|
||||
"references/tax/ITaxProvider/methods/tax.ITaxProvider.getIdentifier/page.mdx": "2025-10-25T20:14:14.786Z",
|
||||
"references/tax/ITaxProvider/methods/tax.ITaxProvider.getTaxLines/page.mdx": "2025-10-25T20:14:14.789Z",
|
||||
"references/tax/interfaces/tax.ITaxProvider/page.mdx": "2025-10-25T20:14:14.784Z",
|
||||
"references/tax/types/tax.ItemTaxCalculationLine/page.mdx": "2025-10-21T08:10:52.149Z",
|
||||
"references/tax/types/tax.ShippingTaxCalculationLine/page.mdx": "2025-10-21T08:10:52.146Z",
|
||||
"references/types/CachingTypes/interfaces/types.CachingTypes.ICachingModuleService/page.mdx": "2025-10-21T08:10:45.096Z",
|
||||
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the ApiKey data model. It belongs to the API Key Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/api-key/src/models/api-key.ts#L3" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/api-key/src/models/api-key.ts#L3" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[\"publishable\", \"secret\"]>","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"/>
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the AuthIdentity data model. It belongs to the Auth Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/auth/src/models/auth-identity.ts#L4" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/auth/src/models/auth-identity.ts#L4" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the auth identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"HasMany<[ProviderIdentity](../auth_models.ProviderIdentity/page.mdx)>","description":"The associated `ProviderIdentity` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the provider identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`TextProperty`","description":"The entity ID of the provider identity","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`TextProperty`","description":"The ID of the provider that created this identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity","type":"BelongsTo<[AuthIdentity](./page.mdx)>","description":"The associated `AuthIdentity`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the auth identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"HasMany<[ProviderIdentity](../auth_models.ProviderIdentity/page.mdx)>","description":"The associated `ProviderIdentity` records.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"app_metadata","type":"`JSONProperty`","description":"The app metadata of the auth identity","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"user_metadata","type":"`JSONProperty`","description":"The user metadata of the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_metadata","type":"`JSONProperty`","description":"The provider metadata of the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"app_metadata","type":"`JSONProperty`","description":"The app metadata of the auth identity","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="AuthIdentity"/>
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the ProviderIdentity data model. It belongs to the Auth Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/auth/src/models/provider-identity.ts#L4" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/auth/src/models/provider-identity.ts#L4" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the provider identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`TextProperty`","description":"The entity ID of the provider identity","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`TextProperty`","description":"The ID of the provider that created this identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity","type":"BelongsTo<[AuthIdentity](../auth_models.AuthIdentity/page.mdx)>","description":"The associated `AuthIdentity`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the auth identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"HasMany<[ProviderIdentity](./page.mdx)>","description":"The associated `ProviderIdentity` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the provider identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`TextProperty`","description":"The entity ID of the provider identity","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`TextProperty`","description":"The ID of the provider that created this identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity","type":"BelongsTo<[AuthIdentity](../auth_models.AuthIdentity/page.mdx)>","description":"The associated `AuthIdentity`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"user_metadata","type":"`JSONProperty`","description":"The user metadata of the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_metadata","type":"`JSONProperty`","description":"The provider metadata of the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"app_metadata","type":"`JSONProperty`","description":"The app metadata of the auth identity","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"user_metadata","type":"`JSONProperty`","description":"The user metadata of the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_metadata","type":"`JSONProperty`","description":"The provider metadata of the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProviderIdentity"/>
|
||||
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the Address data model. It belongs to the Cart Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/cart/src/models/address.ts#L3" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/cart/src/models/address.ts#L3" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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"/>
|
||||
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the Cart data model. It belongs to the Cart Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/cart/src/models/cart.ts#L7" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/cart/src/models/cart.ts#L7" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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_giftcard","type":"`BooleanProperty`","description":"Whether the line item is a giftcard.","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":"is_custom_price","type":"`BooleanProperty`","description":"Whether the line item's price is custom.","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<[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)>","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item adjustment is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","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<[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","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":"","expandableLine truncated
|
||||
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the CreditLine data model. It belongs to the Cart Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/cart/src/models/credit-line.ts#L4" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/cart/src/models/credit-line.ts#L4" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the credit line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"BelongsTo<[Cart](../cart_models.Cart/page.mdx)>","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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_giftcard","type":"`BooleanProperty`","description":"Whether the line item is a giftcard.","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":"is_custom_price","type":"`BooleanProperty`","description":"Whether the line item's price is custom.","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<[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)>","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_lines","type":"HasMany<[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart","type":"BelongsTo<[Cart](../cart_models.Cart/page.mdx)>","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":"`TextProperty`","description":"The unique handle of the line item's product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_sku","tLine truncated
|
||||
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the LineItem data model. It belongs to the Cart Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/cart/src/models/line-item.ts#L6" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/cart/src/models/line-item.ts#L6" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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_giftcard","type":"`BooleanProperty`","description":"Whether the line item is a giftcard.","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":"is_custom_price","type":"`BooleanProperty`","description":"Whether the line item's price is custom.","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<[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)>","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item adjustment is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](./page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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_giftcard","type":"`BooleanProperty`","description":"Whether the line item is a giftcard.","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":"is_custom_price","type":"`BooleanProperty`","description":"Whether the line item's price is custom.","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<[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)>","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_lines","type":"HasMany<[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart","type":"BelongsTo<[Cart](../cart_models.Cart/page.mdx)>","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"Line truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the LineItemAdjustment data model. It belongs to the Cart Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/cart/src/models/line-item-adjustment.ts#L4" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/cart/src/models/line-item-adjustment.ts#L4" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item adjustment is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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_giftcard","type":"`BooleanProperty`","description":"Whether the line item is a giftcard.","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":"is_custom_price","type":"`BooleanProperty`","description":"Whether the line item's price is custom.","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<[LineItemAdjustment](./page.mdx)>","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item adjustment is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","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<[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,Line truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the LineItemTaxLine data model. It belongs to the Cart Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/cart/src/models/line-item-tax-line.ts#L4" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/cart/src/models/line-item-tax-line.ts#L4" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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_giftcard","type":"`BooleanProperty`","description":"Whether the line item is a giftcard.","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":"is_custom_price","type":"`BooleanProperty`","description":"Whether the line item's price is custom.","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<[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)>","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the line item adjustment is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","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<[LineItemTaxLine](./page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"BelongsTo<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","typeLine truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the ShippingMethod data model. It belongs to the Cart Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/cart/src/models/shipping-method.ts#L6" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/cart/src/models/shipping-method.ts#L6" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[Cart](../cart_models.Cart/page.mdx)>","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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_giftcard","type":"`BooleanProperty`","description":"Whether the line item is a giftcard.","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":"is_custom_price","type":"`BooleanProperty`","description":"Whether the line item's price is custom.","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<[LineItemAdjustment](../cart_models.LineItemAdjustment/page.mdx)>","description":"The associated adjustments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_lines","type":"HasMany<[LineItemTaxLine](../cart_models.LineItemTaxLine/page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart","type":"BelongsTo<[Cart](../cart_models.Cart/page.mdx)>","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":"`TextProLine truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the ShippingMethodAdjustment data model. It belongs to the Cart Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/cart/src/models/shipping-method-adjustment.ts#L4" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/cart/src/models/shipping-method-adjustment.ts#L4" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[ShippingMethod](../cart_models.ShippingMethod/page.mdx)>","description":"The associated shipping\\_method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[Cart](../cart_models.Cart/page.mdx)>","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"credit_lines","type":"HasMany<[CreditLine](../cart_models.CreditLine/page.mdx)>","description":"The associated credit\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"HasMany<[ShippingMethod](../cart_models.ShippingMethod/page.mdx)>","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<[Address](../cart_models.Address/page.mdx)>","description":"The associated shipping\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address","type":"HasOneWithForeignKey<[Address](../cart_models.Address/page.mdx)>","description":"The associated billing\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"tax_lines","type":"HasMany<[ShippingMethodTaxLine](../cart_models.ShippingMethodTaxLine/page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"BelongsTo<[ShippingMethod](../cart_models.ShippingMethod/page.mdx)>","description":"The associated shipping\\_method.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the shipping method tax line","optional":true,"defaultValue":"","Line truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the ShippingMethodTaxLine data model. It belongs to the Cart Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/cart/src/models/shipping-method-tax-line.ts#L4" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/cart/src/models/shipping-method-tax-line.ts#L4" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"BelongsTo<[ShippingMethod](../cart_models.ShippingMethod/page.mdx)>","description":"The associated shipping\\_method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[Cart](../cart_models.Cart/page.mdx)>","description":"The associated cart.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[LineItem](../cart_models.LineItem/page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"credit_lines","type":"HasMany<[CreditLine](../cart_models.CreditLine/page.mdx)>","description":"The associated credit\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"HasMany<[ShippingMethod](../cart_models.ShippingMethod/page.mdx)>","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<[Address](../cart_models.Address/page.mdx)>","description":"The associated shipping\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address","type":"HasOneWithForeignKey<[Address](../cart_models.Address/page.mdx)>","description":"The associated billing\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"tax_lines","type":"HasMany<[ShippingMethodTaxLine](./page.mdx)>","description":"The associated tax\\_lines.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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":"`FloatProperty`","description":"The rate of the applied tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"BelongsTo<[ShippingMethod](../cart_models.ShippingMethod/page.mdx)>","description":"The associated shipping\\_method.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextPLine truncated
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = createCartsStep({
|
||||
"currency_code": "lak"
|
||||
"currency_code": "dzd"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -19,7 +19,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = retrieveCartStep({
|
||||
"id": "id_tiUfQtiwvf1X2q1"
|
||||
"id": "id_wm73qa502E9os"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -46,4 +46,4 @@ const data = setTaxLinesForItemsStep({
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"SetTaxLinesForItemsStepInput","type":"[SetTaxLinesForItemsStepInput](../../../../interfaces/core_flows.SetTaxLinesForItemsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"The details of the tax lines to set in a cart.","expandable":false,"children":[{"name":"cart","type":"[CartWorkflowDTO](../../../../../types/interfaces/types.CartWorkflowDTO/page.mdx)","description":"The cart's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollectionDTO](../../../../../payment/interfaces/payment.PaymentCollectionDTO/page.mdx)","description":"The payment collection details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The ISO 3 character currency code of the payment sessions and payments associated with payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The total amount to be authorized and captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../../../../payment/types/payment.PaymentCollectionStatus/page.mdx)","description":"The status of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProviderDTO](../../../../../payment/interfaces/payment.PaymentProviderDTO/page.mdx)[]","description":"The payment provider used to process the associated payment sessions and payments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"authorized_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The amount authorized within the associated payment sessions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The amount refunded within the associated payments.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The amount captured within the associated payments.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`string` \\| `Date`","description":"When the payment collection was completed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the payment collection was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the payment collection was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSessionDTO](../../../../../payment/interfaces/payment.PaymentSessionDTO/page.mdx)[]","description":"The associated payment sessions.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[PaymentDTO](../../../../../payment/interfaces/payment.PaymentDTO/page.mdx)[]","description":"The associated payments.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"customer","type":"[CustomerDTO](../../../../../customer/interfaces/customer.CustomerDTO/page.mdx)","description":"The cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"A flag indicating if customer has an account or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_billing_address_id","type":"`null` \\| `string`","description":"The associated default billing address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_shipping_address_id","type":"`null` \\| `string`","description":"The associated default shipping address's ID.","optional":falsLine truncated
|
||||
<TypeList types={[{"name":"SetTaxLinesForItemsStepInput","type":"[SetTaxLinesForItemsStepInput](../../../../interfaces/core_flows.SetTaxLinesForItemsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"The details of the tax lines to set in a cart.","expandable":false,"children":[{"name":"cart","type":"[CartWorkflowDTO](../../../../../types/interfaces/types.CartWorkflowDTO/page.mdx)","description":"The cart's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollectionDTO](../../../../../payment/interfaces/payment.PaymentCollectionDTO/page.mdx)","description":"The payment collection details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The ISO 3 character currency code of the payment sessions and payments associated with payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The total amount to be authorized and captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../../../../payment/types/payment.PaymentCollectionStatus/page.mdx)","description":"The status of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProviderDTO](../../../../../payment/interfaces/payment.PaymentProviderDTO/page.mdx)[]","description":"The payment provider used to process the associated payment sessions and payments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"authorized_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The amount authorized within the associated payment sessions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The amount refunded within the associated payments.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The amount captured within the associated payments.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`string` \\| `Date`","description":"When the payment collection was completed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the payment collection was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the payment collection was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSessionDTO](../../../../../payment/interfaces/payment.PaymentSessionDTO/page.mdx)[]","description":"The associated payment sessions.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[PaymentDTO](../../../../../payment/interfaces/payment.PaymentDTO/page.mdx)[]","description":"The associated payments.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"customer","type":"[CustomerDTO](../../../../../customer/interfaces/customer.CustomerDTO/page.mdx)","description":"The cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"A flag indicating if customer has an account or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_billing_address_id","type":"`null` \\| `string`","description":"The associated default billing address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_shipping_address_id","type":"`null` \\| `string`","description":"The associated default shipping address's ID.","optional":falsLine truncated
|
||||
+1
-1
@@ -24,7 +24,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = updateCartPromotionsStep({
|
||||
"id": "id_ebexShyZ8H"
|
||||
"id": "id_6YN7cmJWHDhP"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+4
-4
@@ -36,7 +36,7 @@ export async function POST(
|
||||
.run({
|
||||
input: {
|
||||
"id": [
|
||||
"id_RY29rszqzM"
|
||||
"id_U0PK0ogdIQd2NJb"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -63,7 +63,7 @@ export default async function handleOrderPlaced({
|
||||
.run({
|
||||
input: {
|
||||
"id": [
|
||||
"id_RY29rszqzM"
|
||||
"id_U0PK0ogdIQd2NJb"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -90,7 +90,7 @@ export default async function myCustomJob(
|
||||
.run({
|
||||
input: {
|
||||
"id": [
|
||||
"id_RY29rszqzM"
|
||||
"id_U0PK0ogdIQd2NJb"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -118,7 +118,7 @@ const myWorkflow = createWorkflow(
|
||||
.runAsStep({
|
||||
input: {
|
||||
"id": [
|
||||
"id_RY29rszqzM"
|
||||
"id_U0PK0ogdIQd2NJb"
|
||||
]
|
||||
}
|
||||
})
|
||||
|
||||
+4
-4
@@ -43,7 +43,7 @@ export async function POST(
|
||||
"payment_collection_id": "{value}",
|
||||
"provider_id": "{value}",
|
||||
"payment_id": "{value}",
|
||||
"amount": 3
|
||||
"amount": 31
|
||||
}
|
||||
})
|
||||
|
||||
@@ -72,7 +72,7 @@ export default async function handleOrderPlaced({
|
||||
"payment_collection_id": "{value}",
|
||||
"provider_id": "{value}",
|
||||
"payment_id": "{value}",
|
||||
"amount": 3
|
||||
"amount": 31
|
||||
}
|
||||
})
|
||||
|
||||
@@ -101,7 +101,7 @@ export default async function myCustomJob(
|
||||
"payment_collection_id": "{value}",
|
||||
"provider_id": "{value}",
|
||||
"payment_id": "{value}",
|
||||
"amount": 3
|
||||
"amount": 31
|
||||
}
|
||||
})
|
||||
|
||||
@@ -130,7 +130,7 @@ const myWorkflow = createWorkflow(
|
||||
"payment_collection_id": "{value}",
|
||||
"provider_id": "{value}",
|
||||
"payment_id": "{value}",
|
||||
"amount": 3
|
||||
"amount": 31
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = createCustomerGroupsStep({
|
||||
"name": "Cleo"
|
||||
"name": "Loren"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = convertDraftOrderStep({
|
||||
"id": "id_HdSDOdzQsr7a"
|
||||
"id": "id_oBvkcot59aLyI8wEuwxU"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+2
-2
@@ -23,7 +23,7 @@ const data = uploadFilesStep({
|
||||
{
|
||||
filename: "test.jpg",
|
||||
mimeType: "img/jpg",
|
||||
content: "base64-string",
|
||||
content: "binary-string",
|
||||
access: "public"
|
||||
}
|
||||
]
|
||||
@@ -32,7 +32,7 @@ const data = uploadFilesStep({
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UploadFilesStepInput","type":"[UploadFilesStepInput](../../../../types/core_flows.UploadFilesStepInput/page.mdx)","optional":false,"defaultValue":"","description":"The data to upload files.","expandable":false,"children":[{"name":"files","type":"`object`[]","description":"The files to upload.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The MIME type of the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The content of the file. For images, for example, \nuse base64 string. For CSV files, use the CSV content.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"`\"public\"` \\| `\"private\"`","description":"The access level of the file. Use `public` for the file that\ncan be accessed by anyone. For example, for images that are displayed\non the storefront. Use `private` for files that are only accessible\nby authenticated users. For example, for CSV files used to\nimport data.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="uploadFilesStep"/>
|
||||
<TypeList types={[{"name":"UploadFilesStepInput","type":"[UploadFilesStepInput](../../../../types/core_flows.UploadFilesStepInput/page.mdx)","optional":false,"defaultValue":"","description":"The data to upload files.","expandable":false,"children":[{"name":"files","type":"`object`[]","description":"The files to upload.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The MIME type of the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The content of the file. For images, for example, \nuse binary string. For CSV files, use the CSV content.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"`\"public\"` \\| `\"private\"`","description":"The access level of the file. Use `public` for the file that\ncan be accessed by anyone. For example, for images that are displayed\non the storefront. Use `private` for files that are only accessible\nby authenticated users. For example, for CSV files used to\nimport data.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="uploadFilesStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
|
||||
+5
-5
@@ -44,7 +44,7 @@ export async function POST(
|
||||
files: [{
|
||||
filename: "test.jpg",
|
||||
mimeType: "img/jpg",
|
||||
content: "base64-string",
|
||||
content: "binary-string",
|
||||
access: "public"
|
||||
}]
|
||||
}
|
||||
@@ -74,7 +74,7 @@ export default async function handleOrderPlaced({
|
||||
files: [{
|
||||
filename: "test.jpg",
|
||||
mimeType: "img/jpg",
|
||||
content: "base64-string",
|
||||
content: "binary-string",
|
||||
access: "public"
|
||||
}]
|
||||
}
|
||||
@@ -104,7 +104,7 @@ export default async function myCustomJob(
|
||||
files: [{
|
||||
filename: "test.jpg",
|
||||
mimeType: "img/jpg",
|
||||
content: "base64-string",
|
||||
content: "binary-string",
|
||||
access: "public"
|
||||
}]
|
||||
}
|
||||
@@ -135,7 +135,7 @@ const myWorkflow = createWorkflow(
|
||||
files: [{
|
||||
filename: "test.jpg",
|
||||
mimeType: "img/jpg",
|
||||
content: "base64-string",
|
||||
content: "binary-string",
|
||||
access: "public"
|
||||
}]
|
||||
}
|
||||
@@ -153,7 +153,7 @@ const myWorkflow = createWorkflow(
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UploadFilesWorkflowInput","type":"[UploadFilesWorkflowInput](../../../../types/core_flows.UploadFilesWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"The data to upload files.","expandable":false,"children":[{"name":"files","type":"`object`[]","description":"The files to upload.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The MIME type of the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The content of the file. For images, for example, \nuse base64 string. For CSV files, use the CSV content.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"`\"public\"` \\| `\"private\"`","description":"The access level of the file. Use `public` for the file that\ncan be accessed by anyone. For example, for images that are displayed\non the storefront. Use `private` for files that are only accessible\nby authenticated users. For example, for CSV files used to \nimport data.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="uploadFilesWorkflow"/>
|
||||
<TypeList types={[{"name":"UploadFilesWorkflowInput","type":"[UploadFilesWorkflowInput](../../../../types/core_flows.UploadFilesWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"The data to upload files.","expandable":false,"children":[{"name":"files","type":"`object`[]","description":"The files to upload.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The MIME type of the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The content of the file. For images, for example, \nuse binary string. For CSV files, use the CSV content.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"`\"public\"` \\| `\"private\"`","description":"The access level of the file. Use `public` for the file that\ncan be accessed by anyone. For example, for images that are displayed\non the storefront. Use `private` for files that are only accessible\nby authenticated users. For example, for CSV files used to \nimport data.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="uploadFilesWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = createFulfillmentSets({
|
||||
"name": "Julius",
|
||||
"name": "Randall",
|
||||
"type": "{value}"
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = createServiceZonesStep({
|
||||
"name": "Helga",
|
||||
"name": "Syble",
|
||||
"fulfillment_set_id": "{value}"
|
||||
})
|
||||
}
|
||||
|
||||
+3
-3
@@ -29,10 +29,10 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = createShippingOptionsPriceSetsStep({
|
||||
"id": "id_Nm3Ns1JLPdoshYGA3Q",
|
||||
"id": "id_XU1jAyQA0PU8BHzkcw",
|
||||
"prices": [{
|
||||
"currency_code": "mru",
|
||||
"amount": 32
|
||||
"currency_code": "usd",
|
||||
"amount": 45
|
||||
}]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = createShippingProfilesStep({
|
||||
"name": "Alessandra",
|
||||
"name": "Nicklaus",
|
||||
"type": "{value}"
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = deleteShippingOptionRulesStep({
|
||||
"ids": [
|
||||
"id_mb49kkKASZTOL"
|
||||
"id_3OcqHJC1ZD72nB4"
|
||||
]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = updateInventoryItemsStep({
|
||||
"id": "id_Q4aqwxpWoxJy4tsNI"
|
||||
"id": "id_uUf2n2EcBpwWt9F"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+2
-2
@@ -20,8 +20,8 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = validateInventoryDeleteStep({
|
||||
"inventory_items": [{
|
||||
"id": "id_LItE2qY9mmvIe5SNvZa",
|
||||
"reserved_quantity": 41
|
||||
"id": "id_PdZZPjJACSpzAftDEr",
|
||||
"reserved_quantity": 43
|
||||
}]
|
||||
})
|
||||
}
|
||||
|
||||
+2
-2
@@ -23,8 +23,8 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = addOrderTransactionStep({
|
||||
"order_id": "order_123",
|
||||
"amount": 3,
|
||||
"currency_code": "mur"
|
||||
"amount": 30,
|
||||
"currency_code": "gel"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = cancelOrderChangeStep({
|
||||
"id": "id_0AzNeTjYow"
|
||||
"id": "id_CJZtQPaqqeXa2AJHP"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = declineOrderChangeStep({
|
||||
"id": "id_LTFYmNT6lTSlQ0jims3Y"
|
||||
"id": "id_h9MMrNfPcISIdB"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = deleteClaimsStep({
|
||||
"ids": [
|
||||
"id_4xBjgcHWVtFnJqPwU"
|
||||
"id_Tw1SKTATEsdEbit"
|
||||
]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = deleteExchangesStep({
|
||||
"ids": [
|
||||
"id_6p0h3MEeZL"
|
||||
"id_P8Su5On6uBJVte"
|
||||
]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = deleteOrderChangeActionsStep({
|
||||
"ids": [
|
||||
"id_QR61XWMvph"
|
||||
"id_vJBCQhkI2uKRu"
|
||||
]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = deleteOrderChangesStep({
|
||||
"ids": [
|
||||
"id_UCJhhMJluoWt"
|
||||
"id_vUkJKpdQlQS0p"
|
||||
]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -20,7 +20,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = deleteOrderLineItems({
|
||||
"ids": [
|
||||
"id_7w5Srbx8QbZppFA9MA"
|
||||
"id_uum8RDj4gRVRZXrrlNc"
|
||||
]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = deleteOrderShippingMethods({
|
||||
"ids": [
|
||||
"id_Na5mOzcAHVfO1I2AqO3"
|
||||
"id_GFUTy0dCb4Y"
|
||||
]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = deleteReturnsStep({
|
||||
"ids": [
|
||||
"id_tbWMmkr2V83H4C"
|
||||
"id_j4fnzaY4NZpA93kPU"
|
||||
]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -43,4 +43,4 @@ const data = setOrderTaxLinesForItemsStep({
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"SetOrderTaxLinesForItemsStepInput","type":"[SetOrderTaxLinesForItemsStepInput](../../../../interfaces/core_flows.SetOrderTaxLinesForItemsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"The details of setting tax lines for an order's items and shipping methods.","expandable":false,"children":[{"name":"order","type":"[OrderDTO](../../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../../../fulfillment/types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_discount_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item discount total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount subtotal of the order.","Line truncated
|
||||
<TypeList types={[{"name":"SetOrderTaxLinesForItemsStepInput","type":"[SetOrderTaxLinesForItemsStepInput](../../../../interfaces/core_flows.SetOrderTaxLinesForItemsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"The details of setting tax lines for an order's items and shipping methods.","expandable":false,"children":[{"name":"order","type":"[OrderDTO](../../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../../../fulfillment/types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_discount_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item discount total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount subtotal of the order.","Line truncated
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = updateOrderChangeActionsStep({
|
||||
"id": "id_NatBiQLfeUwFKUi7r"
|
||||
"id": "id_eaBsTlbSnzkium"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = updateOrderChangesStep({
|
||||
"id": "id_twl3DQ6gp1awgI"
|
||||
"id": "id_5nJ96eB3pDRoNwfKmK8s"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = updateOrderShippingMethodsStep({
|
||||
"id": "id_GmGSwDrj5s"
|
||||
"id": "id_loH4IRfOlnH"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -21,7 +21,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = updateReturnsStep({
|
||||
"id": "id_VdWVDsbqcxDGnr"
|
||||
"id": "id_pLV9PdrdprON0Q5"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+4
-4
@@ -39,7 +39,7 @@ export async function POST(
|
||||
const { result } = await cancelOrderChangeWorkflow(req.scope)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_Uyv1BYEV2cQoHeUXd"
|
||||
"id": "id_7qRAwUbxg3nak4KERwd"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -64,7 +64,7 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await cancelOrderChangeWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_Uyv1BYEV2cQoHeUXd"
|
||||
"id": "id_7qRAwUbxg3nak4KERwd"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -89,7 +89,7 @@ export default async function myCustomJob(
|
||||
const { result } = await cancelOrderChangeWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_Uyv1BYEV2cQoHeUXd"
|
||||
"id": "id_7qRAwUbxg3nak4KERwd"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -115,7 +115,7 @@ const myWorkflow = createWorkflow(
|
||||
const result = cancelOrderChangeWorkflow
|
||||
.runAsStep({
|
||||
input: {
|
||||
"id": "id_Uyv1BYEV2cQoHeUXd"
|
||||
"id": "id_7qRAwUbxg3nak4KERwd"
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
+4
-4
@@ -39,7 +39,7 @@ export async function POST(
|
||||
const { result } = await createOrderChangeActionsWorkflow(req.scope)
|
||||
.run({
|
||||
input: [{
|
||||
"action": "PROMOTION_REMOVE"
|
||||
"action": "RETURN_ITEM"
|
||||
}]
|
||||
})
|
||||
|
||||
@@ -64,7 +64,7 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await createOrderChangeActionsWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
"action": "PROMOTION_REMOVE"
|
||||
"action": "RETURN_ITEM"
|
||||
}]
|
||||
})
|
||||
|
||||
@@ -89,7 +89,7 @@ export default async function myCustomJob(
|
||||
const { result } = await createOrderChangeActionsWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
"action": "PROMOTION_REMOVE"
|
||||
"action": "RETURN_ITEM"
|
||||
}]
|
||||
})
|
||||
|
||||
@@ -115,7 +115,7 @@ const myWorkflow = createWorkflow(
|
||||
const result = createOrderChangeActionsWorkflow
|
||||
.runAsStep({
|
||||
input: [{
|
||||
"action": "PROMOTION_REMOVE"
|
||||
"action": "RETURN_ITEM"
|
||||
}]
|
||||
})
|
||||
}
|
||||
|
||||
+4
-4
@@ -34,7 +34,7 @@ export async function POST(
|
||||
const { result } = await createOrderCreditLinesWorkflow(req.scope)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_wCesgKvgIPhptn0",
|
||||
"id": "id_1NDTLjVl44x",
|
||||
"credit_lines": [
|
||||
"{value}"
|
||||
]
|
||||
@@ -62,7 +62,7 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await createOrderCreditLinesWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_wCesgKvgIPhptn0",
|
||||
"id": "id_1NDTLjVl44x",
|
||||
"credit_lines": [
|
||||
"{value}"
|
||||
]
|
||||
@@ -90,7 +90,7 @@ export default async function myCustomJob(
|
||||
const { result } = await createOrderCreditLinesWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_wCesgKvgIPhptn0",
|
||||
"id": "id_1NDTLjVl44x",
|
||||
"credit_lines": [
|
||||
"{value}"
|
||||
]
|
||||
@@ -119,7 +119,7 @@ const myWorkflow = createWorkflow(
|
||||
const result = createOrderCreditLinesWorkflow
|
||||
.runAsStep({
|
||||
input: {
|
||||
"id": "id_wCesgKvgIPhptn0",
|
||||
"id": "id_1NDTLjVl44x",
|
||||
"credit_lines": [
|
||||
"{value}"
|
||||
]
|
||||
|
||||
+4
-4
@@ -39,7 +39,7 @@ export async function POST(
|
||||
const { result } = await declineOrderChangeWorkflow(req.scope)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_U58Dn5TxARGuQfeU1"
|
||||
"id": "id_k2g821FXfNZCdOu1T1"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -64,7 +64,7 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await declineOrderChangeWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_U58Dn5TxARGuQfeU1"
|
||||
"id": "id_k2g821FXfNZCdOu1T1"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -89,7 +89,7 @@ export default async function myCustomJob(
|
||||
const { result } = await declineOrderChangeWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_U58Dn5TxARGuQfeU1"
|
||||
"id": "id_k2g821FXfNZCdOu1T1"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -115,7 +115,7 @@ const myWorkflow = createWorkflow(
|
||||
const result = declineOrderChangeWorkflow
|
||||
.runAsStep({
|
||||
input: {
|
||||
"id": "id_U58Dn5TxARGuQfeU1"
|
||||
"id": "id_k2g821FXfNZCdOu1T1"
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
+4
-4
@@ -40,7 +40,7 @@ export async function POST(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_vAlobaY6wySJ47"
|
||||
"id_gopWYzOVgqiPeTNGXy"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -67,7 +67,7 @@ export default async function handleOrderPlaced({
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_vAlobaY6wySJ47"
|
||||
"id_gopWYzOVgqiPeTNGXy"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -94,7 +94,7 @@ export default async function myCustomJob(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_vAlobaY6wySJ47"
|
||||
"id_gopWYzOVgqiPeTNGXy"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -122,7 +122,7 @@ const myWorkflow = createWorkflow(
|
||||
.runAsStep({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_vAlobaY6wySJ47"
|
||||
"id_gopWYzOVgqiPeTNGXy"
|
||||
]
|
||||
}
|
||||
})
|
||||
|
||||
+4
-4
@@ -40,7 +40,7 @@ export async function POST(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_2997zBGEspAlb5Og"
|
||||
"id_JDCk0pOmBgL5V"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -67,7 +67,7 @@ export default async function handleOrderPlaced({
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_2997zBGEspAlb5Og"
|
||||
"id_JDCk0pOmBgL5V"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -94,7 +94,7 @@ export default async function myCustomJob(
|
||||
.run({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_2997zBGEspAlb5Og"
|
||||
"id_JDCk0pOmBgL5V"
|
||||
]
|
||||
}
|
||||
})
|
||||
@@ -122,7 +122,7 @@ const myWorkflow = createWorkflow(
|
||||
.runAsStep({
|
||||
input: {
|
||||
"ids": [
|
||||
"id_2997zBGEspAlb5Og"
|
||||
"id_JDCk0pOmBgL5V"
|
||||
]
|
||||
}
|
||||
})
|
||||
|
||||
+4
-4
@@ -23,14 +23,14 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = throwUnlessStatusIsNotPaid({
|
||||
"paymentCollection": {
|
||||
"id": "id_bvcy6w7LSk95",
|
||||
"currency_code": "ves",
|
||||
"id": "id_1rkji8toNwFZ",
|
||||
"currency_code": "stn",
|
||||
"amount": {
|
||||
"numeric": 9
|
||||
"numeric": 1
|
||||
},
|
||||
"status": "partially_captured",
|
||||
"payment_providers": [{
|
||||
"id": "id_v0VrpUex4Hc2oEYkoSuQ",
|
||||
"id": "id_5F5AxBi8bSEk",
|
||||
"is_enabled": true
|
||||
}]
|
||||
}
|
||||
|
||||
+4
-4
@@ -39,7 +39,7 @@ export async function POST(
|
||||
const { result } = await updateOrderChangeActionsWorkflow(req.scope)
|
||||
.run({
|
||||
input: [{
|
||||
"id": "id_a94xQkyi1uz4X13"
|
||||
"id": "id_qa5cOb98GOR"
|
||||
}]
|
||||
})
|
||||
|
||||
@@ -64,7 +64,7 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await updateOrderChangeActionsWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
"id": "id_a94xQkyi1uz4X13"
|
||||
"id": "id_qa5cOb98GOR"
|
||||
}]
|
||||
})
|
||||
|
||||
@@ -89,7 +89,7 @@ export default async function myCustomJob(
|
||||
const { result } = await updateOrderChangeActionsWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
"id": "id_a94xQkyi1uz4X13"
|
||||
"id": "id_qa5cOb98GOR"
|
||||
}]
|
||||
})
|
||||
|
||||
@@ -115,7 +115,7 @@ const myWorkflow = createWorkflow(
|
||||
const result = updateOrderChangeActionsWorkflow
|
||||
.runAsStep({
|
||||
input: [{
|
||||
"id": "id_a94xQkyi1uz4X13"
|
||||
"id": "id_qa5cOb98GOR"
|
||||
}]
|
||||
})
|
||||
}
|
||||
|
||||
+4
-4
@@ -39,7 +39,7 @@ export async function POST(
|
||||
const { result } = await updateOrderChangesWorkflow(req.scope)
|
||||
.run({
|
||||
input: [{
|
||||
"id": "id_1fHLem2lcH"
|
||||
"id": "id_QLfQATZBg8cayLA"
|
||||
}]
|
||||
})
|
||||
|
||||
@@ -64,7 +64,7 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await updateOrderChangesWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
"id": "id_1fHLem2lcH"
|
||||
"id": "id_QLfQATZBg8cayLA"
|
||||
}]
|
||||
})
|
||||
|
||||
@@ -89,7 +89,7 @@ export default async function myCustomJob(
|
||||
const { result } = await updateOrderChangesWorkflow(container)
|
||||
.run({
|
||||
input: [{
|
||||
"id": "id_1fHLem2lcH"
|
||||
"id": "id_QLfQATZBg8cayLA"
|
||||
}]
|
||||
})
|
||||
|
||||
@@ -115,7 +115,7 @@ const myWorkflow = createWorkflow(
|
||||
const result = updateOrderChangesWorkflow
|
||||
.runAsStep({
|
||||
input: [{
|
||||
"id": "id_1fHLem2lcH"
|
||||
"id": "id_QLfQATZBg8cayLA"
|
||||
}]
|
||||
})
|
||||
}
|
||||
|
||||
+70
-70
@@ -21,90 +21,90 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = validateOrderCreditLinesStep({
|
||||
"order": {
|
||||
"id": "id_BsozItggMsbvch",
|
||||
"version": 30,
|
||||
"display_id": 25,
|
||||
"status": "completed",
|
||||
"currency_code": "uyu",
|
||||
"created_at": "2025-12-22T18:57:25.505Z",
|
||||
"updated_at": "2026-03-11T09:12:13.294Z",
|
||||
"id": "id_6JeNlJUn8ENhVQfLw",
|
||||
"version": 46,
|
||||
"display_id": 38,
|
||||
"status": "pending",
|
||||
"currency_code": "aed",
|
||||
"created_at": "2026-05-06T14:22:59.991Z",
|
||||
"updated_at": "2026-09-02T23:00:01.277Z",
|
||||
"original_item_total": {
|
||||
"numeric": 5
|
||||
},
|
||||
"original_item_subtotal": {
|
||||
"numeric": 13
|
||||
},
|
||||
"original_item_tax_total": {
|
||||
"numeric": 6
|
||||
},
|
||||
"item_total": {
|
||||
"numeric": 0
|
||||
},
|
||||
"item_subtotal": {
|
||||
"numeric": 10
|
||||
},
|
||||
"item_tax_total": {
|
||||
"numeric": 8
|
||||
},
|
||||
"item_discount_total": {
|
||||
"numeric": 47
|
||||
},
|
||||
"original_total": {
|
||||
"numeric": 13
|
||||
},
|
||||
"original_subtotal": {
|
||||
"numeric": 46
|
||||
},
|
||||
"original_tax_total": {
|
||||
"numeric": 13
|
||||
},
|
||||
"total": {
|
||||
"numeric": 33
|
||||
},
|
||||
"subtotal": {
|
||||
"numeric": 36
|
||||
},
|
||||
"tax_total": {
|
||||
"numeric": 45
|
||||
},
|
||||
"discount_subtotal": {
|
||||
"numeric": 43
|
||||
},
|
||||
"discount_total": {
|
||||
"numeric": 36
|
||||
},
|
||||
"discount_tax_total": {
|
||||
"numeric": 21
|
||||
},
|
||||
"credit_line_total": {
|
||||
"numeric": 19
|
||||
},
|
||||
"gift_card_total": {
|
||||
"numeric": 35
|
||||
},
|
||||
"gift_card_tax_total": {
|
||||
"numeric": 9
|
||||
},
|
||||
"shipping_total": {
|
||||
"numeric": 38
|
||||
},
|
||||
"shipping_subtotal": {
|
||||
"original_item_subtotal": {
|
||||
"numeric": 39
|
||||
},
|
||||
"original_item_tax_total": {
|
||||
"numeric": 29
|
||||
},
|
||||
"item_total": {
|
||||
"numeric": 1
|
||||
},
|
||||
"item_subtotal": {
|
||||
"numeric": 8
|
||||
},
|
||||
"item_tax_total": {
|
||||
"numeric": 48
|
||||
},
|
||||
"item_discount_total": {
|
||||
"numeric": 5
|
||||
},
|
||||
"original_total": {
|
||||
"numeric": 6
|
||||
},
|
||||
"original_subtotal": {
|
||||
"numeric": 38
|
||||
},
|
||||
"original_tax_total": {
|
||||
"numeric": 36
|
||||
},
|
||||
"total": {
|
||||
"numeric": 27
|
||||
},
|
||||
"subtotal": {
|
||||
"numeric": 40
|
||||
},
|
||||
"tax_total": {
|
||||
"numeric": 22
|
||||
},
|
||||
"discount_subtotal": {
|
||||
"numeric": 45
|
||||
},
|
||||
"discount_total": {
|
||||
"numeric": 17
|
||||
},
|
||||
"discount_tax_total": {
|
||||
"numeric": 0
|
||||
},
|
||||
"credit_line_total": {
|
||||
"numeric": 27
|
||||
},
|
||||
"gift_card_total": {
|
||||
"numeric": 3
|
||||
},
|
||||
"gift_card_tax_total": {
|
||||
"numeric": 5
|
||||
},
|
||||
"shipping_total": {
|
||||
"numeric": 8
|
||||
},
|
||||
"shipping_subtotal": {
|
||||
"numeric": 24
|
||||
},
|
||||
"shipping_tax_total": {
|
||||
"numeric": 15
|
||||
"numeric": 30
|
||||
},
|
||||
"shipping_discount_total": {
|
||||
"numeric": 35
|
||||
"numeric": 40
|
||||
},
|
||||
"original_shipping_total": {
|
||||
"numeric": 50
|
||||
"numeric": 44
|
||||
},
|
||||
"original_shipping_subtotal": {
|
||||
"numeric": 47
|
||||
"numeric": 28
|
||||
},
|
||||
"original_shipping_tax_total": {
|
||||
"numeric": 43
|
||||
"numeric": 15
|
||||
}
|
||||
},
|
||||
"creditLines": [
|
||||
|
||||
+1
-1
@@ -24,7 +24,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = refundPaymentsStep({
|
||||
"payment_id": "{value}",
|
||||
"amount": 27
|
||||
"amount": 17
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+2
-2
@@ -24,8 +24,8 @@ const myWorkflow = createWorkflow(
|
||||
const data = createPaymentSessionStep({
|
||||
"payment_collection_id": "{value}",
|
||||
"provider_id": "{value}",
|
||||
"amount": 18,
|
||||
"currency_code": "xof"
|
||||
"amount": 48,
|
||||
"currency_code": "krw"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -27,7 +27,7 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = deletePaymentSessionsStep({
|
||||
"ids": [
|
||||
"id_w4RWM2whdYked2tjjcCl"
|
||||
"id_fvXlhEPmeXoP"
|
||||
]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = updateRefundReasonsStep({
|
||||
"id": "id_fIm7e0qjD9a6wxe"
|
||||
"id": "id_KXnK1q2jRxL1Q9te"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = validatePriceListsStep({
|
||||
"id": "id_HB8vTiqYz7qK1"
|
||||
"id": "id_IeS7qnl0C6UcgE"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = createCollectionsStep([{
|
||||
"title": "pauper"
|
||||
"title": "vinitor"
|
||||
}])
|
||||
}
|
||||
)
|
||||
|
||||
+2
-2
@@ -21,8 +21,8 @@ const myWorkflow = createWorkflow(
|
||||
() => {
|
||||
const data = updatePromotionsValidationStep({
|
||||
"promotionsData": [{
|
||||
"id": "id_IszKIskucacOrjuy8f50",
|
||||
"status": "inactive"
|
||||
"id": "id_CRw3yefxAtwysr4qIR",
|
||||
"status": "active"
|
||||
}]
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -32,7 +32,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = setActiveViewConfigurationStep({
|
||||
"id": "id_2k2t0yh5ZGmrmNp",
|
||||
"id": "id_KbwlBtLy1DgYqKEQTl",
|
||||
"entity": "{value}",
|
||||
"user_id": "{value}"
|
||||
})
|
||||
|
||||
+1
-1
@@ -32,7 +32,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = updateViewConfigurationStep({
|
||||
"id": "id_2JozxhzQW2n",
|
||||
"id": "id_CmAXujMIg9nDC",
|
||||
"data": {}
|
||||
})
|
||||
}
|
||||
|
||||
+4
-4
@@ -46,7 +46,7 @@ export async function POST(
|
||||
const { result } = await updateViewConfigurationWorkflow(req.scope)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_3dagJObEyBggQV"
|
||||
"id": "id_nhO76e4fFjQxGMPigZcD"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -71,7 +71,7 @@ export default async function handleOrderPlaced({
|
||||
const { result } = await updateViewConfigurationWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_3dagJObEyBggQV"
|
||||
"id": "id_nhO76e4fFjQxGMPigZcD"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -96,7 +96,7 @@ export default async function myCustomJob(
|
||||
const { result } = await updateViewConfigurationWorkflow(container)
|
||||
.run({
|
||||
input: {
|
||||
"id": "id_3dagJObEyBggQV"
|
||||
"id": "id_nhO76e4fFjQxGMPigZcD"
|
||||
}
|
||||
})
|
||||
|
||||
@@ -122,7 +122,7 @@ const myWorkflow = createWorkflow(
|
||||
const result = updateViewConfigurationWorkflow
|
||||
.runAsStep({
|
||||
input: {
|
||||
"id": "id_3dagJObEyBggQV"
|
||||
"id": "id_nhO76e4fFjQxGMPigZcD"
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
+1
-1
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = createStockLocations({
|
||||
"name": "Marvin"
|
||||
"name": "Marcos"
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
+1
-1
@@ -50,4 +50,4 @@ const data = getItemTaxLinesStep({
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"WorkflowDataProperties","type":"[WorkflowDataProperties](../../../../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<object>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"lineItemTaxLines","type":"[ItemTaxLineDTO](../../../../../tax/interfaces/tax.ItemTaxLineDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the tax provider used to calculate and retrieve the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate_id","type":"`string`","description":"The associated rate's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethodsTaxLines","type":"[ShippingTaxLineDTO](../../../../../tax/interfaces/tax.ShippingTaxLineDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the tax provider used to calculate and retrieve the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_line_id","type":"`string`","description":"The associated shipping line's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate_id","type":"`string`","description":"The associated rate's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="getItemTaxLinesStep"/>
|
||||
<TypeList types={[{"name":"WorkflowDataProperties","type":"[WorkflowDataProperties](../../../../../workflows/types/workflows.WorkflowDataProperties/page.mdx)<object>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"lineItemTaxLines","type":"[ItemTaxLineDTO](../../../../../tax/interfaces/tax.ItemTaxLineDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the tax provider used to calculate and retrieve the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate_id","type":"`string`","description":"The associated rate's ID.\nWhen integrating with a third-party, you don't need to provide it.\nThis is mainly used for the built-in rates.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shippingMethodsTaxLines","type":"[ShippingTaxLineDTO](../../../../../tax/interfaces/tax.ShippingTaxLineDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"rate","type":"`number`","description":"The rate of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the tax provider used to calculate and retrieve the tax line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_line_id","type":"`string`","description":"The associated shipping line's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate_id","type":"`string`","description":"The associated rate's ID.\nWhen integrating with a third-party, you don't need to provide it.\nThis is mainly used for the built-in rates.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="getItemTaxLinesStep"/>
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
The details of setting tax lines for an order's items and shipping methods.
|
||||
|
||||
<TypeList types={[{"name":"order","type":"[OrderDTO](../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../fulfillment/types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_total","type":"[BigNumberValue](../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_subtotal","type":"[BigNumberValue](../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_tax_total","type":"[BigNumberValue](../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric",Line truncated
|
||||
<TypeList types={[{"name":"order","type":"[OrderDTO](../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../fulfillment/types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_total","type":"[BigNumberValue](../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_subtotal","type":"[BigNumberValue](../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_tax_total","type":"[BigNumberValue](../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric",Line truncated
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
The details of the tax lines to set in a cart.
|
||||
|
||||
<TypeList types={[{"name":"cart","type":"[CartWorkflowDTO](../../../types/interfaces/types.CartWorkflowDTO/page.mdx)","description":"The cart's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollectionDTO](../../../payment/interfaces/payment.PaymentCollectionDTO/page.mdx)","description":"The payment collection details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The ISO 3 character currency code of the payment sessions and payments associated with payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The total amount to be authorized and captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../../payment/types/payment.PaymentCollectionStatus/page.mdx)","description":"The status of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProviderDTO](../../../payment/interfaces/payment.PaymentProviderDTO/page.mdx)[]","description":"The payment provider used to process the associated payment sessions and payments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"authorized_amount","type":"[BigNumberValue](../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The amount authorized within the associated payment sessions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_amount","type":"[BigNumberValue](../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The amount refunded within the associated payments.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"[BigNumberValue](../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The amount captured within the associated payments.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`string` \\| `Date`","description":"When the payment collection was completed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the payment collection was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the payment collection was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSessionDTO](../../../payment/interfaces/payment.PaymentSessionDTO/page.mdx)[]","description":"The associated payment sessions.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[PaymentDTO](../../../payment/interfaces/payment.PaymentDTO/page.mdx)[]","description":"The associated payments.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"customer","type":"[CustomerDTO](../../../customer/interfaces/customer.CustomerDTO/page.mdx)","description":"The cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"A flag indicating if customer has an account or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_billing_address_id","type":"`null` \\| `string`","description":"The associated default billing address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_shipping_address_id","type":"`null` \\| `string`","description":"The associated default shipping address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company_name","type":"`null` \\| `string`","description":"The company name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name of the customer.","optional":false,"defaulLine truncated
|
||||
<TypeList types={[{"name":"cart","type":"[CartWorkflowDTO](../../../types/interfaces/types.CartWorkflowDTO/page.mdx)","description":"The cart's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollectionDTO](../../../payment/interfaces/payment.PaymentCollectionDTO/page.mdx)","description":"The payment collection details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The ISO 3 character currency code of the payment sessions and payments associated with payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The total amount to be authorized and captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../../payment/types/payment.PaymentCollectionStatus/page.mdx)","description":"The status of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProviderDTO](../../../payment/interfaces/payment.PaymentProviderDTO/page.mdx)[]","description":"The payment provider used to process the associated payment sessions and payments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"authorized_amount","type":"[BigNumberValue](../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The amount authorized within the associated payment sessions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_amount","type":"[BigNumberValue](../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The amount refunded within the associated payments.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"[BigNumberValue](../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The amount captured within the associated payments.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`string` \\| `Date`","description":"When the payment collection was completed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the payment collection was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the payment collection was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSessionDTO](../../../payment/interfaces/payment.PaymentSessionDTO/page.mdx)[]","description":"The associated payment sessions.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[PaymentDTO](../../../payment/interfaces/payment.PaymentDTO/page.mdx)[]","description":"The associated payments.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"customer","type":"[CustomerDTO](../../../customer/interfaces/customer.CustomerDTO/page.mdx)","description":"The cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"A flag indicating if customer has an account or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_billing_address_id","type":"`null` \\| `string`","description":"The associated default billing address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_shipping_address_id","type":"`null` \\| `string`","description":"The associated default shipping address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company_name","type":"`null` \\| `string`","description":"The company name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name of the customer.","optional":false,"defaulLine truncated
|
||||
+1
-1
@@ -6,4 +6,4 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
The data to upload files.
|
||||
|
||||
<TypeList types={[{"name":"files","type":"`object`[]","description":"The files to upload.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The MIME type of the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The content of the file. For images, for example, \nuse base64 string. For CSV files, use the CSV content.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"`\"public\"` \\| `\"private\"`","description":"The access level of the file. Use `public` for the file that\ncan be accessed by anyone. For example, for images that are displayed\non the storefront. Use `private` for files that are only accessible\nby authenticated users. For example, for CSV files used to\nimport data.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="UploadFilesStepInput"/>
|
||||
<TypeList types={[{"name":"files","type":"`object`[]","description":"The files to upload.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The MIME type of the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The content of the file. For images, for example, \nuse binary string. For CSV files, use the CSV content.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"`\"public\"` \\| `\"private\"`","description":"The access level of the file. Use `public` for the file that\ncan be accessed by anyone. For example, for images that are displayed\non the storefront. Use `private` for files that are only accessible\nby authenticated users. For example, for CSV files used to\nimport data.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="UploadFilesStepInput"/>
|
||||
+1
-1
@@ -6,4 +6,4 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
The data to upload files.
|
||||
|
||||
<TypeList types={[{"name":"files","type":"`object`[]","description":"The files to upload.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The MIME type of the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The content of the file. For images, for example, \nuse base64 string. For CSV files, use the CSV content.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"`\"public\"` \\| `\"private\"`","description":"The access level of the file. Use `public` for the file that\ncan be accessed by anyone. For example, for images that are displayed\non the storefront. Use `private` for files that are only accessible\nby authenticated users. For example, for CSV files used to \nimport data.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="UploadFilesWorkflowInput"/>
|
||||
<TypeList types={[{"name":"files","type":"`object`[]","description":"The files to upload.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The MIME type of the file.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The content of the file. For images, for example, \nuse binary string. For CSV files, use the CSV content.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"`\"public\"` \\| `\"private\"`","description":"The access level of the file. Use `public` for the file that\ncan be accessed by anyone. For example, for images that are displayed\non the storefront. Use `private` for files that are only accessible\nby authenticated users. For example, for CSV files used to \nimport data.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="UploadFilesWorkflowInput"/>
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the Currency data model. It belongs to the Currency Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/currency/src/models/currency.ts#L3" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/currency/src/models/currency.ts#L3" />
|
||||
|
||||
<TypeList types={[{"name":"code","type":"PrimaryKeyModifier<TextProperty>","description":"The ISO 3-character currency code. For example, `USD`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`TextProperty`","description":"The symbol of the currency. For example, `$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`TextProperty`","description":"The native symbol of the currency, if it has a different local symbol.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"decimal_digits","type":"`NumberProperty`","description":"How many digits are after the decimal separator for prices in this currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rounding","type":"`BigNumberProperty`","description":"The rounding percision of prices in this currency.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Currency"/>
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the Customer data model. It belongs to the Customer Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/customer/src/models/customer.ts#L6" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/customer/src/models/customer.ts#L6" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`BooleanProperty`","description":"Whether the customer has account. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/customer/customer-accounts)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"ManyToMany<[CustomerGroup](../customer_models.CustomerGroup/page.mdx)>","description":"The associated groups.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"ManyToMany<[Customer](./page.mdx)>","description":"The associated customers.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`BooleanProperty`","description":"Whether the customer has account. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/customer/customer-accounts)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"ManyToMany<[CustomerGroup](../customer_models.CustomerGroup/page.mdx)>","description":"The associated groups.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"addresses","type":"HasMany<[CustomerAddress](../customer_models.CustomerAddress/page.mdx)>","description":"The associated addresses.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"company_name","type":"`TextProperty`","description":"The company name of the customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`TextProperty`","description":"The first name of the customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`TextProperty`","description":"The last name of the customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`TextProperty`","description":"The phone of the 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":"created_by","type":"`TextProperty`","description":"The ID of the user that created the 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":"created_by","type":"`TextProperty`","description":"The ID of the user that created the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"addresses","type":"HasMany<[CustomerAddress](../customer_models.CustomerAddress/page.mdx)>","description":"The associated addresses.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`BooleanProperty`","description":"Whether the customer address is used by default for shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`BooleanProperty`","description":"Whether the customer address is used by default for billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"BelongsTo<[Customer](./page.mdx)>","description":"The associated customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`BooleanProperty`","description":"Whether the customer has account. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/customer/customer-accounts)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","typLine truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the CustomerAddress data model. It belongs to the Customer Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/customer/src/models/address.ts#L4" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/customer/src/models/address.ts#L4" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`BooleanProperty`","description":"Whether the customer address is used by default for shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`BooleanProperty`","description":"Whether the customer address is used by default for billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"BelongsTo<[Customer](../customer_models.Customer/page.mdx)>","description":"The associated customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`BooleanProperty`","description":"Whether the customer has account. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/customer/customer-accounts)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"ManyToMany<[CustomerGroup](../customer_models.CustomerGroup/page.mdx)>","description":"The associated groups.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"ManyToMany<[Customer](../customer_models.Customer/page.mdx)>","description":"The associated customers.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"addresses","type":"HasMany<[CustomerAddress](./page.mdx)>","description":"The associated addresses.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`BooleanProperty`","description":"Whether the customer address is used by default for shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`BooleanProperty`","description":"Whether the customer address is used by default for billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"BelongsTo<[Customer](../customer_models.Customer/page.mdx)>","description":"The associated customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"address_name","type":"`TextProperty`","description":"The name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`TextProperty`","description":"The company of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`TextProperty`","description":"The first name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`TextProperty`","description":"The last name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`TextProperty`","description":"The first line of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`TextProperty`","description":"The second line of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"The city of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the customer address.\n\n@example us","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`TextProperty`","description":"The province of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`TextProperty`","description":"The postal code of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},Line truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the CustomerGroup data model. It belongs to the Customer Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/customer/src/models/customer-group.ts#L5" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/customer/src/models/customer-group.ts#L5" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"ManyToMany<[Customer](../customer_models.Customer/page.mdx)>","description":"The associated customers.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`BooleanProperty`","description":"Whether the customer has account. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/customer/customer-accounts)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"ManyToMany<[CustomerGroup](./page.mdx)>","description":"The associated groups.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"ManyToMany<[Customer](../customer_models.Customer/page.mdx)>","description":"The associated customers.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"addresses","type":"HasMany<[CustomerAddress](../customer_models.CustomerAddress/page.mdx)>","description":"The associated addresses.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`BooleanProperty`","description":"Whether the customer address is used by default for shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`BooleanProperty`","description":"Whether the customer address is used by default for billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"BelongsTo<[Customer](../customer_models.Customer/page.mdx)>","description":"The associated customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"address_name","type":"`TextProperty`","description":"The name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`TextProperty`","description":"The company of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`TextProperty`","description":"The first name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`TextProperty`","description":"The last name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`TextProperty`","description":"The first line of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`TextProperty`","description":"The second line of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"The city of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the customer address.\n\n@example us","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`TextProperty`","description":"The province of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`TextProperty`","description":"The postal code of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`TextProperty`","description":"The phone of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pLine truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the CustomerGroupCustomer data model. It belongs to the Customer Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/customer/src/models/customer-group-customer.ts#L5" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/customer/src/models/customer-group-customer.ts#L5" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the group-customer pairing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"BelongsTo<[Customer](../customer_models.Customer/page.mdx)>","description":"The associated customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`BooleanProperty`","description":"Whether the customer has account. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/customer/customer-accounts)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"ManyToMany<[CustomerGroup](../customer_models.CustomerGroup/page.mdx)>","description":"The associated groups.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"ManyToMany<[Customer](../customer_models.Customer/page.mdx)>","description":"The associated customers.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"addresses","type":"HasMany<[CustomerAddress](../customer_models.CustomerAddress/page.mdx)>","description":"The associated addresses.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the customer address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`BooleanProperty`","description":"Whether the customer address is used by default for shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`BooleanProperty`","description":"Whether the customer address is used by default for billing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"BelongsTo<[Customer](../customer_models.Customer/page.mdx)>","description":"The associated customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"address_name","type":"`TextProperty`","description":"The name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`TextProperty`","description":"The company of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`TextProperty`","description":"The first name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`TextProperty`","description":"The last name of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`TextProperty`","description":"The first line of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`TextProperty`","description":"The second line of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"The city of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the customer address.\n\n@example us","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`TextProperty`","description":"The province of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`TextProperty`","description":"The postal code of the customer address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`TextProperty`","description":"The phone of the customer 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":[]}]},{"name":"company_name","type":"`TextProperLine truncated
|
||||
+1
-1
@@ -316,7 +316,7 @@ class MyFileProviderService extends AbstractFileProviderService {
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"file","type":"[ProviderUploadFileDTO](../../../types/FileTypes/interfaces/types.FileTypes.ProviderUploadFileDTO/page.mdx)","description":"The file to upload.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The filename of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The file content as a base64-encoded string","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"[FileAccessPermission](../../../types/FileTypes/types/types.FileTypes.FileAccessPermission/page.mdx)","description":"The access level of the file. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="upload"/>
|
||||
<TypeList types={[{"name":"file","type":"[ProviderUploadFileDTO](../../../types/FileTypes/interfaces/types.FileTypes.ProviderUploadFileDTO/page.mdx)","description":"The file to upload.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The filename of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The file content as a binary-encoded string","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"[FileAccessPermission](../../../types/FileTypes/types/types.FileTypes.FileAccessPermission/page.mdx)","description":"The access level of the file. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="upload"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
|
||||
+4
-4
@@ -51,13 +51,13 @@ This method uploads files to the designated file storage system.
|
||||
const [file] = await fileModuleService.createFiles([{
|
||||
filename: "product.png",
|
||||
mimeType: "image/png",
|
||||
content: "somecontent" // base64 string
|
||||
content: "somecontent" // binary string
|
||||
}])
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[CreateFileDTO](../../../types/FileTypes/interfaces/types.FileTypes.CreateFileDTO/page.mdx)[]","description":"The files to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The file content as a base64-encoded string.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"[FileAccessPermission](../../../types/FileTypes/types/types.FileTypes.FileAccessPermission/page.mdx)","description":"The access level of the file. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"runId","type":"`string`","description":"A string indicating the ID of the current run.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../types/interfaces/types.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isCancelling","type":"`boolean`","description":"A boolean value indicating whether the current workflow execution is being cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cancelingFromParentStep","type":"`boolean`","description":"Weither or not a sub workflow cancellation is being triggered from a parent step.\nIf true, the parent step will not be triggered by the sub workflow.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createFiles"/>
|
||||
<TypeList types={[{"name":"data","type":"[CreateFileDTO](../../../types/FileTypes/interfaces/types.FileTypes.CreateFileDTO/page.mdx)[]","description":"The files to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The file content as a binary-encoded string.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"[FileAccessPermission](../../../types/FileTypes/types/types.FileTypes.FileAccessPermission/page.mdx)","description":"The access level of the file. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"runId","type":"`string`","description":"A string indicating the ID of the current run.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../types/interfaces/types.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isCancelling","type":"`boolean`","description":"A boolean value indicating whether the current workflow execution is being cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cancelingFromParentStep","type":"`boolean`","description":"Weither or not a sub workflow cancellation is being triggered from a parent step.\nIf true, the parent step will not be triggered by the sub workflow.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createFiles"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -73,13 +73,13 @@ This method uploads a file to the designated file storage system.
|
||||
const file = await fileModuleService.createFiles({
|
||||
filename: "product.png",
|
||||
mimeType: "image/png",
|
||||
content: "somecontent" // base64 string
|
||||
content: "somecontent" // binary string
|
||||
})
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[CreateFileDTO](../../../types/FileTypes/interfaces/types.FileTypes.CreateFileDTO/page.mdx)","description":"The file to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The file content as a base64-encoded string.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"[FileAccessPermission](../../../types/FileTypes/types/types.FileTypes.FileAccessPermission/page.mdx)","description":"The access level of the file. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"runId","type":"`string`","description":"A string indicating the ID of the current run.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../types/interfaces/types.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isCancelling","type":"`boolean`","description":"A boolean value indicating whether the current workflow execution is being cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cancelingFromParentStep","type":"`boolean`","description":"Weither or not a sub workflow cancellation is being triggered from a parent step.\nIf true, the parent step will not be triggered by the sub workflow.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createFiles"/>
|
||||
<TypeList types={[{"name":"data","type":"[CreateFileDTO](../../../types/FileTypes/interfaces/types.FileTypes.CreateFileDTO/page.mdx)","description":"The file to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"The name of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"The mimetype of the uploaded file","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"The file content as a binary-encoded string.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"[FileAccessPermission](../../../types/FileTypes/types/types.FileTypes.FileAccessPermission/page.mdx)","description":"The access level of the file. Defaults to private if not passed","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"runId","type":"`string`","description":"A string indicating the ID of the current run.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../types/interfaces/types.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preventReleaseEvents","type":"`boolean`","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isCancelling","type":"`boolean`","description":"A boolean value indicating whether the current workflow execution is being cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cancelingFromParentStep","type":"`boolean`","description":"Weither or not a sub workflow cancellation is being triggered from a parent step.\nIf true, the parent step will not be triggered by the sub workflow.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createFiles"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
|
||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the GeoZoneSchema data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/fulfillment/src/models/geo-zone.ts#L16" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/fulfillment/src/models/geo-zone.ts#L16" />
|
||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the ServiceZoneSchema data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/fulfillment/src/models/service-zone.ts#L18" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/fulfillment/src/models/service-zone.ts#L18" />
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the Fulfillment data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/fulfillment/src/models/fulfillment.ts#L9" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/fulfillment/src/models/fulfillment.ts#L9" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`TextProperty`","description":"The ID of the location to fulfill items from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the fulfillment item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany<[FulfillmentItem](../fulfillment_models.FulfillmentItem/page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`TextProperty`","description":"The SKU of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`TextProperty`","description":"The barcode of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`BigNumberProperty`","description":"The quantity of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"BelongsTo<[Fulfillment](./page.mdx)>","description":"The associated fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`TextProperty`","description":"The ID of the location to fulfill items from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the fulfillment item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany<[FulfillmentItem](../fulfillment_models.FulfillmentItem/page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"labels","type":"HasMany<[FulfillmentLabel](../fulfillment_models.FulfillmentLabel/page.mdx)>","description":"The associated labels.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"packed_at","type":"`DateTimeProperty`","description":"The date the fulfillment items were packed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`DateTimeProperty`","description":"The date the fulfillment items were shipped.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`TextProperty`","description":"The ID of the user that marked this fulfillment as shipped.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created this fulfillment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"`DateTimeProperty`","description":"The date the fulfillment items were delivered.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`DateTimeProperty`","description":"The date the fulfillment was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`JSONProperty`","description":"The data of the fulfillment useful for the associated fulfillment provider. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/fulfillment/item-fulfillment#data-property)","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"HasOneWithForeignKey<[FulfillmentProvider](../fulfillment_models.FulfillmentProvider/page.mdx)>","description":"The associated provider.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_option","type":"BelongsTo<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"The associated shipping option.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"delivery_address","type":"HasOneWithForeignKey<[FulfillmentAddress](../fulfillment_models.FulfillmentAddress/page.mdx)>","description":"The associated delivery address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":trLine truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the FulfillmentAddress data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/fulfillment/src/models/address.ts#L3" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/fulfillment/src/models/address.ts#L3" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the fulfillment address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`TextProperty`","description":"The company of the fulfillment address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`TextProperty`","description":"The first name of the fulfillment address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`TextProperty`","description":"The last name of the fulfillment address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`TextProperty`","description":"The first line of the fulfillment address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`TextProperty`","description":"The second line of the fulfillment address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"The city of the fulfillment address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the fulfillment address.\n\n@example us","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`TextProperty`","description":"The province of the fulfillment address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`TextProperty`","description":"The postal code of the fulfillment address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`TextProperty`","description":"The phone of the fulfillment 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="FulfillmentAddress"/>
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the FulfillmentItem data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/fulfillment/src/models/fulfillment-item.ts#L5" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/fulfillment/src/models/fulfillment-item.ts#L5" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`TextProperty`","description":"The SKU of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`TextProperty`","description":"The barcode of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`BigNumberProperty`","description":"The quantity of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"BelongsTo<[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)>","description":"The associated fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`TextProperty`","description":"The ID of the location to fulfill items from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the fulfillment item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany<[FulfillmentItem](./page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`TextProperty`","description":"The SKU of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`TextProperty`","description":"The barcode of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`BigNumberProperty`","description":"The quantity of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"BelongsTo<[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)>","description":"The associated fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"line_item_id","type":"`TextProperty`","description":"The ID the line item being fulfilled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`TextProperty`","description":"The ID of the inventory item being fulfilled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"labels","type":"HasMany<[FulfillmentLabel](../fulfillment_models.FulfillmentLabel/page.mdx)>","description":"The associated labels.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the fulfillment label.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_number","type":"`TextProperty`","description":"The tracking number of the fulfillment label","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_url","type":"`TextProperty`","description":"The tracking URL of the fulfillment label","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label_url","type":"`TextProperty`","description":"The label URL of the fulfillment label","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"BelongsTo<[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)>","description":"The associated fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"packed_at","type":"`DateTimeProperty`","description":"The date the fulfillment items were packed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`DateTimeProperty`","description":"The date the fulfillment items were shipped.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`TextProperty`","description":"The ID of the user that marked this fulfillment as shipped.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created this fulfillment.","optional":true,"defaultValueLine truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the FulfillmentLabel data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/fulfillment/src/models/fulfillment-label.ts#L5" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/fulfillment/src/models/fulfillment-label.ts#L5" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the fulfillment label.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_number","type":"`TextProperty`","description":"The tracking number of the fulfillment label","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_url","type":"`TextProperty`","description":"The tracking URL of the fulfillment label","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label_url","type":"`TextProperty`","description":"The label URL of the fulfillment label","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"BelongsTo<[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)>","description":"The associated fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`TextProperty`","description":"The ID of the location to fulfill items from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the fulfillment item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"HasMany<[FulfillmentItem](../fulfillment_models.FulfillmentItem/page.mdx)>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`TextProperty`","description":"The SKU of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`TextProperty`","description":"The barcode of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`BigNumberProperty`","description":"The quantity of the fulfillment item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"BelongsTo<[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)>","description":"The associated fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"line_item_id","type":"`TextProperty`","description":"The ID the line item being fulfilled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`TextProperty`","description":"The ID of the inventory item being fulfilled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"labels","type":"HasMany<[FulfillmentLabel](./page.mdx)>","description":"The associated labels.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the fulfillment label.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_number","type":"`TextProperty`","description":"The tracking number of the fulfillment label","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_url","type":"`TextProperty`","description":"The tracking URL of the fulfillment label","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label_url","type":"`TextProperty`","description":"The label URL of the fulfillment label","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"BelongsTo<[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)>","description":"The associated fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"packed_at","type":"`DateTimeProperty`","description":"The date the fulfillment items were packed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`DateTimeProperty`","description":"The date the fulfillment items were shipped.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`TextProperty`","description":"The ID of the user that marked this fulfillment as shipped.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created this fulfillment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"`DateTimeProperty`","description":"The date the fulfillLine truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the FulfillmentProvider data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/fulfillment/src/models/fulfillment-provider.ts#L3" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/fulfillment/src/models/fulfillment-provider.ts#L3" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`BooleanProperty`","description":"Whether the fulfillment provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FulfillmentProvider"/>
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the FulfillmentSet data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/fulfillment/src/models/fulfillment-set.ts#L5" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/fulfillment/src/models/fulfillment-set.ts#L5" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"The type of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"HasMany<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"The associated service zones.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo<[FulfillmentSet](./page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"The type of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"HasMany<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"The associated service zones.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"geo_zones","type":"HasMany<[GeoZone](../fulfillment_models.GeoZone/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`TextProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_expression","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_options","type":"HasMany<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"EnumProperty<typeof [ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)>","description":"The price type of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"HasOneWithForeignKey<[ShippingOptionType](../fulfillment_models.ShippingOptionType/page.mdx)>","description":"The associated type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rules","type":"HasMany<[ShippingOptionRule](../fulfillment_models.ShippingOptionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"fulfillments","type":"HasMany<[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)>","description":"The associated fulfillmLine truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the GeoZone data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/fulfillment/src/models/geo-zone.ts#L27" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/fulfillment/src/models/geo-zone.ts#L27" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo<[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"The type of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"HasMany<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"The associated service zones.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"geo_zones","type":"HasMany<[GeoZone](./page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`TextProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_expression","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_options","type":"HasMany<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"EnumProperty<typeof [ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)>","description":"The price type of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"HasOneWithForeignKey<[ShippingOptionType](../fulfillment_models.ShippingOptionType/page.mdx)>","description":"The associated type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rules","type":"HasMany<[ShippingOptionRule](../fulfillment_models.ShippingOptionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"fulfillments","type":"HasMany<[Fulfillment](../fulfillment_models.Fulfillment/page.mdx)>","description":"The associated fulfillments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"data","type":"`JSONPLine truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the ServiceZone data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/fulfillment/src/models/service-zone.ts#L27" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/fulfillment/src/models/service-zone.ts#L27" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo<[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"The type of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"HasMany<[ServiceZone](./page.mdx)>","description":"The associated service zones.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo<[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"HasMany<[GeoZone](../fulfillment_models.GeoZone/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"HasMany<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","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":"geo_zones","type":"HasMany<[GeoZone](../fulfillment_models.GeoZone/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo<[ServiceZone](./page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo<[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"HasMany<[GeoZone](../fulfillment_models.GeoZone/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"HasMany<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"province_code","type":"`TextProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_expression","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_options","type":"HasMany<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`"Line truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the ShippingOption data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/fulfillment/src/models/shipping-option.ts#L10" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/fulfillment/src/models/shipping-option.ts#L10" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"EnumProperty<typeof [ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)>","description":"The price type of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo<[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"The type of the fulfillment set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"HasMany<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"The associated service zones.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"geo_zones","type":"HasMany<[GeoZone](../fulfillment_models.GeoZone/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`TextProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_expression","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_options","type":"HasMany<[ShippingOption](./page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"EnumProperty<typeof [ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)>","description":"The price type of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"HasOneWithForeignKey<[ShippingOptionType](../fulfillment_models.ShippingOptionType/page.mdx)>","description":"The associated type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rules","type":"HasMany<[ShippingOptionRule](../fulfillment_models.ShippingOptionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]Line truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the ShippingOptionRule data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/fulfillment/src/models/shipping-option-rule.ts#L4" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/fulfillment/src/models/shipping-option-rule.ts#L4" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping option rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The name of a property or table that the rule applies to.\n\n@example customer\\_group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof RuleOperator>","description":"The operator used in the condition.\n\n@example eq","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"BelongsTo<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"EnumProperty<typeof [ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)>","description":"The price type of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo<[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"HasMany<[GeoZone](../fulfillment_models.GeoZone/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"HasMany<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"HasOneWithForeignKey<[ShippingOptionType](../fulfillment_models.ShippingOptionType/page.mdx)>","description":"The associated type.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping option type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`TextProperty`","description":"The label of the shipping option type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the shipping option type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"HasOne<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the shipping option type","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"HasMany<[ShippingOptionRule](./page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping option rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The name of a property or table that the rule applies to.\n\n@example customer\\_group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof RuleOperator>","description":"The operator used in the condition.\n\n@example eq","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"BelongsTo<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"value","type":"`JSONProperty`","description":"The value of the shipping option rule","optional":true,"defaultValue":"","expandable":faLine truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the ShippingOptionType data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/fulfillment/src/models/shipping-option-type.ts#L5" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/fulfillment/src/models/shipping-option-type.ts#L5" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping option type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`TextProperty`","description":"The label of the shipping option type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the shipping option type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"HasOne<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"EnumProperty<typeof [ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)>","description":"The price type of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo<[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"HasMany<[GeoZone](../fulfillment_models.GeoZone/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"HasMany<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"HasOneWithForeignKey<[ShippingOptionType](./page.mdx)>","description":"The associated type.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping option type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`TextProperty`","description":"The label of the shipping option type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the shipping option type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"HasOne<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the shipping option type","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"HasMany<[ShippingOptionRule](../fulfillment_models.ShippingOptionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping option rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The name of a property or table that the rule applies to.\n\n@example customer\\_group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof RuleOperator>","description":"The operator used in the condition.\n\n@example eq","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"BelongsTo<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"value","type":"`JSONProperty`","description":"The value of the shipping option rule","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fulfillments","type":"HasMany<[Fulfillment](../fulfillment_models.FLine truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the ShippingProfile data model. It belongs to the Fulfillment Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/fulfillment/src/models/shipping-profile.ts#L5" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/fulfillment/src/models/shipping-profile.ts#L5" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping profile","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`TextProperty`","description":"The type of the shipping profile","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"HasMany<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"The associated shipping options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"EnumProperty<typeof [ShippingOptionPriceType](../../../utils/FulfillmentUtils/enums/utils.FulfillmentUtils.ShippingOptionPriceType/page.mdx)>","description":"The price type of the shipping option","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"BelongsTo<[ServiceZone](../fulfillment_models.ServiceZone/page.mdx)>","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"BelongsTo<[FulfillmentSet](../fulfillment_models.FulfillmentSet/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"HasMany<[GeoZone](../fulfillment_models.GeoZone/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"HasMany<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"HasOneWithForeignKey<[ShippingOptionType](../fulfillment_models.ShippingOptionType/page.mdx)>","description":"The associated type.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping option type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`TextProperty`","description":"The label of the shipping option type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the shipping option type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"HasOne<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the shipping option type","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"HasMany<[ShippingOptionRule](../fulfillment_models.ShippingOptionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the shipping option rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The name of a property or table that the rule applies to.\n\n@example customer\\_group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof RuleOperator>","description":"The operator used in the condition.\n\n@example eq","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"BelongsTo<[ShippingOption](../fulfillment_models.ShippingOption/page.mdx)>","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"value","type":"`JSONProperty`","description":"The value of the shipping option rule","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fulfillments","type":"HasMany<[FulfillmLine truncated
|
||||
+5
-1
@@ -9,7 +9,11 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `emitEventStep` step. It belongs to the `@medusajs/medusa/core-flows` package.
|
||||
|
||||
Emit an event.
|
||||
This step emits an event, which you can listen to in a [subscriber](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers). You can pass data to the
|
||||
subscriber by including it in the `data` property.
|
||||
|
||||
The event is only emitted after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully.
|
||||
If the workflow fails, it won't emit the event at all.
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the InventoryItem data model. It belongs to the Inventory Next Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/inventory/src/models/inventory-item.ts#L5" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/inventory/src/models/inventory-item.ts#L5" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the inventory item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"HasMany<[InventoryLevel](../inventory_next_models.InventoryLevel/page.mdx)>","description":"The associated location levels.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the inventory level.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`TextProperty`","description":"The ID of the inventory level's location. When used with the [Stock Location Module](https://docs.medusajs.com/resources/commerce-modules/stock-location), the ID will be a `StockLocation`'s ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`BigNumberProperty`","description":"The stocked quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`BigNumberProperty`","description":"The reserved quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`BigNumberProperty`","description":"The incoming quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item","type":"BelongsTo<[InventoryItem](./page.mdx)>","description":"The associated inventory item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the inventory item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"HasMany<[InventoryLevel](../inventory_next_models.InventoryLevel/page.mdx)>","description":"The associated location levels.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"reservation_items","type":"HasMany<[ReservationItem](../inventory_next_models.ReservationItem/page.mdx)>","description":"The associated reservation items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"reserved_quantity","type":"ComputedProperty<null \\| number, NumberProperty>","description":"The reserved quantity of the inventory item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"ComputedProperty<null \\| number, NumberProperty>","description":"The stocked quantity of the inventory item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`TextProperty`","description":"The SKU of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`TextProperty`","description":"The origin country of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`TextProperty`","description":"The HS code of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`TextProperty`","description":"The MID code of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`TextProperty`","description":"The material of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`NumberProperty`","description":"The weight of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`NumberProperty`","description":"The length of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`NumberProperty`","description":"The height of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`NumberProperty`","description":"The width of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`TextProperty`","description":"The thumbnail URL Line truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the InventoryLevel data model. It belongs to the Inventory Next Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/inventory/src/models/inventory-level.ts#L4" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/inventory/src/models/inventory-level.ts#L4" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the inventory level.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`TextProperty`","description":"The ID of the inventory level's location. When used with the [Stock Location Module](https://docs.medusajs.com/resources/commerce-modules/stock-location), the ID will be a `StockLocation`'s ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`BigNumberProperty`","description":"The stocked quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`BigNumberProperty`","description":"The reserved quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`BigNumberProperty`","description":"The incoming quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item","type":"BelongsTo<[InventoryItem](../inventory_next_models.InventoryItem/page.mdx)>","description":"The associated inventory item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the inventory item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"HasMany<[InventoryLevel](./page.mdx)>","description":"The associated location levels.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the inventory level.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`TextProperty`","description":"The ID of the inventory level's location. When used with the [Stock Location Module](https://docs.medusajs.com/resources/commerce-modules/stock-location), the ID will be a `StockLocation`'s ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`BigNumberProperty`","description":"The stocked quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`BigNumberProperty`","description":"The reserved quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`BigNumberProperty`","description":"The incoming quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item","type":"BelongsTo<[InventoryItem](../inventory_next_models.InventoryItem/page.mdx)>","description":"The associated inventory item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"available_quantity","type":"ComputedProperty<null \\| number, BigNumberProperty>","description":"The available quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"reservation_items","type":"HasMany<[ReservationItem](../inventory_next_models.ReservationItem/page.mdx)>","description":"The associated reservation items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the reservation item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether the underlying item can still be ordered despite the reserved quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`TextProperty`","description":"The ID of the location that the quantity is reserved from. When used with the [Stock Location Module](https://docs.medusajs.com/resources/commerce-modules/stock-location), the ID will be a `StockLocation`'s ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`BigNumberProperty`","description":"The reserved quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"`JSONProperty`","description":"The raw reserved quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item","type":"BelongsTo<[InventoryItem](../inventory_next_models.InventoryItem/page.mdx)>","description":"The associated inveLine truncated
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the ReservationItem data model. It belongs to the Inventory Next Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/inventory/src/models/reservation-item.ts#L4" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/inventory/src/models/reservation-item.ts#L4" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the reservation item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether the underlying item can still be ordered despite the reserved quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`TextProperty`","description":"The ID of the location that the quantity is reserved from. When used with the [Stock Location Module](https://docs.medusajs.com/resources/commerce-modules/stock-location), the ID will be a `StockLocation`'s ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`BigNumberProperty`","description":"The reserved quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"`JSONProperty`","description":"The raw reserved quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item","type":"BelongsTo<[InventoryItem](../inventory_next_models.InventoryItem/page.mdx)>","description":"The associated inventory item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`BooleanProperty`","description":"Whether the inventory item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"HasMany<[InventoryLevel](../inventory_next_models.InventoryLevel/page.mdx)>","description":"The associated location levels.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the inventory level.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`TextProperty`","description":"The ID of the inventory level's location. When used with the [Stock Location Module](https://docs.medusajs.com/resources/commerce-modules/stock-location), the ID will be a `StockLocation`'s ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`BigNumberProperty`","description":"The stocked quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`BigNumberProperty`","description":"The reserved quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"incoming_quantity","type":"`BigNumberProperty`","description":"The incoming quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item","type":"BelongsTo<[InventoryItem](../inventory_next_models.InventoryItem/page.mdx)>","description":"The associated inventory item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"available_quantity","type":"ComputedProperty<null \\| number, BigNumberProperty>","description":"The available quantity of the inventory level","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"reservation_items","type":"HasMany<[ReservationItem](./page.mdx)>","description":"The associated reservation items.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the reservation item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether the underlying item can still be ordered despite the reserved quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`TextProperty`","description":"The ID of the location that the quantity is reserved from. When used with the [Stock Location Module](https://docs.medusajs.com/resources/commerce-modules/stock-location), the ID will be a `StockLocation`'s ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`BigNumberProperty`","description":"The reserved quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"`JSONProperty`","description":"The raw reserved quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item","type":"BelongsTo<[InventoryItem](../inventory_next_models.InventoryItem/page.mdx)>","description":"The associated inventory iteLine truncated
|
||||
+1
-1
@@ -194,7 +194,7 @@ sdk.store.cart.deleteLineItem(
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"cartId","type":"`string`","description":"The cart's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lineItemId","type":"`string`","description":"The item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../../admin/types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
|
||||
<TypeList types={[{"name":"cartId","type":"`string`","description":"The cart's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lineItemId","type":"`string`","description":"The item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the cart.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../../admin/types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the Order data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/order/src/models/order.ts#L124" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/order/src/models/order.ts#L124" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`AutoIncrementProperty`","description":"The display ID of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`NumberProperty`","description":"The version of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [OrderStatus](../../../utils/OrderUtils/enums/utils.OrderUtils.OrderStatus/page.mdx)>","description":"The status of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_draft_order","type":"`BooleanProperty`","description":"Whether the order is a draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the order.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"HasMany<any>","description":"The associated summary.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"items","type":"HasMany<any>","description":"The associated items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"HasMany<any>","description":"The associated shipping methods.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"transactions","type":"HasMany<any>","description":"The associated transactions, which include amounts captured and refunded.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"credit_lines","type":"HasMany<any>","description":"The associated credit lines, which include additional payment amounts for an order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"returns","type":"HasMany<any>","description":"The associated returns.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the region that the order was purchased in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the customer that placed the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`TextProperty`","description":"The ID of the sales channel that the order was purchased through.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the order's customer","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`BooleanProperty`","description":"Whether the customer should receive notifications for order updates.","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":"canceled_at","type":"`DateTimeProperty`","description":"The date the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"HasOneWithForeignKey<any, undefined>","description":"The associated shipping\\_address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address","type":"HasOneWithForeignKey<any, undefined>","description":"The associated billing address.","optional":true,"defaultValue":"","expandable":true,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Order"/>
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderAddress data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/order/src/models/address.ts#L27" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/order/src/models/address.ts#L27" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the order 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 order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`TextProperty`","description":"The first name of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`TextProperty`","description":"The last name of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`TextProperty`","description":"The first line of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`TextProperty`","description":"The second line of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`TextProperty`","description":"The city of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the order address.\n\n@example us","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`TextProperty`","description":"The province of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`TextProperty`","description":"The postal code of the order address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`TextProperty`","description":"The phone of the order 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="OrderAddress"/>
|
||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the OrderChange data model. It belongs to the Order Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/33f788be42975c3bd05db3074b1aa636f84d6fd4/packages/modules/order/src/models/order-change.ts#L85" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/bafd0060946049bc2cd1490ef26b7ed2650c561f/packages/modules/order/src/models/order-change.ts#L85" />
|
||||
Loaded 100 of 237 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user