docs: generate references manually (#10438)

This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-12-04 21:37:07 +02:00
1 parent c9eeaebdd9
commit 1cb885d566
143 files changed
+178984 -164140

No files matched your search

+79 -44
View File
@@ -246,8 +246,8 @@ export const generatedEditDates = {
"references/core_flows/Order/functions/core_flows.Order.updateOrderEditAddItemValidationStep/page.mdx": "2024-08-20T00:10:59.065Z", "references/core_flows/Order/functions/core_flows.Order.updateOrderEditAddItemValidationStep/page.mdx": "2024-08-20T00:10:59.065Z",
"references/core_flows/Order/functions/core_flows.Order.updateOrderEditAddItemWorkflow/page.mdx": "2024-08-20T00:10:59.105Z", "references/core_flows/Order/functions/core_flows.Order.updateOrderEditAddItemWorkflow/page.mdx": "2024-08-20T00:10:59.105Z",
"references/core_flows/core_flows.Order/page.mdx": "2024-08-20T00:10:56.437Z", "references/core_flows/core_flows.Order/page.mdx": "2024-08-20T00:10:56.437Z",
"references/modules/core_flows/page.mdx": "2024-11-25T17:49:33.871Z", "references/modules/core_flows/page.mdx": "2024-12-04T18:29:22.470Z",
"references/types/types.HttpTypes/page.mdx": "2024-11-25T17:49:25.831Z", "references/types/types.HttpTypes/page.mdx": "2024-12-04T18:29:18.477Z",
"app/troubleshooting/medusa-admin/no-widget-route/page.mdx": "2024-08-23T11:31:26.346Z", "app/troubleshooting/medusa-admin/no-widget-route/page.mdx": "2024-08-23T11:31:26.346Z",
"references/auth/IAuthModuleService/methods/auth.IAuthModuleService.createProviderIdentities/page.mdx": "2024-10-23T07:15:29.604Z", "references/auth/IAuthModuleService/methods/auth.IAuthModuleService.createProviderIdentities/page.mdx": "2024-10-23T07:15:29.604Z",
"references/auth/IAuthModuleService/methods/auth.IAuthModuleService.deleteProviderIdentities/page.mdx": "2024-10-23T07:15:29.608Z", "references/auth/IAuthModuleService/methods/auth.IAuthModuleService.deleteProviderIdentities/page.mdx": "2024-10-23T07:15:29.608Z",
@@ -286,9 +286,9 @@ export const generatedEditDates = {
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createShipmentWorkflow/page.mdx": "2024-10-03T00:12:00.907Z", "references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createShipmentWorkflow/page.mdx": "2024-10-03T00:12:00.907Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateFulfillmentWorkflow/page.mdx": "2024-10-03T00:12:00.965Z", "references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateFulfillmentWorkflow/page.mdx": "2024-10-03T00:12:00.965Z",
"references/core_flows/Fulfillment/core_flows.Fulfillment.Steps_Fulfillment/page.mdx": "2024-11-25T17:49:35.427Z", "references/core_flows/Fulfillment/core_flows.Fulfillment.Steps_Fulfillment/page.mdx": "2024-11-25T17:49:35.427Z",
"references/core_flows/Fulfillment/core_flows.Fulfillment.Workflows_Fulfillment/page.mdx": "2024-11-25T17:49:35.691Z", "references/core_flows/Fulfillment/core_flows.Fulfillment.Workflows_Fulfillment/page.mdx": "2024-12-04T18:29:23.413Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createCompleteReturnStep/page.mdx": "2024-11-25T17:49:36.891Z", "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createCompleteReturnStep/page.mdx": "2024-11-25T17:49:36.891Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderChangeStep/page.mdx": "2024-11-25T17:49:36.767Z", "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderChangeStep/page.mdx": "2024-12-04T18:29:23.966Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderClaimsStep/page.mdx": "2024-11-06T21:08:51.602Z", "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderClaimsStep/page.mdx": "2024-11-06T21:08:51.602Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderExchangesStep/page.mdx": "2024-11-06T21:08:51.698Z", "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderExchangesStep/page.mdx": "2024-11-06T21:08:51.698Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createReturnsStep/page.mdx": "2024-11-06T21:08:51.786Z", "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createReturnsStep/page.mdx": "2024-11-06T21:08:51.786Z",
@@ -323,7 +323,7 @@ export const generatedEditDates = {
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createClaimShippingMethodWorkflow/page.mdx": "2024-11-25T17:49:40.067Z", "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createClaimShippingMethodWorkflow/page.mdx": "2024-11-25T17:49:40.067Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createExchangeShippingMethodValidationStep/page.mdx": "2024-11-25T17:49:40.703Z", "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createExchangeShippingMethodValidationStep/page.mdx": "2024-11-25T17:49:40.703Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createExchangeShippingMethodWorkflow/page.mdx": "2024-11-25T17:49:40.739Z", "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createExchangeShippingMethodWorkflow/page.mdx": "2024-11-25T17:49:40.739Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderChangeWorkflow/page.mdx": "2024-11-25T17:49:40.467Z", "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderChangeWorkflow/page.mdx": "2024-12-04T18:29:25.936Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderEditShippingMethodValidationStep/page.mdx": "2024-11-25T17:49:41.291Z", "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderEditShippingMethodValidationStep/page.mdx": "2024-11-25T17:49:41.291Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderEditShippingMethodWorkflow/page.mdx": "2024-11-25T17:49:41.323Z", "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderEditShippingMethodWorkflow/page.mdx": "2024-11-25T17:49:41.323Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderFulfillmentWorkflow/page.mdx": "2024-11-25T17:49:40.427Z", "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderFulfillmentWorkflow/page.mdx": "2024-11-25T17:49:40.427Z",
@@ -399,18 +399,18 @@ export const generatedEditDates = {
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateReturnShippingMethodWorkflow/page.mdx": "2024-11-25T17:49:42.559Z", "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateReturnShippingMethodWorkflow/page.mdx": "2024-11-25T17:49:42.559Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateReturnValidationStep/page.mdx": "2024-11-25T17:49:42.567Z", "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateReturnValidationStep/page.mdx": "2024-11-25T17:49:42.567Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateReturnWorkflow/page.mdx": "2024-11-25T17:49:42.603Z", "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateReturnWorkflow/page.mdx": "2024-11-25T17:49:42.603Z",
"references/core_flows/Order/core_flows.Order.Steps_Order/page.mdx": "2024-11-25T17:49:36.639Z", "references/core_flows/Order/core_flows.Order.Steps_Order/page.mdx": "2024-12-04T18:29:23.900Z",
"references/core_flows/Order/core_flows.Order.Workflows_Order/page.mdx": "2024-11-25T17:49:39.619Z", "references/core_flows/Order/core_flows.Order.Workflows_Order/page.mdx": "2024-12-04T18:29:25.484Z",
"references/core_flows/Shipping_Options/Steps_Shipping_Options/functions/core_flows.Shipping_Options.Steps_Shipping_Options.listShippingOptionsForContextStep/page.mdx": "2024-11-25T17:49:49.404Z", "references/core_flows/Shipping_Options/Steps_Shipping_Options/functions/core_flows.Shipping_Options.Steps_Shipping_Options.listShippingOptionsForContextStep/page.mdx": "2024-11-25T17:49:49.404Z",
"references/core_flows/Shipping_Options/core_flows.Shipping_Options.Steps_Shipping_Options/page.mdx": "2024-11-25T17:49:49.396Z", "references/core_flows/Shipping_Options/core_flows.Shipping_Options.Steps_Shipping_Options/page.mdx": "2024-11-25T17:49:49.396Z",
"references/core_flows/core_flows.Steps_Common/page.mdx": "2024-11-25T17:49:34.971Z", "references/core_flows/core_flows.Steps_Common/page.mdx": "2024-11-25T17:49:34.971Z",
"references/core_flows/core_flows.Steps_Fulfillment/page.mdx": "2024-11-25T17:49:35.967Z", "references/core_flows/core_flows.Steps_Fulfillment/page.mdx": "2024-11-25T17:49:35.967Z",
"references/core_flows/core_flows.Steps_Order/page.mdx": "2024-11-25T17:49:42.887Z", "references/core_flows/core_flows.Steps_Order/page.mdx": "2024-12-04T18:29:27.223Z",
"references/core_flows/core_flows.Steps_Shipping_Options/page.mdx": "2024-11-25T17:49:49.412Z", "references/core_flows/core_flows.Steps_Shipping_Options/page.mdx": "2024-11-25T17:49:49.412Z",
"references/core_flows/core_flows.Workflows_Cart/page.mdx": "2024-11-25T17:49:34.911Z", "references/core_flows/core_flows.Workflows_Cart/page.mdx": "2024-11-25T17:49:34.911Z",
"references/core_flows/core_flows.Workflows_Common/page.mdx": "2024-11-25T17:49:34.991Z", "references/core_flows/core_flows.Workflows_Common/page.mdx": "2024-11-25T17:49:34.991Z",
"references/core_flows/core_flows.Workflows_Fulfillment/page.mdx": "2024-11-25T17:49:36.099Z", "references/core_flows/core_flows.Workflows_Fulfillment/page.mdx": "2024-12-04T18:29:23.625Z",
"references/core_flows/core_flows.Workflows_Order/page.mdx": "2024-11-25T17:49:47.611Z", "references/core_flows/core_flows.Workflows_Order/page.mdx": "2024-12-04T18:29:29.708Z",
"references/core_flows/types/core_flows.DismissRemoteLinksStepInput/page.mdx": "2024-08-28T00:11:29.422Z", "references/core_flows/types/core_flows.DismissRemoteLinksStepInput/page.mdx": "2024-08-28T00:11:29.422Z",
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.cancelFulfillment/page.mdx": "2024-10-23T07:15:52.740Z", "references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.cancelFulfillment/page.mdx": "2024-10-23T07:15:52.740Z",
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createFulfillment/page.mdx": "2024-11-06T21:09:05.842Z", "references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createFulfillment/page.mdx": "2024-11-06T21:09:05.842Z",
@@ -437,7 +437,7 @@ export const generatedEditDates = {
"references/fulfillment/interfaces/fulfillment.ShippingOptionRuleDTO/page.mdx": "2024-10-03T00:12:15.712Z", "references/fulfillment/interfaces/fulfillment.ShippingOptionRuleDTO/page.mdx": "2024-10-03T00:12:15.712Z",
"references/fulfillment/interfaces/fulfillment.ShippingOptionTypeDTO/page.mdx": "2024-10-03T00:12:15.724Z", "references/fulfillment/interfaces/fulfillment.ShippingOptionTypeDTO/page.mdx": "2024-10-03T00:12:15.724Z",
"references/fulfillment/interfaces/fulfillment.ShippingProfileDTO/page.mdx": "2024-10-03T00:12:15.779Z", "references/fulfillment/interfaces/fulfillment.ShippingProfileDTO/page.mdx": "2024-10-03T00:12:15.779Z",
"references/fulfillment/types/fulfillment.ChangeActionType/page.mdx": "2024-11-25T17:49:51.320Z", "references/fulfillment/types/fulfillment.ChangeActionType/page.mdx": "2024-12-04T18:29:31.558Z",
"references/fulfillment_models/classes/fulfillment_models.Fulfillment/page.mdx": "2024-10-03T00:12:15.529Z", "references/fulfillment_models/classes/fulfillment_models.Fulfillment/page.mdx": "2024-10-03T00:12:15.529Z",
"references/fulfillment_models/classes/fulfillment_models.FulfillmentItem/page.mdx": "2024-10-03T00:12:15.502Z", "references/fulfillment_models/classes/fulfillment_models.FulfillmentItem/page.mdx": "2024-10-03T00:12:15.502Z",
"references/fulfillment_models/classes/fulfillment_models.FulfillmentLabel/page.mdx": "2024-10-03T00:12:15.508Z", "references/fulfillment_models/classes/fulfillment_models.FulfillmentLabel/page.mdx": "2024-10-03T00:12:15.508Z",
@@ -469,7 +469,7 @@ export const generatedEditDates = {
"references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelExchange/page.mdx": "2024-11-06T21:09:11.390Z", "references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelExchange/page.mdx": "2024-11-06T21:09:11.390Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.createClaim/page.mdx": "2024-11-06T21:09:11.370Z", "references/order/IOrderModuleService/methods/order.IOrderModuleService.createClaim/page.mdx": "2024-11-06T21:09:11.370Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.createExchange/page.mdx": "2024-11-06T21:09:11.386Z", "references/order/IOrderModuleService/methods/order.IOrderModuleService.createExchange/page.mdx": "2024-11-06T21:09:11.386Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.createOrderChange/page.mdx": "2024-11-25T17:49:56.668Z", "references/order/IOrderModuleService/methods/order.IOrderModuleService.createOrderChange/page.mdx": "2024-12-04T18:29:34.060Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.createOrderClaims/page.mdx": "2024-11-06T21:09:11.238Z", "references/order/IOrderModuleService/methods/order.IOrderModuleService.createOrderClaims/page.mdx": "2024-11-06T21:09:11.238Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.createOrderExchanges/page.mdx": "2024-11-06T21:09:11.270Z", "references/order/IOrderModuleService/methods/order.IOrderModuleService.createOrderExchanges/page.mdx": "2024-11-06T21:09:11.270Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.createReturn/page.mdx": "2024-11-06T21:09:11.350Z", "references/order/IOrderModuleService/methods/order.IOrderModuleService.createReturn/page.mdx": "2024-11-06T21:09:11.350Z",
@@ -480,7 +480,7 @@ export const generatedEditDates = {
"references/order/IOrderModuleService/methods/order.IOrderModuleService.updateOrderChanges/page.mdx": "2024-11-25T17:49:56.684Z", "references/order/IOrderModuleService/methods/order.IOrderModuleService.updateOrderChanges/page.mdx": "2024-11-25T17:49:56.684Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.updateOrderClaims/page.mdx": "2024-11-06T21:09:11.250Z", "references/order/IOrderModuleService/methods/order.IOrderModuleService.updateOrderClaims/page.mdx": "2024-11-06T21:09:11.250Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.updateOrderExchanges/page.mdx": "2024-11-06T21:09:11.282Z", "references/order/IOrderModuleService/methods/order.IOrderModuleService.updateOrderExchanges/page.mdx": "2024-11-06T21:09:11.282Z",
"references/order/interfaces/order.CreateOrderChangeDTO/page.mdx": "2024-11-25T17:49:56.232Z", "references/order/interfaces/order.CreateOrderChangeDTO/page.mdx": "2024-12-04T18:29:33.855Z",
"references/order/interfaces/order.CreateOrderClaimDTO/page.mdx": "2024-10-03T00:12:17.704Z", "references/order/interfaces/order.CreateOrderClaimDTO/page.mdx": "2024-10-03T00:12:17.704Z",
"references/order/interfaces/order.CreateOrderExchangeDTO/page.mdx": "2024-10-03T00:12:17.709Z", "references/order/interfaces/order.CreateOrderExchangeDTO/page.mdx": "2024-10-03T00:12:17.709Z",
"references/order/interfaces/order.CreateOrderReturnDTO/page.mdx": "2024-10-03T00:12:17.661Z", "references/order/interfaces/order.CreateOrderReturnDTO/page.mdx": "2024-10-03T00:12:17.661Z",
@@ -493,7 +493,7 @@ export const generatedEditDates = {
"references/order/interfaces/order.ReturnDTO/page.mdx": "2024-11-25T17:49:55.948Z", "references/order/interfaces/order.ReturnDTO/page.mdx": "2024-11-25T17:49:55.948Z",
"references/order/interfaces/order.UpdateOrderClaimWithSelectorDTO/page.mdx": "2024-11-06T21:09:10.662Z", "references/order/interfaces/order.UpdateOrderClaimWithSelectorDTO/page.mdx": "2024-11-06T21:09:10.662Z",
"references/order/interfaces/order.UpdateOrderExchangeWithSelectorDTO/page.mdx": "2024-11-06T21:09:10.670Z", "references/order/interfaces/order.UpdateOrderExchangeWithSelectorDTO/page.mdx": "2024-11-06T21:09:10.670Z",
"references/order/types/order.ChangeActionType/page.mdx": "2024-11-25T17:49:55.808Z", "references/order/types/order.ChangeActionType/page.mdx": "2024-12-04T18:29:33.645Z",
"references/order_models/classes/order_models.Order/page.mdx": "2024-11-06T21:09:10.058Z", "references/order_models/classes/order_models.Order/page.mdx": "2024-11-06T21:09:10.058Z",
"references/order_models/classes/order_models.OrderChange/page.mdx": "2024-10-23T07:15:57.040Z", "references/order_models/classes/order_models.OrderChange/page.mdx": "2024-10-23T07:15:57.040Z",
"references/order_models/classes/order_models.OrderChangeAction/page.mdx": "2024-10-23T07:15:57.004Z", "references/order_models/classes/order_models.OrderChangeAction/page.mdx": "2024-10-23T07:15:57.004Z",
@@ -536,7 +536,7 @@ export const generatedEditDates = {
"references/types/WorkflowsSdkTypes/interfaces/types.WorkflowsSdkTypes.WorkflowOrchestratorRunDTO/page.mdx": "2024-09-17T00:10:59.355Z", "references/types/WorkflowsSdkTypes/interfaces/types.WorkflowsSdkTypes.WorkflowOrchestratorRunDTO/page.mdx": "2024-09-17T00:10:59.355Z",
"references/types/interfaces/types.BaseExchange/page.mdx": "2024-11-06T21:08:40.718Z", "references/types/interfaces/types.BaseExchange/page.mdx": "2024-11-06T21:08:40.718Z",
"references/types/interfaces/types.BaseReturn/page.mdx": "2024-09-20T00:12:03.021Z", "references/types/interfaces/types.BaseReturn/page.mdx": "2024-09-20T00:12:03.021Z",
"references/types/types.DmlTypes/page.mdx": "2024-11-27T16:33:39.160Z", "references/types/types.DmlTypes/page.mdx": "2024-12-04T18:29:18.325Z",
"references/types/types.ModulesSdkTypes/page.mdx": "2024-11-25T17:49:27.891Z", "references/types/types.ModulesSdkTypes/page.mdx": "2024-11-25T17:49:27.891Z",
"references/types/types/types.FlowRunOptions/page.mdx": "2024-09-17T00:10:59.375Z", "references/types/types/types.FlowRunOptions/page.mdx": "2024-09-17T00:10:59.375Z",
"references/fulfillment_models/classes/fulfillment_models.FulfillmentAddress/page.mdx": "2024-08-29T00:11:41.369Z", "references/fulfillment_models/classes/fulfillment_models.FulfillmentAddress/page.mdx": "2024-08-29T00:11:41.369Z",
@@ -602,7 +602,7 @@ export const generatedEditDates = {
"references/modules/fulfillment_models/page.mdx": "2024-11-25T17:49:50.572Z", "references/modules/fulfillment_models/page.mdx": "2024-11-25T17:49:50.572Z",
"references/modules/order_models/page.mdx": "2024-11-25T17:49:55.360Z", "references/modules/order_models/page.mdx": "2024-11-25T17:49:55.360Z",
"references/notification/classes/notification.AbstractNotificationProviderService/page.mdx": "2024-10-23T07:15:56.836Z", "references/notification/classes/notification.AbstractNotificationProviderService/page.mdx": "2024-10-23T07:15:56.836Z",
"references/order/interfaces/order.IOrderModuleService/page.mdx": "2024-11-25T17:49:56.332Z", "references/order/interfaces/order.IOrderModuleService/page.mdx": "2024-12-04T18:29:33.901Z",
"references/order_models/classes/order_models.OrderItem/page.mdx": "2024-11-06T21:09:09.998Z", "references/order_models/classes/order_models.OrderItem/page.mdx": "2024-11-06T21:09:09.998Z",
"references/order_models/classes/order_models.OrderSummary/page.mdx": "2024-10-23T07:15:57.096Z", "references/order_models/classes/order_models.OrderSummary/page.mdx": "2024-10-23T07:15:57.096Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCampaignResponse/page.mdx": "2024-10-23T07:15:27.872Z", "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCampaignResponse/page.mdx": "2024-10-23T07:15:27.872Z",
@@ -985,14 +985,14 @@ export const generatedEditDates = {
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderClaimItemsFromActionsStep/page.mdx": "2024-11-25T17:49:36.699Z", "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderClaimItemsFromActionsStep/page.mdx": "2024-11-25T17:49:36.699Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderExchangeItemsFromActionsStep/page.mdx": "2024-11-25T17:49:36.799Z", "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderExchangeItemsFromActionsStep/page.mdx": "2024-11-25T17:49:36.799Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangeActionsStep/page.mdx": "2024-11-25T17:49:36.927Z", "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangeActionsStep/page.mdx": "2024-11-25T17:49:36.927Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderChangeActionsWorkflow/page.mdx": "2024-11-25T17:49:40.435Z", "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderChangeActionsWorkflow/page.mdx": "2024-12-04T18:29:25.919Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderChangeActionsWorkflow/page.mdx": "2024-11-25T17:49:42.611Z", "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderChangeActionsWorkflow/page.mdx": "2024-11-25T17:49:42.611Z",
"references/core_flows/core_flows.Auth/page.mdx": "2024-09-06T11:11:43.042Z", "references/core_flows/core_flows.Auth/page.mdx": "2024-09-06T11:11:43.042Z",
"references/core_flows/core_flows.Steps_Auth/page.mdx": "2024-11-25T17:49:33.995Z", "references/core_flows/core_flows.Steps_Auth/page.mdx": "2024-11-25T17:49:33.995Z",
"references/core_flows/types/core_flows.CreateOrderClaimItemsFromActionsInput/page.mdx": "2024-11-25T17:49:49.968Z", "references/core_flows/types/core_flows.CreateOrderClaimItemsFromActionsInput/page.mdx": "2024-11-25T17:49:49.968Z",
"references/core_flows/types/core_flows.CreateOrderExchangeItemsFromActionsInput/page.mdx": "2024-11-25T17:49:49.980Z", "references/core_flows/types/core_flows.CreateOrderExchangeItemsFromActionsInput/page.mdx": "2024-11-25T17:49:49.980Z",
"references/modules/medusa/page.mdx": "2024-11-25T17:49:25.171Z", "references/modules/medusa/page.mdx": "2024-11-25T17:49:25.171Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.addOrderAction/page.mdx": "2024-11-25T17:49:56.748Z", "references/order/IOrderModuleService/methods/order.IOrderModuleService.addOrderAction/page.mdx": "2024-12-04T18:29:34.103Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.retrieveOrderChangeAction/page.mdx": "2024-11-25T17:49:56.736Z", "references/order/IOrderModuleService/methods/order.IOrderModuleService.retrieveOrderChangeAction/page.mdx": "2024-11-25T17:49:56.736Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.updateOrderChangeActions/page.mdx": "2024-11-25T17:49:56.740Z", "references/order/IOrderModuleService/methods/order.IOrderModuleService.updateOrderChangeActions/page.mdx": "2024-11-25T17:49:56.740Z",
"references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunction/page.mdx": "2024-10-23T07:15:28.900Z", "references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunction/page.mdx": "2024-10-23T07:15:28.900Z",
@@ -1044,11 +1044,11 @@ export const generatedEditDates = {
"references/types/types/types.ExtractFiltersOperators/page.mdx": "2024-10-14T09:11:12.264Z", "references/types/types/types.ExtractFiltersOperators/page.mdx": "2024-10-14T09:11:12.264Z",
"references/types/types/types.OmitNever/page.mdx": "2024-09-23T00:11:34.539Z", "references/types/types/types.OmitNever/page.mdx": "2024-09-23T00:11:34.539Z",
"references/types/types/types.TypeOnly-1/page.mdx": "2024-09-17T00:10:59.143Z", "references/types/types/types.TypeOnly-1/page.mdx": "2024-09-17T00:10:59.143Z",
"references/utils/OrderUtils/enums/utils.OrderUtils.ChangeActionType/page.mdx": "2024-11-25T17:49:28.567Z", "references/utils/OrderUtils/enums/utils.OrderUtils.ChangeActionType/page.mdx": "2024-12-04T18:29:19.788Z",
"references/utils/OrderUtils/enums/utils.OrderUtils.OrderChangeStatus/page.mdx": "2024-09-17T00:10:59.431Z", "references/utils/OrderUtils/enums/utils.OrderUtils.OrderChangeStatus/page.mdx": "2024-09-17T00:10:59.431Z",
"references/utils/OrderUtils/enums/utils.OrderUtils.OrderChangeType/page.mdx": "2024-09-17T00:10:59.435Z", "references/utils/OrderUtils/enums/utils.OrderUtils.OrderChangeType/page.mdx": "2024-09-17T00:10:59.435Z",
"references/utils/enums/utils.NotificationStatus/page.mdx": "2024-09-17T00:10:59.419Z", "references/utils/enums/utils.NotificationStatus/page.mdx": "2024-09-17T00:10:59.419Z",
"references/utils/utils.CoreFlowsUitls/page.mdx": "2024-11-25T17:49:28.523Z", "references/utils/utils.CoreFlowsUitls/page.mdx": "2024-12-04T18:29:19.767Z",
"references/workflows/types/workflows.LocalStepConfig/page.mdx": "2024-09-17T00:11:28.827Z", "references/workflows/types/workflows.LocalStepConfig/page.mdx": "2024-09-17T00:11:28.827Z",
"references/api_key/IApiKeyModuleService/methods/api_key.IApiKeyModuleService.authenticate/page.mdx": "2024-10-23T07:15:29.432Z", "references/api_key/IApiKeyModuleService/methods/api_key.IApiKeyModuleService.authenticate/page.mdx": "2024-10-23T07:15:29.432Z",
"references/api_key/IApiKeyModuleService/methods/api_key.IApiKeyModuleService.createApiKeys/page.mdx": "2024-11-25T17:49:28.683Z", "references/api_key/IApiKeyModuleService/methods/api_key.IApiKeyModuleService.createApiKeys/page.mdx": "2024-11-25T17:49:28.683Z",
@@ -1222,7 +1222,7 @@ export const generatedEditDates = {
"references/dml/Relationship_Methods/methods/dml.Relationship_Methods.hasMany/page.mdx": "2024-10-03T00:12:15.471Z", "references/dml/Relationship_Methods/methods/dml.Relationship_Methods.hasMany/page.mdx": "2024-10-03T00:12:15.471Z",
"references/dml/Relationship_Methods/methods/dml.Relationship_Methods.hasOne/page.mdx": "2024-10-03T00:12:15.468Z", "references/dml/Relationship_Methods/methods/dml.Relationship_Methods.hasOne/page.mdx": "2024-10-03T00:12:15.468Z",
"references/dml/Relationship_Methods/methods/dml.Relationship_Methods.manyToMany/page.mdx": "2024-11-27T16:33:52.369Z", "references/dml/Relationship_Methods/methods/dml.Relationship_Methods.manyToMany/page.mdx": "2024-11-27T16:33:52.369Z",
"references/dml/entity/classes/dml.entity.DmlEntity/page.mdx": "2024-11-25T17:49:50.520Z", "references/dml/entity/classes/dml.entity.DmlEntity/page.mdx": "2024-12-04T18:29:31.176Z",
"references/dml/entity_builder/EntityBuilder/methods/dml.entity_builder.EntityBuilder.define/page.mdx": "2024-10-03T00:12:15.442Z", "references/dml/entity_builder/EntityBuilder/methods/dml.entity_builder.EntityBuilder.define/page.mdx": "2024-10-03T00:12:15.442Z",
"references/dml/entity_builder/types/dml.entity_builder.ManyToManyOptions/page.mdx": "2024-11-27T16:33:52.350Z", "references/dml/entity_builder/types/dml.entity_builder.ManyToManyOptions/page.mdx": "2024-11-27T16:33:52.350Z",
"references/file/classes/file.AbstractFileProviderService/page.mdx": "2024-10-14T15:28:21.810Z", "references/file/classes/file.AbstractFileProviderService/page.mdx": "2024-10-14T15:28:21.810Z",
@@ -1330,8 +1330,8 @@ export const generatedEditDates = {
"references/inventory_next/types/inventory_next.JoinerRelationship/page.mdx": "2024-10-23T07:15:53.292Z", "references/inventory_next/types/inventory_next.JoinerRelationship/page.mdx": "2024-10-23T07:15:53.292Z",
"references/modules/api_key/page.mdx": "2024-11-27T16:33:40.668Z", "references/modules/api_key/page.mdx": "2024-11-27T16:33:40.668Z",
"references/modules/customer_models/page.mdx": "2024-11-25T17:49:50.228Z", "references/modules/customer_models/page.mdx": "2024-11-25T17:49:50.228Z",
"references/modules/order/page.mdx": "2024-11-27T16:33:54.918Z", "references/modules/order/page.mdx": "2024-12-04T18:29:33.622Z",
"references/modules/utils/page.mdx": "2024-11-25T17:49:28.511Z", "references/modules/utils/page.mdx": "2024-12-04T18:29:19.760Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.applyPendingOrderActions/page.mdx": "2024-10-23T07:15:58.188Z", "references/order/IOrderModuleService/methods/order.IOrderModuleService.applyPendingOrderActions/page.mdx": "2024-10-23T07:15:58.188Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelFulfillment/page.mdx": "2024-10-23T07:15:58.476Z", "references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelFulfillment/page.mdx": "2024-10-23T07:15:58.476Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelOrderChange/page.mdx": "2024-10-23T07:15:58.152Z", "references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelOrderChange/page.mdx": "2024-10-23T07:15:58.152Z",
@@ -1748,15 +1748,15 @@ export const generatedEditDates = {
"references/types/types/types.RawBigNumberPrefix-1/page.mdx": "2024-09-23T00:11:34.851Z", "references/types/types/types.RawBigNumberPrefix-1/page.mdx": "2024-09-23T00:11:34.851Z",
"references/types/types/types.Scalars-1/page.mdx": "2024-09-23T00:11:34.695Z", "references/types/types/types.Scalars-1/page.mdx": "2024-09-23T00:11:34.695Z",
"references/types/types/types.TypeOnly-2/page.mdx": "2024-09-23T00:11:34.858Z", "references/types/types/types.TypeOnly-2/page.mdx": "2024-09-23T00:11:34.858Z",
"references/medusa/interfaces/medusa.MedusaRequest/page.mdx": "2024-11-25T17:49:25.199Z", "references/medusa/interfaces/medusa.MedusaRequest/page.mdx": "2024-12-04T18:29:18.184Z",
"references/medusa/types/medusa.MedusaContainer-2/page.mdx": "2024-09-24T00:11:41.170Z", "references/medusa/types/medusa.MedusaContainer-2/page.mdx": "2024-09-24T00:11:41.170Z",
"references/medusa/types/medusa.MedusaErrorHandlerFunction/page.mdx": "2024-10-23T07:15:27.336Z", "references/medusa/types/medusa.MedusaErrorHandlerFunction/page.mdx": "2024-12-04T18:29:18.178Z",
"references/medusa/types/medusa.MedusaRequestHandler/page.mdx": "2024-10-23T07:15:27.360Z", "references/medusa/types/medusa.MedusaRequestHandler/page.mdx": "2024-12-04T18:29:18.188Z",
"references/medusa/types/medusa.SubscriberArgs/page.mdx": "2024-10-23T07:15:27.396Z", "references/medusa/types/medusa.SubscriberArgs/page.mdx": "2024-10-23T07:15:27.396Z",
"references/workflows/types/workflows.ReturnWorkflow/page.mdx": "2024-09-24T00:12:12.649Z", "references/workflows/types/workflows.ReturnWorkflow/page.mdx": "2024-09-24T00:12:12.649Z",
"references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx": "2024-10-03T00:12:00.178Z", "references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx": "2024-10-03T00:12:00.178Z",
"references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.removeRemoteLinkStep/page.mdx": "2024-10-24T13:48:11.284Z", "references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.removeRemoteLinkStep/page.mdx": "2024-10-24T13:48:11.284Z",
"references/dml/Model_Methods/methods/dml.Model_Methods.indexes/page.mdx": "2024-10-03T00:12:15.476Z", "references/dml/Model_Methods/methods/dml.Model_Methods.indexes/page.mdx": "2024-12-04T18:29:31.193Z",
"references/dml/Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.default/page.mdx": "2024-10-03T00:12:15.484Z", "references/dml/Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.default/page.mdx": "2024-10-03T00:12:15.484Z",
"references/dml/Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.index/page.mdx": "2024-10-03T00:12:15.482Z", "references/dml/Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.index/page.mdx": "2024-10-03T00:12:15.482Z",
"references/dml/Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.nullable/page.mdx": "2024-10-03T00:12:15.481Z", "references/dml/Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.nullable/page.mdx": "2024-10-03T00:12:15.481Z",
@@ -1845,7 +1845,7 @@ export const generatedEditDates = {
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.deleteServiceZonesWorkflow/page.mdx": "2024-10-02T00:12:01.148Z", "references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.deleteServiceZonesWorkflow/page.mdx": "2024-10-02T00:12:01.148Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.deleteShippingOptionsWorkflow/page.mdx": "2024-10-24T13:48:12.136Z", "references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.deleteShippingOptionsWorkflow/page.mdx": "2024-10-24T13:48:12.136Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateServiceZonesWorkflow/page.mdx": "2024-10-02T00:12:01.194Z", "references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateServiceZonesWorkflow/page.mdx": "2024-10-02T00:12:01.194Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateShippingOptionsWorkflow/page.mdx": "2024-10-02T00:12:01.197Z", "references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateShippingOptionsWorkflow/page.mdx": "2024-12-04T18:29:23.494Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateShippingProfilesWorkflow/page.mdx": "2024-10-02T00:12:01.199Z", "references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateShippingProfilesWorkflow/page.mdx": "2024-10-02T00:12:01.199Z",
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.adjustInventoryLevelsStep/page.mdx": "2024-10-02T00:12:01.403Z", "references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.adjustInventoryLevelsStep/page.mdx": "2024-10-02T00:12:01.403Z",
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.attachInventoryItemToVariants/page.mdx": "2024-10-02T00:12:01.405Z", "references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.attachInventoryItemToVariants/page.mdx": "2024-10-02T00:12:01.405Z",
@@ -2040,7 +2040,7 @@ export const generatedEditDates = {
"references/core_flows/User/Steps_User/functions/core_flows.User.Steps_User.createUsersStep/page.mdx": "2024-10-02T00:12:15.147Z", "references/core_flows/User/Steps_User/functions/core_flows.User.Steps_User.createUsersStep/page.mdx": "2024-10-02T00:12:15.147Z",
"references/core_flows/User/Steps_User/functions/core_flows.User.Steps_User.deleteUsersStep/page.mdx": "2024-10-02T00:12:15.149Z", "references/core_flows/User/Steps_User/functions/core_flows.User.Steps_User.deleteUsersStep/page.mdx": "2024-10-02T00:12:15.149Z",
"references/core_flows/User/Steps_User/functions/core_flows.User.Steps_User.updateUsersStep/page.mdx": "2024-10-02T00:12:15.152Z", "references/core_flows/User/Steps_User/functions/core_flows.User.Steps_User.updateUsersStep/page.mdx": "2024-10-02T00:12:15.152Z",
"references/modules/helper_steps/page.mdx": "2024-10-14T09:11:41.865Z", "references/modules/helper_steps/page.mdx": "2024-12-04T18:29:31.695Z",
"references/api_key/IModuleService/methods/api_key.IModuleService.__joinerConfig/page.mdx": "2024-11-11T10:31:43.555Z", "references/api_key/IModuleService/methods/api_key.IModuleService.__joinerConfig/page.mdx": "2024-11-11T10:31:43.555Z",
"references/auth/IModuleService/methods/auth.IModuleService.__joinerConfig/page.mdx": "2024-11-11T10:31:43.707Z", "references/auth/IModuleService/methods/auth.IModuleService.__joinerConfig/page.mdx": "2024-11-11T10:31:43.707Z",
"references/cart/IModuleService/methods/cart.IModuleService.__joinerConfig/page.mdx": "2024-11-11T10:31:44.291Z", "references/cart/IModuleService/methods/cart.IModuleService.__joinerConfig/page.mdx": "2024-11-11T10:31:44.291Z",
@@ -2283,7 +2283,7 @@ export const generatedEditDates = {
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.inventoryItem/page.mdx": "2024-10-25T15:35:28.081Z", "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.inventoryItem/page.mdx": "2024-10-25T15:35:28.081Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.notification/page.mdx": "2024-11-06T21:09:07.294Z", "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.notification/page.mdx": "2024-11-06T21:09:07.294Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.invite/page.mdx": "2024-10-25T15:35:27.829Z", "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.invite/page.mdx": "2024-10-25T15:35:27.829Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.order/page.mdx": "2024-11-27T16:33:53.517Z", "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.order/page.mdx": "2024-12-04T18:29:32.269Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.orderEdit/page.mdx": "2024-11-25T17:49:52.832Z", "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.orderEdit/page.mdx": "2024-11-25T17:49:52.832Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.payment/page.mdx": "2024-11-06T21:09:07.554Z", "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.payment/page.mdx": "2024-11-06T21:09:07.554Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.paymentCollection/page.mdx": "2024-11-06T21:09:07.570Z", "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.paymentCollection/page.mdx": "2024-11-06T21:09:07.570Z",
@@ -2662,7 +2662,7 @@ export const generatedEditDates = {
"references/js_sdk/admin/classes/js_sdk.admin.FulfillmentSet/page.mdx": "2024-11-25T17:49:52.396Z", "references/js_sdk/admin/classes/js_sdk.admin.FulfillmentSet/page.mdx": "2024-11-25T17:49:52.396Z",
"references/js_sdk/admin/classes/js_sdk.admin.Invite/page.mdx": "2024-11-25T17:49:53.248Z", "references/js_sdk/admin/classes/js_sdk.admin.Invite/page.mdx": "2024-11-25T17:49:53.248Z",
"references/js_sdk/admin/classes/js_sdk.admin.Notification/page.mdx": "2024-11-25T17:49:53.304Z", "references/js_sdk/admin/classes/js_sdk.admin.Notification/page.mdx": "2024-11-25T17:49:53.304Z",
"references/js_sdk/admin/classes/js_sdk.admin.Order/page.mdx": "2024-11-27T16:33:53.800Z", "references/js_sdk/admin/classes/js_sdk.admin.Order/page.mdx": "2024-12-04T18:29:32.538Z",
"references/js_sdk/admin/classes/js_sdk.admin.OrderEdit/page.mdx": "2024-11-25T17:49:53.348Z", "references/js_sdk/admin/classes/js_sdk.admin.OrderEdit/page.mdx": "2024-11-25T17:49:53.348Z",
"references/js_sdk/admin/classes/js_sdk.admin.Payment/page.mdx": "2024-11-25T17:49:53.540Z", "references/js_sdk/admin/classes/js_sdk.admin.Payment/page.mdx": "2024-11-25T17:49:53.540Z",
"references/js_sdk/admin/classes/js_sdk.admin.PaymentCollection/page.mdx": "2024-11-25T17:49:53.492Z", "references/js_sdk/admin/classes/js_sdk.admin.PaymentCollection/page.mdx": "2024-11-25T17:49:53.492Z",
@@ -3300,9 +3300,9 @@ export const generatedEditDates = {
"references/modules/inventory_next/page.mdx": "2024-11-27T16:33:52.948Z", "references/modules/inventory_next/page.mdx": "2024-11-27T16:33:52.948Z",
"references/modules/medusa_config/page.mdx": "2024-11-25T17:49:55.224Z", "references/modules/medusa_config/page.mdx": "2024-11-25T17:49:55.224Z",
"references/modules/payment_models/page.mdx": "2024-11-25T17:49:57.100Z", "references/modules/payment_models/page.mdx": "2024-11-25T17:49:57.100Z",
"references/modules/pricing/page.mdx": "2024-11-27T16:33:55.845Z", "references/modules/pricing/page.mdx": "2024-12-04T18:29:34.516Z",
"references/modules/pricing_models/page.mdx": "2024-11-25T17:49:57.544Z", "references/modules/pricing_models/page.mdx": "2024-12-04T18:29:34.496Z",
"references/modules/product_models/page.mdx": "2024-11-27T16:33:56.000Z", "references/modules/product_models/page.mdx": "2024-12-04T18:29:34.662Z",
"references/modules/promotion_models/page.mdx": "2024-11-25T17:49:58.440Z", "references/modules/promotion_models/page.mdx": "2024-11-25T17:49:58.440Z",
"references/modules/region/page.mdx": "2024-11-27T16:33:56.472Z", "references/modules/region/page.mdx": "2024-11-27T16:33:56.472Z",
"references/modules/sales_channel/page.mdx": "2024-11-25T17:49:58.852Z", "references/modules/sales_channel/page.mdx": "2024-11-25T17:49:58.852Z",
@@ -3369,7 +3369,7 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductType/page.mdx": "2024-11-25T17:49:26.819Z", "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductType/page.mdx": "2024-11-25T17:49:26.819Z",
"references/types/WorkflowTypes/types.WorkflowTypes.CartWorkflow/page.mdx": "2024-11-25T17:49:28.199Z", "references/types/WorkflowTypes/types.WorkflowTypes.CartWorkflow/page.mdx": "2024-11-25T17:49:28.199Z",
"references/types/WorkflowTypes/types.WorkflowTypes.FulfillmentWorkflow/page.mdx": "2024-11-25T17:49:28.211Z", "references/types/WorkflowTypes/types.WorkflowTypes.FulfillmentWorkflow/page.mdx": "2024-11-25T17:49:28.211Z",
"references/types/WorkflowTypes/types.WorkflowTypes.OrderWorkflow/page.mdx": "2024-11-25T17:49:28.259Z", "references/types/WorkflowTypes/types.WorkflowTypes.OrderWorkflow/page.mdx": "2024-12-04T18:29:19.635Z",
"references/types/WorkflowTypes/types.WorkflowTypes.PriceListWorkflow/page.mdx": "2024-11-25T17:49:28.355Z", "references/types/WorkflowTypes/types.WorkflowTypes.PriceListWorkflow/page.mdx": "2024-11-25T17:49:28.355Z",
"references/types/WorkflowTypes/types.WorkflowTypes.ProductCategoryWorkflow/page.mdx": "2024-11-25T17:49:28.375Z", "references/types/WorkflowTypes/types.WorkflowTypes.ProductCategoryWorkflow/page.mdx": "2024-11-25T17:49:28.375Z",
"references/types/WorkflowTypes/types.WorkflowTypes.ProductWorkflow/page.mdx": "2024-11-25T17:49:28.379Z", "references/types/WorkflowTypes/types.WorkflowTypes.ProductWorkflow/page.mdx": "2024-11-25T17:49:28.379Z",
@@ -3405,14 +3405,13 @@ export const generatedEditDates = {
"references/pricing/types/pricing.FilterQueryProperties/page.mdx": "2024-11-27T16:33:55.857Z", "references/pricing/types/pricing.FilterQueryProperties/page.mdx": "2024-11-27T16:33:55.857Z",
"references/product/types/product.Constructor/page.mdx": "2024-11-27T16:33:56.095Z", "references/product/types/product.Constructor/page.mdx": "2024-11-27T16:33:56.095Z",
"references/product/types/product.FilterQueryProperties/page.mdx": "2024-11-27T16:33:56.088Z", "references/product/types/product.FilterQueryProperties/page.mdx": "2024-11-27T16:33:56.088Z",
"references/product_models/variables/product_models.Image/page.mdx": "2024-11-27T16:33:56.023Z", "references/product_models/variables/product_models.Product/page.mdx": "2024-12-04T18:29:34.729Z",
"references/product_models/variables/product_models.Product/page.mdx": "2024-11-27T16:33:56.076Z", "references/product_models/variables/product_models.ProductCategory/page.mdx": "2024-12-04T18:29:34.669Z",
"references/product_models/variables/product_models.ProductCategory/page.mdx": "2024-11-27T16:33:56.008Z", "references/product_models/variables/product_models.ProductCollection/page.mdx": "2024-12-04T18:29:34.675Z",
"references/product_models/variables/product_models.ProductCollection/page.mdx": "2024-11-27T16:33:56.016Z", "references/product_models/variables/product_models.ProductOption/page.mdx": "2024-12-04T18:29:34.694Z",
"references/product_models/variables/product_models.ProductOption/page.mdx": "2024-11-27T16:33:56.037Z",
"references/product_models/variables/product_models.ProductOptionValue/page.mdx": "2024-11-27T16:33:56.027Z", "references/product_models/variables/product_models.ProductOptionValue/page.mdx": "2024-11-27T16:33:56.027Z",
"references/product_models/variables/product_models.ProductTag/page.mdx": "2024-11-27T16:33:56.044Z", "references/product_models/variables/product_models.ProductTag/page.mdx": "2024-12-04T18:29:34.701Z",
"references/product_models/variables/product_models.ProductType/page.mdx": "2024-11-27T16:33:56.050Z", "references/product_models/variables/product_models.ProductType/page.mdx": "2024-12-04T18:29:34.708Z",
"references/product_models/variables/product_models.ProductVariant/page.mdx": "2024-11-27T16:33:56.057Z", "references/product_models/variables/product_models.ProductVariant/page.mdx": "2024-11-27T16:33:56.057Z",
"references/promotion/types/promotion.Constructor/page.mdx": "2024-11-27T16:33:56.374Z", "references/promotion/types/promotion.Constructor/page.mdx": "2024-11-27T16:33:56.374Z",
"references/promotion/types/promotion.FilterQueryProperties/page.mdx": "2024-11-27T16:33:56.367Z", "references/promotion/types/promotion.FilterQueryProperties/page.mdx": "2024-11-27T16:33:56.367Z",
@@ -3440,7 +3439,43 @@ export const generatedEditDates = {
"references/tax/types/tax.FilterQuery/page.mdx": "2024-11-27T16:33:56.778Z", "references/tax/types/tax.FilterQuery/page.mdx": "2024-11-27T16:33:56.778Z",
"references/types/DAL/types/types.DAL.FilterQuery/page.mdx": "2024-11-27T16:33:39.147Z", "references/types/DAL/types/types.DAL.FilterQuery/page.mdx": "2024-11-27T16:33:39.147Z",
"references/types/DmlTypes/types/types.DmlTypes.InferForeignKeys/page.mdx": "2024-11-27T16:33:39.170Z", "references/types/DmlTypes/types/types.DmlTypes.InferForeignKeys/page.mdx": "2024-11-27T16:33:39.170Z",
"references/types/DmlTypes/types/types.DmlTypes.InferSchemaFields/page.mdx": "2024-11-27T16:33:39.173Z", "references/types/DmlTypes/types/types.DmlTypes.InferSchemaFields/page.mdx": "2024-12-04T18:29:18.340Z",
"references/types/interfaces/types.BaseRepositoryService/page.mdx": "2024-11-27T16:33:39.153Z", "references/types/interfaces/types.BaseRepositoryService/page.mdx": "2024-11-27T16:33:39.153Z",
"app/events-reference/page.mdx": "2024-11-27T13:31:07.385Z" "app/events-reference/page.mdx": "2024-11-27T13:31:07.385Z",
"references/auth_models/variables/auth_models.AuthIdentity/page.mdx": "2024-12-04T18:29:19.888Z",
"references/auth_models/variables/auth_models.ProviderIdentity/page.mdx": "2024-12-04T18:29:19.890Z",
"references/dml/entity/DmlEntity/methods/dml.entity.DmlEntity.checks/page.mdx": "2024-12-04T18:29:31.178Z",
"references/helper_steps/functions/helper_steps.validatePresenceOfStep/page.mdx": "2024-12-04T18:29:31.708Z",
"references/js_sdk/admin/Order/methods/js_sdk.admin.Order.update/page.mdx": "2024-12-04T18:29:32.559Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.registerOrderChange/page.mdx": "2024-12-04T18:29:34.088Z",
"references/order/interfaces/order.RegisterOrderChangeDTO/page.mdx": "2024-12-04T18:29:33.859Z",
"references/order/types/order.OrderChangeType/page.mdx": "2024-12-04T18:29:33.826Z",
"references/pricing/interfaces/pricing.RuleWithOperator/page.mdx": "2024-12-04T18:29:34.575Z",
"references/pricing/types/pricing.PricingRuleOperatorValues/page.mdx": "2024-12-04T18:29:34.568Z",
"references/pricing_models/variables/pricing_models.Price/page.mdx": "2024-12-04T18:29:34.516Z",
"references/pricing_models/variables/pricing_models.PriceList/page.mdx": "2024-12-04T18:29:34.503Z",
"references/pricing_models/variables/pricing_models.PriceListRule/page.mdx": "2024-12-04T18:29:34.499Z",
"references/pricing_models/variables/pricing_models.PricePreference/page.mdx": "2024-12-04T18:29:34.506Z",
"references/pricing_models/variables/pricing_models.PriceRule/page.mdx": "2024-12-04T18:29:34.508Z",
"references/pricing_models/variables/pricing_models.PriceSet/page.mdx": "2024-12-04T18:29:34.511Z",
"references/product_models/variables/product_models.ProductImage/page.mdx": "2024-12-04T18:29:34.682Z",
"references/types/DmlTypes/types/types.DmlTypes.CheckConstraint/page.mdx": "2024-12-04T18:29:18.347Z",
"references/types/DmlTypes/types/types.DmlTypes.InferCheckConstraintsProperties/page.mdx": "2024-12-04T18:29:18.346Z",
"references/types/DmlTypes/types/types.DmlTypes.InferSchemaProperties/page.mdx": "2024-12-04T18:29:18.341Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateOrder/page.mdx": "2024-12-04T18:29:18.781Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.OrderAddress/page.mdx": "2024-12-04T18:29:18.784Z",
"references/types/WorkflowTypes/OrderWorkflow/types/types.WorkflowTypes.OrderWorkflow.UpdateOrderShippingAddressWorkflowInput/page.mdx": "2024-12-04T18:29:19.681Z",
"references/types/WorkflowTypes/OrderWorkflow/types/types.WorkflowTypes.OrderWorkflow.UpdateOrderWorkflowInput/page.mdx": "2024-12-04T18:29:19.680Z",
"references/user_models/variables/user_models.Invite/page.mdx": "2024-12-04T18:29:35.550Z",
"references/user_models/variables/user_models.User/page.mdx": "2024-12-04T18:29:35.551Z",
"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",
"references/utils/utils.PricingUtils/page.mdx": "2024-12-04T18:29:19.805Z",
"references/modules/auth_models/page.mdx": "2024-12-04T18:29:19.886Z",
"references/modules/user_models/page.mdx": "2024-12-04T18:29:35.548Z",
"references/order/interfaces/order.CreateOrderChangeActionDTO/page.mdx": "2024-12-04T18:29:33.860Z",
"references/types/DmlTypes/types/types.DmlTypes.EntityIndex/page.mdx": "2024-12-04T18:29:18.347Z",
"references/types/DmlTypes/types/types.DmlTypes.InferIndexableProperties/page.mdx": "2024-12-04T18:29:18.345Z",
"references/types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx": "2024-12-04T18:29:19.628Z"
} }
+100 -32
View File
@@ -1420,12 +1420,12 @@ export const filesMap = [
"pathname": "/references/auth/types/auth.RawMessageFormat" "pathname": "/references/auth/types/auth.RawMessageFormat"
}, },
{ {
"filePath": "/www/apps/resources/references/auth_models/classes/auth_models.AuthIdentity/page.mdx", "filePath": "/www/apps/resources/references/auth_models/variables/auth_models.AuthIdentity/page.mdx",
"pathname": "/references/auth_models/classes/auth_models.AuthIdentity" "pathname": "/references/auth_models/variables/auth_models.AuthIdentity"
}, },
{ {
"filePath": "/www/apps/resources/references/auth_models/classes/auth_models.ProviderIdentity/page.mdx", "filePath": "/www/apps/resources/references/auth_models/variables/auth_models.ProviderIdentity/page.mdx",
"pathname": "/references/auth_models/classes/auth_models.ProviderIdentity" "pathname": "/references/auth_models/variables/auth_models.ProviderIdentity"
}, },
{ {
"filePath": "/www/apps/resources/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx", "filePath": "/www/apps/resources/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx",
@@ -7947,6 +7947,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/dml/dml.Relationship_Methods/page.mdx", "filePath": "/www/apps/resources/references/dml/dml.Relationship_Methods/page.mdx",
"pathname": "/references/dml/dml.Relationship_Methods" "pathname": "/references/dml/dml.Relationship_Methods"
}, },
{
"filePath": "/www/apps/resources/references/dml/entity/DmlEntity/methods/dml.entity.DmlEntity.checks/page.mdx",
"pathname": "/references/dml/entity/DmlEntity/methods/dml.entity.DmlEntity.checks"
},
{ {
"filePath": "/www/apps/resources/references/dml/entity/DmlEntity/methods/dml.entity.DmlEntity.isDmlEntity/page.mdx", "filePath": "/www/apps/resources/references/dml/entity/DmlEntity/methods/dml.entity.DmlEntity.isDmlEntity/page.mdx",
"pathname": "/references/dml/entity/DmlEntity/methods/dml.entity.DmlEntity.isDmlEntity" "pathname": "/references/dml/entity/DmlEntity/methods/dml.entity.DmlEntity.isDmlEntity"
@@ -8851,6 +8855,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/helper_steps/functions/helper_steps.useRemoteQueryStep/page.mdx", "filePath": "/www/apps/resources/references/helper_steps/functions/helper_steps.useRemoteQueryStep/page.mdx",
"pathname": "/references/helper_steps/functions/helper_steps.useRemoteQueryStep" "pathname": "/references/helper_steps/functions/helper_steps.useRemoteQueryStep"
}, },
{
"filePath": "/www/apps/resources/references/helper_steps/functions/helper_steps.validatePresenceOfStep/page.mdx",
"pathname": "/references/helper_steps/functions/helper_steps.validatePresenceOfStep"
},
{ {
"filePath": "/www/apps/resources/references/helper_steps/interfaces/helper_steps.EntryStepInput/page.mdx", "filePath": "/www/apps/resources/references/helper_steps/interfaces/helper_steps.EntryStepInput/page.mdx",
"pathname": "/references/helper_steps/interfaces/helper_steps.EntryStepInput" "pathname": "/references/helper_steps/interfaces/helper_steps.EntryStepInput"
@@ -9979,6 +9987,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.retrievePreview/page.mdx", "filePath": "/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.retrievePreview/page.mdx",
"pathname": "/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.retrievePreview" "pathname": "/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.retrievePreview"
}, },
{
"filePath": "/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.update/page.mdx",
"pathname": "/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.update"
},
{ {
"filePath": "/www/apps/resources/references/js_sdk/admin/Order/properties/js_sdk.admin.Order.client/page.mdx", "filePath": "/www/apps/resources/references/js_sdk/admin/Order/properties/js_sdk.admin.Order.client/page.mdx",
"pathname": "/references/js_sdk/admin/Order/properties/js_sdk.admin.Order.client" "pathname": "/references/js_sdk/admin/Order/properties/js_sdk.admin.Order.client"
@@ -11831,6 +11843,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.registerFulfillment/page.mdx", "filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.registerFulfillment/page.mdx",
"pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.registerFulfillment" "pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.registerFulfillment"
}, },
{
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.registerOrderChange/page.mdx",
"pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.registerOrderChange"
},
{ {
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.registerShipment/page.mdx", "filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.registerShipment/page.mdx",
"pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.registerShipment" "pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.registerShipment"
@@ -12371,6 +12387,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/order/interfaces/order.ReceiveOrderReturnDTO/page.mdx", "filePath": "/www/apps/resources/references/order/interfaces/order.ReceiveOrderReturnDTO/page.mdx",
"pathname": "/references/order/interfaces/order.ReceiveOrderReturnDTO" "pathname": "/references/order/interfaces/order.ReceiveOrderReturnDTO"
}, },
{
"filePath": "/www/apps/resources/references/order/interfaces/order.RegisterOrderChangeDTO/page.mdx",
"pathname": "/references/order/interfaces/order.RegisterOrderChangeDTO"
},
{ {
"filePath": "/www/apps/resources/references/order/interfaces/order.RegisterOrderDeliveryDTO/page.mdx", "filePath": "/www/apps/resources/references/order/interfaces/order.RegisterOrderDeliveryDTO/page.mdx",
"pathname": "/references/order/interfaces/order.RegisterOrderDeliveryDTO" "pathname": "/references/order/interfaces/order.RegisterOrderDeliveryDTO"
@@ -12571,6 +12591,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/order/types/order.OrderChangeStatus/page.mdx", "filePath": "/www/apps/resources/references/order/types/order.OrderChangeStatus/page.mdx",
"pathname": "/references/order/types/order.OrderChangeStatus" "pathname": "/references/order/types/order.OrderChangeStatus"
}, },
{
"filePath": "/www/apps/resources/references/order/types/order.OrderChangeType/page.mdx",
"pathname": "/references/order/types/order.OrderChangeType"
},
{ {
"filePath": "/www/apps/resources/references/order/types/order.OrderClaimType/page.mdx", "filePath": "/www/apps/resources/references/order/types/order.OrderClaimType/page.mdx",
"pathname": "/references/order/types/order.OrderClaimType" "pathname": "/references/order/types/order.OrderClaimType"
@@ -13543,6 +13567,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/pricing/interfaces/pricing.RestoreReturn/page.mdx", "filePath": "/www/apps/resources/references/pricing/interfaces/pricing.RestoreReturn/page.mdx",
"pathname": "/references/pricing/interfaces/pricing.RestoreReturn" "pathname": "/references/pricing/interfaces/pricing.RestoreReturn"
}, },
{
"filePath": "/www/apps/resources/references/pricing/interfaces/pricing.RuleWithOperator/page.mdx",
"pathname": "/references/pricing/interfaces/pricing.RuleWithOperator"
},
{ {
"filePath": "/www/apps/resources/references/pricing/interfaces/pricing.SetPriceListRulesDTO/page.mdx", "filePath": "/www/apps/resources/references/pricing/interfaces/pricing.SetPriceListRulesDTO/page.mdx",
"pathname": "/references/pricing/interfaces/pricing.SetPriceListRulesDTO" "pathname": "/references/pricing/interfaces/pricing.SetPriceListRulesDTO"
@@ -13671,6 +13699,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/pricing/types/pricing.PriceListType/page.mdx", "filePath": "/www/apps/resources/references/pricing/types/pricing.PriceListType/page.mdx",
"pathname": "/references/pricing/types/pricing.PriceListType" "pathname": "/references/pricing/types/pricing.PriceListType"
}, },
{
"filePath": "/www/apps/resources/references/pricing/types/pricing.PricingRuleOperatorValues/page.mdx",
"pathname": "/references/pricing/types/pricing.PricingRuleOperatorValues"
},
{ {
"filePath": "/www/apps/resources/references/pricing/types/pricing.Primary/page.mdx", "filePath": "/www/apps/resources/references/pricing/types/pricing.Primary/page.mdx",
"pathname": "/references/pricing/types/pricing.Primary" "pathname": "/references/pricing/types/pricing.Primary"
@@ -13692,28 +13724,28 @@ export const filesMap = [
"pathname": "/references/pricing/types/pricing.Scalar" "pathname": "/references/pricing/types/pricing.Scalar"
}, },
{ {
"filePath": "/www/apps/resources/references/pricing_models/classes/pricing_models.Price/page.mdx", "filePath": "/www/apps/resources/references/pricing_models/variables/pricing_models.Price/page.mdx",
"pathname": "/references/pricing_models/classes/pricing_models.Price" "pathname": "/references/pricing_models/variables/pricing_models.Price"
}, },
{ {
"filePath": "/www/apps/resources/references/pricing_models/classes/pricing_models.PriceList/page.mdx", "filePath": "/www/apps/resources/references/pricing_models/variables/pricing_models.PriceList/page.mdx",
"pathname": "/references/pricing_models/classes/pricing_models.PriceList" "pathname": "/references/pricing_models/variables/pricing_models.PriceList"
}, },
{ {
"filePath": "/www/apps/resources/references/pricing_models/classes/pricing_models.PriceListRule/page.mdx", "filePath": "/www/apps/resources/references/pricing_models/variables/pricing_models.PriceListRule/page.mdx",
"pathname": "/references/pricing_models/classes/pricing_models.PriceListRule" "pathname": "/references/pricing_models/variables/pricing_models.PriceListRule"
}, },
{ {
"filePath": "/www/apps/resources/references/pricing_models/classes/pricing_models.PricePreference/page.mdx", "filePath": "/www/apps/resources/references/pricing_models/variables/pricing_models.PricePreference/page.mdx",
"pathname": "/references/pricing_models/classes/pricing_models.PricePreference" "pathname": "/references/pricing_models/variables/pricing_models.PricePreference"
}, },
{ {
"filePath": "/www/apps/resources/references/pricing_models/classes/pricing_models.PriceRule/page.mdx", "filePath": "/www/apps/resources/references/pricing_models/variables/pricing_models.PriceRule/page.mdx",
"pathname": "/references/pricing_models/classes/pricing_models.PriceRule" "pathname": "/references/pricing_models/variables/pricing_models.PriceRule"
}, },
{ {
"filePath": "/www/apps/resources/references/pricing_models/classes/pricing_models.PriceSet/page.mdx", "filePath": "/www/apps/resources/references/pricing_models/variables/pricing_models.PriceSet/page.mdx",
"pathname": "/references/pricing_models/classes/pricing_models.PriceSet" "pathname": "/references/pricing_models/variables/pricing_models.PriceSet"
}, },
{ {
"filePath": "/www/apps/resources/references/product/IMessageAggregator/methods/product.IMessageAggregator.clearMessages/page.mdx", "filePath": "/www/apps/resources/references/product/IMessageAggregator/methods/product.IMessageAggregator.clearMessages/page.mdx",
@@ -14319,10 +14351,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/product/types/product.Scalar/page.mdx", "filePath": "/www/apps/resources/references/product/types/product.Scalar/page.mdx",
"pathname": "/references/product/types/product.Scalar" "pathname": "/references/product/types/product.Scalar"
}, },
{
"filePath": "/www/apps/resources/references/product_models/variables/product_models.Image/page.mdx",
"pathname": "/references/product_models/variables/product_models.Image"
},
{ {
"filePath": "/www/apps/resources/references/product_models/variables/product_models.Product/page.mdx", "filePath": "/www/apps/resources/references/product_models/variables/product_models.Product/page.mdx",
"pathname": "/references/product_models/variables/product_models.Product" "pathname": "/references/product_models/variables/product_models.Product"
@@ -14335,6 +14363,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductCollection/page.mdx", "filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductCollection/page.mdx",
"pathname": "/references/product_models/variables/product_models.ProductCollection" "pathname": "/references/product_models/variables/product_models.ProductCollection"
}, },
{
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductImage/page.mdx",
"pathname": "/references/product_models/variables/product_models.ProductImage"
},
{ {
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductOption/page.mdx", "filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductOption/page.mdx",
"pathname": "/references/product_models/variables/product_models.ProductOption" "pathname": "/references/product_models/variables/product_models.ProductOption"
@@ -16243,6 +16275,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/DmlTypes/interfaces/types.DmlTypes.IDmlEntity/page.mdx", "filePath": "/www/apps/resources/references/types/DmlTypes/interfaces/types.DmlTypes.IDmlEntity/page.mdx",
"pathname": "/references/types/DmlTypes/interfaces/types.DmlTypes.IDmlEntity" "pathname": "/references/types/DmlTypes/interfaces/types.DmlTypes.IDmlEntity"
}, },
{
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.CheckConstraint/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.CheckConstraint"
},
{ {
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.DMLSchema/page.mdx", "filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.DMLSchema/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.DMLSchema" "pathname": "/references/types/DmlTypes/types/types.DmlTypes.DMLSchema"
@@ -16271,6 +16307,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferBelongsToFields/page.mdx", "filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferBelongsToFields/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.InferBelongsToFields" "pathname": "/references/types/DmlTypes/types/types.DmlTypes.InferBelongsToFields"
}, },
{
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferCheckConstraintsProperties/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.InferCheckConstraintsProperties"
},
{ {
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferDmlEntityNameFromConfig/page.mdx", "filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferDmlEntityNameFromConfig/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.InferDmlEntityNameFromConfig" "pathname": "/references/types/DmlTypes/types/types.DmlTypes.InferDmlEntityNameFromConfig"
@@ -16303,6 +16343,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferSchemaFields/page.mdx", "filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferSchemaFields/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.InferSchemaFields" "pathname": "/references/types/DmlTypes/types/types.DmlTypes.InferSchemaFields"
}, },
{
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferSchemaProperties/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.InferSchemaProperties"
},
{ {
"filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferTypeOf/page.mdx", "filePath": "/www/apps/resources/references/types/DmlTypes/types/types.DmlTypes.InferTypeOf/page.mdx",
"pathname": "/references/types/DmlTypes/types/types.DmlTypes.InferTypeOf" "pathname": "/references/types/DmlTypes/types/types.DmlTypes.InferTypeOf"
@@ -17847,6 +17891,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateInventoryLevel/page.mdx", "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateInventoryLevel/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateInventoryLevel" "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateInventoryLevel"
}, },
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateOrder/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateOrder"
},
{ {
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateOrderEditItem/page.mdx", "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateOrderEditItem/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateOrderEditItem" "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateOrderEditItem"
@@ -18047,6 +18095,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.InventoryLevel/page.mdx", "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.InventoryLevel/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.InventoryLevel" "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.InventoryLevel"
}, },
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.OrderAddress/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.OrderAddress"
},
{ {
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.PromotionRuleResponse/page.mdx", "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.PromotionRuleResponse/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.PromotionRuleResponse" "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.PromotionRuleResponse"
@@ -19443,6 +19495,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/WorkflowTypes/OrderWorkflow/types/types.WorkflowTypes.OrderWorkflow.DeclineTransferOrderRequestWorkflowInput/page.mdx", "filePath": "/www/apps/resources/references/types/WorkflowTypes/OrderWorkflow/types/types.WorkflowTypes.OrderWorkflow.DeclineTransferOrderRequestWorkflowInput/page.mdx",
"pathname": "/references/types/WorkflowTypes/OrderWorkflow/types/types.WorkflowTypes.OrderWorkflow.DeclineTransferOrderRequestWorkflowInput" "pathname": "/references/types/WorkflowTypes/OrderWorkflow/types/types.WorkflowTypes.OrderWorkflow.DeclineTransferOrderRequestWorkflowInput"
}, },
{
"filePath": "/www/apps/resources/references/types/WorkflowTypes/OrderWorkflow/types/types.WorkflowTypes.OrderWorkflow.UpdateOrderShippingAddressWorkflowInput/page.mdx",
"pathname": "/references/types/WorkflowTypes/OrderWorkflow/types/types.WorkflowTypes.OrderWorkflow.UpdateOrderShippingAddressWorkflowInput"
},
{
"filePath": "/www/apps/resources/references/types/WorkflowTypes/OrderWorkflow/types/types.WorkflowTypes.OrderWorkflow.UpdateOrderWorkflowInput/page.mdx",
"pathname": "/references/types/WorkflowTypes/OrderWorkflow/types/types.WorkflowTypes.OrderWorkflow.UpdateOrderWorkflowInput"
},
{ {
"filePath": "/www/apps/resources/references/types/WorkflowTypes/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListDTO/page.mdx", "filePath": "/www/apps/resources/references/types/WorkflowTypes/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListDTO/page.mdx",
"pathname": "/references/types/WorkflowTypes/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListDTO" "pathname": "/references/types/WorkflowTypes/PriceListWorkflow/interfaces/types.WorkflowTypes.PriceListWorkflow.CreatePriceListDTO"
@@ -21196,12 +21256,12 @@ export const filesMap = [
"pathname": "/references/user/types/user.RawMessageFormat" "pathname": "/references/user/types/user.RawMessageFormat"
}, },
{ {
"filePath": "/www/apps/resources/references/user_models/classes/user_models.Invite/page.mdx", "filePath": "/www/apps/resources/references/user_models/variables/user_models.Invite/page.mdx",
"pathname": "/references/user_models/classes/user_models.Invite" "pathname": "/references/user_models/variables/user_models.Invite"
}, },
{ {
"filePath": "/www/apps/resources/references/user_models/classes/user_models.User/page.mdx", "filePath": "/www/apps/resources/references/user_models/variables/user_models.User/page.mdx",
"pathname": "/references/user_models/classes/user_models.User" "pathname": "/references/user_models/variables/user_models.User"
}, },
{ {
"filePath": "/www/apps/resources/references/utils/FulfillmentUtils/enums/utils.FulfillmentUtils.GeoZoneType/page.mdx", "filePath": "/www/apps/resources/references/utils/FulfillmentUtils/enums/utils.FulfillmentUtils.GeoZoneType/page.mdx",
@@ -21243,6 +21303,18 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/utils/OrderUtils/enums/utils.OrderUtils.ReturnStatus/page.mdx", "filePath": "/www/apps/resources/references/utils/OrderUtils/enums/utils.OrderUtils.ReturnStatus/page.mdx",
"pathname": "/references/utils/OrderUtils/enums/utils.OrderUtils.ReturnStatus" "pathname": "/references/utils/OrderUtils/enums/utils.OrderUtils.ReturnStatus"
}, },
{
"filePath": "/www/apps/resources/references/utils/PricingUtils/enums/utils.PricingUtils.PriceListStatus/page.mdx",
"pathname": "/references/utils/PricingUtils/enums/utils.PricingUtils.PriceListStatus"
},
{
"filePath": "/www/apps/resources/references/utils/PricingUtils/enums/utils.PricingUtils.PriceListType/page.mdx",
"pathname": "/references/utils/PricingUtils/enums/utils.PricingUtils.PriceListType"
},
{
"filePath": "/www/apps/resources/references/utils/PricingUtils/enums/utils.PricingUtils.PricingRuleOperator/page.mdx",
"pathname": "/references/utils/PricingUtils/enums/utils.PricingUtils.PricingRuleOperator"
},
{ {
"filePath": "/www/apps/resources/references/utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx", "filePath": "/www/apps/resources/references/utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx",
"pathname": "/references/utils/ProductUtils/enums/utils.ProductUtils.ProductStatus" "pathname": "/references/utils/ProductUtils/enums/utils.ProductUtils.ProductStatus"
@@ -21307,14 +21379,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/utils/enums/utils.PaymentWebhookEvents/page.mdx", "filePath": "/www/apps/resources/references/utils/enums/utils.PaymentWebhookEvents/page.mdx",
"pathname": "/references/utils/enums/utils.PaymentWebhookEvents" "pathname": "/references/utils/enums/utils.PaymentWebhookEvents"
}, },
{
"filePath": "/www/apps/resources/references/utils/enums/utils.PriceListStatus/page.mdx",
"pathname": "/references/utils/enums/utils.PriceListStatus"
},
{
"filePath": "/www/apps/resources/references/utils/enums/utils.PriceListType/page.mdx",
"pathname": "/references/utils/enums/utils.PriceListType"
},
{ {
"filePath": "/www/apps/resources/references/utils/interfaces/utils.Argument/page.mdx", "filePath": "/www/apps/resources/references/utils/interfaces/utils.Argument/page.mdx",
"pathname": "/references/utils/interfaces/utils.Argument" "pathname": "/references/utils/interfaces/utils.Argument"
@@ -21351,6 +21415,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/utils/utils.OrderUtils/page.mdx", "filePath": "/www/apps/resources/references/utils/utils.OrderUtils/page.mdx",
"pathname": "/references/utils/utils.OrderUtils" "pathname": "/references/utils/utils.OrderUtils"
}, },
{
"filePath": "/www/apps/resources/references/utils/utils.PricingUtils/page.mdx",
"pathname": "/references/utils/utils.PricingUtils"
},
{ {
"filePath": "/www/apps/resources/references/utils/utils.ProductUtils/page.mdx", "filePath": "/www/apps/resources/references/utils/utils.ProductUtils/page.mdx",
"pathname": "/references/utils/utils.ProductUtils" "pathname": "/references/utils/utils.ProductUtils"
+27 -11
View File
@@ -641,7 +641,7 @@ export const generatedSidebar = [
"isPathHref": true, "isPathHref": true,
"type": "category", "type": "category",
"title": "Data Models", "title": "Data Models",
"autogenerate_path": "/references/auth_models/classes", "autogenerate_path": "/references/auth_models/variables",
"children": [ "children": [
{ {
"loaded": true, "loaded": true,
@@ -3574,6 +3574,14 @@ export const generatedSidebar = [
"title": "registerFulfillment", "title": "registerFulfillment",
"children": [] "children": []
}, },
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/order/registerOrderChange",
"title": "registerOrderChange",
"children": []
},
{ {
"loaded": true, "loaded": true,
"isPathHref": true, "isPathHref": true,
@@ -5188,7 +5196,7 @@ export const generatedSidebar = [
"type": "category", "type": "category",
"title": "Data Models", "title": "Data Models",
"hasTitleStyling": true, "hasTitleStyling": true,
"autogenerate_path": "/references/pricing_models/classes", "autogenerate_path": "/references/pricing_models/variables",
"children": [ "children": [
{ {
"loaded": true, "loaded": true,
@@ -5921,14 +5929,6 @@ export const generatedSidebar = [
"hasTitleStyling": true, "hasTitleStyling": true,
"autogenerate_path": "/references/product_models/variables", "autogenerate_path": "/references/product_models/variables",
"children": [ "children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/product/models/Image",
"title": "Image",
"children": []
},
{ {
"loaded": true, "loaded": true,
"isPathHref": true, "isPathHref": true,
@@ -5953,6 +5953,14 @@ export const generatedSidebar = [
"title": "ProductCollection", "title": "ProductCollection",
"children": [] "children": []
}, },
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/product/models/ProductImage",
"title": "ProductImage",
"children": []
},
{ {
"loaded": true, "loaded": true,
"isPathHref": true, "isPathHref": true,
@@ -7697,7 +7705,7 @@ export const generatedSidebar = [
"type": "category", "type": "category",
"title": "Data Models", "title": "Data Models",
"hasTitleStyling": true, "hasTitleStyling": true,
"autogenerate_path": "/references/user_models/classes", "autogenerate_path": "/references/user_models/variables",
"children": [ "children": [
{ {
"loaded": true, "loaded": true,
@@ -9917,6 +9925,14 @@ export const generatedSidebar = [
"path": "/references/helper-steps/useRemoteQueryStep", "path": "/references/helper-steps/useRemoteQueryStep",
"title": "useRemoteQueryStep", "title": "useRemoteQueryStep",
"children": [] "children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/helper-steps/validatePresenceOfStep",
"title": "validatePresenceOfStep",
"children": []
} }
] ]
}, },
+35 -25
View File
@@ -135,14 +135,14 @@ export const slugChanges = [
"filePath": "/www/apps/resources/references/auth/interfaces/auth.IAuthModuleService/page.mdx" "filePath": "/www/apps/resources/references/auth/interfaces/auth.IAuthModuleService/page.mdx"
}, },
{ {
"origSlug": "/references/auth_models/classes/auth_models.AuthIdentity", "origSlug": "/references/auth_models/variables/auth_models.AuthIdentity",
"newSlug": "/references/auth/models/AuthIdentity", "newSlug": "/references/auth/models/AuthIdentity",
"filePath": "/www/apps/resources/references/auth_models/classes/auth_models.AuthIdentity/page.mdx" "filePath": "/www/apps/resources/references/auth_models/variables/auth_models.AuthIdentity/page.mdx"
}, },
{ {
"origSlug": "/references/auth_models/classes/auth_models.ProviderIdentity", "origSlug": "/references/auth_models/variables/auth_models.ProviderIdentity",
"newSlug": "/references/auth/models/ProviderIdentity", "newSlug": "/references/auth/models/ProviderIdentity",
"filePath": "/www/apps/resources/references/auth_models/classes/auth_models.ProviderIdentity/page.mdx" "filePath": "/www/apps/resources/references/auth_models/variables/auth_models.ProviderIdentity/page.mdx"
}, },
{ {
"origSlug": "/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider", "origSlug": "/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider",
@@ -3889,6 +3889,11 @@ export const slugChanges = [
"newSlug": "/references/helper-steps/useRemoteQueryStep", "newSlug": "/references/helper-steps/useRemoteQueryStep",
"filePath": "/www/apps/resources/references/helper_steps/functions/helper_steps.useRemoteQueryStep/page.mdx" "filePath": "/www/apps/resources/references/helper_steps/functions/helper_steps.useRemoteQueryStep/page.mdx"
}, },
{
"origSlug": "/references/helper_steps/functions/helper_steps.validatePresenceOfStep",
"newSlug": "/references/helper-steps/validatePresenceOfStep",
"filePath": "/www/apps/resources/references/helper_steps/functions/helper_steps.validatePresenceOfStep/page.mdx"
},
{ {
"origSlug": "/references/inventory_next/IInventoryService/methods/inventory_next.IInventoryService.adjustInventory", "origSlug": "/references/inventory_next/IInventoryService/methods/inventory_next.IInventoryService.adjustInventory",
"newSlug": "/references/inventory-next/adjustInventory", "newSlug": "/references/inventory-next/adjustInventory",
@@ -4869,6 +4874,11 @@ export const slugChanges = [
"newSlug": "/references/order/registerFulfillment", "newSlug": "/references/order/registerFulfillment",
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.registerFulfillment/page.mdx" "filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.registerFulfillment/page.mdx"
}, },
{
"origSlug": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.registerOrderChange",
"newSlug": "/references/order/registerOrderChange",
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.registerOrderChange/page.mdx"
},
{ {
"origSlug": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.registerShipment", "origSlug": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.registerShipment",
"newSlug": "/references/order/registerShipment", "newSlug": "/references/order/registerShipment",
@@ -5700,34 +5710,34 @@ export const slugChanges = [
"filePath": "/www/apps/resources/references/pricing/interfaces/pricing.IPricingModuleService/page.mdx" "filePath": "/www/apps/resources/references/pricing/interfaces/pricing.IPricingModuleService/page.mdx"
}, },
{ {
"origSlug": "/references/pricing_models/classes/pricing_models.Price", "origSlug": "/references/pricing_models/variables/pricing_models.Price",
"newSlug": "/references/pricing/models/Price", "newSlug": "/references/pricing/models/Price",
"filePath": "/www/apps/resources/references/pricing_models/classes/pricing_models.Price/page.mdx" "filePath": "/www/apps/resources/references/pricing_models/variables/pricing_models.Price/page.mdx"
}, },
{ {
"origSlug": "/references/pricing_models/classes/pricing_models.PriceList", "origSlug": "/references/pricing_models/variables/pricing_models.PriceList",
"newSlug": "/references/pricing/models/PriceList", "newSlug": "/references/pricing/models/PriceList",
"filePath": "/www/apps/resources/references/pricing_models/classes/pricing_models.PriceList/page.mdx" "filePath": "/www/apps/resources/references/pricing_models/variables/pricing_models.PriceList/page.mdx"
}, },
{ {
"origSlug": "/references/pricing_models/classes/pricing_models.PriceListRule", "origSlug": "/references/pricing_models/variables/pricing_models.PriceListRule",
"newSlug": "/references/pricing/models/PriceListRule", "newSlug": "/references/pricing/models/PriceListRule",
"filePath": "/www/apps/resources/references/pricing_models/classes/pricing_models.PriceListRule/page.mdx" "filePath": "/www/apps/resources/references/pricing_models/variables/pricing_models.PriceListRule/page.mdx"
}, },
{ {
"origSlug": "/references/pricing_models/classes/pricing_models.PricePreference", "origSlug": "/references/pricing_models/variables/pricing_models.PricePreference",
"newSlug": "/references/pricing/models/PricePreference", "newSlug": "/references/pricing/models/PricePreference",
"filePath": "/www/apps/resources/references/pricing_models/classes/pricing_models.PricePreference/page.mdx" "filePath": "/www/apps/resources/references/pricing_models/variables/pricing_models.PricePreference/page.mdx"
}, },
{ {
"origSlug": "/references/pricing_models/classes/pricing_models.PriceRule", "origSlug": "/references/pricing_models/variables/pricing_models.PriceRule",
"newSlug": "/references/pricing/models/PriceRule", "newSlug": "/references/pricing/models/PriceRule",
"filePath": "/www/apps/resources/references/pricing_models/classes/pricing_models.PriceRule/page.mdx" "filePath": "/www/apps/resources/references/pricing_models/variables/pricing_models.PriceRule/page.mdx"
}, },
{ {
"origSlug": "/references/pricing_models/classes/pricing_models.PriceSet", "origSlug": "/references/pricing_models/variables/pricing_models.PriceSet",
"newSlug": "/references/pricing/models/PriceSet", "newSlug": "/references/pricing/models/PriceSet",
"filePath": "/www/apps/resources/references/pricing_models/classes/pricing_models.PriceSet/page.mdx" "filePath": "/www/apps/resources/references/pricing_models/variables/pricing_models.PriceSet/page.mdx"
}, },
{ {
"origSlug": "/references/product/IProductModuleService/methods/product.IProductModuleService.createProductCategories", "origSlug": "/references/product/IProductModuleService/methods/product.IProductModuleService.createProductCategories",
@@ -6084,11 +6094,6 @@ export const slugChanges = [
"newSlug": "/references/product", "newSlug": "/references/product",
"filePath": "/www/apps/resources/references/product/interfaces/product.IProductModuleService/page.mdx" "filePath": "/www/apps/resources/references/product/interfaces/product.IProductModuleService/page.mdx"
}, },
{
"origSlug": "/references/product_models/variables/product_models.Image",
"newSlug": "/references/product/models/Image",
"filePath": "/www/apps/resources/references/product_models/variables/product_models.Image/page.mdx"
},
{ {
"origSlug": "/references/product_models/variables/product_models.Product", "origSlug": "/references/product_models/variables/product_models.Product",
"newSlug": "/references/product/models/Product", "newSlug": "/references/product/models/Product",
@@ -6104,6 +6109,11 @@ export const slugChanges = [
"newSlug": "/references/product/models/ProductCollection", "newSlug": "/references/product/models/ProductCollection",
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductCollection/page.mdx" "filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductCollection/page.mdx"
}, },
{
"origSlug": "/references/product_models/variables/product_models.ProductImage",
"newSlug": "/references/product/models/ProductImage",
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductImage/page.mdx"
},
{ {
"origSlug": "/references/product_models/variables/product_models.ProductOption", "origSlug": "/references/product_models/variables/product_models.ProductOption",
"newSlug": "/references/product/models/ProductOption", "newSlug": "/references/product/models/ProductOption",
@@ -6795,14 +6805,14 @@ export const slugChanges = [
"filePath": "/www/apps/resources/references/user/interfaces/user.IUserModuleService/page.mdx" "filePath": "/www/apps/resources/references/user/interfaces/user.IUserModuleService/page.mdx"
}, },
{ {
"origSlug": "/references/user_models/classes/user_models.Invite", "origSlug": "/references/user_models/variables/user_models.Invite",
"newSlug": "/references/user/models/Invite", "newSlug": "/references/user/models/Invite",
"filePath": "/www/apps/resources/references/user_models/classes/user_models.Invite/page.mdx" "filePath": "/www/apps/resources/references/user_models/variables/user_models.Invite/page.mdx"
}, },
{ {
"origSlug": "/references/user_models/classes/user_models.User", "origSlug": "/references/user_models/variables/user_models.User",
"newSlug": "/references/user/models/User", "newSlug": "/references/user/models/User",
"filePath": "/www/apps/resources/references/user_models/classes/user_models.User/page.mdx" "filePath": "/www/apps/resources/references/user_models/variables/user_models.User/page.mdx"
}, },
{ {
"origSlug": "/references/workflows/functions/workflows.createHook", "origSlug": "/references/workflows/functions/workflows.createHook",
@@ -1,13 +0,0 @@
---
displayed_sidebar: authModelReference
slug: /references/auth/models/AuthIdentity
sidebar_label: AuthIdentity
---
import { TypeList } from "docs-ui"
# AuthIdentity - Auth Module Data Models Reference
This documentation provides a reference to the AuthIdentity . This belongs to the Auth Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"Collection&#60;[ProviderIdentity](../auth_models.ProviderIdentity/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity","type":"[AuthIdentity](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"Collection&#60;[ProviderIdentity](../auth_models.ProviderIdentity/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"app_metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"user_metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"app_metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="AuthIdentity"/>
@@ -1,13 +0,0 @@
---
displayed_sidebar: authModelReference
slug: /references/auth/models/ProviderIdentity
sidebar_label: ProviderIdentity
---
import { TypeList } from "docs-ui"
# ProviderIdentity - Auth Module Data Models Reference
This documentation provides a reference to the ProviderIdentity . This belongs to the Auth Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity","type":"[AuthIdentity](../auth_models.AuthIdentity/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"Collection&#60;[ProviderIdentity](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity","type":"[AuthIdentity](../auth_models.AuthIdentity/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user_metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"app_metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"user_metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProviderIdentity"/>
@@ -0,0 +1,13 @@
---
displayed_sidebar: authModelReference
slug: /references/auth/models/AuthIdentity
sidebar_label: AuthIdentity
---
import { TypeList } from "docs-ui"
# AuthIdentity - Auth Module Data Models Reference
This documentation provides a reference to the AuthIdentity data model. It belongs to the Auth Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the auth identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"HasMany&#60;[ProviderIdentity](../auth_models.ProviderIdentity/page.mdx)&#62;","description":"The associated `ProviderIdentity` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","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&#60;[AuthIdentity](page.mdx)&#62;","description":"The associated `AuthIdentity`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the auth identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"HasMany&#60;[ProviderIdentity](../auth_models.ProviderIdentity/page.mdx)&#62;","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/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="AuthIdentity"/>
@@ -0,0 +1,13 @@
---
displayed_sidebar: authModelReference
slug: /references/auth/models/ProviderIdentity
sidebar_label: ProviderIdentity
---
import { TypeList } from "docs-ui"
# ProviderIdentity - Auth Module Data Models Reference
This documentation provides a reference to the ProviderIdentity data model. It belongs to the Auth Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","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&#60;[AuthIdentity](../auth_models.AuthIdentity/page.mdx)&#62;","description":"The associated `AuthIdentity`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the auth identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"HasMany&#60;[ProviderIdentity](page.mdx)&#62;","description":"The associated `ProviderIdentity` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","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&#60;[AuthIdentity](../auth_models.AuthIdentity/page.mdx)&#62;","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/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProviderIdentity"/>
@@ -17,7 +17,7 @@ This workflow updates one or more shipping options.
## Input ## Input
<TypeList types={[{"name":"UpdateShippingOptionsWorkflowInput[]","type":"[UpdateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateShippingOptionsWorkflowInput","type":"[UpdateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../../../fulfillment/types/fulfillment.ShippingOptionPriceType/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"prices","type":"(`object` \\| `object`)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[RuleOperatorType](../../../../../types/CommonTypes/types/types.CommonTypes.RuleOperatorType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateShippingOptionsWorkflow"/> <TypeList types={[{"name":"UpdateShippingOptionsWorkflowInput[]","type":"[UpdateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateShippingOptionsWorkflowInput","type":"[UpdateShippingOptionsWorkflowInput](../../../../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../../../fulfillment/types/fulfillment.ShippingOptionPriceType/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"prices","type":"(`object` \\| `object`)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PriceRule](../../../../../pricing_models/variables/pricing_models.PriceRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PriceRule](../../../../../pricing_models/variables/pricing_models.PriceRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[RuleOperatorType](../../../../../types/CommonTypes/types/types.CommonTypes.RuleOperatorType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateShippingOptionsWorkflow"/>
## Output ## Output
@@ -262,7 +262,7 @@ This workflow updates one or more shipping options.
### Input ### Input
<TypeList types={[{"name":"UpdateShippingOptionsWorkflowInput[]","type":"[UpdateShippingOptionsWorkflowInput](../../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateShippingOptionsWorkflowInput","type":"[UpdateShippingOptionsWorkflowInput](../../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../fulfillment/types/fulfillment.ShippingOptionPriceType/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"prices","type":"(`object` \\| `object`)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[RuleOperatorType](../../../types/CommonTypes/types/types.CommonTypes.RuleOperatorType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateShippingOptionsWorkflow"/> <TypeList types={[{"name":"UpdateShippingOptionsWorkflowInput[]","type":"[UpdateShippingOptionsWorkflowInput](../../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateShippingOptionsWorkflowInput","type":"[UpdateShippingOptionsWorkflowInput](../../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../fulfillment/types/fulfillment.ShippingOptionPriceType/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"prices","type":"(`object` \\| `object`)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PriceRule](../../../pricing_models/variables/pricing_models.PriceRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PriceRule](../../../pricing_models/variables/pricing_models.PriceRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[RuleOperatorType](../../../types/CommonTypes/types/types.CommonTypes.RuleOperatorType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateShippingOptionsWorkflow"/>
### Output ### Output
@@ -13,7 +13,7 @@ This step creates an order change.
## Input ## Input
<TypeList types={[{"name":"CreateOrderChangeDTO","type":"[CreateOrderChangeDTO](../../../../../order/interfaces/order.CreateOrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"`\"return_request\"` \\| `\"return_receive\"` \\| `\"exchange\"` \\| `\"claim\"` \\| `\"edit\"` \\| `\"transfer\"`","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../../../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandabLine truncated <TypeList types={[{"name":"CreateOrderChangeDTO","type":"[CreateOrderChangeDTO](../../../../../order/interfaces/order.CreateOrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"[OrderChangeType](../../../../../order/types/order.OrderChangeType/page.mdx)","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../../../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNLine truncated
## Output ## Output
@@ -13,7 +13,7 @@ This workflow creates order change actions.
## Input ## Input
<TypeList types={[{"name":"CreateOrderChangeActionDTO[]","type":"[CreateOrderChangeActionDTO](../../../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateOrderChangeActionDTO","type":"[CreateOrderChangeActionDTO](../../../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The data of the order change action to be created.","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderChangeActionsWorkflow"/> <TypeList types={[{"name":"CreateOrderChangeActionDTO[]","type":"[CreateOrderChangeActionDTO](../../../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateOrderChangeActionDTO","type":"[CreateOrderChangeActionDTO](../../../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The data of the order change action to be created.","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"applied","type":"`boolean`","description":"Whether the action has been applied.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderChangeActionsWorkflow"/>
## Output ## Output
@@ -17,7 +17,7 @@ This workflow creates an order change.
## Input ## Input
<TypeList types={[{"name":"CreateOrderChangeDTO","type":"[CreateOrderChangeDTO](../../../../../order/interfaces/order.CreateOrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"`\"return_request\"` \\| `\"return_receive\"` \\| `\"exchange\"` \\| `\"claim\"` \\| `\"edit\"` \\| `\"transfer\"`","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../../../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandabLine truncated <TypeList types={[{"name":"CreateOrderChangeDTO","type":"[CreateOrderChangeDTO](../../../../../order/interfaces/order.CreateOrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"[OrderChangeType](../../../../../order/types/order.OrderChangeType/page.mdx)","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../../../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNLine truncated
## Output ## Output
@@ -165,7 +165,7 @@ This step creates an order change.
### Input ### Input
<TypeList types={[{"name":"CreateOrderChangeDTO","type":"[CreateOrderChangeDTO](../../../order/interfaces/order.CreateOrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"`\"return_request\"` \\| `\"return_receive\"` \\| `\"exchange\"` \\| `\"claim\"` \\| `\"edit\"` \\| `\"transfer\"`","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"biLine truncated <TypeList types={[{"name":"CreateOrderChangeDTO","type":"[CreateOrderChangeDTO](../../../order/interfaces/order.CreateOrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"[OrderChangeType](../../../order/types/order.OrderChangeType/page.mdx)","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":Line truncated
### Output ### Output
@@ -906,7 +906,7 @@ This workflow creates order change actions.
### Input ### Input
<TypeList types={[{"name":"CreateOrderChangeActionDTO[]","type":"[CreateOrderChangeActionDTO](../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateOrderChangeActionDTO","type":"[CreateOrderChangeActionDTO](../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The data of the order change action to be created.","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderChangeActionsWorkflow"/> <TypeList types={[{"name":"CreateOrderChangeActionDTO[]","type":"[CreateOrderChangeActionDTO](../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateOrderChangeActionDTO","type":"[CreateOrderChangeActionDTO](../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The data of the order change action to be created.","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"applied","type":"`boolean`","description":"Whether the action has been applied.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderChangeActionsWorkflow"/>
### Output ### Output
@@ -924,7 +924,7 @@ This workflow creates an order change.
### Input ### Input
<TypeList types={[{"name":"CreateOrderChangeDTO","type":"[CreateOrderChangeDTO](../../../order/interfaces/order.CreateOrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"`\"return_request\"` \\| `\"return_receive\"` \\| `\"exchange\"` \\| `\"claim\"` \\| `\"edit\"` \\| `\"transfer\"`","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"biLine truncated <TypeList types={[{"name":"CreateOrderChangeDTO","type":"[CreateOrderChangeDTO](../../../order/interfaces/order.CreateOrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"[OrderChangeType](../../../order/types/order.OrderChangeType/page.mdx)","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":Line truncated
### Output ### Output
@@ -230,7 +230,7 @@ This step creates an order change.
### Input ### Input
<TypeList types={[{"name":"CreateOrderChangeDTO","type":"[CreateOrderChangeDTO](../../order/interfaces/order.CreateOrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"`\"return_request\"` \\| `\"return_receive\"` \\| `\"exchange\"` \\| `\"claim\"` \\| `\"edit\"` \\| `\"transfer\"`","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`Line truncated <TypeList types={[{"name":"CreateOrderChangeDTO","type":"[CreateOrderChangeDTO](../../order/interfaces/order.CreateOrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"[OrderChangeType](../../order/types/order.OrderChangeType/page.mdx)","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"dLine truncated
### Output ### Output
@@ -303,7 +303,7 @@ This workflow updates one or more shipping options.
### Input ### Input
<TypeList types={[{"name":"UpdateShippingOptionsWorkflowInput[]","type":"[UpdateShippingOptionsWorkflowInput](../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateShippingOptionsWorkflowInput","type":"[UpdateShippingOptionsWorkflowInput](../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../fulfillment/types/fulfillment.ShippingOptionPriceType/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"prices","type":"(`object` \\| `object`)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[RuleOperatorType](../../types/CommonTypes/types/types.CommonTypes.RuleOperatorType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateShippingOptionsWorkflow"/> <TypeList types={[{"name":"UpdateShippingOptionsWorkflowInput[]","type":"[UpdateShippingOptionsWorkflowInput](../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateShippingOptionsWorkflowInput","type":"[UpdateShippingOptionsWorkflowInput](../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../fulfillment/types/fulfillment.ShippingOptionPriceType/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"prices","type":"(`object` \\| `object`)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PriceRule](../../pricing_models/variables/pricing_models.PriceRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PriceRule](../../pricing_models/variables/pricing_models.PriceRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[RuleOperatorType](../../types/CommonTypes/types/types.CommonTypes.RuleOperatorType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateShippingOptionsWorkflow"/>
### Output ### Output
@@ -1560,7 +1560,7 @@ This workflow creates order change actions.
### Input ### Input
<TypeList types={[{"name":"CreateOrderChangeActionDTO[]","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateOrderChangeActionDTO","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The data of the order change action to be created.","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderChangeActionsWorkflow"/> <TypeList types={[{"name":"CreateOrderChangeActionDTO[]","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateOrderChangeActionDTO","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The data of the order change action to be created.","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"applied","type":"`boolean`","description":"Whether the action has been applied.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderChangeActionsWorkflow"/>
### Output ### Output
@@ -1578,7 +1578,7 @@ This workflow creates an order change.
### Input ### Input
<TypeList types={[{"name":"CreateOrderChangeDTO","type":"[CreateOrderChangeDTO](../../order/interfaces/order.CreateOrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"`\"return_request\"` \\| `\"return_receive\"` \\| `\"exchange\"` \\| `\"claim\"` \\| `\"edit\"` \\| `\"transfer\"`","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`Line truncated <TypeList types={[{"name":"CreateOrderChangeDTO","type":"[CreateOrderChangeDTO](../../order/interfaces/order.CreateOrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"[OrderChangeType](../../order/types/order.OrderChangeType/page.mdx)","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"dLine truncated
### Output ### Output
@@ -78,4 +78,4 @@ In this example, the index is created when the value of `age` doesn't equal `30`
## Parameters ## Parameters
<TypeList types={[{"name":"indexes","type":"[EntityIndex](../../../../types/DmlTypes/types/types.DmlTypes.EntityIndex/page.mdx)&#60;Schema, string \\| [QueryCondition](../../../../types/DmlTypes/types/types.DmlTypes.QueryCondition/page.mdx)&#60;Schema&#62;&#62;[]","description":"The index's configuration.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"on","type":"[InferIndexableProperties](../../../../types/DmlTypes/types/types.DmlTypes.InferIndexableProperties/page.mdx)&#60;[IDmlEntity](../../../../types/DmlTypes/interfaces/types.DmlTypes.IDmlEntity/page.mdx)&#60;TSchema, any&#62;&#62;[]","description":"The list of properties to create the index on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the index. If not provided,\nMedusa generates the name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"unique","type":"`boolean`","description":"When enabled, a unique index is created on the specified\nproperties.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"where","type":"TWhere","description":"Conditions to restrict which records are indexed.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="indexes"/> <TypeList types={[{"name":"indexes","type":"[EntityIndex](../../../../types/DmlTypes/types/types.DmlTypes.EntityIndex/page.mdx)&#60;Schema, string \\| [QueryCondition](../../../../types/DmlTypes/types/types.DmlTypes.QueryCondition/page.mdx)&#60;Schema&#62;&#62;[]","description":"The index's configuration.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"on","type":"[InferIndexableProperties](../../../../types/DmlTypes/types/types.DmlTypes.InferIndexableProperties/page.mdx)&#60;Schema&#62;[]","description":"The list of properties to create the index on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the index. If not provided,\nMedusa generates the name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"unique","type":"`boolean`","description":"When enabled, a unique index is created on the specified\nproperties.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"where","type":"Where","description":"Conditions to restrict which records are indexed.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="indexes"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# checks
## Parameters
<TypeList types={[{"name":"checks","type":"[CheckConstraint](../../../../../types/DmlTypes/types/types.DmlTypes.CheckConstraint/page.mdx)&#60;Schema&#62;[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expression","type":"`string` \\| (`columns`: [InferCheckConstraintsProperties](../../../../../types/DmlTypes/types/types.DmlTypes.InferCheckConstraintsProperties/page.mdx)&#60;Schema&#62;) => `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"property","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="checks"/>
@@ -16,6 +16,7 @@ name, its schema and relationships.
## Methods ## Methods
- [cascades](../../../Model_Methods/methods/dml.Model_Methods.cascades/page.mdx) - [cascades](../../../Model_Methods/methods/dml.Model_Methods.cascades/page.mdx)
- [checks](../../DmlEntity/methods/dml.entity.DmlEntity.checks/page.mdx)
- [indexes](../../../Model_Methods/methods/dml.Model_Methods.indexes/page.mdx) - [indexes](../../../Model_Methods/methods/dml.Model_Methods.indexes/page.mdx)
- [isDmlEntity](../../DmlEntity/methods/dml.entity.DmlEntity.isDmlEntity/page.mdx) - [isDmlEntity](../../DmlEntity/methods/dml.entity.DmlEntity.isDmlEntity/page.mdx)
- [parse](../../DmlEntity/methods/dml.entity.DmlEntity.parse/page.mdx) - [parse](../../DmlEntity/methods/dml.entity.DmlEntity.parse/page.mdx)
@@ -6,6 +6,6 @@ import { TypeList } from "docs-ui"
# ChangeActionType # ChangeActionType
**ChangeActionType**: `"CANCEL_RETURN_ITEM"` \| `"FULFILL_ITEM"` \| `"DELIVER_ITEM"` \| `"CANCEL_ITEM_FULFILLMENT"` \| `"ITEM_ADD"` \| `"ITEM_REMOVE"` \| `"ITEM_UPDATE"` \| `"RECEIVE_DAMAGED_RETURN_ITEM"` \| `"RECEIVE_RETURN_ITEM"` \| `"RETURN_ITEM"` \| `"SHIPPING_ADD"` \| `"SHIPPING_REMOVE"` \| `"SHIP_ITEM"` \| `"WRITE_OFF_ITEM"` \| `"REINSTATE_ITEM"` \| `"TRANSFER_CUSTOMER"` **ChangeActionType**: `"CANCEL_RETURN_ITEM"` \| `"FULFILL_ITEM"` \| `"DELIVER_ITEM"` \| `"CANCEL_ITEM_FULFILLMENT"` \| `"ITEM_ADD"` \| `"ITEM_REMOVE"` \| `"ITEM_UPDATE"` \| `"RECEIVE_DAMAGED_RETURN_ITEM"` \| `"RECEIVE_RETURN_ITEM"` \| `"RETURN_ITEM"` \| `"SHIPPING_ADD"` \| `"SHIPPING_REMOVE"` \| `"SHIP_ITEM"` \| `"WRITE_OFF_ITEM"` \| `"REINSTATE_ITEM"` \| `"TRANSFER_CUSTOMER"` \| `"UPDATE_ORDER_PROPERTIES"`
The change action's type. The change action's type.
@@ -0,0 +1,16 @@
---
slug: /references/helper-steps/validatePresenceOfStep
sidebar_label: validatePresenceOfStep
---
import { TypeList } from "docs-ui"
# validatePresenceOfStep - Helper Steps API Reference
This documentation provides a reference to the `validatePresenceOfStep` step. It belongs to the `@medusajs/medusa/core-flows` package.
This step validates the presence of attributes on an object
## Input
<TypeList types={[{"name":"entity","type":"`Record<any, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validatePresenceOfStep"/>
@@ -49,6 +49,41 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
___ ___
## update
This method updates an order. It sends a request to the
[Update Order Email](https://docs.medusajs.com/api/admin#orders\_postordersid)
API route.
### Example
```ts
sdk.admin.order.update(
"order_123",
{
email: "new_email@example.com",
shipping_address: {
first_name: "John",
last_name: "Doe",
address_1: "123 Main St",
}
}
)
.then(({ order }) => {
console.log(order)
})
```
### Parameters
<TypeList types={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminUpdateOrder](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateOrder/page.mdx)","description":"The update details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"email","type":"`string`","description":"The order's email.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[OrderAddress](../../../../../types/HttpTypes/interfaces/types.HttpTypes.OrderAddress/page.mdx)","description":"The order's shipping address.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address","type":"[OrderAddress](../../../../../types/HttpTypes/interfaces/types.HttpTypes.OrderAddress/page.mdx)","description":"The order's billing address.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"headers","type":"[ClientHeaders](../../../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":[]}]}]} expandUrlLine truncated
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminOrderResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The order's details.","expandable":false,"children":[{"name":"AdminOrderResponse","type":"[AdminOrderResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order","type":"[AdminOrder](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrder/page.mdx)","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"payment_collections","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)[]","description":"The order's payment collections.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx)[]","description":"The order's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx)[]","description":"The order's shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The order's version.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The ID of the associated region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel the order was placed in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The order's currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../../../../types/types/types.PaymentStatus/page.mdx)","description":"The order's payment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../../../../types/types/types.FulfillmentStatus/page.mdx)","description":"The order's fulfillment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"[BaseOrderSummary](../../../../../types/interfaces/types.BaseOrderSummary/page.mdx)","description":"The order's summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"`number`","description":"The total of the order's items including taxes, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"`number`","description":"The tax total applied on the order's items, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"`number`","description":"The total of the order's items including taxes and promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`number`","description":"The tax total applied on the order's items, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`number`","description":"The total of the order including taxes, excluding promotions.","optional":false,"defaLine truncated
___
## retrievePreview ## retrievePreview
This method retrieves the preview of an order based on its last associated change. It sends a request to the This method retrieves the preview of an order based on its last associated change. It sends a request to the
@@ -0,0 +1,34 @@
import { TypeList } from "docs-ui"
# update
This method updates an order. It sends a request to the
[Update Order Email](https://docs.medusajs.com/api/admin#orders\_postordersid)
API route.
## Example
```ts
sdk.admin.order.update(
"order_123",
{
email: "new_email@example.com",
shipping_address: {
first_name: "John",
last_name: "Doe",
address_1: "123 Main St",
}
}
)
.then(({ order }) => {
console.log(order)
})
```
## Parameters
<TypeList types={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminUpdateOrder](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateOrder/page.mdx)","description":"The update details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"email","type":"`string`","description":"The order's email.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[OrderAddress](../../../../../types/HttpTypes/interfaces/types.HttpTypes.OrderAddress/page.mdx)","description":"The order's shipping address.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address","type":"[OrderAddress](../../../../../types/HttpTypes/interfaces/types.HttpTypes.OrderAddress/page.mdx)","description":"The order's billing address.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"headers","type":"[ClientHeaders](../../../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":[]}]}]} expandUrlLine truncated
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminOrderResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The order's details.","expandable":false,"children":[{"name":"AdminOrderResponse","type":"[AdminOrderResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order","type":"[AdminOrder](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrder/page.mdx)","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"payment_collections","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)[]","description":"The order's payment collections.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[AdminOrderLineItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx)[]","description":"The order's items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[AdminOrderShippingMethod](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx)[]","description":"The order's shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The order's version.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The ID of the associated region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel the order was placed in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer that placed the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The order's currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../../../../types/types/types.PaymentStatus/page.mdx)","description":"The order's payment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../../../../types/types/types.FulfillmentStatus/page.mdx)","description":"The order's fulfillment status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"summary","type":"[BaseOrderSummary](../../../../../types/interfaces/types.BaseOrderSummary/page.mdx)","description":"The order's summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"`number`","description":"The total of the order's items including taxes, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"`number`","description":"The tax total applied on the order's items, excluding promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"`number`","description":"The total of the order's items including taxes and promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"`number`","description":"The total of the order's items excluding taxes, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`number`","description":"The tax total applied on the order's items, including promotions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`number`","description":"The total of the order including taxes, excluding promotions.","optional":false,"defaLine truncated
@@ -16,6 +16,7 @@ import { TypeList } from "docs-ui"
- [requestTransfer](../../Order/methods/js_sdk.admin.Order.requestTransfer/page.mdx) - [requestTransfer](../../Order/methods/js_sdk.admin.Order.requestTransfer/page.mdx)
- [retrieve](../../Order/methods/js_sdk.admin.Order.retrieve/page.mdx) - [retrieve](../../Order/methods/js_sdk.admin.Order.retrieve/page.mdx)
- [retrievePreview](../../Order/methods/js_sdk.admin.Order.retrievePreview/page.mdx) - [retrievePreview](../../Order/methods/js_sdk.admin.Order.retrievePreview/page.mdx)
- [update](../../Order/methods/js_sdk.admin.Order.update/page.mdx)
## Properties ## Properties
@@ -4,8 +4,8 @@ import { TypeList } from "docs-ui"
## Type parameters ## Type parameters
<TypeList types={[{"name":"Body","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="MedusaRequest"/> <TypeList types={[{"name":"Body","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"QueryFields","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="MedusaRequest"/>
## Properties ## Properties
<TypeList types={[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../medusa.FindConfig/page.mdx)&#60;unknown&#62;","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[FindConfigOrder](../../types/medusa.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"retrieveConfig","type":"[FindConfig](../medusa.FindConfig/page.mdx)&#60;unknown&#62;","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[FindConfigOrder](../../types/medusa.FindConfigOrder/page.mdx)","description":"An object used to specify how to soLine truncated <TypeList types={[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../medusa.RequestQueryFields/page.mdx) & QueryFields","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../medusa.FindConfig/page.mdx)&#60;unknown&#62;","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[FindConfigOrder](../../types/medusa.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"retrieveConfig","type":"[FindConfig](../medusa.FindConfig/page.mdx)&#60;unknown&#62;","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[FindConfigOrder](../../types/medusa.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returneLine truncated
@@ -6,7 +6,7 @@ import { TypeList } from "docs-ui"
## Parameters ## Parameters
<TypeList types={[{"name":"error","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"req","type":"[MedusaRequest](../../interfaces/medusa.MedusaRequest/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../../interfaces/medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)&#60;unknown&#62;","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retrieveConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)&#60;unknown&#62;","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the req.allowed set\nby the api","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rawBody","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"restrictedFields","type":"[RestrictedFields](../../classes/medusa.RestrictedFields/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingContext","type":"[MedusaPricingContext](../medusa.MedusaPricingContext/page.mdx)","description":"An object that carries the context that is used to calculate prices for variants","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, any>`","description":"A generic context object that can be used across the request lifecycle","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additionalDataValidator","type":"ZodOptional&#60;ZodNullable&#60;ZodObject&#60;any, any, ZodTypeAny, object, object&#62;&#62;&#62;","description":"Custom validator to validate the `additional_data` property in\nrequests that allows for additional\\_data","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"res","type":"[MedusaResponse](../medusa.MedusaResponse/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"[MedusaNextFunction](../medusa.MedusaNextFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/> <TypeList types={[{"name":"error","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"req","type":"[MedusaRequest](../../interfaces/medusa.MedusaRequest/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../../interfaces/medusa.RequestQueryFields/page.mdx) & QueryFields","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)&#60;unknown&#62;","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retrieveConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)&#60;unknown&#62;","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filterableFields","type":"QueryFields","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the req.allowed set\nby the api","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rawBody","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"restrictedFields","type":"[RestrictedFields](../../classes/medusa.RestrictedFields/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingContext","type":"[MedusaPricingContext](../medusa.MedusaPricingContext/page.mdx)","description":"An object that carries the context that is used to calculate prices for variants","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, any>`","description":"A generic context object that can be used across the request lifecycle","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additionalDataValidator","type":"ZodOptional&#60;ZodNullable&#60;ZodObject&#60;any, any, ZodTypeAny, object, object&#62;&#62;&#62;","description":"Custom validator to validate the `additional_data` property in\nrequests that allows for additional\\_data","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"res","type":"[MedusaResponse](../medusa.MedusaResponse/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"[MedusaNextFunction](../medusa.MedusaNextFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
## Returns ## Returns
@@ -10,7 +10,7 @@ import { TypeList } from "docs-ui"
## Parameters ## Parameters
<TypeList types={[{"name":"req","type":"[MedusaRequest](../../interfaces/medusa.MedusaRequest/page.mdx)&#60;Body&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../../interfaces/medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)&#60;unknown&#62;","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retrieveConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)&#60;unknown&#62;","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the req.allowed set\nby the api","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rawBody","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"restrictedFields","type":"[RestrictedFields](../../classes/medusa.RestrictedFields/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingContext","type":"[MedusaPricingContext](../medusa.MedusaPricingContext/page.mdx)","description":"An object that carries the context that is used to calculate prices for variants","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, any>`","description":"A generic context object that can be used across the request lifecycle","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additionalDataValidator","type":"ZodOptional&#60;ZodNullable&#60;ZodObject&#60;any, any, ZodTypeAny, object, object&#62;&#62;&#62;","description":"Custom validator to validate the `additional_data` property in\nrequests that allows for additional\\_data","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"res","type":"[MedusaResponse](../medusa.MedusaResponse/page.mdx)&#60;Res&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"[MedusaNextFunction](../medusa.MedusaNextFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/> <TypeList types={[{"name":"req","type":"[MedusaRequest](../../interfaces/medusa.MedusaRequest/page.mdx)&#60;Body&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../../interfaces/medusa.RequestQueryFields/page.mdx) & QueryFields","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)&#60;unknown&#62;","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retrieveConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)&#60;unknown&#62;","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filterableFields","type":"QueryFields","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the req.allowed set\nby the api","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rawBody","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"restrictedFields","type":"[RestrictedFields](../../classes/medusa.RestrictedFields/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingContext","type":"[MedusaPricingContext](../medusa.MedusaPricingContext/page.mdx)","description":"An object that carries the context that is used to calculate prices for variants","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, any>`","description":"A generic context object that can be used across the request lifecycle","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additionalDataValidator","type":"ZodOptional&#60;ZodNullable&#60;ZodObject&#60;any, any, ZodTypeAny, object, object&#62;&#62;&#62;","description":"Custom validator to validate the `additional_data` property in\nrequests that allows for additional\\_data","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"res","type":"[MedusaResponse](../medusa.MedusaResponse/page.mdx)&#60;Res&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"[MedusaNextFunction](../medusa.MedusaNextFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
## Returns ## Returns
@@ -17,7 +17,7 @@ erDiagram
``` ```
## Classes ## Data Models
- [AuthIdentity](../../auth_models/classes/auth_models.AuthIdentity/page.mdx) - [AuthIdentity](../../auth_models/variables/auth_models.AuthIdentity/page.mdx)
- [ProviderIdentity](../../auth_models/classes/auth_models.ProviderIdentity/page.mdx) - [ProviderIdentity](../../auth_models/variables/auth_models.ProviderIdentity/page.mdx)
@@ -3086,7 +3086,7 @@ This workflow creates order change actions.
#### Input #### Input
<TypeList types={[{"name":"CreateOrderChangeActionDTO[]","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateOrderChangeActionDTO","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The data of the order change action to be created.","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderChangeActionsWorkflow"/> <TypeList types={[{"name":"CreateOrderChangeActionDTO[]","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateOrderChangeActionDTO","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The data of the order change action to be created.","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"applied","type":"`boolean`","description":"Whether the action has been applied.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createOrderChangeActionsWorkflow"/>
#### Output #### Output
@@ -3098,7 +3098,7 @@ This step creates an order change.
#### Input #### Input
<TypeList types={[{"name":"CreateOrderChangeDTO","type":"[CreateOrderChangeDTO](../../order/interfaces/order.CreateOrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"`\"return_request\"` \\| `\"return_receive\"` \\| `\"exchange\"` \\| `\"claim\"` \\| `\"edit\"` \\| `\"transfer\"`","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`Line truncated <TypeList types={[{"name":"CreateOrderChangeDTO","type":"[CreateOrderChangeDTO](../../order/interfaces/order.CreateOrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"[OrderChangeType](../../order/types/order.OrderChangeType/page.mdx)","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"dLine truncated
#### Output #### Output
@@ -3114,7 +3114,7 @@ This workflow creates an order change.
#### Input #### Input
<TypeList types={[{"name":"CreateOrderChangeDTO","type":"[CreateOrderChangeDTO](../../order/interfaces/order.CreateOrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"`\"return_request\"` \\| `\"return_receive\"` \\| `\"exchange\"` \\| `\"claim\"` \\| `\"edit\"` \\| `\"transfer\"`","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`Line truncated <TypeList types={[{"name":"CreateOrderChangeDTO","type":"[CreateOrderChangeDTO](../../order/interfaces/order.CreateOrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"[OrderChangeType](../../order/types/order.OrderChangeType/page.mdx)","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../order/types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../order/interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../order/types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../order/types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"dLine truncated
#### Output #### Output
@@ -8706,7 +8706,7 @@ This workflow updates one or more shipping options.
#### Input #### Input
<TypeList types={[{"name":"UpdateShippingOptionsWorkflowInput[]","type":"[UpdateShippingOptionsWorkflowInput](../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateShippingOptionsWorkflowInput","type":"[UpdateShippingOptionsWorkflowInput](../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../fulfillment/types/fulfillment.ShippingOptionPriceType/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"prices","type":"(`object` \\| `object`)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[RuleOperatorType](../../types/CommonTypes/types/types.CommonTypes.RuleOperatorType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateShippingOptionsWorkflow"/> <TypeList types={[{"name":"UpdateShippingOptionsWorkflowInput[]","type":"[UpdateShippingOptionsWorkflowInput](../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateShippingOptionsWorkflowInput","type":"[UpdateShippingOptionsWorkflowInput](../../types/WorkflowTypes/FulfillmentWorkflow/interfaces/types.WorkflowTypes.FulfillmentWorkflow.UpdateShippingOptionsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../fulfillment/types/fulfillment.ShippingOptionPriceType/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"prices","type":"(`object` \\| `object`)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PriceRule](../../pricing_models/variables/pricing_models.PriceRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PriceRule](../../pricing_models/variables/pricing_models.PriceRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[RuleOperatorType](../../types/CommonTypes/types/types.CommonTypes.RuleOperatorType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateShippingOptionsWorkflow"/>
#### Output #### Output
@@ -17,3 +17,4 @@ This section of the documentation provides a reference to utility steps that you
- [updateRemoteLinksStep](../../helper_steps/functions/helper_steps.updateRemoteLinksStep/page.mdx) - [updateRemoteLinksStep](../../helper_steps/functions/helper_steps.updateRemoteLinksStep/page.mdx)
- [useQueryGraphStep](../../helper_steps/functions/helper_steps.useQueryGraphStep/page.mdx) - [useQueryGraphStep](../../helper_steps/functions/helper_steps.useQueryGraphStep/page.mdx)
- [useRemoteQueryStep](../../helper_steps/functions/helper_steps.useRemoteQueryStep/page.mdx) - [useRemoteQueryStep](../../helper_steps/functions/helper_steps.useRemoteQueryStep/page.mdx)
- [validatePresenceOfStep](../../helper_steps/functions/helper_steps.validatePresenceOfStep/page.mdx)
@@ -83,6 +83,7 @@ import { TypeList } from "docs-ui"
- [OrderTaxLineDTO](../../order/interfaces/order.OrderTaxLineDTO/page.mdx) - [OrderTaxLineDTO](../../order/interfaces/order.OrderTaxLineDTO/page.mdx)
- [OrderTransactionDTO](../../order/interfaces/order.OrderTransactionDTO/page.mdx) - [OrderTransactionDTO](../../order/interfaces/order.OrderTransactionDTO/page.mdx)
- [ReceiveOrderReturnDTO](../../order/interfaces/order.ReceiveOrderReturnDTO/page.mdx) - [ReceiveOrderReturnDTO](../../order/interfaces/order.ReceiveOrderReturnDTO/page.mdx)
- [RegisterOrderChangeDTO](../../order/interfaces/order.RegisterOrderChangeDTO/page.mdx)
- [RegisterOrderDeliveryDTO](../../order/interfaces/order.RegisterOrderDeliveryDTO/page.mdx) - [RegisterOrderDeliveryDTO](../../order/interfaces/order.RegisterOrderDeliveryDTO/page.mdx)
- [RegisterOrderFulfillmentDTO](../../order/interfaces/order.RegisterOrderFulfillmentDTO/page.mdx) - [RegisterOrderFulfillmentDTO](../../order/interfaces/order.RegisterOrderFulfillmentDTO/page.mdx)
- [RegisterOrderShipmentDTO](../../order/interfaces/order.RegisterOrderShipmentDTO/page.mdx) - [RegisterOrderShipmentDTO](../../order/interfaces/order.RegisterOrderShipmentDTO/page.mdx)
@@ -136,6 +137,7 @@ import { TypeList } from "docs-ui"
- [ModuleJoinerRelationship](../../order/types/order.ModuleJoinerRelationship/page.mdx) - [ModuleJoinerRelationship](../../order/types/order.ModuleJoinerRelationship/page.mdx)
- [OperatorMap](../../order/types/order.OperatorMap/page.mdx) - [OperatorMap](../../order/types/order.OperatorMap/page.mdx)
- [OrderChangeStatus](../../order/types/order.OrderChangeStatus/page.mdx) - [OrderChangeStatus](../../order/types/order.OrderChangeStatus/page.mdx)
- [OrderChangeType](../../order/types/order.OrderChangeType/page.mdx)
- [OrderClaimType](../../order/types/order.OrderClaimType/page.mdx) - [OrderClaimType](../../order/types/order.OrderClaimType/page.mdx)
- [OrderStatus](../../order/types/order.OrderStatus/page.mdx) - [OrderStatus](../../order/types/order.OrderStatus/page.mdx)
- [PrevLimit](../../order/types/order.PrevLimit/page.mdx) - [PrevLimit](../../order/types/order.PrevLimit/page.mdx)
@@ -45,6 +45,7 @@ import { TypeList } from "docs-ui"
- [PricingFilters](../../pricing/interfaces/pricing.PricingFilters/page.mdx) - [PricingFilters](../../pricing/interfaces/pricing.PricingFilters/page.mdx)
- [RemovePriceListRulesDTO](../../pricing/interfaces/pricing.RemovePriceListRulesDTO/page.mdx) - [RemovePriceListRulesDTO](../../pricing/interfaces/pricing.RemovePriceListRulesDTO/page.mdx)
- [RestoreReturn](../../pricing/interfaces/pricing.RestoreReturn/page.mdx) - [RestoreReturn](../../pricing/interfaces/pricing.RestoreReturn/page.mdx)
- [RuleWithOperator](../../pricing/interfaces/pricing.RuleWithOperator/page.mdx)
- [SetPriceListRulesDTO](../../pricing/interfaces/pricing.SetPriceListRulesDTO/page.mdx) - [SetPriceListRulesDTO](../../pricing/interfaces/pricing.SetPriceListRulesDTO/page.mdx)
- [SoftDeleteReturn](../../pricing/interfaces/pricing.SoftDeleteReturn/page.mdx) - [SoftDeleteReturn](../../pricing/interfaces/pricing.SoftDeleteReturn/page.mdx)
- [UpdateMoneyAmountDTO](../../pricing/interfaces/pricing.UpdateMoneyAmountDTO/page.mdx) - [UpdateMoneyAmountDTO](../../pricing/interfaces/pricing.UpdateMoneyAmountDTO/page.mdx)
@@ -80,6 +81,7 @@ import { TypeList } from "docs-ui"
- [PrevLimit](../../pricing/types/pricing.PrevLimit/page.mdx) - [PrevLimit](../../pricing/types/pricing.PrevLimit/page.mdx)
- [PriceListStatus](../../pricing/types/pricing.PriceListStatus/page.mdx) - [PriceListStatus](../../pricing/types/pricing.PriceListStatus/page.mdx)
- [PriceListType](../../pricing/types/pricing.PriceListType/page.mdx) - [PriceListType](../../pricing/types/pricing.PriceListType/page.mdx)
- [PricingRuleOperatorValues](../../pricing/types/pricing.PricingRuleOperatorValues/page.mdx)
- [Primary](../../pricing/types/pricing.Primary/page.mdx) - [Primary](../../pricing/types/pricing.Primary/page.mdx)
- [Query](../../pricing/types/pricing.Query/page.mdx) - [Query](../../pricing/types/pricing.Query/page.mdx)
- [RawMessageFormat](../../pricing/types/pricing.RawMessageFormat/page.mdx) - [RawMessageFormat](../../pricing/types/pricing.RawMessageFormat/page.mdx)
@@ -13,18 +13,18 @@ This documentation provides a reference to the data models in the Pricing Module
```mermaid ```mermaid
erDiagram erDiagram
Price }|--|{ PriceSet : price_set
Price ||--|| PriceRule : price_rules Price ||--|| PriceRule : price_rules
Price }|--|{ PriceList : price_list PriceList ||--|| Price : prices
PriceList ||--|| PriceListRule : price_list_rules PriceList ||--|| PriceListRule : price_list_rules
PriceSet ||--|| Price : prices
``` ```
## Classes ## Data Models
- [Price](../../pricing_models/classes/pricing_models.Price/page.mdx) - [Price](../../pricing_models/variables/pricing_models.Price/page.mdx)
- [PriceList](../../pricing_models/classes/pricing_models.PriceList/page.mdx) - [PriceList](../../pricing_models/variables/pricing_models.PriceList/page.mdx)
- [PriceListRule](../../pricing_models/classes/pricing_models.PriceListRule/page.mdx) - [PriceListRule](../../pricing_models/variables/pricing_models.PriceListRule/page.mdx)
- [PricePreference](../../pricing_models/classes/pricing_models.PricePreference/page.mdx) - [PricePreference](../../pricing_models/variables/pricing_models.PricePreference/page.mdx)
- [PriceRule](../../pricing_models/classes/pricing_models.PriceRule/page.mdx) - [PriceRule](../../pricing_models/variables/pricing_models.PriceRule/page.mdx)
- [PriceSet](../../pricing_models/classes/pricing_models.PriceSet/page.mdx) - [PriceSet](../../pricing_models/variables/pricing_models.PriceSet/page.mdx)
@@ -16,7 +16,7 @@ erDiagram
Product ||--|| ProductVariant : variants Product ||--|| ProductVariant : variants
Product }|--|{ ProductTag : tags Product }|--|{ ProductTag : tags
Product ||--|| ProductOption : options Product ||--|| ProductOption : options
Product ||--|| Image : images Product ||--|| ProductImage : images
Product }|--|{ ProductCategory : categories Product }|--|{ ProductCategory : categories
ProductCollection ||--|| Product : products ProductCollection ||--|| Product : products
ProductOption ||--|| ProductOptionValue : values ProductOption ||--|| ProductOptionValue : values
@@ -27,10 +27,10 @@ erDiagram
## Data Models ## Data Models
- [Image](../../product_models/variables/product_models.Image/page.mdx)
- [Product](../../product_models/variables/product_models.Product/page.mdx) - [Product](../../product_models/variables/product_models.Product/page.mdx)
- [ProductCategory](../../product_models/variables/product_models.ProductCategory/page.mdx) - [ProductCategory](../../product_models/variables/product_models.ProductCategory/page.mdx)
- [ProductCollection](../../product_models/variables/product_models.ProductCollection/page.mdx) - [ProductCollection](../../product_models/variables/product_models.ProductCollection/page.mdx)
- [ProductImage](../../product_models/variables/product_models.ProductImage/page.mdx)
- [ProductOption](../../product_models/variables/product_models.ProductOption/page.mdx) - [ProductOption](../../product_models/variables/product_models.ProductOption/page.mdx)
- [ProductOptionValue](../../product_models/variables/product_models.ProductOptionValue/page.mdx) - [ProductOptionValue](../../product_models/variables/product_models.ProductOptionValue/page.mdx)
- [ProductTag](../../product_models/variables/product_models.ProductTag/page.mdx) - [ProductTag](../../product_models/variables/product_models.ProductTag/page.mdx)
@@ -9,7 +9,7 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the data models in the User Module This documentation provides a reference to the data models in the User Module
## Classes ## Data Models
- [Invite](../../user_models/classes/user_models.Invite/page.mdx) - [Invite](../../user_models/variables/user_models.Invite/page.mdx)
- [User](../../user_models/classes/user_models.User/page.mdx) - [User](../../user_models/variables/user_models.User/page.mdx)
@@ -9,8 +9,6 @@ import { TypeList } from "docs-ui"
- [PaymentCollectionStatus](../../utils/enums/utils.PaymentCollectionStatus/page.mdx) - [PaymentCollectionStatus](../../utils/enums/utils.PaymentCollectionStatus/page.mdx)
- [PaymentSessionStatus](../../utils/enums/utils.PaymentSessionStatus/page.mdx) - [PaymentSessionStatus](../../utils/enums/utils.PaymentSessionStatus/page.mdx)
- [PaymentWebhookEvents](../../utils/enums/utils.PaymentWebhookEvents/page.mdx) - [PaymentWebhookEvents](../../utils/enums/utils.PaymentWebhookEvents/page.mdx)
- [PriceListStatus](../../utils/enums/utils.PriceListStatus/page.mdx)
- [PriceListType](../../utils/enums/utils.PriceListType/page.mdx)
## Interfaces ## Interfaces
@@ -26,6 +24,7 @@ import { TypeList } from "docs-ui"
- [InventoryUtils](../../utils/utils.InventoryUtils/page.mdx) - [InventoryUtils](../../utils/utils.InventoryUtils/page.mdx)
- [LinkUtils](../../utils/utils.LinkUtils/page.mdx) - [LinkUtils](../../utils/utils.LinkUtils/page.mdx)
- [OrderUtils](../../utils/utils.OrderUtils/page.mdx) - [OrderUtils](../../utils/utils.OrderUtils/page.mdx)
- [PricingUtils](../../utils/utils.PricingUtils/page.mdx)
- [ProductUtils](../../utils/utils.ProductUtils/page.mdx) - [ProductUtils](../../utils/utils.ProductUtils/page.mdx)
- [PromotionUtils](../../utils/utils.PromotionUtils/page.mdx) - [PromotionUtils](../../utils/utils.PromotionUtils/page.mdx)
- [ShippingProfileUtils](../../utils/utils.ShippingProfileUtils/page.mdx) - [ShippingProfileUtils](../../utils/utils.ShippingProfileUtils/page.mdx)
@@ -37,7 +36,6 @@ import { TypeList } from "docs-ui"
- [MedusaModuleType](page.mdx#medusamoduletype) - [MedusaModuleType](page.mdx#medusamoduletype)
- [NotificationEvents](page.mdx#notificationevents) - [NotificationEvents](page.mdx#notificationevents)
- [PaymentEvents](page.mdx#paymentevents) - [PaymentEvents](page.mdx#paymentevents)
- [PricingEvents](page.mdx#pricingevents)
___ ___
@@ -62,7 +60,3 @@ ___
#### Properties #### Properties
<TypeList types={[{"name":"CAPTURED","type":"`string`","description":"","optional":false,"defaultValue":"\"payment.captured\"","expandable":false,"children":[]},{"name":"REFUNDED","type":"`string`","description":"","optional":false,"defaultValue":"\"payment.refunded\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="PaymentEvents"/> <TypeList types={[{"name":"CAPTURED","type":"`string`","description":"","optional":false,"defaultValue":"\"payment.captured\"","expandable":false,"children":[]},{"name":"REFUNDED","type":"`string`","description":"","optional":false,"defaultValue":"\"payment.refunded\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="PaymentEvents"/>
### PricingEvents
`Const` **PricingEvents**: ReturnType&#60;["priceListRule", "priceList", "priceRule", "priceSet", "price"]&#62;
@@ -32,7 +32,7 @@ const orderChangeAction = await orderModuleService.addOrderAction({
### Parameters ### Parameters
<TypeList types={[{"name":"data","type":"[CreateOrderChangeActionDTO](../../../interfaces/order.CreateOrderChangeActionDTO/page.mdx)","description":"The action to be added to an order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/order.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":"messageAggreLine truncated <TypeList types={[{"name":"data","type":"[CreateOrderChangeActionDTO](../../../interfaces/order.CreateOrderChangeActionDTO/page.mdx)","description":"The action to be added to an order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"applied","type":"`boolean`","description":"Whether the action has been applied.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/order.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`","dLine truncated
### Returns ### Returns
@@ -54,7 +54,7 @@ const orderChangeActions = await orderModuleService.addOrderAction([{
### Parameters ### Parameters
<TypeList types={[{"name":"data","type":"[CreateOrderChangeActionDTO](../../../interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The order change actions to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/order.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":"messagLine truncated <TypeList types={[{"name":"data","type":"[CreateOrderChangeActionDTO](../../../interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The order change actions to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"applied","type":"`boolean`","description":"Whether the action has been applied.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/order.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":"`strinLine truncated
### Returns ### Returns
@@ -30,7 +30,7 @@ const orderChange = await orderModuleService.createOrderChange({
### Parameters ### Parameters
<TypeList types={[{"name":"data","type":"[CreateOrderChangeDTO](../../../interfaces/order.CreateOrderChangeDTO/page.mdx)","description":"The order change to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"`\"return_request\"` \\| `\"return_receive\"` \\| `\"exchange\"` \\| `\"claim\"` \\| `\"edit\"` \\| `\"transfer\"`","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../../../interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/order.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between theLine truncated <TypeList types={[{"name":"data","type":"[CreateOrderChangeDTO](../../../interfaces/order.CreateOrderChangeDTO/page.mdx)","description":"The order change to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"[OrderChangeType](../../../types/order.OrderChangeType/page.mdx)","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../../../interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"applied","type":"`boolean`","description":"Whether the action has been applied.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/order.CLine truncated
### Returns ### Returns
@@ -52,7 +52,7 @@ const orderChanges = await orderModuleService.createOrderChange([
### Parameters ### Parameters
<TypeList types={[{"name":"data","type":"[CreateOrderChangeDTO](../../../interfaces/order.CreateOrderChangeDTO/page.mdx)[]","description":"The order changes to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"`\"return_request\"` \\| `\"return_receive\"` \\| `\"exchange\"` \\| `\"claim\"` \\| `\"edit\"` \\| `\"transfer\"`","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../../../interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/order.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between Line truncated <TypeList types={[{"name":"data","type":"[CreateOrderChangeDTO](../../../interfaces/order.CreateOrderChangeDTO/page.mdx)[]","description":"The order changes to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"[OrderChangeType](../../../types/order.OrderChangeType/page.mdx)","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../../../interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"applied","type":"`boolean`","description":"Whether the action has been applied.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/ordeLine truncated
### Returns ### Returns
@@ -74,7 +74,7 @@ const orderChanges = await orderModuleService.createOrderChange([
### Parameters ### Parameters
<TypeList types={[{"name":"data","type":"[CreateOrderChangeDTO](../../../interfaces/order.CreateOrderChangeDTO/page.mdx) \\| [CreateOrderChangeDTO](../../../interfaces/order.CreateOrderChangeDTO/page.mdx)[]","description":"The order changes to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"`\"return_request\"` \\| `\"return_receive\"` \\| `\"exchange\"` \\| `\"claim\"` \\| `\"edit\"` \\| `\"transfer\"`","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../../../interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":trLine truncated <TypeList types={[{"name":"data","type":"[CreateOrderChangeDTO](../../../interfaces/order.CreateOrderChangeDTO/page.mdx) \\| [CreateOrderChangeDTO](../../../interfaces/order.CreateOrderChangeDTO/page.mdx)[]","description":"The order changes to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"[OrderChangeType](../../../types/order.OrderChangeType/page.mdx)","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../../../interfaces/order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../../types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../../../interfaces/order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children"Line truncated
### Returns ### Returns
@@ -0,0 +1,59 @@
---
displayed_sidebar: orderReference
slug: /references/order/registerOrderChange
sidebar_label: registerOrderChange
---
import { TypeList } from "docs-ui"
# registerOrderChange - Order Module Reference
This documentation provides a reference to the `registerOrderChange` method. This belongs to the Order Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>
## registerOrderChange(data, sharedContext?): Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)&#62;
This method registers an order change.
### Example
```ts
await orderModuleService.registerOrderChange({
order_id: "123",
details: Record<string, unknown>
})
```
### Parameters
<TypeList types={[{"name":"data","type":"[RegisterOrderChangeDTO](../../../interfaces/order.RegisterOrderChangeDTO/page.mdx)","description":"The register order change details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"[OrderChangeType](../../../types/order.OrderChangeType/page.mdx)","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The user or customer that confirmed the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this change\nreferences. For example, `shipping_address`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the data model's record referenced.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/order.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":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/order.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":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="registerOrderChange"/>
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The item and shipping method changes made on the order.","expandable":false,"children":[{"name":"OrderChangeDTO","type":"[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"The order change details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../interfaces/order.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"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](../../../types/order.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](../../../types/order.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../types/order.BigNumberValue/page.mdx)","description":"The subtotal oLine truncated
## registerOrderChange(data, sharedContext?): Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)[]&#62;
This method registers order changes.
### Example
```ts
await orderModuleService.registerOrderChange({
order_id: "123",
details: Record<string, unknown>
})
```
### Parameters
<TypeList types={[{"name":"data","type":"[RegisterOrderChangeDTO](../../../interfaces/order.RegisterOrderChangeDTO/page.mdx)[]","description":"The register order changes details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"[OrderChangeType](../../../types/order.OrderChangeType/page.mdx)","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The user or customer that confirmed the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this change\nreferences. For example, `shipping_address`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the data model's record referenced.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/order.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":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/order.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":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="registerOrderChange"/>
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The item and shipping method changes made on the orders.","expandable":false,"children":[{"name":"OrderChangeDTO[]","type":"[OrderChangeDTO](../../../interfaces/order.OrderChangeDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderChangeDTO","type":"`object`","description":"The order change details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="registerOrderChange"/>
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
The data of the order change action to be created. The data of the order change action to be created.
<TypeList types={[{"name":"action","type":"[ChangeActionType](../../types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CreateOrderChangeActionDTO"/> <TypeList types={[{"name":"action","type":"[ChangeActionType](../../types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"applied","type":"`boolean`","description":"Whether the action has been applied.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CreateOrderChangeActionDTO"/>
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
The data of the order change to be created. The data of the order change to be created.
<TypeList types={[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"`\"return_request\"` \\| `\"return_receive\"` \\| `\"exchange\"` \\| `\"claim\"` \\| `\"edit\"` \\| `\"transfer\"`","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changedLine truncated <TypeList types={[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"[OrderChangeType](../../types/order.OrderChangeType/page.mdx)","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The user or customer that requested the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date that the order change was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"actions","type":"[CreateOrderChangeActionDTO](../order.CreateOrderChangeActionDTO/page.mdx)[]","description":"The actions of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"action","type":"[ChangeActionType](../../types/order.ChangeActionType/page.mdx)","description":"The type of action.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`string`","description":"The associated order change's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change action.\nOnce the order change action is confirmed, this\nbecomes the order's version.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record references of the data model\nspecified in [reference](../order.CreateOrderChangeActionDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the `reference_id`\nis the ID of the return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../types/order.BigNumberInput/page.mdx)","description":"The amount of the order change action.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/order.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action.\n\nThis could include the returned items or their changed\nquantity, based on the type of this action.","optioLine truncated
@@ -93,6 +93,7 @@ The main service interface for the Order Module.
- [receiveReturn](../../IOrderModuleService/methods/order.IOrderModuleService.receiveReturn/page.mdx) - [receiveReturn](../../IOrderModuleService/methods/order.IOrderModuleService.receiveReturn/page.mdx)
- [registerDelivery](../../IOrderModuleService/methods/order.IOrderModuleService.registerDelivery/page.mdx) - [registerDelivery](../../IOrderModuleService/methods/order.IOrderModuleService.registerDelivery/page.mdx)
- [registerFulfillment](../../IOrderModuleService/methods/order.IOrderModuleService.registerFulfillment/page.mdx) - [registerFulfillment](../../IOrderModuleService/methods/order.IOrderModuleService.registerFulfillment/page.mdx)
- [registerOrderChange](../../IOrderModuleService/methods/order.IOrderModuleService.registerOrderChange/page.mdx)
- [registerShipment](../../IOrderModuleService/methods/order.IOrderModuleService.registerShipment/page.mdx) - [registerShipment](../../IOrderModuleService/methods/order.IOrderModuleService.registerShipment/page.mdx)
- [restoreOrderAddresses](../../IOrderModuleService/methods/order.IOrderModuleService.restoreOrderAddresses/page.mdx) - [restoreOrderAddresses](../../IOrderModuleService/methods/order.IOrderModuleService.restoreOrderAddresses/page.mdx)
- [restoreOrderChangeActions](../../IOrderModuleService/methods/order.IOrderModuleService.restoreOrderChangeActions/page.mdx) - [restoreOrderChangeActions](../../IOrderModuleService/methods/order.IOrderModuleService.restoreOrderChangeActions/page.mdx)
@@ -0,0 +1,11 @@
---
displayed_sidebar: orderReference
---
import { TypeList } from "docs-ui"
# RegisterOrderChangeDTO
The details of the order change registration.
<TypeList types={[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"[OrderChangeType](../../types/order.OrderChangeType/page.mdx)","description":"The type of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`null` \\| `string`","description":"The internal note of the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The user that created the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The user or customer that confirmed the order change.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"`Record<string, unknown>`","description":"The details of the order change action","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model that this change\nreferences. For example, `shipping_address`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the data model's record referenced.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="RegisterOrderChangeDTO"/>
@@ -6,6 +6,6 @@ import { TypeList } from "docs-ui"
# ChangeActionType # ChangeActionType
**ChangeActionType**: `"CANCEL_RETURN_ITEM"` \| `"FULFILL_ITEM"` \| `"DELIVER_ITEM"` \| `"CANCEL_ITEM_FULFILLMENT"` \| `"ITEM_ADD"` \| `"ITEM_REMOVE"` \| `"ITEM_UPDATE"` \| `"RECEIVE_DAMAGED_RETURN_ITEM"` \| `"RECEIVE_RETURN_ITEM"` \| `"RETURN_ITEM"` \| `"SHIPPING_ADD"` \| `"SHIPPING_REMOVE"` \| `"SHIP_ITEM"` \| `"WRITE_OFF_ITEM"` \| `"REINSTATE_ITEM"` \| `"TRANSFER_CUSTOMER"` **ChangeActionType**: `"CANCEL_RETURN_ITEM"` \| `"FULFILL_ITEM"` \| `"DELIVER_ITEM"` \| `"CANCEL_ITEM_FULFILLMENT"` \| `"ITEM_ADD"` \| `"ITEM_REMOVE"` \| `"ITEM_UPDATE"` \| `"RECEIVE_DAMAGED_RETURN_ITEM"` \| `"RECEIVE_RETURN_ITEM"` \| `"RETURN_ITEM"` \| `"SHIPPING_ADD"` \| `"SHIPPING_REMOVE"` \| `"SHIP_ITEM"` \| `"WRITE_OFF_ITEM"` \| `"REINSTATE_ITEM"` \| `"TRANSFER_CUSTOMER"` \| `"UPDATE_ORDER_PROPERTIES"`
The change action's type. The change action's type.
@@ -0,0 +1,9 @@
---
displayed_sidebar: orderReference
---
import { TypeList } from "docs-ui"
# OrderChangeType
**OrderChangeType**: `"return_request"` \| `"return_receive"` \| `"exchange"` \| `"claim"` \| `"edit"` \| `"transfer"` \| `"update_order"`
@@ -0,0 +1,9 @@
---
displayed_sidebar: pricingReference
---
import { TypeList } from "docs-ui"
# RuleWithOperator
<TypeList types={[{"name":"operator","type":"[PricingRuleOperatorValues](../../types/pricing.PricingRuleOperatorValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="RuleWithOperator"/>
@@ -0,0 +1,11 @@
---
displayed_sidebar: pricingReference
---
import { TypeList } from "docs-ui"
# PricingRuleOperatorValues
**PricingRuleOperatorValues**: `"gt"` \| `"lt"` \| `"eq"` \| `"lte"` \| `"gte"`
The possible operators to use in a price rule.
@@ -1,13 +0,0 @@
---
displayed_sidebar: pricingModelReference
slug: /references/pricing/models/Price
sidebar_label: Price
---
import { TypeList } from "docs-ui"
# Price - Pricing Module Data Models Reference
This documentation provides a reference to the Price . This belongs to the Pricing Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"price_rules","type":"Collection&#60;[PriceRule](../pricing_models.PriceRule/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"priority","type":"`number`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"price_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price","type":"[Price](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"price_rules","type":"Collection&#60;[PriceRule](../pricing_models.PriceRule/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"price_list","type":"`null` \\| [PriceList](../pricing_models.PriceList/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"[PriceSet](../pricing_models.PriceSet/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":falsLine truncated
@@ -1,13 +0,0 @@
---
displayed_sidebar: pricingModelReference
slug: /references/pricing/models/PriceList
sidebar_label: PriceList
---
import { TypeList } from "docs-ui"
# PriceList - Pricing Module Data Models Reference
This documentation provides a reference to the PriceList . This belongs to the Pricing Module.
<TypeList types={[{"name":"[OptionalProps]","type":"`OptionalFields`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../utils/enums/utils.PriceListStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ACTIVE","type":"`\"active\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"[PriceListType](../../../utils/enums/utils.PriceListType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"SALE","type":"`\"sale\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OVERRIDE","type":"`\"override\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"starts_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"prices","type":"Collection&#60;[Price](../pricing_models.Price/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"price_rules","type":"Collection&#60;[PriceRule](../pricing_models.PriceRule/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"priority","type":"`number`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"price_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price","type":"[Price](../pricing_models.Price/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_list_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"price_list","type":"`null` \\| [PriceList](page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"[OptionalProps]","type":"`OptionalFields`","description":"","optional":false,"defaultValue":"","expandable":falsLine truncated
@@ -1,13 +0,0 @@
---
displayed_sidebar: pricingModelReference
slug: /references/pricing/models/PriceListRule
sidebar_label: PriceListRule
---
import { TypeList } from "docs-ui"
# PriceListRule - Pricing Module Data Models Reference
This documentation provides a reference to the PriceListRule . This belongs to the Pricing Module.
<TypeList types={[{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string` \\| `string`[]","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"price_list_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"[PriceList](../pricing_models.PriceList/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[OptionalProps]","type":"`OptionalFields`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../utils/enums/utils.PriceListStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ACTIVE","type":"`\"active\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"[PriceListType](../../../utils/enums/utils.PriceListType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"SALE","type":"`\"sale\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OVERRIDE","type":"`\"override\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"starts_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"prices","type":"Collection&#60;[Price](../pricing_models.Price/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"price_rules","type":"Collection&#60;[PriceRule](../pricing_models.PriceRule/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"price_list","type":"`null` \\| [PriceList](../pricing_models.PriceList/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optionaLine truncated
@@ -1,13 +0,0 @@
---
displayed_sidebar: pricingModelReference
slug: /references/pricing/models/PricePreference
sidebar_label: PricePreference
---
import { TypeList } from "docs-ui"
# PricePreference - Pricing Module Data Models Reference
This documentation provides a reference to the PricePreference . This belongs to the Pricing Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="PricePreference"/>
@@ -1,13 +0,0 @@
---
displayed_sidebar: pricingModelReference
slug: /references/pricing/models/PriceRule
sidebar_label: PriceRule
---
import { TypeList } from "docs-ui"
# PriceRule - Pricing Module Data Models Reference
This documentation provides a reference to the PriceRule . This belongs to the Pricing Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"priority","type":"`number`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"price_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price","type":"[Price](../pricing_models.Price/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"price_rules","type":"Collection&#60;[PriceRule](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"priority","type":"`number`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"price_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price","type":"[Price](../pricing_models.Price/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_list_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"price_list","type":"`null` \\| [PriceList](../pricing_models.PriceList/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"[OptionalProps]","type":"`OptionalFields`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../utils/enums/utils.PriceListStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../utils/enums/utils.PriceListType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"prices","type":"CollectioLine truncated
@@ -1,13 +0,0 @@
---
displayed_sidebar: pricingModelReference
slug: /references/pricing/models/PriceSet
sidebar_label: PriceSet
---
import { TypeList } from "docs-ui"
# PriceSet - Pricing Module Data Models Reference
This documentation provides a reference to the PriceSet . This belongs to the Pricing Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"Collection&#60;[Price](../pricing_models.Price/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"price_rules","type":"Collection&#60;[PriceRule](../pricing_models.PriceRule/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"priority","type":"`number`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"price_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price","type":"[Price](../pricing_models.Price/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_list_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"price_list","type":"`null` \\| [PriceList](../pricing_models.PriceList/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"[OptionalProps]","type":"`OptionalFields`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../utils/enums/utils.PriceListStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../utils/enums/utils.PriceListType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"prices","type":"Collection&#60;[Price](../pricing_models.Price/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_rules","type":"Collection&#60;[PriceListRule](../pricing_models.PriceListRule/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"","optional":false,"defLine truncated
@@ -0,0 +1,13 @@
---
displayed_sidebar: pricingModelReference
slug: /references/pricing/models/Price
sidebar_label: Price
---
import { TypeList } from "docs-ui"
# Price - Pricing Module Data Models Reference
This documentation provides a reference to the Price data model. It belongs to the Pricing Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the price. For example, `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"BelongsTo&#60;[PriceList](../pricing_models.PriceList/page.mdx)&#62;","description":"The associated `PriceSet`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PriceListStatus](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListStatus/page.mdx)&#62;","description":"The status of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty&#60;typeof [PriceListType](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListType/page.mdx)&#62;","description":"The type of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"HasMany&#60;[Price](page.mdx)&#62;","description":"The associated `Price` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the price. For example, `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"BelongsTo&#60;[PriceList](../pricing_models.PriceList/page.mdx)&#62;","description":"The associated `PriceSet`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_rules","type":"HasMany&#60;[PriceRule](../pricing_models.PriceRule/page.mdx)&#62;","description":"The associated `PriceRule` records.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; description: TextProperty ; status: EnumProperty&#60;typeof [PriceListStatus](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListStatus/page.mdx)&#62; ; type: EnumProperty&#60;typeof [PriceListType](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListType/page.mdx)&#62; ; starts_at?: DateTimeProperty ; ends_at?: DateTimeProperty ; rules_count?: NumberProperty ; prices: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: NullableModifier<string, TextProperty>; currency_code: TextProperty; ... 6 more ...; price_list: RelationNullableModifier<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"Price\">&#62; ; price_list_rules: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; description: TextProperty ; status: EnumProperty&#60;typeof [PriceListStatus](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListStatus/page.mdx)&#62; ; type: EnumProperty&#60;typeof [PriceListType](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListType/page.mdx)&#62; ; starts_at?: DateTimeProperty ; ends_at?: DateTimeProperty ; rules_count?: NumberProperty ; prices: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: NullableModifier<string, TextProperty>; currency_code: TextProperty; ... 6 more ...; price_list: RelationNullableModifier<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"Price\">&#62; ; price_list_rules: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; raw_rules_count?: JSONProperty &#125; & DMLSchemaDefaults, \"PriceList\"&#62;, BelongsTo&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TeLine truncated
@@ -0,0 +1,13 @@
---
displayed_sidebar: pricingModelReference
slug: /references/pricing/models/PriceList
sidebar_label: PriceList
---
import { TypeList } from "docs-ui"
# PriceList - Pricing Module Data Models Reference
This documentation provides a reference to the PriceList data model. It belongs to the Pricing Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PriceListStatus](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListStatus/page.mdx)&#62;","description":"The status of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty&#60;typeof [PriceListType](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListType/page.mdx)&#62;","description":"The type of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"HasMany&#60;[Price](../pricing_models.Price/page.mdx)&#62;","description":"The associated `Price` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the price. For example, `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"BelongsTo&#60;[PriceList](page.mdx)&#62;","description":"The associated `PriceSet`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PriceListStatus](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListStatus/page.mdx)&#62;","description":"The status of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty&#60;typeof [PriceListType](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListType/page.mdx)&#62;","description":"The type of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"HasMany&#60;[Price](../pricing_models.Price/page.mdx)&#62;","description":"The associated `Price` records.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list_rules","type":"HasMany&#60;[PriceListRule](../pricing_models.PriceListRule/page.mdx)&#62;","description":"The associated `PriceListRule` records.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"starts_at","type":"`DateTimeProperty`","description":"The date the price list starts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`DateTimeProperty`","description":"The date the price list ends.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`NumberProperty`","description":"The total number of rules of the price list.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_rules","type":"HasMany&#60;[PriceRule](../pricing_models.PriceRule/page.mdx)&#62;","description":"The associated `PriceRule` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the price rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the price rule. For example, `region\\_id`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the price rule. For example, `reg\\_123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty&#60;typeof [PricingRuleOperator](../../../utils/PricingUtils/enums/utils.PricingUtils.PricingRuleOperator/page.mdx)&#62;","description":"The operator of the price rule. For example, `eq`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"priority","type":"`NumberProperty`","description":"The priLine truncated
@@ -0,0 +1,13 @@
---
displayed_sidebar: pricingModelReference
slug: /references/pricing/models/PriceListRule
sidebar_label: PriceListRule
---
import { TypeList } from "docs-ui"
# PriceListRule - Pricing Module Data Models Reference
This documentation provides a reference to the PriceListRule data model. It belongs to the Pricing Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the price list rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the price list rule. For example, `region\\_id`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"BelongsTo&#60;[PriceList](../pricing_models.PriceList/page.mdx)&#62;","description":"The associated `PriceList`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PriceListStatus](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListStatus/page.mdx)&#62;","description":"The status of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty&#60;typeof [PriceListType](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListType/page.mdx)&#62;","description":"The type of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"HasMany&#60;[Price](../pricing_models.Price/page.mdx)&#62;","description":"The associated `Price` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the price. For example, `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"BelongsTo&#60;[PriceList](../pricing_models.PriceList/page.mdx)&#62;","description":"The associated `PriceSet`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_rules","type":"HasMany&#60;[PriceRule](../pricing_models.PriceRule/page.mdx)&#62;","description":"The associated `PriceRule` records.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; description: TextProperty ; status: EnumProperty&#60;typeof [PriceListStatus](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListStatus/page.mdx)&#62; ; type: EnumProperty&#60;typeof [PriceListType](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListType/page.mdx)&#62; ; starts_at?: DateTimeProperty ; ends_at?: DateTimeProperty ; rules_count?: NumberProperty ; prices: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: NullableModifier<string, TextProperty>; currency_code: TextProperty; ... 6 more ...; price_list: RelationNullableModifier<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"Price\">&#62; ; price_list_rules: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; description: TextProperty ; status: EnumProperty&#60;typeof [PriceListStatus](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListStatus/page.mdx)&#62; ; type: EnumProperty&#60;typeof [PriceListType](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListType/page.mdx)&#62; ; starts_at?: DateTimeProperty ; ends_at?: DateTimeProperty ; rules_count?: NumberProperty ; prices: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: NullableModifier<string, TextProperty>; currency_code: TextProperty; ... 6 more ...; price_list: RelationNullableModifier<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"Price\">&#62; ; price_list_rules: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; raw_rules_count?: JSONProperty &#125; & DMLSchemaDefaults, \"PriceList\"&#62;, BelongsTo&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; description: TextProperty ; status: EnumProperty&#60;typeof [PriceListStatus](../../../utils/PricLine truncated
@@ -0,0 +1,13 @@
---
displayed_sidebar: pricingModelReference
slug: /references/pricing/models/PricePreference
sidebar_label: PricePreference
---
import { TypeList } from "docs-ui"
# PricePreference - Pricing Module Data Models Reference
This documentation provides a reference to the PricePreference data model. It belongs to the Pricing Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the price preference. For example, `region\\_id`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether prices matching this preference include taxes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the price preference. For example, `reg\\_123`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="PricePreference"/>
@@ -0,0 +1,13 @@
---
displayed_sidebar: pricingModelReference
slug: /references/pricing/models/PriceRule
sidebar_label: PriceRule
---
import { TypeList } from "docs-ui"
# PriceRule - Pricing Module Data Models Reference
This documentation provides a reference to the PriceRule data model. It belongs to the Pricing Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the price rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the price rule. For example, `region\\_id`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the price rule. For example, `reg\\_123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty&#60;typeof [PricingRuleOperator](../../../utils/PricingUtils/enums/utils.PricingUtils.PricingRuleOperator/page.mdx)&#62;","description":"The operator of the price rule. For example, `eq`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"priority","type":"`NumberProperty`","description":"The priority of the price rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price","type":"BelongsTo&#60;[Price](../pricing_models.Price/page.mdx)&#62;","description":"The associated `Price`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the price. For example, `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"BelongsTo&#60;[PriceList](../pricing_models.PriceList/page.mdx)&#62;","description":"The associated `PriceSet`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PriceListStatus](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListStatus/page.mdx)&#62;","description":"The status of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty&#60;typeof [PriceListType](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListType/page.mdx)&#62;","description":"The type of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"HasMany&#60;[Price](../pricing_models.Price/page.mdx)&#62;","description":"The associated `Price` records.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list_rules","type":"HasMany&#60;[PriceListRule](../pricing_models.PriceListRule/page.mdx)&#62;","description":"The associated `PriceListRule` records.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"starts_at","type":"`DateTimeProperty`","description":"The date the price list starts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`DateTimeProperty`","description":"The date the price list ends.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`NumberProperty`","description":"The total number of rules of the price list.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_rules","type":"HasMany&#60;[PriceRule](page.mdx)&#62;","description":"The associated `PriceRule` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the price rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the price rule. For example, `region\\_id`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the price rule. For example, `reg\\_123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty&#60;typeof [PricingRuleOperator](../../../utils/PricingUtils/enums/utils.PricingUtils.PricingRuleOperator/page.mdx)&#62;","description":"The operator of the price rule. For example, `eq`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"priority","type":"`NumberProperty`","description":"The priority of the price ruleLine truncated
@@ -0,0 +1,13 @@
---
displayed_sidebar: pricingModelReference
slug: /references/pricing/models/PriceSet
sidebar_label: PriceSet
---
import { TypeList } from "docs-ui"
# PriceSet - Pricing Module Data Models Reference
This documentation provides a reference to the PriceSet data model. It belongs to the Pricing Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"HasMany&#60;[Price](../pricing_models.Price/page.mdx)&#62;","description":"The associated `Price` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the price. For example, `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"BelongsTo&#60;[PriceList](../pricing_models.PriceList/page.mdx)&#62;","description":"The associated `PriceSet`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [PriceListStatus](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListStatus/page.mdx)&#62;","description":"The status of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty&#60;typeof [PriceListType](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListType/page.mdx)&#62;","description":"The type of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"HasMany&#60;[Price](../pricing_models.Price/page.mdx)&#62;","description":"The associated `Price` records.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list_rules","type":"HasMany&#60;[PriceListRule](../pricing_models.PriceListRule/page.mdx)&#62;","description":"The associated `PriceListRule` records.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"starts_at","type":"`DateTimeProperty`","description":"The date the price list starts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`DateTimeProperty`","description":"The date the price list ends.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`NumberProperty`","description":"The total number of rules of the price list.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_rules","type":"HasMany&#60;[PriceRule](../pricing_models.PriceRule/page.mdx)&#62;","description":"The associated `PriceRule` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the price rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the price rule. For example, `region\\_id`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the price rule. For example, `reg\\_123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty&#60;typeof [PricingRuleOperator](../../../utils/PricingUtils/enums/utils.PricingUtils.PricingRuleOperator/page.mdx)&#62;","description":"The operator of the price rule. For example, `eq`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"priority","type":"`NumberProperty`","description":"The priority of the price rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price","type":"BelongsTo&#60;[Price](../pricing_models.Price/page.mdx)&#62;","description":"The associated `Price`.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"price_list","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; description: TextProperty ; status: EnumProperty&#60;typeof [PriceListStatus](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListStatus/page.mdx)&#62; ; type: EnumProperty&#60;typeof [PriceListType](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListType/page.mdx)&#62; ; starts_at?: DateTimePLine truncated
@@ -1,13 +0,0 @@
---
displayed_sidebar: productModelReference
slug: /references/product/models/Image
sidebar_label: Image
---
import { TypeList } from "docs-ui"
# Image - Product Module Data Models Reference
This documentation provides a reference to the Image data model. It belongs to the Product Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`NumberProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"BelongsTo&#60;[Product](../product_models.Product/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the product is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62;","description":"The status of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`BooleanProperty`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"HasMany&#60;[ProductVariant](../product_models.ProductVariant/page.mdx)&#62;","description":"The associated variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; tags: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; options: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; images: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; collection: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; categories: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?:Line truncated
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the Product data model. It belongs to the Product Module. This documentation provides a reference to the Product data model. It belongs to the Product Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the product is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62;","description":"The status of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`BooleanProperty`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"HasMany&#60;[ProductVariant](../product_models.ProductVariant/page.mdx)&#62;","description":"The associated variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; tags: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; options: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; images: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; collection: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; categories: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62Line truncated <TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the product is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62;","description":"The status of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`BooleanProperty`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"HasMany&#60;[ProductVariant](../product_models.ProductVariant/page.mdx)&#62;","description":"The associated variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; tags: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; options: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; images: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; collection: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; categories: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62Line truncated
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the ProductCategory data model. It belongs to the Product Module. This documentation provides a reference to the ProductCategory data model. It belongs to the Product Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the product category","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the product category","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product category","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mpath","type":"`TextProperty`","description":"The mpath of the product category","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`BooleanProperty`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`BooleanProperty`","description":"Whether the product category is internal, meaning it's only available for admin users.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`NumberProperty`","description":"The rank of the product category among its siblings.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"RelationNullableModifier&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; name: TextProperty; description: TextProperty; handle: TextProperty; ... 7 more ...; products: ManyToMany<...>; } & { ...; } & {} & DMLSchemaDefaults, \"ProductCategory\">, BelongsTo&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; name: TextProperty; description: TextProperty; handle: TextProperty; ... 7 more ...; products: ManyToMany<...>; } & { ...; } & {} & DMLSchemaDefaults, \"ProductCategory\">&#62;&#62;","description":"The associated parent\\_category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"category_children","type":"HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; name: TextProperty; description: TextProperty; handle: TextProperty; ... 7 more ...; products: ManyToMany<...>; } & { ...; } & {} & DMLSchemaDefaults, \"ProductCategory\">&#62;","description":"The associated category\\_children.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"ManyToMany&#60;[Product](../product_models.Product/page.mdx)&#62;","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the product is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62;","description":"The status of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`BooleanProperty`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"HasMany&#60;[ProductVariant](../product_models.ProductVariant/page.mdx)&#62;","description":"The associated variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle:Line truncated <TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the product category","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the product category","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product category","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mpath","type":"`TextProperty`","description":"The mpath of the product category","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`BooleanProperty`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`BooleanProperty`","description":"Whether the product category is internal, meaning it's only available for admin users.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`NumberProperty`","description":"The rank of the product category among its siblings.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"RelationNullableModifier&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; name: TextProperty; description: TextProperty; handle: TextProperty; ... 7 more ...; products: ManyToMany<...>; } & { ...; } & {} & DMLSchemaDefaults, \"ProductCategory\">, BelongsTo&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; name: TextProperty; description: TextProperty; handle: TextProperty; ... 7 more ...; products: ManyToMany<...>; } & { ...; } & {} & DMLSchemaDefaults, \"ProductCategory\">&#62;&#62;","description":"The associated parent\\_category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"category_children","type":"HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; name: TextProperty; description: TextProperty; handle: TextProperty; ... 7 more ...; products: ManyToMany<...>; } & { ...; } & {} & DMLSchemaDefaults, \"ProductCategory\">&#62;","description":"The associated category\\_children.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"ManyToMany&#60;[Product](../product_models.Product/page.mdx)&#62;","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the product is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62;","description":"The status of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`BooleanProperty`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"HasMany&#60;[ProductVariant](../product_models.ProductVariant/page.mdx)&#62;","description":"The associated variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle:Line truncated
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the ProductCollection data model. It belongs to the Product Module. This documentation provides a reference to the ProductCollection data model. It belongs to the Product Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"HasMany&#60;[Product](../product_models.Product/page.mdx)&#62;","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the product is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62;","description":"The status of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`BooleanProperty`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"HasMany&#60;[ProductVariant](../product_models.ProductVariant/page.mdx)&#62;","description":"The associated variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; tags: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; options: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; images: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; collection: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; categories: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thuLine truncated <TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"HasMany&#60;[Product](../product_models.Product/page.mdx)&#62;","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the product is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62;","description":"The status of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`BooleanProperty`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"HasMany&#60;[ProductVariant](../product_models.ProductVariant/page.mdx)&#62;","description":"The associated variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; tags: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; options: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; images: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; collection: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; categories: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thuLine truncated
@@ -0,0 +1,13 @@
---
displayed_sidebar: productModelReference
slug: /references/product/models/ProductImage
sidebar_label: ProductImage
---
import { TypeList } from "docs-ui"
# ProductImage - Product Module Data Models Reference
This documentation provides a reference to the ProductImage data model. It belongs to the Product Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`TextProperty`","description":"The URL of the product image","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`NumberProperty`","description":"The rank of the product image among its sibling images.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"BelongsTo&#60;[Product](../product_models.Product/page.mdx)&#62;","description":"The associated product.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the product is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62;","description":"The status of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`BooleanProperty`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"HasMany&#60;[ProductVariant](../product_models.ProductVariant/page.mdx)&#62;","description":"The associated variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; tags: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; options: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; images: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; collection: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; categories: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbLine truncated
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the ProductOption data model. It belongs to the Product Module. This documentation provides a reference to the ProductOption data model. It belongs to the Product Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"BelongsTo&#60;[Product](../product_models.Product/page.mdx)&#62;","description":"The associated product.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the product is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62;","description":"The status of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`BooleanProperty`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"HasMany&#60;[ProductVariant](../product_models.ProductVariant/page.mdx)&#62;","description":"The associated variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; tags: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; options: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; images: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; collection: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; categories: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mLine truncated <TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"BelongsTo&#60;[Product](../product_models.Product/page.mdx)&#62;","description":"The associated product.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the product is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62;","description":"The status of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`BooleanProperty`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"HasMany&#60;[ProductVariant](../product_models.ProductVariant/page.mdx)&#62;","description":"The associated variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; tags: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; options: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; images: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; collection: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; categories: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mLine truncated
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the ProductTag data model. It belongs to the Product Module. This documentation provides a reference to the ProductTag data model. It belongs to the Product Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the product tag","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"ManyToMany&#60;[Product](../product_models.Product/page.mdx)&#62;","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the product is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62;","description":"The status of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`BooleanProperty`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"HasMany&#60;[ProductVariant](../product_models.ProductVariant/page.mdx)&#62;","description":"The associated variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; tags: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; options: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; images: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; collection: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; categories: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_cLine truncated <TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the product tag","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"ManyToMany&#60;[Product](../product_models.Product/page.mdx)&#62;","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the product is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62;","description":"The status of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`BooleanProperty`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"HasMany&#60;[ProductVariant](../product_models.ProductVariant/page.mdx)&#62;","description":"The associated variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; tags: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; options: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; images: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; collection: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; categories: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_cLine truncated
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the ProductType data model. It belongs to the Product Module. This documentation provides a reference to the ProductType data model. It belongs to the Product Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the product type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"HasMany&#60;[Product](../product_models.Product/page.mdx)&#62;","description":"The associated product.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the product is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62;","description":"The status of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`BooleanProperty`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"HasMany&#60;[ProductVariant](../product_models.ProductVariant/page.mdx)&#62;","description":"The associated variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; tags: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; options: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; images: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; collection: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; categories: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_codeLine truncated <TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the product type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"HasMany&#60;[Product](../product_models.Product/page.mdx)&#62;","description":"The associated product.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`TextProperty`","description":"The unique handle of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`BooleanProperty`","description":"Whether the product is a giftcard.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62;","description":"The status of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`BooleanProperty`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"HasMany&#60;[ProductVariant](../product_models.ProductVariant/page.mdx)&#62;","description":"The associated variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the product variant","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`BooleanProperty`","description":"Whether customers can purchase this variant even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`BooleanProperty`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_code?: TextProperty ; material?: TextProperty ; discountable: BooleanProperty ; external_id?: TextProperty ; metadata?: JSONProperty ; variants: HasMany&#60;() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; title: TextProperty; sku: NullableModifier<string, TextProperty>; ... 16 more ...; options: ManyToMany<...>; } & { ...; } & { ...; } & DMLSchemaDefaults, \"ProductVariant\">&#62; ; type: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; tags: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; options: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; images: HasMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; ; collection: RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;, BelongsTo&#60;() => ...&#62;&#62; ; categories: ManyToMany&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;..., ...&#62;&#62; &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; title: TextProperty ; handle: TextProperty ; subtitle?: TextProperty ; description?: TextProperty ; is_giftcard: BooleanProperty ; status: EnumProperty&#60;typeof [ProductStatus](../../../utils/ProductUtils/enums/utils.ProductUtils.ProductStatus/page.mdx)&#62; ; thumbnail?: TextProperty ; weight?: TextProperty ; length?: TextProperty ; height?: TextProperty ; width?: TextProperty ; origin_country?: TextProperty ; hs_code?: TextProperty ; mid_codeLine truncated
@@ -0,0 +1,11 @@
import { TypeList } from "docs-ui"
# CheckConstraint
**CheckConstraint**: (`columns`: [InferCheckConstraintsProperties](../types.DmlTypes.InferCheckConstraintsProperties/page.mdx)&#60;Schema&#62;) => `string` \| `object`
Options supported when defining a PostgreSQL check
## Type Parameters
<TypeList types={[{"name":"Schema","type":"[DMLSchema](../types.DmlTypes.DMLSchema/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[RelationshipTypes](../types.DmlTypes.RelationshipTypes/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CheckConstraint"/>
@@ -6,8 +6,8 @@ import { TypeList } from "docs-ui"
## Type Parameters ## Type Parameters
<TypeList types={[{"name":"TSchema","type":"[DMLSchema](../types.DmlTypes.DMLSchema/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[RelationshipTypes](../types.DmlTypes.RelationshipTypes/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"TWhere","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="EntityIndex"/> <TypeList types={[{"name":"Schema","type":"[DMLSchema](../types.DmlTypes.DMLSchema/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[RelationshipTypes](../types.DmlTypes.RelationshipTypes/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"Where","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="EntityIndex"/>
## Properties ## Properties
<TypeList types={[{"name":"on","type":"[InferIndexableProperties](../types.DmlTypes.InferIndexableProperties/page.mdx)&#60;[IDmlEntity](../../interfaces/types.DmlTypes.IDmlEntity/page.mdx)&#60;TSchema, any&#62;&#62;[]","description":"The list of properties to create the index on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the index. If not provided,\nMedusa generates the name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"unique","type":"`boolean`","description":"When enabled, a unique index is created on the specified\nproperties.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"where","type":"TWhere","description":"Conditions to restrict which records are indexed.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="EntityIndex"/> <TypeList types={[{"name":"on","type":"[InferIndexableProperties](../types.DmlTypes.InferIndexableProperties/page.mdx)&#60;Schema&#62;[]","description":"The list of properties to create the index on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the index. If not provided,\nMedusa generates the name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"unique","type":"`boolean`","description":"When enabled, a unique index is created on the specified\nproperties.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"where","type":"Where","description":"Conditions to restrict which records are indexed.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="EntityIndex"/>
@@ -0,0 +1,12 @@
import { TypeList } from "docs-ui"
# InferCheckConstraintsProperties
**InferCheckConstraintsProperties**: &#123; [K in keyof InferSchemaProperties&#60;Schema&#62;]: string &#125;
Returns a list of columns that could be mentioned
within the checks
## Type Parameters
<TypeList types={[{"name":"Schema","type":"[DMLSchema](../types.DmlTypes.DMLSchema/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[RelationshipTypes](../types.DmlTypes.RelationshipTypes/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="InferCheckConstraintsProperties"/>
@@ -2,10 +2,10 @@ import { TypeList } from "docs-ui"
# InferIndexableProperties # InferIndexableProperties
**InferIndexableProperties**: keyof T extends [IDmlEntity](../../interfaces/types.DmlTypes.IDmlEntity/page.mdx)&#60;infer Schema, any&#62; ? &#123; [K in keyof Schema as Schema[K] extends Object ? Type extends RelationshipTypes ? never : K : K]: string &#125; & [InferForeignKeys](../types.DmlTypes.InferForeignKeys/page.mdx)&#60;Schema&#62; : `never` **InferIndexableProperties**: keyof [InferSchemaProperties](../types.DmlTypes.InferSchemaProperties/page.mdx)&#60;Schema&#62;
Infer all indexable properties from a DML entity including inferred foreign keys and excluding relationship Infer all indexable properties from a DML entity including inferred foreign keys and excluding relationship
## Type Parameters ## Type Parameters
<TypeList types={[{"name":"T","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="InferIndexableProperties"/> <TypeList types={[{"name":"Schema","type":"[DMLSchema](../types.DmlTypes.DMLSchema/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[RelationshipTypes](../types.DmlTypes.RelationshipTypes/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="InferIndexableProperties"/>
@@ -4,8 +4,7 @@ import { TypeList } from "docs-ui"
**InferSchemaFields**: [Prettify](../../../CommonTypes/types/types.CommonTypes.Prettify/page.mdx)&#60;&#123; [K in keyof Schema]: Schema[K] extends RelationshipType&#60;any&#62; ? Schema[K]["type"] extends "belongsTo" ? InferBelongsToFields&#60;Schema[K]["$dataType"]&#62; : Schema[K]["type"] extends "hasOne" ? InferHasOneFields&#60;Schema[K]["$dataType"]&#62; : Schema[K]["type"] extends "hasMany" ? InferHasManyFields&#60;Schema[K]["$dataType"]&#62; : Schema[K]["type"] extends "manyToMany" ? InferManyToManyFields&#60;(...)[(...)]["$dataType"]&#62; : never : Schema[K]["$dataType"] &#125; & [InferForeignKeys](../types.DmlTypes.InferForeignKeys/page.mdx)&#60;Schema&#62;&#62; **InferSchemaFields**: [Prettify](../../../CommonTypes/types/types.CommonTypes.Prettify/page.mdx)&#60;&#123; [K in keyof Schema]: Schema[K] extends RelationshipType&#60;any&#62; ? Schema[K]["type"] extends "belongsTo" ? InferBelongsToFields&#60;Schema[K]["$dataType"]&#62; : Schema[K]["type"] extends "hasOne" ? InferHasOneFields&#60;Schema[K]["$dataType"]&#62; : Schema[K]["type"] extends "hasMany" ? InferHasManyFields&#60;Schema[K]["$dataType"]&#62; : Schema[K]["type"] extends "manyToMany" ? InferManyToManyFields&#60;(...)[(...)]["$dataType"]&#62; : never : Schema[K]["$dataType"] &#125; & [InferForeignKeys](../types.DmlTypes.InferForeignKeys/page.mdx)&#60;Schema&#62;&#62;
Inferring the types of the schema fields from the DML Infers the types of the schema fields from the DML entity
entity
## Type Parameters ## Type Parameters
@@ -0,0 +1,11 @@
import { TypeList } from "docs-ui"
# InferSchemaProperties
**InferSchemaProperties**: [Prettify](../../../CommonTypes/types/types.CommonTypes.Prettify/page.mdx)&#60;&#123; [K in keyof Schema as Schema[K] extends Object ? Type extends RelationshipTypes ? never : K : K]: Schema[K]["$dataType"] &#125; & [InferForeignKeys](../types.DmlTypes.InferForeignKeys/page.mdx)&#60;Schema&#62;&#62;
Infers the schema properties without the relationships
## Type Parameters
<TypeList types={[{"name":"Schema","type":"[DMLSchema](../types.DmlTypes.DMLSchema/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[RelationshipTypes](../types.DmlTypes.RelationshipTypes/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="InferSchemaProperties"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# AdminUpdateOrder
## Properties
<TypeList types={[{"name":"email","type":"`string`","description":"The order's email.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[OrderAddress](../types.HttpTypes.OrderAddress/page.mdx)","description":"The order's shipping address.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address","type":"[OrderAddress](../types.HttpTypes.OrderAddress/page.mdx)","description":"The order's billing address.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="AdminUpdateOrder"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# OrderAddress
## Properties
<TypeList types={[{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OrderAddress"/>
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
## Properties ## Properties
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../../../fulfillment/types/fulfillment.ShippingOptionPriceType/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"prices","type":"(`object` \\| `object`)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[RuleOperatorType](../../../../CommonTypes/types/types.CommonTypes.RuleOperatorType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="UpdateShippingOptionsWorkflowInput"/> <TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../../../fulfillment/types/fulfillment.ShippingOptionPriceType/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"prices","type":"(`object` \\| `object`)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PriceRule](../../../../../pricing_models/variables/pricing_models.PriceRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"[IsDmlEntity]","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"name","type":"[InferDmlEntityNameFromConfig](../../../../DmlTypes/types/types.DmlTypes.InferDmlEntityNameFromConfig/page.mdx)&#60;TConfig&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"Schema","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[PriceRule](../../../../../pricing_models/variables/pricing_models.PriceRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"[IsDmlEntity]","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"name","type":"[InferDmlEntityNameFromConfig](../../../../DmlTypes/types/types.DmlTypes.InferDmlEntityNameFromConfig/page.mdx)&#60;TConfig&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"Schema","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"rules","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[RuleOperatorType](../../../../CommonTypes/types/types.CommonTypes.RuleOperatorType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="UpdateShippingOptionsWorkflowInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# UpdateOrderShippingAddressWorkflowInput
**UpdateOrderShippingAddressWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[UpsertOrderAddressDTO](../../../../../order/interfaces/order.UpsertOrderAddressDTO/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="UpdateOrderShippingAddressWorkflowInput"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# UpdateOrderWorkflowInput
**UpdateOrderWorkflowInput**: `Object`
## Properties
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[UpsertOrderAddressDTO](../../../../../order/interfaces/order.UpsertOrderAddressDTO/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address","type":"[UpsertOrderAddressDTO](../../../../../order/interfaces/order.UpsertOrderAddressDTO/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The address 1 of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The address 2 of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"email","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="UpdateOrderWorkflowInput"/>
@@ -61,3 +61,5 @@ import { TypeList } from "docs-ui"
- [CancelTransferOrderRequestWorkflowInput](../OrderWorkflow/types/types.WorkflowTypes.OrderWorkflow.CancelTransferOrderRequestWorkflowInput/page.mdx) - [CancelTransferOrderRequestWorkflowInput](../OrderWorkflow/types/types.WorkflowTypes.OrderWorkflow.CancelTransferOrderRequestWorkflowInput/page.mdx)
- [DeclineTransferOrderRequestWorkflowInput](../OrderWorkflow/types/types.WorkflowTypes.OrderWorkflow.DeclineTransferOrderRequestWorkflowInput/page.mdx) - [DeclineTransferOrderRequestWorkflowInput](../OrderWorkflow/types/types.WorkflowTypes.OrderWorkflow.DeclineTransferOrderRequestWorkflowInput/page.mdx)
- [UpdateOrderShippingAddressWorkflowInput](../OrderWorkflow/types/types.WorkflowTypes.OrderWorkflow.UpdateOrderShippingAddressWorkflowInput/page.mdx)
- [UpdateOrderWorkflowInput](../OrderWorkflow/types/types.WorkflowTypes.OrderWorkflow.UpdateOrderWorkflowInput/page.mdx)
@@ -9,6 +9,7 @@ import { TypeList } from "docs-ui"
## Type Aliases ## Type Aliases
- [CheckConstraint](../DmlTypes/types/types.DmlTypes.CheckConstraint/page.mdx)
- [DMLSchema](../DmlTypes/types/types.DmlTypes.DMLSchema/page.mdx) - [DMLSchema](../DmlTypes/types/types.DmlTypes.DMLSchema/page.mdx)
- [EntityCascades](../DmlTypes/types/types.DmlTypes.EntityCascades/page.mdx) - [EntityCascades](../DmlTypes/types/types.DmlTypes.EntityCascades/page.mdx)
- [EntityIndex](../DmlTypes/types/types.DmlTypes.EntityIndex/page.mdx) - [EntityIndex](../DmlTypes/types/types.DmlTypes.EntityIndex/page.mdx)
@@ -16,6 +17,7 @@ import { TypeList } from "docs-ui"
- [IDmlEntityConfig](../DmlTypes/types/types.DmlTypes.IDmlEntityConfig/page.mdx) - [IDmlEntityConfig](../DmlTypes/types/types.DmlTypes.IDmlEntityConfig/page.mdx)
- [Infer](../DmlTypes/types/types.DmlTypes.Infer/page.mdx) - [Infer](../DmlTypes/types/types.DmlTypes.Infer/page.mdx)
- [InferBelongsToFields](../DmlTypes/types/types.DmlTypes.InferBelongsToFields/page.mdx) - [InferBelongsToFields](../DmlTypes/types/types.DmlTypes.InferBelongsToFields/page.mdx)
- [InferCheckConstraintsProperties](../DmlTypes/types/types.DmlTypes.InferCheckConstraintsProperties/page.mdx)
- [InferDmlEntityNameFromConfig](../DmlTypes/types/types.DmlTypes.InferDmlEntityNameFromConfig/page.mdx) - [InferDmlEntityNameFromConfig](../DmlTypes/types/types.DmlTypes.InferDmlEntityNameFromConfig/page.mdx)
- [InferEntityType](../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx) - [InferEntityType](../DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)
- [InferForeignKeys](../DmlTypes/types/types.DmlTypes.InferForeignKeys/page.mdx) - [InferForeignKeys](../DmlTypes/types/types.DmlTypes.InferForeignKeys/page.mdx)
@@ -24,6 +26,7 @@ import { TypeList } from "docs-ui"
- [InferIndexableProperties](../DmlTypes/types/types.DmlTypes.InferIndexableProperties/page.mdx) - [InferIndexableProperties](../DmlTypes/types/types.DmlTypes.InferIndexableProperties/page.mdx)
- [InferManyToManyFields](../DmlTypes/types/types.DmlTypes.InferManyToManyFields/page.mdx) - [InferManyToManyFields](../DmlTypes/types/types.DmlTypes.InferManyToManyFields/page.mdx)
- [InferSchemaFields](../DmlTypes/types/types.DmlTypes.InferSchemaFields/page.mdx) - [InferSchemaFields](../DmlTypes/types/types.DmlTypes.InferSchemaFields/page.mdx)
- [InferSchemaProperties](../DmlTypes/types/types.DmlTypes.InferSchemaProperties/page.mdx)
- [InferTypeOf](../DmlTypes/types/types.DmlTypes.InferTypeOf/page.mdx) - [InferTypeOf](../DmlTypes/types/types.DmlTypes.InferTypeOf/page.mdx)
- [IsNullableRelation](../DmlTypes/types/types.DmlTypes.IsNullableRelation/page.mdx) - [IsNullableRelation](../DmlTypes/types/types.DmlTypes.IsNullableRelation/page.mdx)
- [KnownDataTypes](../DmlTypes/types/types.DmlTypes.KnownDataTypes/page.mdx) - [KnownDataTypes](../DmlTypes/types/types.DmlTypes.KnownDataTypes/page.mdx)
@@ -354,6 +354,7 @@ import { TypeList } from "docs-ui"
- [AdminUpdateFulfillmentSetServiceZone](../HttpTypes/interfaces/types.HttpTypes.AdminUpdateFulfillmentSetServiceZone/page.mdx) - [AdminUpdateFulfillmentSetServiceZone](../HttpTypes/interfaces/types.HttpTypes.AdminUpdateFulfillmentSetServiceZone/page.mdx)
- [AdminUpdateInventoryItem](../HttpTypes/interfaces/types.HttpTypes.AdminUpdateInventoryItem/page.mdx) - [AdminUpdateInventoryItem](../HttpTypes/interfaces/types.HttpTypes.AdminUpdateInventoryItem/page.mdx)
- [AdminUpdateInventoryLevel](../HttpTypes/interfaces/types.HttpTypes.AdminUpdateInventoryLevel/page.mdx) - [AdminUpdateInventoryLevel](../HttpTypes/interfaces/types.HttpTypes.AdminUpdateInventoryLevel/page.mdx)
- [AdminUpdateOrder](../HttpTypes/interfaces/types.HttpTypes.AdminUpdateOrder/page.mdx)
- [AdminUpdateOrderEditItem](../HttpTypes/interfaces/types.HttpTypes.AdminUpdateOrderEditItem/page.mdx) - [AdminUpdateOrderEditItem](../HttpTypes/interfaces/types.HttpTypes.AdminUpdateOrderEditItem/page.mdx)
- [AdminUpdatePriceList](../HttpTypes/interfaces/types.HttpTypes.AdminUpdatePriceList/page.mdx) - [AdminUpdatePriceList](../HttpTypes/interfaces/types.HttpTypes.AdminUpdatePriceList/page.mdx)
- [AdminUpdatePriceListPrice](../HttpTypes/interfaces/types.HttpTypes.AdminUpdatePriceListPrice/page.mdx) - [AdminUpdatePriceListPrice](../HttpTypes/interfaces/types.HttpTypes.AdminUpdatePriceListPrice/page.mdx)
@@ -404,6 +405,7 @@ import { TypeList } from "docs-ui"
- [BatchUpdatePromotionRulesReq](../HttpTypes/interfaces/types.HttpTypes.BatchUpdatePromotionRulesReq/page.mdx) - [BatchUpdatePromotionRulesReq](../HttpTypes/interfaces/types.HttpTypes.BatchUpdatePromotionRulesReq/page.mdx)
- [FindParams](../HttpTypes/interfaces/types.HttpTypes.FindParams/page.mdx) - [FindParams](../HttpTypes/interfaces/types.HttpTypes.FindParams/page.mdx)
- [InventoryLevel](../HttpTypes/interfaces/types.HttpTypes.InventoryLevel/page.mdx) - [InventoryLevel](../HttpTypes/interfaces/types.HttpTypes.InventoryLevel/page.mdx)
- [OrderAddress](../HttpTypes/interfaces/types.HttpTypes.OrderAddress/page.mdx)
- [PromotionRuleResponse](../HttpTypes/interfaces/types.HttpTypes.PromotionRuleResponse/page.mdx) - [PromotionRuleResponse](../HttpTypes/interfaces/types.HttpTypes.PromotionRuleResponse/page.mdx)
- [RefundReasonFilters](../HttpTypes/interfaces/types.HttpTypes.RefundReasonFilters/page.mdx) - [RefundReasonFilters](../HttpTypes/interfaces/types.HttpTypes.RefundReasonFilters/page.mdx)
- [RefundReasonResponse](../HttpTypes/interfaces/types.HttpTypes.RefundReasonResponse/page.mdx) - [RefundReasonResponse](../HttpTypes/interfaces/types.HttpTypes.RefundReasonResponse/page.mdx)
@@ -1,13 +0,0 @@
---
displayed_sidebar: userModelReference
slug: /references/user/models/Invite
sidebar_label: Invite
---
import { TypeList } from "docs-ui"
# Invite - User Module Data Models Reference
This documentation provides a reference to the Invite . This belongs to the User Module.
<TypeList types={[{"name":"[OptionalProps]","type":"`OptionalFields`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"accepted","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"expires_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Invite"/>
@@ -1,13 +0,0 @@
---
displayed_sidebar: userModelReference
slug: /references/user/models/User
sidebar_label: User
---
import { TypeList } from "docs-ui"
# User - User Module Data Models Reference
This documentation provides a reference to the User . This belongs to the User Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"avatar_url","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalFields`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":true,"defaultValue":"null","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="User"/>
@@ -0,0 +1,13 @@
---
displayed_sidebar: userModelReference
slug: /references/user/models/Invite
sidebar_label: Invite
---
import { TypeList } from "docs-ui"
# Invite - User Module Data Models Reference
This documentation provides a reference to the Invite data model. It belongs to the User Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the invite.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the invited user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"accepted","type":"`BooleanProperty`","description":"Whether the invite is accepted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`TextProperty`","description":"The token of the invite.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"expires_at","type":"`DateTimeProperty`","description":"When the invite expires.","optional":false,"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/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Invite"/>
@@ -0,0 +1,13 @@
---
displayed_sidebar: userModelReference
slug: /references/user/models/User
sidebar_label: User
---
import { TypeList } from "docs-ui"
# User - User Module Data Models Reference
This documentation provides a reference to the User data model. It belongs to the User Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`TextProperty`","description":"The email of the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`TextProperty`","description":"The first name of the user.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`TextProperty`","description":"The last name of the user.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"avatar_url","type":"`TextProperty`","description":"The image URL of the user's avatar.","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/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="User"/>
@@ -67,3 +67,7 @@ import { TypeList } from "docs-ui"
### TRANSFER\_CUSTOMER ### TRANSFER\_CUSTOMER
**TRANSFER\_CUSTOMER** = `"TRANSFER_CUSTOMER"` **TRANSFER\_CUSTOMER** = `"TRANSFER_CUSTOMER"`
### UPDATE\_ORDER\_PROPERTIES
**UPDATE\_ORDER\_PROPERTIES** = `"UPDATE_ORDER_PROPERTIES"`
@@ -0,0 +1,25 @@
import { TypeList } from "docs-ui"
# PricingRuleOperator
## Enumeration Members
### GTE
**GTE** = `"gte"`
### LTE
**LTE** = `"lte"`
### GT
**GT** = `"gt"`
### LT
**LT** = `"lt"`
### EQ
**EQ** = `"eq"`
@@ -60,7 +60,7 @@ import { TypeList } from "docs-ui"
#### Properties #### Properties
<TypeList types={[{"name":"PLACED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.placed\"","expandable":false,"children":[]},{"name":"CANCELED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.canceled\"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.completed\"","expandable":false,"children":[]},{"name":"ARCHIVED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.archived\"","expandable":false,"children":[]},{"name":"FULFILLMENT_CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.fulfillment_created\"","expandable":false,"children":[]},{"name":"FULFILLMENT_CANCELED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.fulfillment_canceled\"","expandable":false,"children":[]},{"name":"RETURN_REQUESTED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.return_requested\"","expandable":false,"children":[]},{"name":"RETURN_RECEIVED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.return_received\"","expandable":false,"children":[]},{"name":"CLAIM_CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.claim_created\"","expandable":false,"children":[]},{"name":"EXCHANGE_CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.exchange_created\"","expandable":false,"children":[]},{"name":"TRANSFER_REQUESTED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.transfer_requested\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OrderWorkflowEvents"/> <TypeList types={[{"name":"UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.updated\"","expandable":false,"children":[]},{"name":"PLACED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.placed\"","expandable":false,"children":[]},{"name":"CANCELED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.canceled\"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.completed\"","expandable":false,"children":[]},{"name":"ARCHIVED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.archived\"","expandable":false,"children":[]},{"name":"FULFILLMENT_CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.fulfillment_created\"","expandable":false,"children":[]},{"name":"FULFILLMENT_CANCELED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.fulfillment_canceled\"","expandable":false,"children":[]},{"name":"RETURN_REQUESTED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.return_requested\"","expandable":false,"children":[]},{"name":"RETURN_RECEIVED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.return_received\"","expandable":false,"children":[]},{"name":"CLAIM_CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.claim_created\"","expandable":false,"children":[]},{"name":"EXCHANGE_CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.exchange_created\"","expandable":false,"children":[]},{"name":"TRANSFER_REQUESTED","type":"`string`","description":"","optional":false,"defaultValue":"\"order.transfer_requested\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OrderWorkflowEvents"/>
### ProductCategoryWorkflowEvents ### ProductCategoryWorkflowEvents
@@ -0,0 +1,21 @@
import { TypeList } from "docs-ui"
# PricingUtils
## Enumerations
- [PriceListStatus](../PricingUtils/enums/utils.PricingUtils.PriceListStatus/page.mdx)
- [PriceListType](../PricingUtils/enums/utils.PricingUtils.PriceListType/page.mdx)
- [PricingRuleOperator](../PricingUtils/enums/utils.PricingUtils.PricingRuleOperator/page.mdx)
## Variables
- [PricingEvents](page.mdx#pricingevents)
___
## Variables
### PricingEvents
`Const` **PricingEvents**: ReturnType&#60;["priceListRule", "priceList", "priceRule", "priceSet", "price"]&#62;
+3 -3
View File
@@ -302,7 +302,7 @@ export const sidebar = sidebarAttachHrefCommonOptions([
{ {
type: "category", type: "category",
title: "Data Models", title: "Data Models",
autogenerate_path: "/references/auth_models/classes", autogenerate_path: "/references/auth_models/variables",
}, },
], ],
}, },
@@ -988,7 +988,7 @@ export const sidebar = sidebarAttachHrefCommonOptions([
type: "category", type: "category",
title: "Data Models", title: "Data Models",
hasTitleStyling: true, hasTitleStyling: true,
autogenerate_path: "/references/pricing_models/classes", autogenerate_path: "/references/pricing_models/variables",
}, },
], ],
}, },
@@ -1566,7 +1566,7 @@ export const sidebar = sidebarAttachHrefCommonOptions([
type: "category", type: "category",
title: "Data Models", title: "Data Models",
hasTitleStyling: true, hasTitleStyling: true,
autogenerate_path: "/references/user_models/classes", autogenerate_path: "/references/user_models/variables",
}, },
], ],
}, },
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
@@ -1,12 +1,12 @@
{ {
"id": 36858, "id": 37714,
"name": "auth-provider", "name": "auth-provider",
"variant": "project", "variant": "project",
"kind": 1, "kind": 1,
"flags": {}, "flags": {},
"children": [ "children": [
{ {
"id": 36859, "id": 37715,
"name": "AbstractAuthModuleProvider", "name": "AbstractAuthModuleProvider",
"variant": "declaration", "variant": "declaration",
"kind": 128, "kind": 128,
@@ -27,7 +27,7 @@
}, },
"children": [ "children": [
{ {
"id": 36860, "id": 37716,
"name": "identifier", "name": "identifier",
"variant": "declaration", "variant": "declaration",
"kind": 1024, "kind": 1024,
@@ -99,7 +99,7 @@
} }
}, },
{ {
"id": 36861, "id": 37717,
"name": "DISPLAY_NAME", "name": "DISPLAY_NAME",
"variant": "declaration", "variant": "declaration",
"kind": 1024, "kind": 1024,
@@ -131,7 +131,7 @@
} }
}, },
{ {
"id": 36862, "id": 37718,
"name": "validateOptions", "name": "validateOptions",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
@@ -140,7 +140,7 @@
}, },
"signatures": [ "signatures": [
{ {
"id": 36863, "id": 37719,
"name": "validateOptions", "name": "validateOptions",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -174,7 +174,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 36864, "id": 37720,
"name": "options", "name": "options",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -216,21 +216,21 @@
] ]
}, },
{ {
"id": 36865, "id": 37721,
"name": "constructor", "name": "constructor",
"variant": "declaration", "variant": "declaration",
"kind": 512, "kind": 512,
"flags": {}, "flags": {},
"signatures": [ "signatures": [
{ {
"id": 36866, "id": 37722,
"name": "new AbstractAuthModuleProvider", "name": "new AbstractAuthModuleProvider",
"variant": "signature", "variant": "signature",
"kind": 16384, "kind": 16384,
"flags": {}, "flags": {},
"type": { "type": {
"type": "reference", "type": "reference",
"target": 36859, "target": 37715,
"name": "AbstractAuthModuleProvider", "name": "AbstractAuthModuleProvider",
"package": "@medusajs/utils" "package": "@medusajs/utils"
} }
@@ -238,7 +238,7 @@
] ]
}, },
{ {
"id": 36874, "id": 37730,
"name": "authenticate", "name": "authenticate",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
@@ -247,7 +247,7 @@
}, },
"signatures": [ "signatures": [
{ {
"id": 36875, "id": 37731,
"name": "authenticate", "name": "authenticate",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -294,7 +294,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 36876, "id": 37732,
"name": "data", "name": "data",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -318,7 +318,7 @@
} }
}, },
{ {
"id": 36877, "id": 37733,
"name": "authIdentityProviderService", "name": "authIdentityProviderService",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -392,14 +392,14 @@
} }
}, },
{ {
"id": 36878, "id": 37734,
"name": "register", "name": "register",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
"flags": {}, "flags": {},
"signatures": [ "signatures": [
{ {
"id": 36879, "id": 37735,
"name": "register", "name": "register",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -442,7 +442,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 36880, "id": 37736,
"name": "data", "name": "data",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -466,7 +466,7 @@
} }
}, },
{ {
"id": 36881, "id": 37737,
"name": "authIdentityProviderService", "name": "authIdentityProviderService",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -540,14 +540,14 @@
} }
}, },
{ {
"id": 36882, "id": 37738,
"name": "update", "name": "update",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
"flags": {}, "flags": {},
"signatures": [ "signatures": [
{ {
"id": 36883, "id": 37739,
"name": "update", "name": "update",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -590,7 +590,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 36884, "id": 37740,
"name": "data", "name": "data",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -648,7 +648,7 @@
} }
}, },
{ {
"id": 36885, "id": 37741,
"name": "authIdentityProviderService", "name": "authIdentityProviderService",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -722,14 +722,14 @@
} }
}, },
{ {
"id": 36886, "id": 37742,
"name": "validateCallback", "name": "validateCallback",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
"flags": {}, "flags": {},
"signatures": [ "signatures": [
{ {
"id": 36887, "id": 37743,
"name": "validateCallback", "name": "validateCallback",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -744,7 +744,7 @@
"kind": "inline-tag", "kind": "inline-tag",
"tag": "@link", "tag": "@link",
"text": "authenticate", "text": "authenticate",
"target": 36874, "target": 37730,
"tsLinkText": "" "tsLinkText": ""
}, },
{ {
@@ -799,7 +799,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 36888, "id": 37744,
"name": "data", "name": "data",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -823,7 +823,7 @@
} }
}, },
{ {
"id": 36889, "id": 37745,
"name": "authIdentityProviderService", "name": "authIdentityProviderService",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -901,24 +901,24 @@
{ {
"title": "Constructors", "title": "Constructors",
"children": [ "children": [
36865 37721
] ]
}, },
{ {
"title": "Properties", "title": "Properties",
"children": [ "children": [
36860, 37716,
36861 37717
] ]
}, },
{ {
"title": "Methods", "title": "Methods",
"children": [ "children": [
36862, 37718,
36874, 37730,
36878, 37734,
36882, 37738,
36886 37742
] ]
} }
], ],
@@ -939,101 +939,101 @@
{ {
"title": "Classes", "title": "Classes",
"children": [ "children": [
36859 37715
] ]
} }
], ],
"packageName": "@medusajs/utils", "packageName": "@medusajs/utils",
"symbolIdMap": { "symbolIdMap": {
"36858": { "37714": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "" "qualifiedName": ""
}, },
"36859": { "37715": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "AbstractAuthModuleProvider" "qualifiedName": "AbstractAuthModuleProvider"
}, },
"36860": { "37716": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "AbstractAuthModuleProvider.identifier" "qualifiedName": "AbstractAuthModuleProvider.identifier"
}, },
"36861": { "37717": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "AbstractAuthModuleProvider.DISPLAY_NAME" "qualifiedName": "AbstractAuthModuleProvider.DISPLAY_NAME"
}, },
"36862": { "37718": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "AbstractAuthModuleProvider.validateOptions" "qualifiedName": "AbstractAuthModuleProvider.validateOptions"
}, },
"36863": { "37719": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "AbstractAuthModuleProvider.validateOptions" "qualifiedName": "AbstractAuthModuleProvider.validateOptions"
}, },
"36864": { "37720": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "options" "qualifiedName": "options"
}, },
"36874": { "37730": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "AbstractAuthModuleProvider.authenticate" "qualifiedName": "AbstractAuthModuleProvider.authenticate"
}, },
"36875": { "37731": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "AbstractAuthModuleProvider.authenticate" "qualifiedName": "AbstractAuthModuleProvider.authenticate"
}, },
"36876": { "37732": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "data" "qualifiedName": "data"
}, },
"36877": { "37733": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "authIdentityProviderService" "qualifiedName": "authIdentityProviderService"
}, },
"36878": { "37734": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "AbstractAuthModuleProvider.register" "qualifiedName": "AbstractAuthModuleProvider.register"
}, },
"36879": { "37735": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "AbstractAuthModuleProvider.register" "qualifiedName": "AbstractAuthModuleProvider.register"
}, },
"36880": { "37736": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "data" "qualifiedName": "data"
}, },
"36881": { "37737": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "authIdentityProviderService" "qualifiedName": "authIdentityProviderService"
}, },
"36882": { "37738": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "AbstractAuthModuleProvider.update" "qualifiedName": "AbstractAuthModuleProvider.update"
}, },
"36883": { "37739": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "AbstractAuthModuleProvider.update" "qualifiedName": "AbstractAuthModuleProvider.update"
}, },
"36884": { "37740": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "data" "qualifiedName": "data"
}, },
"36885": { "37741": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "authIdentityProviderService" "qualifiedName": "authIdentityProviderService"
}, },
"36886": { "37742": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "AbstractAuthModuleProvider.validateCallback" "qualifiedName": "AbstractAuthModuleProvider.validateCallback"
}, },
"36887": { "37743": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "AbstractAuthModuleProvider.validateCallback" "qualifiedName": "AbstractAuthModuleProvider.validateCallback"
}, },
"36888": { "37744": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "data" "qualifiedName": "data"
}, },
"36889": { "37745": {
"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
"qualifiedName": "authIdentityProviderService" "qualifiedName": "authIdentityProviderService"
} }
@@ -1043,7 +1043,7 @@
"1": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts" "1": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts"
}, },
"reflections": { "reflections": {
"1": 36858 "1": 37714
} }
} }
} }
File diff suppressed because it is too large. Load diff
Loaded 100 of 143 files, more files were not shown because too many files have changed in this diff. Show more