diff --git a/www/apps/resources/generated/edit-dates.mjs b/www/apps/resources/generated/edit-dates.mjs
index 3baa29bb4f..b228232547 100644
--- a/www/apps/resources/generated/edit-dates.mjs
+++ b/www/apps/resources/generated/edit-dates.mjs
@@ -227,7 +227,7 @@ export const generatedEditDates = {
"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": "2025-05-20T07:51:40.872Z",
"references/modules/core_flows/page.mdx": "2025-09-18T17:04:38.002Z",
- "references/types/types.HttpTypes/page.mdx": "2025-10-21T08:10:45.676Z",
+ "references/types/types.HttpTypes/page.mdx": "2025-10-31T09:41:29.920Z",
"app/troubleshooting/medusa-admin/no-widget-route/page.mdx": "2025-03-11T08:57:17.255Z",
"references/auth/IAuthModuleService/methods/auth.IAuthModuleService.createProviderIdentities/page.mdx": "2025-10-21T08:10:42.895Z",
"references/auth/IAuthModuleService/methods/auth.IAuthModuleService.deleteProviderIdentities/page.mdx": "2025-10-21T08:10:42.902Z",
@@ -273,7 +273,7 @@ export const generatedEditDates = {
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderExchangesStep/page.mdx": "2025-09-12T14:10:31.701Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createReturnsStep/page.mdx": "2025-09-18T17:04:40.223Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.previewOrderChangeStep/page.mdx": "2025-09-12T14:10:31.721Z",
- "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangesStep/page.mdx": "2025-10-25T20:13:59.124Z",
+ "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangesStep/page.mdx": "2025-10-31T09:41:21.429Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginClaimOrderWorkflow/page.mdx": "2025-09-18T17:04:40.356Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginExchangeOrderWorkflow/page.mdx": "2025-09-18T17:04:40.788Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginOrderEditOrderWorkflow/page.mdx": "2025-09-18T17:04:41.031Z",
@@ -363,7 +363,7 @@ export const generatedEditDates = {
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateExchangeAddItemWorkflow/page.mdx": "2025-09-18T17:04:40.957Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateExchangeShippingMethodValidationStep/page.mdx": "2025-05-20T07:51:40.848Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateExchangeShippingMethodWorkflow/page.mdx": "2025-09-18T17:04:40.980Z",
- "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderChangesWorkflow/page.mdx": "2025-10-25T20:14:00.462Z",
+ "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderChangesWorkflow/page.mdx": "2025-10-31T09:41:22.794Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderEditAddItemValidationStep/page.mdx": "2025-09-12T14:10:32.604Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderEditAddItemWorkflow/page.mdx": "2025-09-18T17:04:41.206Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderEditItemQuantityValidationStep/page.mdx": "2025-09-12T14:10:32.621Z",
@@ -472,8 +472,8 @@ export const generatedEditDates = {
"references/stock_location_next/interfaces/stock_location_next.ShippingOptionTypeDTO/page.mdx": "2024-12-23T13:57:07.696Z",
"references/stock_location_next/interfaces/stock_location_next.ShippingProfileDTO/page.mdx": "2024-12-23T13:57:07.704Z",
"references/types/CommonTypes/interfaces/types.CommonTypes.AdminOptions/page.mdx": "2025-04-23T07:49:48.882Z",
- "references/types/CommonTypes/interfaces/types.CommonTypes.ConfigModule/page.mdx": "2025-06-25T10:11:37.097Z",
- "references/types/CommonTypes/interfaces/types.CommonTypes.ProjectConfigOptions/page.mdx": "2025-06-25T10:11:37.093Z",
+ "references/types/CommonTypes/interfaces/types.CommonTypes.ConfigModule/page.mdx": "2025-10-31T09:41:29.432Z",
+ "references/types/CommonTypes/interfaces/types.CommonTypes.ProjectConfigOptions/page.mdx": "2025-10-31T09:41:29.428Z",
"references/types/DmlTypes/interfaces/types.DmlTypes.IDmlEntity/page.mdx": "2025-01-13T18:05:54.049Z",
"references/types/DmlTypes/types/types.DmlTypes.InferTypeOf/page.mdx": "2024-12-09T13:21:33.021Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaimRequestResponse/page.mdx": "2025-09-12T14:10:39.486Z",
@@ -551,15 +551,15 @@ export const generatedEditDates = {
"references/notification/classes/notification.AbstractNotificationProviderService/page.mdx": "2025-06-05T19:05:53.498Z",
"references/order/interfaces/order.IOrderModuleService/page.mdx": "2025-03-04T13:33:53.711Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCampaignResponse/page.mdx": "2025-10-21T08:10:45.709Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx": "2025-10-21T08:10:46.621Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx": "2025-10-31T09:41:30.958Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategoryListResponse/page.mdx": "2025-10-21T08:10:46.636Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategoryResponse/page.mdx": "2025-02-11T11:36:49.739Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminReservationResponse/page.mdx": "2025-04-11T09:04:47.505Z",
- "references/types/NotificationTypes/interfaces/types.NotificationTypes.INotificationModuleService/page.mdx": "2025-10-21T08:10:48.038Z",
+ "references/types/NotificationTypes/interfaces/types.NotificationTypes.INotificationModuleService/page.mdx": "2025-10-31T09:41:32.518Z",
"references/types/NotificationTypes/interfaces/types.NotificationTypes.INotificationProvider/page.mdx": "2024-12-17T16:57:21.140Z",
"references/types/NotificationTypes/interfaces/types.NotificationTypes.NotificationDTO/page.mdx": "2024-12-17T16:57:21.129Z",
"references/types/NotificationTypes/interfaces/types.NotificationTypes.ProviderSendNotificationDTO/page.mdx": "2024-12-17T16:57:21.138Z",
- "references/types/interfaces/types.BaseProductCategory/page.mdx": "2025-10-21T08:10:47.421Z",
+ "references/types/interfaces/types.BaseProductCategory/page.mdx": "2025-10-31T09:41:31.832Z",
"references/types/types.NotificationTypes/page.mdx": "2024-11-25T17:49:28.027Z",
"app/medusa-cli/commands/db/page.mdx": "2025-01-16T07:34:08.014Z",
"app/medusa-cli/commands/develop/page.mdx": "2025-09-01T15:31:35.072Z",
@@ -575,11 +575,11 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCustomerGroupResponse/page.mdx": "2024-12-09T13:21:33.581Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCustomerInGroupFilters/page.mdx": "2025-01-13T17:30:27.952Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetCampaignParams/page.mdx": "2024-12-09T13:21:33.349Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetCampaignsParams/page.mdx": "2024-12-23T13:57:05.173Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetCampaignsParams/page.mdx": "2025-10-31T09:41:29.946Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetCustomerGroupParams/page.mdx": "2024-12-09T13:21:33.581Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetCustomerGroupsParams/page.mdx": "2025-01-13T18:05:54.363Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetReservationsParams/page.mdx": "2025-04-11T09:04:47.502Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetWorkflowExecutionsParams/page.mdx": "2025-05-20T07:51:41.063Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetCustomerGroupsParams/page.mdx": "2025-10-31T09:41:30.205Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetReservationsParams/page.mdx": "2025-10-31T09:41:31.353Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetWorkflowExecutionsParams/page.mdx": "2025-10-31T09:41:31.684Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminReservationParams/page.mdx": "2024-12-09T13:21:34.509Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateCustomerGroup/page.mdx": "2024-12-09T13:21:33.573Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateReservation/page.mdx": "2025-04-11T09:04:47.500Z",
@@ -597,7 +597,7 @@ export const generatedEditDates = {
"references/types/interfaces/types.BaseCustomerGroup/page.mdx": "2025-05-20T07:51:41.083Z",
"references/types/interfaces/types.BatchPriceListPricesWorkflowDTO/page.mdx": "2024-12-09T13:21:35.477Z",
"references/types/interfaces/types.BatchPriceListPricesWorkflowResult/page.mdx": "2024-12-09T13:21:35.481Z",
- "references/types/interfaces/types.CartWorkflowDTO/page.mdx": "2025-06-25T10:11:37.008Z",
+ "references/types/interfaces/types.CartWorkflowDTO/page.mdx": "2025-10-31T09:41:29.331Z",
"references/types/interfaces/types.CompleteCartWorkflowInputDTO/page.mdx": "2024-12-09T13:21:32.813Z",
"references/types/interfaces/types.ConfirmVariantInventoryWorkflowInputDTO/page.mdx": "2025-03-04T13:33:49.888Z",
"references/types/interfaces/types.CreateCartAddressDTO/page.mdx": "2025-05-20T07:51:41.084Z",
@@ -637,8 +637,8 @@ export const generatedEditDates = {
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateTaxLinesWorkflow/page.mdx": "2025-09-18T17:04:38.755Z",
"references/core_flows/Cart/core_flows.Cart.Steps_Cart/page.mdx": "2025-02-11T11:36:38.987Z",
"references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.useRemoteQueryStep/page.mdx": "2025-01-13T17:30:23.158Z",
- "references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingOptionRulesStep/page.mdx": "2025-10-21T08:10:37.349Z",
- "references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.deleteShippingOptionRulesStep/page.mdx": "2025-10-25T20:13:58.381Z",
+ "references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingOptionRulesStep/page.mdx": "2025-10-31T09:41:20.667Z",
+ "references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.deleteShippingOptionRulesStep/page.mdx": "2025-10-31T09:41:20.683Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.cancelOrderClaimStep/page.mdx": "2025-01-17T16:43:22.988Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.cancelOrderExchangeStep/page.mdx": "2025-01-17T16:43:23.041Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.cancelOrderReturnStep/page.mdx": "2025-01-17T16:43:23.074Z",
@@ -680,7 +680,7 @@ export const generatedEditDates = {
"references/core_flows/types/core_flows.UpdateOrderTaxLinesWorkflowInput/page.mdx": "2025-04-23T16:21:22.350Z",
"references/core_flows/types/core_flows.UpdateTaxLinesWorkflowInput/page.mdx": "2025-06-25T10:11:32.641Z",
"references/helper_steps/functions/helper_steps.useRemoteQueryStep/page.mdx": "2025-01-17T16:43:22.250Z",
- "references/modules/types/page.mdx": "2025-10-21T08:10:45.033Z",
+ "references/modules/types/page.mdx": "2025-10-31T09:41:29.221Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelReturn/page.mdx": "2025-10-21T08:10:49.934Z",
"references/order/interfaces/order.CancelOrderClaimDTO/page.mdx": "2025-01-17T16:43:29.277Z",
"references/order/interfaces/order.CancelOrderExchangeDTO/page.mdx": "2025-01-17T16:43:29.280Z",
@@ -692,7 +692,7 @@ export const generatedEditDates = {
"app/test-tools-reference/medusaIntegrationTestRunner/page.mdx": "2025-09-01T16:10:30.965Z",
"app/test-tools-reference/moduleIntegrationTestRunner/page.mdx": "2025-09-01T16:13:56.959Z",
"app/test-tools-reference/page.mdx": "2024-12-09T16:23:04.825Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetInvitesParams/page.mdx": "2025-01-13T18:05:54.493Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetInvitesParams/page.mdx": "2025-10-31T09:41:30.577Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryLevel/page.mdx": "2024-12-23T13:57:05.362Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.BaseAddress/page.mdx": "2024-12-09T13:21:33.325Z",
"references/types/HttpTypes/types/types.HttpTypes.AdminCampaignDeleteResponse/page.mdx": "2024-09-03T00:10:55.015Z",
@@ -714,10 +714,10 @@ export const generatedEditDates = {
"references/cart/interfaces/cart.LineItemAdjustmentDTO/page.mdx": "2025-06-25T10:11:34.883Z",
"references/cart/interfaces/cart.LineItemTaxLineDTO/page.mdx": "2025-06-25T10:11:34.901Z",
"references/cart/interfaces/cart.UpdateLineItemWithSelectorDTO/page.mdx": "2025-06-25T10:11:35.038Z",
- "references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.createCartsStep/page.mdx": "2025-10-25T20:13:57.076Z",
+ "references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.createCartsStep/page.mdx": "2025-10-31T09:41:19.386Z",
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.createLineItemsStep/page.mdx": "2025-06-25T10:11:27.966Z",
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.getActionsToComputeFromPromotionsStep/page.mdx": "2025-05-20T07:51:40.751Z",
- "references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.retrieveCartStep/page.mdx": "2025-10-25T20:13:57.237Z",
+ "references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.retrieveCartStep/page.mdx": "2025-10-31T09:41:19.549Z",
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateLineItemsStep/page.mdx": "2025-06-25T10:11:28.156Z",
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateCartShippingOptionsStep/page.mdx": "2025-09-18T17:04:38.450Z",
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.validateExistingPaymentCollectionStep/page.mdx": "2025-05-20T07:51:40.757Z",
@@ -735,7 +735,7 @@ export const generatedEditDates = {
"references/core_flows/Line_Item/Steps_Line_Item/functions/core_flows.Line_Item.Steps_Line_Item.listLineItemsStep/page.mdx": "2025-06-25T10:11:29.536Z",
"references/core_flows/Line_Item/Steps_Line_Item/functions/core_flows.Line_Item.Steps_Line_Item.updateLineItemsStepWithSelector/page.mdx": "2025-06-25T10:11:29.566Z",
"references/core_flows/Line_Item/core_flows.Line_Item.Steps_Line_Item/page.mdx": "2024-12-23T12:30:24.048Z",
- "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductsWorkflow/page.mdx": "2025-09-18T17:04:42.519Z",
+ "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductsWorkflow/page.mdx": "2025-10-31T09:41:23.626Z",
"references/core_flows/Product/core_flows.Product.Workflows_Product/page.mdx": "2025-05-22T12:22:27.103Z",
"references/core_flows/Region/Workflows_Region/functions/core_flows.Region.Workflows_Region.createRegionsWorkflow/page.mdx": "2025-09-18T17:04:42.749Z",
"references/core_flows/Region/Workflows_Region/functions/core_flows.Region.Workflows_Region.deleteRegionsWorkflow/page.mdx": "2025-09-18T17:04:42.753Z",
@@ -768,7 +768,6 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminExchangeDeleteResponse/page.mdx": "2024-12-09T13:21:33.729Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentSetDeleteResponse/page.mdx": "2024-12-09T13:21:33.757Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItem/page.mdx": "2024-12-23T13:57:05.361Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemParams/page.mdx": "2025-01-13T18:05:54.486Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemResponse/page.mdx": "2024-12-09T13:21:33.801Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListDeleteResponse/page.mdx": "2024-12-09T13:21:34.181Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategoryDeleteResponse/page.mdx": "2024-12-09T13:21:34.221Z",
@@ -776,16 +775,16 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTypeDeleteResponse/page.mdx": "2024-12-09T13:21:34.273Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReasonDeleteResponse/page.mdx": "2024-12-09T13:21:34.529Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminShippingOptionDeleteResponse/page.mdx": "2024-12-09T13:21:34.641Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminShippingOptionListParams/page.mdx": "2025-04-11T09:04:47.623Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminShippingOptionListParams/page.mdx": "2025-10-31T09:41:31.503Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminShippingProfileDeleteResponse/page.mdx": "2024-12-09T13:21:34.661Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminStockLocationDeleteResponse/page.mdx": "2024-12-09T13:21:34.681Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminStockLocationListParams/page.mdx": "2025-04-11T09:04:47.666Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminStockLocationListParams/page.mdx": "2025-10-31T09:41:31.560Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRateDeleteResponse/page.mdx": "2024-12-09T13:21:34.709Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRateListParams/page.mdx": "2025-04-11T09:04:47.696Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRateListParams/page.mdx": "2025-10-31T09:41:31.601Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegionDeleteResponse/page.mdx": "2024-12-09T13:21:34.725Z",
"references/types/HttpTypes/types/types.HttpTypes.DeleteResponse/page.mdx": "2024-12-09T13:21:33.545Z",
"references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.validateRefundStep/page.mdx": "2025-09-12T14:10:33.138Z",
- "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.addOrderTransactionStep/page.mdx": "2025-10-25T20:13:58.894Z",
+ "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.addOrderTransactionStep/page.mdx": "2025-10-31T09:41:21.200Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.archiveOrdersStep/page.mdx": "2025-09-12T14:10:31.586Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.completeOrdersStep/page.mdx": "2025-09-12T14:10:31.641Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrdersStep/page.mdx": "2025-09-12T14:10:31.677Z",
@@ -872,7 +871,7 @@ export const generatedEditDates = {
"references/promotion/types/promotion.UsageComputedActions/page.mdx": "2025-10-21T08:10:51.303Z",
"references/modules/product/page.mdx": "2025-01-17T16:43:29.966Z",
"references/modules/promotion/page.mdx": "2025-10-21T08:10:51.228Z",
- "references/product/interfaces/product.IProductModuleService/page.mdx": "2025-09-12T14:10:44.379Z",
+ "references/product/interfaces/product.IProductModuleService/page.mdx": "2025-10-31T09:41:35.643Z",
"references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.registerUsage/page.mdx": "2025-10-21T08:10:51.357Z",
"references/promotion/interfaces/promotion.IPromotionModuleService/page.mdx": "2024-11-25T17:49:58.612Z",
"references/types/EventBusTypes/interfaces/types.EventBusTypes.IEventBusService/page.mdx": "2025-04-11T09:04:46.063Z",
@@ -925,9 +924,9 @@ export const generatedEditDates = {
"references/core_flows/Auth/core_flows.Auth.Steps_Auth/page.mdx": "2024-12-23T12:30:23.503Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderClaimItemsFromActionsStep/page.mdx": "2025-05-20T07:51:40.780Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderExchangeItemsFromActionsStep/page.mdx": "2025-05-20T07:51:40.781Z",
- "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangeActionsStep/page.mdx": "2025-10-25T20:13:59.116Z",
- "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderChangeActionsWorkflow/page.mdx": "2025-10-25T20:13:59.515Z",
- "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderChangeActionsWorkflow/page.mdx": "2025-10-25T20:14:00.453Z",
+ "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangeActionsStep/page.mdx": "2025-10-31T09:41:21.421Z",
+ "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderChangeActionsWorkflow/page.mdx": "2025-10-31T09:41:21.823Z",
+ "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderChangeActionsWorkflow/page.mdx": "2025-10-31T09:41:22.786Z",
"references/core_flows/core_flows.Auth/page.mdx": "2024-12-23T12:30:23.503Z",
"references/core_flows/core_flows.Steps_Auth/page.mdx": "2024-12-09T13:21:37.257Z",
"references/core_flows/types/core_flows.CreateOrderClaimItemsFromActionsInput/page.mdx": "2025-09-12T14:10:34.808Z",
@@ -937,7 +936,7 @@ export const generatedEditDates = {
"references/order/IOrderModuleService/methods/order.IOrderModuleService.retrieveOrderChangeAction/page.mdx": "2025-10-21T08:10:49.741Z",
"references/order/IOrderModuleService/methods/order.IOrderModuleService.updateOrderChangeActions/page.mdx": "2025-10-21T08:10:49.750Z",
"references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunction/page.mdx": "2025-10-21T08:10:47.957Z",
- "references/types/types.CommonTypes/page.mdx": "2025-06-25T10:11:37.045Z",
+ "references/types/types.CommonTypes/page.mdx": "2025-10-31T09:41:29.372Z",
"app/storefront-development/publishable-api-keys/page.mdx": "2025-03-26T10:31:43.815Z",
"references/api_key/types/api_key.ExpandScalar/page.mdx": "2024-09-17T00:10:59.563Z",
"references/api_key/types/api_key.FilterQuery/page.mdx": "2024-11-27T16:33:40.706Z",
@@ -1065,26 +1064,26 @@ export const generatedEditDates = {
"references/core_flows/Inventory/core_flows.Inventory.Steps_Inventory/page.mdx": "2024-12-23T12:30:23.988Z",
"references/core_flows/Inventory/core_flows.Inventory.Workflows_Inventory/page.mdx": "2025-01-13T17:30:23.526Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderLineItemsStep/page.mdx": "2025-05-20T07:51:40.781Z",
- "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateReturnsStep/page.mdx": "2025-10-25T20:13:59.106Z",
+ "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateReturnsStep/page.mdx": "2025-10-31T09:41:21.412Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.addOrderLineItemsWorkflow/page.mdx": "2025-09-18T17:04:40.302Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderWorkflow/page.mdx": "2025-09-18T17:04:40.344Z",
- "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createCollectionsWorkflow/page.mdx": "2025-09-18T17:04:42.333Z",
- "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductOptionsWorkflow/page.mdx": "2025-09-18T17:04:42.343Z",
- "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTagsWorkflow/page.mdx": "2025-09-18T17:04:42.351Z",
+ "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createCollectionsWorkflow/page.mdx": "2025-10-31T09:41:23.445Z",
+ "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductOptionsWorkflow/page.mdx": "2025-10-31T09:41:23.454Z",
+ "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTagsWorkflow/page.mdx": "2025-10-31T09:41:23.462Z",
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTypesWorkflow/page.mdx": "2025-09-18T17:04:42.358Z",
- "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductVariantsWorkflow/page.mdx": "2025-09-18T17:04:42.374Z",
- "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductsWorkflow/page.mdx": "2025-09-18T17:04:42.391Z",
+ "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductVariantsWorkflow/page.mdx": "2025-10-31T09:41:23.483Z",
+ "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductsWorkflow/page.mdx": "2025-10-31T09:41:23.500Z",
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteCollectionsWorkflow/page.mdx": "2025-09-18T17:04:42.396Z",
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductOptionsWorkflow/page.mdx": "2025-09-18T17:04:42.402Z",
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductTagsWorkflow/page.mdx": "2025-09-18T17:04:42.414Z",
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductTypesWorkflow/page.mdx": "2025-09-18T17:04:42.409Z",
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductVariantsWorkflow/page.mdx": "2025-09-18T17:04:42.419Z",
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductsWorkflow/page.mdx": "2025-09-18T17:04:42.423Z",
- "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateCollectionsWorkflow/page.mdx": "2025-09-18T17:04:42.433Z",
- "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductOptionsWorkflow/page.mdx": "2025-09-18T17:04:42.446Z",
- "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductTagsWorkflow/page.mdx": "2025-09-18T17:04:42.463Z",
+ "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateCollectionsWorkflow/page.mdx": "2025-10-31T09:41:23.544Z",
+ "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductOptionsWorkflow/page.mdx": "2025-10-31T09:41:23.553Z",
+ "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductTagsWorkflow/page.mdx": "2025-10-31T09:41:23.571Z",
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductTypesWorkflow/page.mdx": "2025-09-18T17:04:42.454Z",
- "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductVariantsWorkflow/page.mdx": "2025-09-18T17:04:42.477Z",
+ "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductVariantsWorkflow/page.mdx": "2025-10-31T09:41:23.584Z",
"references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.createCampaignsWorkflow/page.mdx": "2025-10-21T08:10:40.118Z",
"references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.createPromotionsWorkflow/page.mdx": "2025-10-21T08:10:40.131Z",
"references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.deleteCampaignsWorkflow/page.mdx": "2025-09-18T17:04:42.681Z",
@@ -1356,7 +1355,7 @@ export const generatedEditDates = {
"references/payment/interfaces/payment.JoinerServiceConfig/page.mdx": "2025-05-20T07:51:40.998Z",
"references/payment/interfaces/payment.JoinerServiceConfigAlias/page.mdx": "2025-05-20T07:51:40.998Z",
"references/payment/types/payment.JoinerRelationship/page.mdx": "2024-12-09T13:22:02.304Z",
- "references/payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx": "2025-10-21T08:10:52.792Z",
+ "references/payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx": "2025-10-31T09:41:38.608Z",
"references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.addPriceListPrices/page.mdx": "2025-10-21T08:10:50.653Z",
"references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.addPrices/page.mdx": "2025-10-21T08:10:50.580Z",
"references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.calculatePrices/page.mdx": "2025-10-21T08:10:50.545Z",
@@ -1410,8 +1409,8 @@ export const generatedEditDates = {
"references/product/IProductModuleService/methods/product.IProductModuleService.createProductOptions/page.mdx": "2025-10-21T08:10:51.045Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.createProductTags/page.mdx": "2025-10-21T08:10:50.973Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.createProductTypes/page.mdx": "2025-10-21T08:10:51.005Z",
- "references/product/IProductModuleService/methods/product.IProductModuleService.createProductVariants/page.mdx": "2025-10-21T08:10:51.113Z",
- "references/product/IProductModuleService/methods/product.IProductModuleService.createProducts/page.mdx": "2025-10-21T08:10:50.927Z",
+ "references/product/IProductModuleService/methods/product.IProductModuleService.createProductVariants/page.mdx": "2025-10-31T09:41:35.892Z",
+ "references/product/IProductModuleService/methods/product.IProductModuleService.createProducts/page.mdx": "2025-10-31T09:41:35.680Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.deleteProductCategories/page.mdx": "2025-10-21T08:10:51.211Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.deleteProductCollections/page.mdx": "2025-10-21T08:10:51.170Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.deleteProductOptions/page.mdx": "2025-10-21T08:10:51.059Z",
@@ -1431,8 +1430,8 @@ export const generatedEditDates = {
"references/product/IProductModuleService/methods/product.IProductModuleService.listProductOptions/page.mdx": "2025-10-21T08:10:51.033Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.listProductTags/page.mdx": "2025-10-21T08:10:50.965Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.listProductTypes/page.mdx": "2025-10-21T08:10:50.994Z",
- "references/product/IProductModuleService/methods/product.IProductModuleService.listProductVariants/page.mdx": "2025-10-21T08:10:51.103Z",
- "references/product/IProductModuleService/methods/product.IProductModuleService.listProducts/page.mdx": "2025-10-21T08:10:50.908Z",
+ "references/product/IProductModuleService/methods/product.IProductModuleService.listProductVariants/page.mdx": "2025-10-31T09:41:35.875Z",
+ "references/product/IProductModuleService/methods/product.IProductModuleService.listProducts/page.mdx": "2025-10-31T09:41:35.658Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.restoreProductCategories/page.mdx": "2025-10-21T08:10:51.215Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.restoreProductCollections/page.mdx": "2025-10-21T08:10:51.174Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.restoreProductOptions/page.mdx": "2025-10-21T08:10:51.063Z",
@@ -1440,13 +1439,13 @@ export const generatedEditDates = {
"references/product/IProductModuleService/methods/product.IProductModuleService.restoreProductTypes/page.mdx": "2025-10-21T08:10:51.026Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.restoreProductVariants/page.mdx": "2025-10-21T08:10:51.138Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.restoreProducts/page.mdx": "2025-10-21T08:10:50.955Z",
- "references/product/IProductModuleService/methods/product.IProductModuleService.retrieveProduct/page.mdx": "2025-10-21T08:10:50.900Z",
+ "references/product/IProductModuleService/methods/product.IProductModuleService.retrieveProduct/page.mdx": "2025-10-31T09:41:35.649Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.retrieveProductCategory/page.mdx": "2025-10-21T08:10:51.178Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.retrieveProductCollection/page.mdx": "2025-10-21T08:10:51.141Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.retrieveProductOption/page.mdx": "2025-10-21T08:10:51.029Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.retrieveProductTag/page.mdx": "2025-10-21T08:10:50.962Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.retrieveProductType/page.mdx": "2025-10-21T08:10:50.990Z",
- "references/product/IProductModuleService/methods/product.IProductModuleService.retrieveProductVariant/page.mdx": "2025-10-21T08:10:51.098Z",
+ "references/product/IProductModuleService/methods/product.IProductModuleService.retrieveProductVariant/page.mdx": "2025-10-31T09:41:35.869Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.softDeleteProductCategories/page.mdx": "2025-10-21T08:10:51.213Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.softDeleteProductCollections/page.mdx": "2025-10-21T08:10:51.172Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.softDeleteProductOptions/page.mdx": "2025-10-21T08:10:51.061Z",
@@ -1459,15 +1458,15 @@ export const generatedEditDates = {
"references/product/IProductModuleService/methods/product.IProductModuleService.updateProductOptions/page.mdx": "2025-10-21T08:10:51.057Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.updateProductTags/page.mdx": "2025-10-21T08:10:50.982Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.updateProductTypes/page.mdx": "2025-10-21T08:10:51.016Z",
- "references/product/IProductModuleService/methods/product.IProductModuleService.updateProductVariants/page.mdx": "2025-10-21T08:10:51.131Z",
- "references/product/IProductModuleService/methods/product.IProductModuleService.updateProducts/page.mdx": "2025-10-21T08:10:50.949Z",
+ "references/product/IProductModuleService/methods/product.IProductModuleService.updateProductVariants/page.mdx": "2025-10-31T09:41:35.909Z",
+ "references/product/IProductModuleService/methods/product.IProductModuleService.updateProducts/page.mdx": "2025-10-31T09:41:35.710Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.upsertProductCategories/page.mdx": "2025-10-21T08:10:51.202Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.upsertProductCollections/page.mdx": "2025-10-21T08:10:51.162Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.upsertProductOptions/page.mdx": "2025-10-21T08:10:51.051Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.upsertProductTags/page.mdx": "2025-10-21T08:10:50.977Z",
"references/product/IProductModuleService/methods/product.IProductModuleService.upsertProductTypes/page.mdx": "2025-10-21T08:10:51.009Z",
- "references/product/IProductModuleService/methods/product.IProductModuleService.upsertProductVariants/page.mdx": "2025-10-21T08:10:51.124Z",
- "references/product/IProductModuleService/methods/product.IProductModuleService.upsertProducts/page.mdx": "2025-10-21T08:10:50.936Z",
+ "references/product/IProductModuleService/methods/product.IProductModuleService.upsertProductVariants/page.mdx": "2025-10-31T09:41:35.900Z",
+ "references/product/IProductModuleService/methods/product.IProductModuleService.upsertProducts/page.mdx": "2025-10-31T09:41:35.691Z",
"references/product/interfaces/product.Context/page.mdx": "2025-10-21T08:10:51.227Z",
"references/product/interfaces/product.JoinerServiceConfig/page.mdx": "2025-05-20T07:51:41.024Z",
"references/product/interfaces/product.JoinerServiceConfigAlias/page.mdx": "2025-05-20T07:51:41.024Z",
@@ -1639,8 +1638,8 @@ export const generatedEditDates = {
"references/workflows/types/workflows.CreateWorkflowComposerContext/page.mdx": "2025-07-24T08:20:55.470Z",
"references/workflows/types/workflows.InvokeFn/page.mdx": "2025-06-25T10:11:45.300Z",
"references/workflows/types/workflows.StepFunctionResult/page.mdx": "2025-07-24T08:20:55.449Z",
- "references/types/IndexTypes/interfaces/types.IndexTypes.IIndexService/page.mdx": "2025-05-22T12:22:35.051Z",
- "references/types/types.IndexTypes/page.mdx": "2025-05-20T07:51:41.086Z",
+ "references/types/IndexTypes/interfaces/types.IndexTypes.IIndexService/page.mdx": "2025-10-31T09:41:31.991Z",
+ "references/types/types.IndexTypes/page.mdx": "2025-10-31T09:41:31.953Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminServiceZone/page.mdx": "2025-05-20T07:51:41.066Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminShippingOption/page.mdx": "2025-05-20T07:51:41.067Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminShippingOptionResponse/page.mdx": "2025-04-11T09:04:47.626Z",
@@ -1709,13 +1708,13 @@ export const generatedEditDates = {
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.findSalesChannelStep/page.mdx": "2025-01-13T17:30:22.985Z",
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.getPromotionCodesToApply/page.mdx": "2025-01-13T17:30:22.998Z",
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.getVariantPriceSetsStep/page.mdx": "2025-01-13T17:30:23.000Z",
- "references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.getVariantsStep/page.mdx": "2025-05-20T07:51:40.752Z",
+ "references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.getVariantsStep/page.mdx": "2025-10-31T09:41:19.498Z",
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.prepareAdjustmentsFromPromotionActionsStep/page.mdx": "2025-08-14T12:59:34.787Z",
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.removeLineItemAdjustmentsStep/page.mdx": "2025-01-13T17:30:23.007Z",
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.removeShippingMethodAdjustmentsStep/page.mdx": "2025-01-13T17:30:23.012Z",
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.removeShippingMethodFromCartStep/page.mdx": "2025-01-13T17:30:23.013Z",
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.reserveInventoryStep/page.mdx": "2025-04-11T09:04:35.568Z",
- "references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateCartPromotionsStep/page.mdx": "2025-10-25T20:13:57.246Z",
+ "references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateCartPromotionsStep/page.mdx": "2025-10-31T09:41:19.558Z",
"references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateVariantPricesStep/page.mdx": "2025-01-13T18:05:49.333Z",
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refreshPaymentCollectionForCartWorkflow/page.mdx": "2025-09-18T17:04:38.678Z",
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateCartPromotionsWorkflow/page.mdx": "2025-09-18T17:04:38.724Z",
@@ -1726,7 +1725,7 @@ export const generatedEditDates = {
"references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.maybeUnsetDefaultShippingAddressesStep/page.mdx": "2025-05-20T07:51:40.758Z",
"references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.updateCustomerAddressesStep/page.mdx": "2025-05-20T07:51:40.758Z",
"references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.updateCustomersStep/page.mdx": "2025-05-20T07:51:40.759Z",
- "references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.createCustomerGroupsStep/page.mdx": "2025-10-25T20:13:57.837Z",
+ "references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.createCustomerGroupsStep/page.mdx": "2025-10-31T09:41:20.136Z",
"references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.deleteCustomerGroupStep/page.mdx": "2025-01-13T17:30:23.255Z",
"references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.linkCustomersToCustomerGroupStep/page.mdx": "2025-01-13T18:05:49.505Z",
"references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.updateCustomerGroupsStep/page.mdx": "2025-05-20T07:51:40.761Z",
@@ -1741,10 +1740,10 @@ export const generatedEditDates = {
"references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.deleteFilesWorkflow/page.mdx": "2025-09-18T17:04:39.383Z",
"references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.uploadFilesWorkflow/page.mdx": "2025-10-25T20:13:58.245Z",
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.cancelFulfillmentStep/page.mdx": "2025-01-13T17:30:23.344Z",
- "references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createFulfillmentSets/page.mdx": "2025-10-25T20:13:58.279Z",
- "references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createServiceZonesStep/page.mdx": "2025-10-25T20:13:58.352Z",
- "references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingOptionsPriceSetsStep/page.mdx": "2025-10-25T20:13:58.261Z",
- "references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingProfilesStep/page.mdx": "2025-10-25T20:13:58.370Z",
+ "references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createFulfillmentSets/page.mdx": "2025-10-31T09:41:20.580Z",
+ "references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createServiceZonesStep/page.mdx": "2025-10-31T09:41:20.655Z",
+ "references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingOptionsPriceSetsStep/page.mdx": "2025-10-31T09:41:20.567Z",
+ "references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingProfilesStep/page.mdx": "2025-10-31T09:41:20.674Z",
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.deleteFulfillmentSetsStep/page.mdx": "2025-01-13T17:30:23.386Z",
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.deleteServiceZonesStep/page.mdx": "2025-01-13T17:30:23.387Z",
"references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.deleteShippingOptionsStep/page.mdx": "2025-01-13T17:30:23.392Z",
@@ -1768,7 +1767,7 @@ export const generatedEditDates = {
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.createInventoryLevelsStep/page.mdx": "2025-04-11T09:04:36.537Z",
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.deleteInventoryItemStep/page.mdx": "2025-01-13T17:30:23.517Z",
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.deleteInventoryLevelsStep/page.mdx": "2025-01-13T17:30:23.519Z",
- "references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.updateInventoryItemsStep/page.mdx": "2025-10-25T20:13:58.694Z",
+ "references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.updateInventoryItemsStep/page.mdx": "2025-10-31T09:41:20.999Z",
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.updateInventoryLevelsStep/page.mdx": "2025-04-11T09:04:36.558Z",
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryItemsForCreate/page.mdx": "2025-01-13T17:30:23.525Z",
"references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryLocationsStep/page.mdx": "2025-01-13T17:30:23.524Z",
@@ -1783,24 +1782,24 @@ export const generatedEditDates = {
"references/core_flows/Invite/Steps_Invite/functions/core_flows.Invite.Steps_Invite.validateTokenStep/page.mdx": "2025-01-13T17:30:23.565Z",
"references/core_flows/Line_Item/Steps_Line_Item/functions/core_flows.Line_Item.Steps_Line_Item.deleteLineItemsStep/page.mdx": "2025-01-13T17:30:23.577Z",
"references/core_flows/Line_Item/Workflows_Line_Item/functions/core_flows.Line_Item.Workflows_Line_Item.deleteLineItemsWorkflow/page.mdx": "2025-09-18T17:04:39.988Z",
- "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.cancelOrderChangeStep/page.mdx": "2025-10-25T20:13:58.918Z",
+ "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.cancelOrderChangeStep/page.mdx": "2025-10-31T09:41:21.225Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.cancelOrderFulfillmentStep/page.mdx": "2025-05-20T07:51:40.777Z",
- "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.declineOrderChangeStep/page.mdx": "2025-10-25T20:13:59.013Z",
- "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteClaimsStep/page.mdx": "2025-10-25T20:13:58.957Z",
- "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteExchangesStep/page.mdx": "2025-10-25T20:13:59.042Z",
- "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderChangeActionsStep/page.mdx": "2025-10-25T20:13:59.018Z",
- "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderChangesStep/page.mdx": "2025-10-25T20:13:59.021Z",
- "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderLineItems/page.mdx": "2025-10-25T20:13:59.015Z",
- "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderShippingMethods/page.mdx": "2025-10-25T20:13:59.023Z",
- "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteReturnsStep/page.mdx": "2025-10-25T20:13:59.099Z",
+ "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.declineOrderChangeStep/page.mdx": "2025-10-31T09:41:21.318Z",
+ "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteClaimsStep/page.mdx": "2025-10-31T09:41:21.261Z",
+ "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteExchangesStep/page.mdx": "2025-10-31T09:41:21.346Z",
+ "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderChangeActionsStep/page.mdx": "2025-10-31T09:41:21.323Z",
+ "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderChangesStep/page.mdx": "2025-10-31T09:41:21.326Z",
+ "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderLineItems/page.mdx": "2025-10-31T09:41:21.320Z",
+ "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderShippingMethods/page.mdx": "2025-10-31T09:41:21.328Z",
+ "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteReturnsStep/page.mdx": "2025-10-31T09:41:21.405Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.registerOrderFulfillmentStep/page.mdx": "2025-05-20T07:51:40.785Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.registerOrderShipmentStep/page.mdx": "2025-05-20T07:51:40.785Z",
- "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderShippingMethodsStep/page.mdx": "2025-10-25T20:13:59.150Z",
+ "references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderShippingMethodsStep/page.mdx": "2025-10-31T09:41:21.455Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateReturnItemsStep/page.mdx": "2025-01-13T18:05:49.942Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelBeginOrderClaimWorkflow/page.mdx": "2025-09-18T17:04:40.369Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelBeginOrderEditWorkflow/page.mdx": "2025-09-18T17:04:41.039Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelBeginOrderExchangeWorkflow/page.mdx": "2025-09-18T17:04:40.799Z",
- "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderChangeWorkflow/page.mdx": "2025-10-25T20:13:59.188Z",
+ "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderChangeWorkflow/page.mdx": "2025-10-31T09:41:21.494Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderClaimWorkflow/page.mdx": "2025-09-18T17:04:40.376Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderExchangeWorkflow/page.mdx": "2025-09-18T17:04:40.807Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelReturnReceiveWorkflow/page.mdx": "2025-09-18T17:04:41.291Z",
@@ -1809,27 +1808,27 @@ export const generatedEditDates = {
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createAndCompleteReturnOrderWorkflow/page.mdx": "2025-09-18T17:04:41.371Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createCompleteReturnValidationStep/page.mdx": "2025-05-20T07:51:40.824Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderPaymentCollectionWorkflow/page.mdx": "2025-09-18T17:04:40.739Z",
- "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.declineOrderChangeWorkflow/page.mdx": "2025-10-25T20:13:59.604Z",
- "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderChangeActionsWorkflow/page.mdx": "2025-10-25T20:13:59.608Z",
- "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderChangeWorkflow/page.mdx": "2025-10-25T20:13:59.612Z",
+ "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.declineOrderChangeWorkflow/page.mdx": "2025-10-31T09:41:21.915Z",
+ "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderChangeActionsWorkflow/page.mdx": "2025-10-31T09:41:21.919Z",
+ "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderChangeWorkflow/page.mdx": "2025-10-31T09:41:21.923Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderPaymentCollections/page.mdx": "2025-09-18T17:04:40.770Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.getOrderDetailWorkflow/page.mdx": "2025-09-18T17:04:40.986Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.markPaymentCollectionAsPaid/page.mdx": "2025-09-18T17:04:41.010Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.receiveAndCompleteReturnOrderWorkflow/page.mdx": "2025-09-18T17:04:41.422Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.receiveCompleteReturnValidationStep/page.mdx": "2025-05-20T07:51:40.837Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.throwUnlessPaymentCollectionNotPaid/page.mdx": "2025-05-20T07:51:40.845Z",
- "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.throwUnlessStatusIsNotPaid/page.mdx": "2025-10-25T20:13:59.615Z",
+ "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.throwUnlessStatusIsNotPaid/page.mdx": "2025-10-31T09:41:21.926Z",
"references/core_flows/Payment/Steps_Payment/functions/core_flows.Payment.Steps_Payment.authorizePaymentSessionStep/page.mdx": "2025-06-25T10:11:31.118Z",
"references/core_flows/Payment/Steps_Payment/functions/core_flows.Payment.Steps_Payment.cancelPaymentStep/page.mdx": "2025-01-13T17:30:25.526Z",
"references/core_flows/Payment/Steps_Payment/functions/core_flows.Payment.Steps_Payment.capturePaymentStep/page.mdx": "2025-06-25T10:11:31.137Z",
"references/core_flows/Payment/Steps_Payment/functions/core_flows.Payment.Steps_Payment.refundPaymentStep/page.mdx": "2025-06-25T10:11:31.150Z",
"references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.capturePaymentWorkflow/page.mdx": "2025-09-18T17:04:41.817Z",
- "references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.createPaymentSessionStep/page.mdx": "2025-10-25T20:14:00.654Z",
+ "references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.createPaymentSessionStep/page.mdx": "2025-10-31T09:41:22.983Z",
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.createRefundReasonStep/page.mdx": "2025-10-21T08:10:39.425Z",
- "references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.deletePaymentSessionsStep/page.mdx": "2025-10-25T20:14:00.661Z",
+ "references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.deletePaymentSessionsStep/page.mdx": "2025-10-31T09:41:22.990Z",
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.deleteRefundReasonsStep/page.mdx": "2025-01-13T17:30:25.585Z",
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.updatePaymentCollectionStep/page.mdx": "2025-06-25T10:11:31.275Z",
- "references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.updateRefundReasonsStep/page.mdx": "2025-10-25T20:14:00.683Z",
+ "references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.updateRefundReasonsStep/page.mdx": "2025-10-31T09:41:23.013Z",
"references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.validateDeletedPaymentSessionsStep/page.mdx": "2025-01-13T17:30:25.592Z",
"references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.createPaymentSessionsWorkflow/page.mdx": "2025-09-18T17:04:41.941Z",
"references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.createRefundReasonsWorkflow/page.mdx": "2025-10-21T08:10:39.473Z",
@@ -1839,7 +1838,7 @@ export const generatedEditDates = {
"references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.getExistingPriceListsPriceIdsStep/page.mdx": "2025-01-13T17:30:25.619Z",
"references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.removePriceListPricesStep/page.mdx": "2025-01-13T17:30:25.620Z",
"references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.updatePriceListsStep/page.mdx": "2025-04-11T09:04:40.617Z",
- "references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.validatePriceListsStep/page.mdx": "2025-10-25T20:14:00.767Z",
+ "references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.validatePriceListsStep/page.mdx": "2025-10-31T09:41:23.105Z",
"references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.validateVariantPriceLinksStep/page.mdx": "2025-01-13T17:30:25.630Z",
"references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.deletePriceListsWorkflow/page.mdx": "2025-09-18T17:04:42.042Z",
"references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.removePriceListPricesWorkflow/page.mdx": "2025-09-18T17:04:42.046Z",
@@ -1853,12 +1852,12 @@ export const generatedEditDates = {
"references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.deletePricePreferencesWorkflow/page.mdx": "2025-09-18T17:04:42.101Z",
"references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.updatePricePreferencesWorkflow/page.mdx": "2025-10-21T08:10:39.619Z",
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.batchLinkProductsToCollectionStep/page.mdx": "2025-01-13T18:05:52.101Z",
- "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createCollectionsStep/page.mdx": "2025-10-25T20:14:00.894Z",
- "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductOptionsStep/page.mdx": "2025-04-11T09:04:40.737Z",
- "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductTagsStep/page.mdx": "2025-04-11T09:04:40.811Z",
+ "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createCollectionsStep/page.mdx": "2025-10-31T09:41:23.237Z",
+ "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductOptionsStep/page.mdx": "2025-10-31T09:41:23.244Z",
+ "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductTagsStep/page.mdx": "2025-10-31T09:41:23.254Z",
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductTypesStep/page.mdx": "2025-04-11T09:04:40.815Z",
- "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductVariantsStep/page.mdx": "2025-04-11T09:04:40.744Z",
- "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductsStep/page.mdx": "2025-04-11T09:04:40.724Z",
+ "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductVariantsStep/page.mdx": "2025-10-31T09:41:23.272Z",
+ "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductsStep/page.mdx": "2025-10-31T09:41:23.225Z",
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createVariantPricingLinkStep/page.mdx": "2025-01-13T17:30:25.692Z",
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.deleteCollectionsStep/page.mdx": "2025-01-13T17:30:25.693Z",
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.deleteProductOptionsStep/page.mdx": "2025-01-13T17:30:25.694Z",
@@ -1866,30 +1865,30 @@ export const generatedEditDates = {
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.deleteProductTypesStep/page.mdx": "2025-01-13T17:30:25.727Z",
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.deleteProductVariantsStep/page.mdx": "2025-01-13T17:30:25.696Z",
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.deleteProductsStep/page.mdx": "2025-01-13T17:30:25.698Z",
- "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.generateProductCsvStep/page.mdx": "2025-10-21T08:10:39.765Z",
+ "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.generateProductCsvStep/page.mdx": "2025-10-31T09:41:23.374Z",
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.getAllProductsStep/page.mdx": "2025-06-25T10:11:31.535Z",
- "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.getProductsStep/page.mdx": "2025-04-11T09:04:40.771Z",
+ "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.getProductsStep/page.mdx": "2025-10-31T09:41:23.313Z",
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.parseProductCsvStep/page.mdx": "2025-05-20T07:51:40.859Z",
- "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateCollectionsStep/page.mdx": "2025-04-11T09:04:40.841Z",
- "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductOptionsStep/page.mdx": "2025-04-11T09:04:40.790Z",
- "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductTagsStep/page.mdx": "2025-04-11T09:04:40.853Z",
+ "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateCollectionsStep/page.mdx": "2025-10-31T09:41:23.342Z",
+ "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductOptionsStep/page.mdx": "2025-10-31T09:41:23.337Z",
+ "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductTagsStep/page.mdx": "2025-10-31T09:41:23.401Z",
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductTypesStep/page.mdx": "2025-04-11T09:04:40.856Z",
- "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductVariantsStep/page.mdx": "2025-04-11T09:04:40.800Z",
- "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductsStep/page.mdx": "2025-06-25T10:11:31.563Z",
+ "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductVariantsStep/page.mdx": "2025-10-31T09:41:23.360Z",
+ "references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductsStep/page.mdx": "2025-10-31T09:41:23.329Z",
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.waitConfirmationProductImportStep/page.mdx": "2025-01-13T17:30:25.739Z",
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchLinkProductsToCategoryWorkflow/page.mdx": "2025-09-18T17:04:42.312Z",
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchLinkProductsToCollectionWorkflow/page.mdx": "2025-09-18T17:04:42.297Z",
- "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchProductVariantsWorkflow/page.mdx": "2025-09-18T17:04:42.307Z",
- "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchProductsWorkflow/page.mdx": "2025-09-18T17:04:42.324Z",
+ "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchProductVariantsWorkflow/page.mdx": "2025-10-31T09:41:23.419Z",
+ "references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchProductsWorkflow/page.mdx": "2025-10-31T09:41:23.432Z",
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.exportProductsWorkflow/page.mdx": "2025-09-18T17:04:42.487Z",
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.importProductsWorkflow/page.mdx": "2025-09-18T17:04:42.499Z",
"references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.upsertVariantPricesWorkflow/page.mdx": "2025-09-18T17:04:42.525Z",
- "references/core_flows/Product_Category/Steps_Product_Category/functions/core_flows.Product_Category.Steps_Product_Category.createProductCategoriesStep/page.mdx": "2025-04-11T09:04:41.068Z",
+ "references/core_flows/Product_Category/Steps_Product_Category/functions/core_flows.Product_Category.Steps_Product_Category.createProductCategoriesStep/page.mdx": "2025-10-31T09:41:23.647Z",
"references/core_flows/Product_Category/Steps_Product_Category/functions/core_flows.Product_Category.Steps_Product_Category.deleteProductCategoriesStep/page.mdx": "2025-01-13T17:30:25.836Z",
- "references/core_flows/Product_Category/Steps_Product_Category/functions/core_flows.Product_Category.Steps_Product_Category.updateProductCategoriesStep/page.mdx": "2025-04-11T09:04:41.084Z",
- "references/core_flows/Product_Category/Workflows_Product_Category/functions/core_flows.Product_Category.Workflows_Product_Category.createProductCategoriesWorkflow/page.mdx": "2025-09-18T17:04:42.572Z",
+ "references/core_flows/Product_Category/Steps_Product_Category/functions/core_flows.Product_Category.Steps_Product_Category.updateProductCategoriesStep/page.mdx": "2025-10-31T09:41:23.660Z",
+ "references/core_flows/Product_Category/Workflows_Product_Category/functions/core_flows.Product_Category.Workflows_Product_Category.createProductCategoriesWorkflow/page.mdx": "2025-10-31T09:41:23.673Z",
"references/core_flows/Product_Category/Workflows_Product_Category/functions/core_flows.Product_Category.Workflows_Product_Category.deleteProductCategoriesWorkflow/page.mdx": "2025-09-18T17:04:42.577Z",
- "references/core_flows/Product_Category/Workflows_Product_Category/functions/core_flows.Product_Category.Workflows_Product_Category.updateProductCategoriesWorkflow/page.mdx": "2025-09-18T17:04:42.591Z",
+ "references/core_flows/Product_Category/Workflows_Product_Category/functions/core_flows.Product_Category.Workflows_Product_Category.updateProductCategoriesWorkflow/page.mdx": "2025-10-31T09:41:23.694Z",
"references/core_flows/Promotion/Steps_Promotion/functions/core_flows.Promotion.Steps_Promotion.addCampaignPromotionsStep/page.mdx": "2025-02-11T11:36:44.164Z",
"references/core_flows/Promotion/Steps_Promotion/functions/core_flows.Promotion.Steps_Promotion.createCampaignsStep/page.mdx": "2025-10-21T08:10:40.071Z",
"references/core_flows/Promotion/Steps_Promotion/functions/core_flows.Promotion.Steps_Promotion.createPromotionsStep/page.mdx": "2025-10-21T08:10:40.076Z",
@@ -1927,7 +1926,7 @@ export const generatedEditDates = {
"references/core_flows/Sales_Channel/Workflows_Sales_Channel/functions/core_flows.Sales_Channel.Workflows_Sales_Channel.linkProductsToSalesChannelWorkflow/page.mdx": "2025-09-18T17:04:42.897Z",
"references/core_flows/Shipping_Profile/Steps_Shipping_Profile/functions/core_flows.Shipping_Profile.Steps_Shipping_Profile.deleteShippingProfilesStep/page.mdx": "2025-01-13T17:30:25.996Z",
"references/core_flows/Shipping_Profile/Workflows_Shipping_Profile/functions/core_flows.Shipping_Profile.Workflows_Shipping_Profile.deleteShippingProfileWorkflow/page.mdx": "2025-09-18T17:04:43.029Z",
- "references/core_flows/Stock_Location/Steps_Stock_Location/functions/core_flows.Stock_Location.Steps_Stock_Location.createStockLocations/page.mdx": "2025-10-25T20:14:01.783Z",
+ "references/core_flows/Stock_Location/Steps_Stock_Location/functions/core_flows.Stock_Location.Steps_Stock_Location.createStockLocations/page.mdx": "2025-10-31T09:41:24.132Z",
"references/core_flows/Stock_Location/Steps_Stock_Location/functions/core_flows.Stock_Location.Steps_Stock_Location.deleteStockLocationsStep/page.mdx": "2025-01-13T17:30:26.004Z",
"references/core_flows/Stock_Location/Steps_Stock_Location/functions/core_flows.Stock_Location.Steps_Stock_Location.updateStockLocationsStep/page.mdx": "2025-05-20T07:51:40.869Z",
"references/core_flows/Stock_Location/Workflows_Stock_Location/functions/core_flows.Stock_Location.Workflows_Stock_Location.createLocationFulfillmentSetWorkflow/page.mdx": "2025-09-18T17:04:43.052Z",
@@ -2055,8 +2054,8 @@ export const generatedEditDates = {
"references/region/interfaces/region.MessageAggregatorFormat/page.mdx": "2024-12-09T13:22:04.016Z",
"references/region/interfaces/region.PaymentProviderDTO/page.mdx": "2024-12-09T13:22:03.956Z",
"references/region/interfaces/region.RegionDTO/page.mdx": "2024-12-09T13:22:03.956Z",
- "references/region_models/variables/region_models.Country/page.mdx": "2025-10-25T20:14:21.722Z",
- "references/region_models/variables/region_models.Region/page.mdx": "2025-10-25T20:14:21.726Z",
+ "references/region_models/variables/region_models.Country/page.mdx": "2025-10-31T09:41:44.492Z",
+ "references/region_models/variables/region_models.Region/page.mdx": "2025-10-31T09:41:44.496Z",
"references/sales_channel/IMessageAggregator/methods/sales_channel.IMessageAggregator.getMessages/page.mdx": "2025-04-11T09:04:52.240Z",
"references/sales_channel/interfaces/sales_channel.IModuleService/page.mdx": "2024-12-09T13:22:04.060Z",
"references/sales_channel/interfaces/sales_channel.MessageAggregatorFormat/page.mdx": "2024-12-09T13:22:04.104Z",
@@ -2075,12 +2074,12 @@ export const generatedEditDates = {
"references/tax/interfaces/tax.IModuleService/page.mdx": "2024-12-09T13:22:04.508Z",
"references/tax/interfaces/tax.MessageAggregatorFormat/page.mdx": "2024-12-09T13:22:04.512Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateReturnReason/page.mdx": "2025-04-11T09:04:47.510Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateTaxRate/page.mdx": "2025-04-11T09:04:47.689Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateTaxRate/page.mdx": "2025-10-31T09:41:31.594Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateTaxRegion/page.mdx": "2025-05-20T07:51:41.058Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateReturnReason/page.mdx": "2025-04-11T09:04:47.512Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateShippingOption/page.mdx": "2025-10-21T08:10:47.106Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateShippingOptionRule/page.mdx": "2025-04-11T09:04:47.616Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateTaxRate/page.mdx": "2025-04-11T09:04:47.690Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateTaxRate/page.mdx": "2025-10-31T09:41:31.595Z",
"references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleExports/page.mdx": "2024-12-09T13:21:35.321Z",
"references/types/types/types.AdminBaseReturnReasonPayload/page.mdx": "2025-04-11T09:04:47.945Z",
"references/user/IMessageAggregator/methods/user.IMessageAggregator.getMessages/page.mdx": "2025-04-11T09:04:52.790Z",
@@ -2168,61 +2167,61 @@ export const generatedEditDates = {
"app/examples/page.mdx": "2025-10-28T16:02:32.447Z",
"app/medusa-cli/commands/build/page.mdx": "2025-09-01T15:30:05.995Z",
"app/js-sdk/page.mdx": "2025-08-01T14:17:07.509Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.apiKey/page.mdx": "2025-10-21T08:10:55.265Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.campaign/page.mdx": "2025-10-21T08:10:55.340Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.claim/page.mdx": "2025-10-21T08:10:55.095Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.currency/page.mdx": "2025-10-21T08:10:55.210Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.customer/page.mdx": "2025-10-21T08:10:54.590Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.customerGroup/page.mdx": "2025-10-21T08:10:55.300Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.exchange/page.mdx": "2025-10-21T08:10:55.146Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.apiKey/page.mdx": "2025-10-31T09:41:41.216Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.campaign/page.mdx": "2025-10-31T09:41:41.295Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.claim/page.mdx": "2025-10-31T09:41:41.044Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.currency/page.mdx": "2025-10-31T09:41:41.159Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.customer/page.mdx": "2025-10-31T09:41:40.524Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.customerGroup/page.mdx": "2025-10-31T09:41:41.253Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.exchange/page.mdx": "2025-10-31T09:41:41.094Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.fulfillment/page.mdx": "2025-05-20T07:51:40.928Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.fulfillmentProvider/page.mdx": "2025-10-21T08:10:54.801Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.fulfillmentProvider/page.mdx": "2025-10-31T09:41:40.739Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.fulfillmentSet/page.mdx": "2025-05-20T07:51:40.928Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.inventoryItem/page.mdx": "2025-10-21T08:10:54.864Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.notification/page.mdx": "2025-10-21T08:10:54.870Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.invite/page.mdx": "2025-10-21T08:10:54.562Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.order/page.mdx": "2025-10-21T08:10:54.919Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.inventoryItem/page.mdx": "2025-10-31T09:41:40.804Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.notification/page.mdx": "2025-10-31T09:41:40.809Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.invite/page.mdx": "2025-10-31T09:41:40.499Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.order/page.mdx": "2025-10-31T09:41:40.855Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.orderEdit/page.mdx": "2025-09-12T14:10:48.321Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.payment/page.mdx": "2025-10-21T08:10:55.221Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.paymentCollection/page.mdx": "2024-12-26T11:37:18.123Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.priceList/page.mdx": "2025-10-21T08:10:54.634Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.pricePreference/page.mdx": "2025-10-21T08:10:54.644Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.product/page.mdx": "2025-10-21T08:10:54.696Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productCategory/page.mdx": "2025-10-21T08:10:54.616Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productCollection/page.mdx": "2025-10-21T08:10:54.603Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productTag/page.mdx": "2025-10-21T08:10:55.190Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productType/page.mdx": "2025-10-21T08:10:54.711Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productVariant/page.mdx": "2025-10-21T08:10:55.225Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.promotion/page.mdx": "2025-10-21T08:10:55.326Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.refundReason/page.mdx": "2025-10-21T08:10:55.236Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.region/page.mdx": "2025-10-21T08:10:54.729Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.reservation/page.mdx": "2025-10-21T08:10:55.288Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.return/page.mdx": "2025-10-21T08:10:55.032Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.returnReason/page.mdx": "2025-10-21T08:10:54.741Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.salesChannel/page.mdx": "2025-10-21T08:10:54.775Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.shippingOption/page.mdx": "2025-10-21T08:10:54.814Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.shippingProfile/page.mdx": "2025-10-21T08:10:54.840Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.stockLocation/page.mdx": "2025-10-21T08:10:54.761Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.store/page.mdx": "2025-10-21T08:10:55.180Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.taxRate/page.mdx": "2025-10-21T08:10:55.161Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.taxRegion/page.mdx": "2025-10-21T08:10:55.173Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.payment/page.mdx": "2025-10-31T09:41:41.171Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.paymentCollection/page.mdx": "2025-10-31T09:41:41.193Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.priceList/page.mdx": "2025-10-31T09:41:40.569Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.pricePreference/page.mdx": "2025-10-31T09:41:40.582Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.product/page.mdx": "2025-10-31T09:41:40.638Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productCategory/page.mdx": "2025-10-31T09:41:40.554Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productCollection/page.mdx": "2025-10-31T09:41:40.540Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productTag/page.mdx": "2025-10-31T09:41:41.140Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productType/page.mdx": "2025-10-31T09:41:40.650Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productVariant/page.mdx": "2025-10-31T09:41:41.175Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.promotion/page.mdx": "2025-10-31T09:41:41.276Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.refundReason/page.mdx": "2025-10-31T09:41:41.186Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.region/page.mdx": "2025-10-31T09:41:40.672Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.reservation/page.mdx": "2025-10-31T09:41:41.240Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.return/page.mdx": "2025-10-31T09:41:40.977Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.returnReason/page.mdx": "2025-10-31T09:41:40.684Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.salesChannel/page.mdx": "2025-10-31T09:41:40.717Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.shippingOption/page.mdx": "2025-10-31T09:41:40.757Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.shippingProfile/page.mdx": "2025-10-31T09:41:40.778Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.stockLocation/page.mdx": "2025-10-31T09:41:40.703Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.store/page.mdx": "2025-10-31T09:41:41.129Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.taxRate/page.mdx": "2025-10-31T09:41:41.106Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.taxRegion/page.mdx": "2025-10-31T09:41:41.122Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.upload/page.mdx": "2025-05-22T12:22:42.720Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.user/page.mdx": "2025-10-21T08:10:55.205Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.workflowExecution/page.mdx": "2025-10-21T08:10:55.270Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.user/page.mdx": "2025-10-31T09:41:41.151Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.workflowExecution/page.mdx": "2025-10-31T09:41:41.221Z",
"references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.batchSalesChannels/page.mdx": "2025-04-11T09:04:53.652Z",
- "references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.create/page.mdx": "2025-01-13T18:05:57.861Z",
+ "references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.create/page.mdx": "2025-10-31T09:41:39.627Z",
"references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.delete/page.mdx": "2024-12-09T13:21:56.912Z",
- "references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.list/page.mdx": "2025-10-21T08:10:53.732Z",
+ "references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.list/page.mdx": "2025-10-31T09:41:39.623Z",
"references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.retrieve/page.mdx": "2024-12-09T13:21:56.908Z",
"references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.revoke/page.mdx": "2024-12-09T13:21:56.904Z",
- "references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.update/page.mdx": "2025-01-13T18:05:57.866Z",
+ "references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.update/page.mdx": "2025-10-31T09:41:39.637Z",
"references/js_sdk/admin/ApiKey/properties/js_sdk.admin.ApiKey.client/page.mdx": "2025-08-14T12:59:51.929Z",
"references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.batchPromotions/page.mdx": "2025-04-11T09:04:53.713Z",
- "references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.create/page.mdx": "2025-10-21T08:10:53.810Z",
+ "references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.create/page.mdx": "2025-10-31T09:41:39.703Z",
"references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.delete/page.mdx": "2024-12-09T13:21:56.972Z",
- "references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.list/page.mdx": "2025-10-21T08:10:53.808Z",
+ "references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.list/page.mdx": "2025-10-31T09:41:39.701Z",
"references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.retrieve/page.mdx": "2025-10-21T08:10:53.806Z",
- "references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.update/page.mdx": "2025-10-21T08:10:53.812Z",
+ "references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.update/page.mdx": "2025-10-31T09:41:39.706Z",
"references/js_sdk/admin/Campaign/properties/js_sdk.admin.Campaign.client/page.mdx": "2025-08-14T12:59:52.002Z",
"references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addInboundItems/page.mdx": "2025-09-12T14:10:47.269Z",
"references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addInboundShipping/page.mdx": "2025-09-12T14:10:47.278Z",
@@ -2231,10 +2230,10 @@ export const generatedEditDates = {
"references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addOutboundShipping/page.mdx": "2025-09-12T14:10:47.299Z",
"references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.cancel/page.mdx": "2024-12-09T13:21:57.036Z",
"references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.cancelRequest/page.mdx": "2024-12-09T13:21:57.096Z",
- "references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.create/page.mdx": "2025-09-12T14:10:47.253Z",
+ "references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.create/page.mdx": "2025-10-31T09:41:39.775Z",
"references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.deleteOutboundShipping/page.mdx": "2025-09-12T14:10:47.308Z",
"references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.deleteInboundShipping/page.mdx": "2025-09-12T14:10:47.285Z",
- "references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.list/page.mdx": "2025-10-21T08:10:53.870Z",
+ "references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.list/page.mdx": "2025-10-31T09:41:39.768Z",
"references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.removeInboundItem/page.mdx": "2025-09-12T14:10:47.274Z",
"references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.removeItem/page.mdx": "2025-09-12T14:10:47.266Z",
"references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.removeOutboundItem/page.mdx": "2025-09-12T14:10:47.295Z",
@@ -2242,8 +2241,8 @@ export const generatedEditDates = {
"references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.retrieve/page.mdx": "2024-12-09T13:21:57.032Z",
"references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateInboundItem/page.mdx": "2025-09-12T14:10:47.272Z",
"references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateInboundShipping/page.mdx": "2025-09-12T14:10:47.283Z",
- "references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateItem/page.mdx": "2025-09-12T14:10:47.262Z",
- "references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateOutboundItem/page.mdx": "2025-09-12T14:10:47.292Z",
+ "references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateItem/page.mdx": "2025-10-31T09:41:39.792Z",
+ "references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateOutboundItem/page.mdx": "2025-10-31T09:41:39.820Z",
"references/js_sdk/admin/Claim/properties/js_sdk.admin.Claim.client/page.mdx": "2025-08-14T12:59:52.074Z",
"references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateOutboundShipping/page.mdx": "2025-09-12T14:10:47.303Z",
"references/js_sdk/admin/Client/methods/js_sdk.admin.Client.clearToken/page.mdx": "2025-02-24T10:48:47.006Z",
@@ -2263,39 +2262,39 @@ export const generatedEditDates = {
"references/js_sdk/admin/Client/properties/js_sdk.admin.Client.config/page.mdx": "2025-05-20T07:51:40.935Z",
"references/js_sdk/admin/Client/properties/js_sdk.admin.Client.logger/page.mdx": "2025-02-11T11:36:58.508Z",
"references/js_sdk/admin/Client/properties/js_sdk.admin.Client.token/page.mdx": "2024-10-22T15:09:53.737Z",
- "references/js_sdk/admin/Currency/methods/js_sdk.admin.Currency.list/page.mdx": "2025-10-21T08:10:54.000Z",
+ "references/js_sdk/admin/Currency/methods/js_sdk.admin.Currency.list/page.mdx": "2025-10-31T09:41:39.898Z",
"references/js_sdk/admin/Currency/methods/js_sdk.admin.Currency.retrieve/page.mdx": "2024-12-09T13:21:57.140Z",
"references/js_sdk/admin/Currency/properties/js_sdk.admin.Currency.client/page.mdx": "2025-08-14T12:59:52.218Z",
"references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.create/page.mdx": "2024-12-09T13:21:57.244Z",
"references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.delete/page.mdx": "2025-04-11T09:04:54.005Z",
- "references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.list/page.mdx": "2025-10-21T08:10:54.132Z",
+ "references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.list/page.mdx": "2025-10-31T09:41:40.034Z",
"references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.retrieve/page.mdx": "2025-04-11T09:04:54.003Z",
"references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.update/page.mdx": "2024-12-09T13:21:57.248Z",
"references/js_sdk/admin/Customer/properties/js_sdk.admin.Customer.client/page.mdx": "2025-08-14T12:59:52.343Z",
"references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.batchCustomers/page.mdx": "2025-04-11T09:04:53.944Z",
"references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.create/page.mdx": "2024-12-09T13:21:57.188Z",
"references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.delete/page.mdx": "2024-12-09T13:21:57.196Z",
- "references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.list/page.mdx": "2025-10-21T08:10:54.061Z",
+ "references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.list/page.mdx": "2025-10-31T09:41:39.962Z",
"references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.retrieve/page.mdx": "2024-12-09T13:21:57.184Z",
"references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.update/page.mdx": "2024-12-09T13:21:57.192Z",
"references/js_sdk/admin/CustomerGroup/properties/js_sdk.admin.CustomerGroup.client/page.mdx": "2025-08-14T12:59:52.274Z",
- "references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addInboundItems/page.mdx": "2025-09-12T14:10:47.689Z",
+ "references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addInboundItems/page.mdx": "2025-10-31T09:41:40.247Z",
"references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addInboundShipping/page.mdx": "2025-09-12T14:10:47.699Z",
- "references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addOutboundItems/page.mdx": "2025-09-12T14:10:47.708Z",
+ "references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addOutboundItems/page.mdx": "2025-10-31T09:41:40.268Z",
"references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addOutboundShipping/page.mdx": "2025-09-12T14:10:47.717Z",
"references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.cancel/page.mdx": "2024-12-09T13:21:57.316Z",
"references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.cancelRequest/page.mdx": "2024-12-09T13:21:57.364Z",
"references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.create/page.mdx": "2024-12-09T13:21:57.316Z",
"references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.deleteInboundShipping/page.mdx": "2025-09-12T14:10:47.704Z",
"references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.deleteOutboundShipping/page.mdx": "2025-09-12T14:10:47.724Z",
- "references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.list/page.mdx": "2025-10-21T08:10:54.316Z",
+ "references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.list/page.mdx": "2025-10-31T09:41:40.237Z",
"references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.removeInboundItem/page.mdx": "2025-09-12T14:10:47.696Z",
"references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.removeOutboundItem/page.mdx": "2025-09-12T14:10:47.714Z",
"references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.request/page.mdx": "2025-09-12T14:10:47.727Z",
"references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.retrieve/page.mdx": "2024-12-09T13:21:57.312Z",
"references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateInboundItem/page.mdx": "2025-09-12T14:10:47.692Z",
"references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateInboundShipping/page.mdx": "2025-09-12T14:10:47.702Z",
- "references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateOutboundItem/page.mdx": "2025-09-12T14:10:47.711Z",
+ "references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateOutboundItem/page.mdx": "2025-10-31T09:41:40.272Z",
"references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateOutboundShipping/page.mdx": "2025-09-12T14:10:47.721Z",
"references/js_sdk/admin/Exchange/properties/js_sdk.admin.Exchange.client/page.mdx": "2025-08-14T12:59:52.536Z",
"references/js_sdk/admin/FetchStreamResponse/properties/js_sdk.admin.FetchStreamResponse.abort/page.mdx": "2025-02-11T11:36:58.597Z",
@@ -2304,7 +2303,7 @@ export const generatedEditDates = {
"references/js_sdk/admin/Fulfillment/methods/js_sdk.admin.Fulfillment.create/page.mdx": "2025-05-20T07:51:40.938Z",
"references/js_sdk/admin/Fulfillment/methods/js_sdk.admin.Fulfillment.createShipment/page.mdx": "2024-12-09T13:21:57.516Z",
"references/js_sdk/admin/Fulfillment/properties/js_sdk.admin.Fulfillment.client/page.mdx": "2025-08-14T12:59:52.752Z",
- "references/js_sdk/admin/FulfillmentProvider/methods/js_sdk.admin.FulfillmentProvider.list/page.mdx": "2025-10-21T08:10:54.422Z",
+ "references/js_sdk/admin/FulfillmentProvider/methods/js_sdk.admin.FulfillmentProvider.list/page.mdx": "2025-10-31T09:41:40.347Z",
"references/js_sdk/admin/FulfillmentProvider/properties/js_sdk.admin.FulfillmentProvider.client/page.mdx": "2025-08-14T12:59:52.640Z",
"references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.createServiceZone/page.mdx": "2025-05-20T07:51:40.939Z",
"references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.delete/page.mdx": "2024-12-09T13:21:57.456Z",
@@ -2316,8 +2315,8 @@ export const generatedEditDates = {
"references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.create/page.mdx": "2025-01-17T16:43:31.709Z",
"references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.delete/page.mdx": "2024-12-09T13:21:58.268Z",
"references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.deleteLevel/page.mdx": "2025-01-17T16:43:31.718Z",
- "references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.list/page.mdx": "2025-10-21T08:10:55.445Z",
- "references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.listLevels/page.mdx": "2025-10-21T08:10:55.451Z",
+ "references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.list/page.mdx": "2025-10-31T09:41:41.406Z",
+ "references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.listLevels/page.mdx": "2025-10-31T09:41:41.416Z",
"references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.retrieve/page.mdx": "2025-01-17T16:43:31.714Z",
"references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.update/page.mdx": "2024-12-09T13:21:58.260Z",
"references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.updateLevel/page.mdx": "2025-01-17T16:43:31.717Z",
@@ -2325,23 +2324,23 @@ export const generatedEditDates = {
"references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.accept/page.mdx": "2025-04-11T13:17:47.236Z",
"references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.create/page.mdx": "2024-12-10T14:55:10.090Z",
"references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.delete/page.mdx": "2024-12-09T13:21:58.332Z",
- "references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.list/page.mdx": "2025-10-21T08:10:55.522Z",
+ "references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.list/page.mdx": "2025-10-31T09:41:41.494Z",
"references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.resend/page.mdx": "2024-12-10T14:55:10.094Z",
"references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.retrieve/page.mdx": "2024-12-10T14:55:10.091Z",
"references/js_sdk/admin/Invite/properties/js_sdk.admin.Invite.client/page.mdx": "2025-08-14T12:59:53.621Z",
- "references/js_sdk/admin/Notification/methods/js_sdk.admin.Notification.list/page.mdx": "2025-10-21T08:10:55.584Z",
+ "references/js_sdk/admin/Notification/methods/js_sdk.admin.Notification.list/page.mdx": "2025-10-31T09:41:41.559Z",
"references/js_sdk/admin/Notification/methods/js_sdk.admin.Notification.retrieve/page.mdx": "2024-12-09T13:21:58.376Z",
"references/js_sdk/admin/Notification/properties/js_sdk.admin.Notification.client/page.mdx": "2025-08-14T12:59:53.683Z",
"references/js_sdk/admin/Order/methods/js_sdk.admin.Order.cancel/page.mdx": "2025-09-12T14:10:49.021Z",
"references/js_sdk/admin/Order/methods/js_sdk.admin.Order.cancelFulfillment/page.mdx": "2025-09-12T14:10:49.034Z",
"references/js_sdk/admin/Order/methods/js_sdk.admin.Order.createFulfillment/page.mdx": "2025-09-12T14:10:49.031Z",
"references/js_sdk/admin/Order/methods/js_sdk.admin.Order.createShipment/page.mdx": "2025-09-12T14:10:49.037Z",
- "references/js_sdk/admin/Order/methods/js_sdk.admin.Order.list/page.mdx": "2025-10-21T08:10:55.720Z",
- "references/js_sdk/admin/Order/methods/js_sdk.admin.Order.listChanges/page.mdx": "2025-01-13T18:05:58.641Z",
- "references/js_sdk/admin/Order/methods/js_sdk.admin.Order.listLineItems/page.mdx": "2024-12-09T13:21:58.524Z",
+ "references/js_sdk/admin/Order/methods/js_sdk.admin.Order.list/page.mdx": "2025-10-31T09:41:41.701Z",
+ "references/js_sdk/admin/Order/methods/js_sdk.admin.Order.listChanges/page.mdx": "2025-10-31T09:41:41.735Z",
+ "references/js_sdk/admin/Order/methods/js_sdk.admin.Order.listLineItems/page.mdx": "2025-10-31T09:41:41.737Z",
"references/js_sdk/admin/Order/methods/js_sdk.admin.Order.markAsDelivered/page.mdx": "2025-09-12T14:10:49.039Z",
"references/js_sdk/admin/Order/methods/js_sdk.admin.Order.retrieve/page.mdx": "2025-09-12T14:10:49.003Z",
- "references/js_sdk/admin/Order/methods/js_sdk.admin.Order.retrievePreview/page.mdx": "2025-09-12T14:10:49.010Z",
+ "references/js_sdk/admin/Order/methods/js_sdk.admin.Order.retrievePreview/page.mdx": "2025-10-31T09:41:41.697Z",
"references/js_sdk/admin/Order/properties/js_sdk.admin.Order.client/page.mdx": "2025-08-14T12:59:53.805Z",
"references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.addItems/page.mdx": "2025-09-12T14:10:48.943Z",
"references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.cancelRequest/page.mdx": "2024-12-09T13:21:58.432Z",
@@ -2353,104 +2352,104 @@ export const generatedEditDates = {
"references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.updateOriginalItem/page.mdx": "2025-09-12T14:10:48.946Z",
"references/js_sdk/admin/OrderEdit/properties/js_sdk.admin.OrderEdit.client/page.mdx": "2025-08-14T12:59:53.735Z",
"references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.capture/page.mdx": "2024-12-09T13:21:58.628Z",
- "references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.list/page.mdx": "2025-10-21T08:10:55.870Z",
- "references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.listPaymentProviders/page.mdx": "2025-10-21T08:10:55.872Z",
- "references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.refund/page.mdx": "2024-12-09T13:21:58.632Z",
+ "references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.list/page.mdx": "2025-10-31T09:41:41.856Z",
+ "references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.listPaymentProviders/page.mdx": "2025-10-31T09:41:41.858Z",
+ "references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.refund/page.mdx": "2025-10-31T09:41:41.866Z",
"references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.retrieve/page.mdx": "2024-12-09T13:21:58.624Z",
"references/js_sdk/admin/Payment/properties/js_sdk.admin.Payment.client/page.mdx": "2025-08-14T12:59:53.955Z",
- "references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.create/page.mdx": "2024-12-09T13:21:58.572Z",
+ "references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.create/page.mdx": "2025-10-31T09:41:41.794Z",
"references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.delete/page.mdx": "2024-12-09T13:21:58.572Z",
"references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.markAsPaid/page.mdx": "2024-12-09T13:21:58.576Z",
"references/js_sdk/admin/PaymentCollection/properties/js_sdk.admin.PaymentCollection.client/page.mdx": "2025-08-14T12:59:53.900Z",
"references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.batchPrices/page.mdx": "2024-12-09T13:21:58.688Z",
- "references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.create/page.mdx": "2024-12-09T13:21:58.680Z",
+ "references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.create/page.mdx": "2025-10-31T09:41:41.983Z",
"references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.delete/page.mdx": "2024-12-09T13:21:58.684Z",
"references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.linkProducts/page.mdx": "2024-12-09T13:21:58.688Z",
- "references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.list/page.mdx": "2025-10-21T08:10:55.991Z",
+ "references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.list/page.mdx": "2025-10-31T09:41:41.981Z",
"references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.retrieve/page.mdx": "2024-12-09T13:21:58.672Z",
"references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.update/page.mdx": "2024-12-09T13:21:58.680Z",
"references/js_sdk/admin/PriceList/properties/js_sdk.admin.PriceList.client/page.mdx": "2025-08-14T12:59:54.067Z",
"references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.create/page.mdx": "2024-12-09T13:21:58.736Z",
"references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.delete/page.mdx": "2024-12-09T13:21:58.740Z",
- "references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.list/page.mdx": "2025-10-21T08:10:56.055Z",
+ "references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.list/page.mdx": "2025-10-31T09:41:42.054Z",
"references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.retrieve/page.mdx": "2024-12-09T13:21:58.732Z",
"references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.update/page.mdx": "2024-12-09T13:21:58.740Z",
"references/js_sdk/admin/PricePreference/properties/js_sdk.admin.PricePreference.client/page.mdx": "2025-08-14T12:59:54.133Z",
"references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batch/page.mdx": "2025-05-20T07:51:40.942Z",
"references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchVariantInventoryItems/page.mdx": "2025-05-20T07:51:40.943Z",
- "references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchVariants/page.mdx": "2025-10-21T08:10:56.462Z",
+ "references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchVariants/page.mdx": "2025-10-31T09:41:42.485Z",
"references/js_sdk/admin/Product/methods/js_sdk.admin.Product.confirmImport/page.mdx": "2025-10-21T08:10:56.434Z",
"references/js_sdk/admin/Product/methods/js_sdk.admin.Product.create/page.mdx": "2025-05-20T07:51:40.943Z",
"references/js_sdk/admin/Product/methods/js_sdk.admin.Product.createOption/page.mdx": "2025-05-20T07:51:40.943Z",
"references/js_sdk/admin/Product/methods/js_sdk.admin.Product.createVariant/page.mdx": "2025-02-11T11:36:57.577Z",
"references/js_sdk/admin/Product/methods/js_sdk.admin.Product.delete/page.mdx": "2024-12-09T13:21:59.084Z",
"references/js_sdk/admin/Product/methods/js_sdk.admin.Product.deleteOption/page.mdx": "2025-05-20T07:51:40.944Z",
- "references/js_sdk/admin/Product/methods/js_sdk.admin.Product.export/page.mdx": "2025-06-25T10:11:48.203Z",
+ "references/js_sdk/admin/Product/methods/js_sdk.admin.Product.export/page.mdx": "2025-10-31T09:41:42.460Z",
"references/js_sdk/admin/Product/methods/js_sdk.admin.Product.import/page.mdx": "2025-05-20T07:51:40.944Z",
- "references/js_sdk/admin/Product/methods/js_sdk.admin.Product.list/page.mdx": "2025-10-21T08:10:56.451Z",
+ "references/js_sdk/admin/Product/methods/js_sdk.admin.Product.list/page.mdx": "2025-10-31T09:41:42.474Z",
"references/js_sdk/admin/Product/methods/js_sdk.admin.Product.deleteVariant/page.mdx": "2025-02-11T11:36:57.586Z",
- "references/js_sdk/admin/Product/methods/js_sdk.admin.Product.listOptions/page.mdx": "2025-10-21T08:10:56.485Z",
- "references/js_sdk/admin/Product/methods/js_sdk.admin.Product.listVariants/page.mdx": "2025-10-21T08:10:56.471Z",
+ "references/js_sdk/admin/Product/methods/js_sdk.admin.Product.listOptions/page.mdx": "2025-10-31T09:41:42.508Z",
+ "references/js_sdk/admin/Product/methods/js_sdk.admin.Product.listVariants/page.mdx": "2025-10-31T09:41:42.494Z",
"references/js_sdk/admin/Product/methods/js_sdk.admin.Product.retrieve/page.mdx": "2025-05-20T07:51:40.945Z",
"references/js_sdk/admin/Product/methods/js_sdk.admin.Product.retrieveOption/page.mdx": "2024-12-09T13:21:59.112Z",
- "references/js_sdk/admin/Product/methods/js_sdk.admin.Product.retrieveVariant/page.mdx": "2025-10-21T08:10:56.473Z",
- "references/js_sdk/admin/Product/methods/js_sdk.admin.Product.update/page.mdx": "2025-02-24T10:48:45.960Z",
+ "references/js_sdk/admin/Product/methods/js_sdk.admin.Product.retrieveVariant/page.mdx": "2025-10-31T09:41:42.496Z",
+ "references/js_sdk/admin/Product/methods/js_sdk.admin.Product.update/page.mdx": "2025-10-31T09:41:42.470Z",
"references/js_sdk/admin/Product/methods/js_sdk.admin.Product.updateOption/page.mdx": "2025-05-20T07:51:40.945Z",
- "references/js_sdk/admin/Product/methods/js_sdk.admin.Product.updateVariant/page.mdx": "2025-05-20T07:51:40.945Z",
+ "references/js_sdk/admin/Product/methods/js_sdk.admin.Product.updateVariant/page.mdx": "2025-10-31T09:41:42.491Z",
"references/js_sdk/admin/Product/properties/js_sdk.admin.Product.client/page.mdx": "2025-08-14T12:59:54.503Z",
"references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.create/page.mdx": "2024-12-09T13:21:58.788Z",
"references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.delete/page.mdx": "2024-12-09T13:21:58.796Z",
- "references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.list/page.mdx": "2025-10-21T08:10:56.122Z",
+ "references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.list/page.mdx": "2025-10-31T09:41:42.125Z",
"references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.retrieve/page.mdx": "2024-12-09T13:21:58.796Z",
"references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.update/page.mdx": "2024-12-09T13:21:58.788Z",
"references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.updateProducts/page.mdx": "2024-12-09T13:21:58.800Z",
"references/js_sdk/admin/ProductCategory/properties/js_sdk.admin.ProductCategory.client/page.mdx": "2025-08-14T12:59:54.195Z",
"references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.create/page.mdx": "2024-12-09T13:21:58.840Z",
"references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.delete/page.mdx": "2024-12-09T13:21:58.852Z",
- "references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.list/page.mdx": "2025-10-21T08:10:56.185Z",
+ "references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.list/page.mdx": "2025-10-31T09:41:42.192Z",
"references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.retrieve/page.mdx": "2024-12-09T13:21:58.852Z",
"references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.update/page.mdx": "2025-02-11T11:36:57.348Z",
"references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.updateProducts/page.mdx": "2024-12-09T13:21:58.856Z",
"references/js_sdk/admin/ProductCollection/properties/js_sdk.admin.ProductCollection.client/page.mdx": "2025-08-14T12:59:54.259Z",
"references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.create/page.mdx": "2024-12-09T13:21:58.900Z",
"references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.delete/page.mdx": "2024-12-09T13:21:58.912Z",
- "references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.list/page.mdx": "2025-10-21T08:10:56.250Z",
+ "references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.list/page.mdx": "2025-10-31T09:41:42.263Z",
"references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.retrieve/page.mdx": "2024-12-09T13:21:58.908Z",
"references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.update/page.mdx": "2024-12-09T13:21:58.904Z",
"references/js_sdk/admin/ProductTag/properties/js_sdk.admin.ProductTag.client/page.mdx": "2025-08-14T12:59:54.323Z",
"references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.create/page.mdx": "2024-12-09T13:21:58.956Z",
"references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.delete/page.mdx": "2024-12-09T13:21:58.968Z",
- "references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.list/page.mdx": "2025-10-21T08:10:56.316Z",
+ "references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.list/page.mdx": "2025-10-31T09:41:42.331Z",
"references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.retrieve/page.mdx": "2024-12-09T13:21:58.964Z",
"references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.update/page.mdx": "2024-12-09T13:21:58.960Z",
"references/js_sdk/admin/ProductType/properties/js_sdk.admin.ProductType.client/page.mdx": "2025-08-14T12:59:54.386Z",
- "references/js_sdk/admin/ProductVariant/methods/js_sdk.admin.ProductVariant.list/page.mdx": "2025-10-21T08:10:56.379Z",
+ "references/js_sdk/admin/ProductVariant/methods/js_sdk.admin.ProductVariant.list/page.mdx": "2025-10-31T09:41:42.398Z",
"references/js_sdk/admin/ProductVariant/properties/js_sdk.admin.ProductVariant.client/page.mdx": "2025-08-14T12:59:54.450Z",
"references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.addRules/page.mdx": "2025-06-25T10:11:48.320Z",
- "references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.create/page.mdx": "2025-06-25T10:11:48.313Z",
+ "references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.create/page.mdx": "2025-10-31T09:41:42.581Z",
"references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.delete/page.mdx": "2025-04-11T09:04:56.145Z",
- "references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.list/page.mdx": "2025-10-21T08:10:56.549Z",
+ "references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.list/page.mdx": "2025-10-31T09:41:42.579Z",
"references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRuleAttributes/page.mdx": "2025-04-11T09:04:56.156Z",
- "references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRuleValues/page.mdx": "2025-10-21T08:10:56.568Z",
- "references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRules/page.mdx": "2025-06-25T10:11:48.326Z",
+ "references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRuleValues/page.mdx": "2025-10-31T09:41:42.599Z",
+ "references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRules/page.mdx": "2025-10-31T09:41:42.595Z",
"references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.removeRules/page.mdx": "2025-06-25T10:11:48.324Z",
"references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.retrieve/page.mdx": "2025-06-25T10:11:48.306Z",
- "references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.update/page.mdx": "2025-07-14T09:31:47.090Z",
+ "references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.update/page.mdx": "2025-10-31T09:41:42.584Z",
"references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.updateRules/page.mdx": "2025-06-25T10:11:48.322Z",
"references/js_sdk/admin/Promotion/properties/js_sdk.admin.Promotion.client/page.mdx": "2025-08-14T12:59:54.616Z",
- "references/js_sdk/admin/RefundReason/methods/js_sdk.admin.RefundReason.list/page.mdx": "2025-10-21T08:10:56.625Z",
+ "references/js_sdk/admin/RefundReason/methods/js_sdk.admin.RefundReason.list/page.mdx": "2025-10-31T09:41:42.657Z",
"references/js_sdk/admin/RefundReason/properties/js_sdk.admin.RefundReason.client/page.mdx": "2025-08-14T12:59:54.693Z",
"references/js_sdk/admin/Region/methods/js_sdk.admin.Region.create/page.mdx": "2025-04-11T09:04:56.254Z",
"references/js_sdk/admin/Region/methods/js_sdk.admin.Region.delete/page.mdx": "2025-04-11T09:04:56.264Z",
- "references/js_sdk/admin/Region/methods/js_sdk.admin.Region.list/page.mdx": "2025-10-21T08:10:56.689Z",
+ "references/js_sdk/admin/Region/methods/js_sdk.admin.Region.list/page.mdx": "2025-10-31T09:41:42.725Z",
"references/js_sdk/admin/Region/methods/js_sdk.admin.Region.retrieve/page.mdx": "2025-04-11T09:04:56.262Z",
"references/js_sdk/admin/Region/methods/js_sdk.admin.Region.update/page.mdx": "2025-04-11T09:04:56.256Z",
"references/js_sdk/admin/Region/properties/js_sdk.admin.Region.client/page.mdx": "2025-08-14T12:59:54.745Z",
- "references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.create/page.mdx": "2025-04-11T09:04:56.318Z",
+ "references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.create/page.mdx": "2025-10-31T09:41:42.794Z",
"references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.delete/page.mdx": "2025-04-11T09:04:56.324Z",
- "references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.list/page.mdx": "2025-10-21T08:10:56.751Z",
+ "references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.list/page.mdx": "2025-10-31T09:41:42.790Z",
"references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.retrieve/page.mdx": "2025-04-11T09:04:56.311Z",
- "references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.update/page.mdx": "2025-04-11T09:04:56.323Z",
+ "references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.update/page.mdx": "2025-10-31T09:41:42.797Z",
"references/js_sdk/admin/Reservation/properties/js_sdk.admin.Reservation.client/page.mdx": "2025-08-14T12:59:54.808Z",
"references/js_sdk/admin/Return/methods/js_sdk.admin.Return.addReturnItem/page.mdx": "2025-04-11T09:04:56.441Z",
"references/js_sdk/admin/Return/methods/js_sdk.admin.Return.addReturnShipping/page.mdx": "2025-04-11T09:04:56.449Z",
@@ -2463,28 +2462,28 @@ export const generatedEditDates = {
"references/js_sdk/admin/Return/methods/js_sdk.admin.Return.deleteReturnShipping/page.mdx": "2025-04-11T09:04:56.453Z",
"references/js_sdk/admin/Return/methods/js_sdk.admin.Return.initiateReceive/page.mdx": "2025-04-11T09:04:56.459Z",
"references/js_sdk/admin/Return/methods/js_sdk.admin.Return.initiateRequest/page.mdx": "2025-04-11T09:04:56.435Z",
- "references/js_sdk/admin/Return/methods/js_sdk.admin.Return.list/page.mdx": "2025-10-21T08:10:56.884Z",
- "references/js_sdk/admin/Return/methods/js_sdk.admin.Return.receiveItems/page.mdx": "2025-04-11T09:04:56.461Z",
+ "references/js_sdk/admin/Return/methods/js_sdk.admin.Return.list/page.mdx": "2025-10-31T09:41:42.923Z",
+ "references/js_sdk/admin/Return/methods/js_sdk.admin.Return.receiveItems/page.mdx": "2025-10-31T09:41:42.953Z",
"references/js_sdk/admin/Return/methods/js_sdk.admin.Return.removeDismissItem/page.mdx": "2025-04-11T09:04:56.472Z",
"references/js_sdk/admin/Return/methods/js_sdk.admin.Return.removeReceiveItem/page.mdx": "2025-04-11T09:04:56.465Z",
"references/js_sdk/admin/Return/methods/js_sdk.admin.Return.removeReturnItem/page.mdx": "2025-04-11T09:04:56.446Z",
"references/js_sdk/admin/Return/methods/js_sdk.admin.Return.retrieve/page.mdx": "2025-04-11T09:04:56.433Z",
"references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateDismissItem/page.mdx": "2025-04-11T09:04:56.470Z",
"references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateReceiveItem/page.mdx": "2025-04-11T09:04:56.463Z",
- "references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateReturnItem/page.mdx": "2025-04-11T09:04:56.443Z",
+ "references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateReturnItem/page.mdx": "2025-10-31T09:41:42.936Z",
"references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateRequest/page.mdx": "2025-04-11T09:04:56.455Z",
"references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateReturnShipping/page.mdx": "2025-04-11T09:04:56.451Z",
"references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.create/page.mdx": "2025-04-11T09:04:56.378Z",
"references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.delete/page.mdx": "2025-04-11T09:04:56.382Z",
"references/js_sdk/admin/Return/properties/js_sdk.admin.Return.client/page.mdx": "2025-08-14T12:59:54.933Z",
- "references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.list/page.mdx": "2025-10-21T08:10:56.818Z",
+ "references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.list/page.mdx": "2025-10-31T09:41:42.855Z",
"references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.update/page.mdx": "2025-04-11T09:04:56.380Z",
"references/js_sdk/admin/ReturnReason/properties/js_sdk.admin.ReturnReason.client/page.mdx": "2025-08-14T12:59:54.872Z",
"references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.retrieve/page.mdx": "2025-04-11T09:04:56.376Z",
"references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.create/page.mdx": "2025-04-11T09:04:56.523Z",
"references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.batchProducts/page.mdx": "2025-04-11T09:04:56.538Z",
"references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.delete/page.mdx": "2025-04-11T09:04:56.527Z",
- "references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.list/page.mdx": "2025-10-21T08:10:56.992Z",
+ "references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.list/page.mdx": "2025-10-31T09:41:43.036Z",
"references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.retrieve/page.mdx": "2025-04-11T09:04:56.530Z",
"references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.update/page.mdx": "2025-04-11T09:04:56.525Z",
"references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.updateProducts/page.mdx": "2025-10-21T08:10:56.994Z",
@@ -2495,7 +2494,7 @@ export const generatedEditDates = {
"references/js_sdk/admin/ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.id/page.mdx": "2024-10-22T15:09:53.774Z",
"references/js_sdk/admin/ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.retry/page.mdx": "2024-10-22T15:09:53.775Z",
"references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.create/page.mdx": "2025-10-21T08:10:57.111Z",
- "references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.list/page.mdx": "2025-10-21T08:10:57.121Z",
+ "references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.list/page.mdx": "2025-10-31T09:41:43.175Z",
"references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.delete/page.mdx": "2025-04-11T09:04:56.593Z",
"references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.retrieve/page.mdx": "2025-04-11T09:04:56.588Z",
"references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.update/page.mdx": "2025-10-21T08:10:57.116Z",
@@ -2504,31 +2503,31 @@ export const generatedEditDates = {
"references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.create/page.mdx": "2025-04-11T09:04:56.644Z",
"references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.delete/page.mdx": "2025-04-11T09:04:56.648Z",
"references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.retrieve/page.mdx": "2025-04-11T09:04:56.656Z",
- "references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.list/page.mdx": "2025-10-21T08:10:57.185Z",
+ "references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.list/page.mdx": "2025-10-31T09:41:43.241Z",
"references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.update/page.mdx": "2025-04-11T09:04:56.647Z",
"references/js_sdk/admin/ShippingProfile/properties/js_sdk.admin.ShippingProfile.client/page.mdx": "2025-08-14T12:59:55.163Z",
"references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.create/page.mdx": "2025-05-20T07:51:40.950Z",
"references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.createFulfillmentSet/page.mdx": "2025-04-11T09:04:56.726Z",
"references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.delete/page.mdx": "2025-04-11T09:04:56.717Z",
- "references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.list/page.mdx": "2025-10-21T08:10:57.246Z",
+ "references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.list/page.mdx": "2025-10-31T09:41:43.306Z",
"references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.updateFulfillmentProviders/page.mdx": "2025-04-11T09:04:56.728Z",
"references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.updateSalesChannels/page.mdx": "2025-04-11T09:04:56.724Z",
"references/js_sdk/admin/StockLocation/properties/js_sdk.admin.StockLocation.client/page.mdx": "2025-08-14T12:59:55.222Z",
"references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.retrieve/page.mdx": "2025-04-11T09:04:56.719Z",
- "references/js_sdk/admin/Store/methods/js_sdk.admin.Store.list/page.mdx": "2025-10-21T08:10:57.309Z",
+ "references/js_sdk/admin/Store/methods/js_sdk.admin.Store.list/page.mdx": "2025-10-31T09:41:43.370Z",
"references/js_sdk/admin/Store/methods/js_sdk.admin.Store.retrieve/page.mdx": "2025-04-11T09:04:56.779Z",
"references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.update/page.mdx": "2025-05-20T07:51:40.950Z",
"references/js_sdk/admin/Store/methods/js_sdk.admin.Store.update/page.mdx": "2025-04-11T09:04:56.784Z",
"references/js_sdk/admin/Store/properties/js_sdk.admin.Store.client/page.mdx": "2025-08-14T12:59:55.290Z",
- "references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.create/page.mdx": "2025-04-11T09:04:56.834Z",
+ "references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.create/page.mdx": "2025-10-31T09:41:43.479Z",
"references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.delete/page.mdx": "2025-04-11T09:04:56.838Z",
- "references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.list/page.mdx": "2025-10-21T08:10:57.425Z",
+ "references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.list/page.mdx": "2025-10-31T09:41:43.493Z",
"references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.retrieve/page.mdx": "2025-04-11T09:04:56.840Z",
- "references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.update/page.mdx": "2025-04-11T09:04:56.837Z",
+ "references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.update/page.mdx": "2025-10-31T09:41:43.485Z",
"references/js_sdk/admin/TaxRate/properties/js_sdk.admin.TaxRate.client/page.mdx": "2025-08-14T12:59:55.395Z",
"references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.create/page.mdx": "2025-05-20T07:51:40.951Z",
"references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.delete/page.mdx": "2025-04-11T09:04:56.895Z",
- "references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.list/page.mdx": "2025-10-21T08:10:57.485Z",
+ "references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.list/page.mdx": "2025-10-31T09:41:43.557Z",
"references/js_sdk/admin/TaxRegion/properties/js_sdk.admin.TaxRegion.client/page.mdx": "2025-08-14T12:59:55.456Z",
"references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.retrieve/page.mdx": "2025-05-20T07:51:40.952Z",
"references/js_sdk/admin/Upload/methods/js_sdk.admin.Upload.delete/page.mdx": "2025-04-11T09:04:56.952Z",
@@ -2536,12 +2535,12 @@ export const generatedEditDates = {
"references/js_sdk/admin/Upload/methods/js_sdk.admin.Upload.retrieve/page.mdx": "2025-04-11T09:04:56.950Z",
"references/js_sdk/admin/Upload/properties/js_sdk.admin.Upload.client/page.mdx": "2025-08-14T12:59:55.517Z",
"references/js_sdk/admin/User/methods/js_sdk.admin.User.delete/page.mdx": "2025-04-11T09:04:57.007Z",
- "references/js_sdk/admin/User/methods/js_sdk.admin.User.list/page.mdx": "2025-10-21T08:10:57.599Z",
+ "references/js_sdk/admin/User/methods/js_sdk.admin.User.list/page.mdx": "2025-10-31T09:41:43.681Z",
"references/js_sdk/admin/User/methods/js_sdk.admin.User.me/page.mdx": "2025-04-11T09:04:57.009Z",
"references/js_sdk/admin/User/methods/js_sdk.admin.User.retrieve/page.mdx": "2025-04-11T09:04:57.005Z",
"references/js_sdk/admin/User/methods/js_sdk.admin.User.update/page.mdx": "2025-04-11T09:04:57.000Z",
"references/js_sdk/admin/User/properties/js_sdk.admin.User.client/page.mdx": "2025-08-14T12:59:55.572Z",
- "references/js_sdk/admin/WorkflowExecution/methods/js_sdk.admin.WorkflowExecution.list/page.mdx": "2025-10-21T08:10:57.729Z",
+ "references/js_sdk/admin/WorkflowExecution/methods/js_sdk.admin.WorkflowExecution.list/page.mdx": "2025-10-31T09:41:43.812Z",
"references/js_sdk/admin/WorkflowExecution/methods/js_sdk.admin.WorkflowExecution.retrieve/page.mdx": "2025-04-11T09:04:57.058Z",
"references/js_sdk/admin/WorkflowExecution/properties/js_sdk.admin.WorkflowExecution.client/page.mdx": "2025-08-14T12:59:55.633Z",
"references/js_sdk/admin/classes/js_sdk.admin.Admin/page.mdx": "2025-09-18T17:04:58.359Z",
@@ -2565,7 +2564,7 @@ export const generatedEditDates = {
"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.PriceList/page.mdx": "2024-11-25T17:49:53.596Z",
"references/js_sdk/admin/classes/js_sdk.admin.PricePreference/page.mdx": "2024-11-25T17:49:53.652Z",
- "references/js_sdk/admin/classes/js_sdk.admin.Product/page.mdx": "2025-05-20T07:51:40.953Z",
+ "references/js_sdk/admin/classes/js_sdk.admin.Product/page.mdx": "2025-10-31T09:41:42.399Z",
"references/js_sdk/admin/classes/js_sdk.admin.ProductCategory/page.mdx": "2024-11-25T17:49:53.704Z",
"references/js_sdk/admin/classes/js_sdk.admin.ProductCollection/page.mdx": "2024-11-25T17:49:53.764Z",
"references/js_sdk/admin/classes/js_sdk.admin.ProductType/page.mdx": "2024-11-25T17:49:53.872Z",
@@ -2605,20 +2604,20 @@ export const generatedEditDates = {
"references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.updateProvider/page.mdx": "2025-03-04T13:34:00.629Z",
"references/js_sdk/auth/classes/js_sdk.auth.Auth/page.mdx": "2024-12-26T11:37:18.128Z",
"references/js_sdk/modules/js_sdk.admin/page.mdx": "2025-09-12T14:10:47.056Z",
- "references/js_sdk/store/Store/properties/js_sdk.store.Store.category/page.mdx": "2025-10-21T08:10:57.919Z",
+ "references/js_sdk/store/Store/properties/js_sdk.store.Store.category/page.mdx": "2025-10-31T09:41:44.009Z",
"references/js_sdk/modules/js_sdk.store/page.mdx": "2024-10-22T15:09:53.787Z",
"references/js_sdk/modules/js_sdk.auth/page.mdx": "2024-10-22T15:09:53.779Z",
- "references/js_sdk/store/Store/properties/js_sdk.store.Store.collection/page.mdx": "2025-10-21T08:10:57.912Z",
+ "references/js_sdk/store/Store/properties/js_sdk.store.Store.collection/page.mdx": "2025-10-31T09:41:44.001Z",
"references/js_sdk/store/Store/properties/js_sdk.store.Store.cart/page.mdx": "2025-10-25T20:14:21.227Z",
- "references/js_sdk/store/Store/properties/js_sdk.store.Store.customer/page.mdx": "2025-10-21T08:10:58.015Z",
- "references/js_sdk/store/Store/properties/js_sdk.store.Store.fulfillment/page.mdx": "2025-10-21T08:10:57.961Z",
- "references/js_sdk/store/Store/properties/js_sdk.store.Store.order/page.mdx": "2025-10-21T08:10:57.990Z",
- "references/js_sdk/store/Store/properties/js_sdk.store.Store.payment/page.mdx": "2025-10-21T08:10:57.974Z",
- "references/js_sdk/store/Store/properties/js_sdk.store.Store.product/page.mdx": "2025-10-21T08:10:57.931Z",
- "references/js_sdk/store/Store/properties/js_sdk.store.Store.region/page.mdx": "2025-10-21T08:10:57.906Z",
+ "references/js_sdk/store/Store/properties/js_sdk.store.Store.customer/page.mdx": "2025-10-31T09:41:44.106Z",
+ "references/js_sdk/store/Store/properties/js_sdk.store.Store.fulfillment/page.mdx": "2025-10-31T09:41:44.051Z",
+ "references/js_sdk/store/Store/properties/js_sdk.store.Store.order/page.mdx": "2025-10-31T09:41:44.081Z",
+ "references/js_sdk/store/Store/properties/js_sdk.store.Store.payment/page.mdx": "2025-10-31T09:41:44.064Z",
+ "references/js_sdk/store/Store/properties/js_sdk.store.Store.product/page.mdx": "2025-10-31T09:41:44.019Z",
+ "references/js_sdk/store/Store/properties/js_sdk.store.Store.region/page.mdx": "2025-10-31T09:41:43.994Z",
"references/js_sdk/store/classes/js_sdk.store.Store/page.mdx": "2024-11-25T17:49:55.112Z",
"references/modules/js_sdk/page.mdx": "2024-10-22T15:09:52.263Z",
- "references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryDeleteStep/page.mdx": "2025-10-25T20:13:58.683Z",
+ "references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryDeleteStep/page.mdx": "2025-10-31T09:41:20.985Z",
"references/core_flows/Tax/Workflows_Tax/functions/core_flows.Tax.Workflows_Tax.updateTaxRegionsWorkflow/page.mdx": "2025-09-18T17:04:43.238Z",
"references/core_flows/interfaces/core_flows.ValidateInventoryDeleteStepInput/page.mdx": "2024-12-09T13:21:50.648Z",
"references/core_flows/types/core_flows.UseQueryGraphStepInput/page.mdx": "2024-12-09T13:21:50.232Z",
@@ -2811,8 +2810,8 @@ export const generatedEditDates = {
"references/pricing/types/pricing.OperatorMap/page.mdx": "2025-01-13T17:30:30.346Z",
"references/pricing/types/pricing.RawMessageFormat/page.mdx": "2024-12-09T13:22:02.708Z",
"references/product/interfaces/product.CreateProductDTO/page.mdx": "2025-01-17T16:43:30.038Z",
- "references/product/interfaces/product.UpdateProductDTO/page.mdx": "2024-12-09T13:22:03.308Z",
- "references/product/interfaces/product.UpsertProductDTO/page.mdx": "2024-12-09T13:22:03.308Z",
+ "references/product/interfaces/product.UpdateProductDTO/page.mdx": "2025-10-31T09:41:35.641Z",
+ "references/product/interfaces/product.UpsertProductDTO/page.mdx": "2025-10-31T09:41:35.639Z",
"references/product/types/product.Event/page.mdx": "2025-04-11T09:04:51.382Z",
"references/product/types/product.OperatorMap/page.mdx": "2025-01-13T17:30:30.499Z",
"references/product/types/product.RawMessageFormat/page.mdx": "2024-12-09T13:22:03.160Z",
@@ -2846,69 +2845,68 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddClaimInboundItems/page.mdx": "2024-12-09T13:21:33.429Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddClaimItems/page.mdx": "2024-12-09T13:21:33.425Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddClaimOutboundItems/page.mdx": "2024-12-09T13:21:33.429Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddExchangeInboundItems/page.mdx": "2024-12-09T13:21:33.661Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddExchangeOutboundItems/page.mdx": "2024-12-09T13:21:33.665Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddExchangeInboundItems/page.mdx": "2025-10-31T09:41:30.386Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddExchangeOutboundItems/page.mdx": "2025-10-31T09:41:30.383Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchLink/page.mdx": "2025-04-11T09:04:46.517Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListParams/page.mdx": "2025-01-13T18:05:54.298Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaimParams/page.mdx": "2025-01-13T17:30:27.890Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCollection/page.mdx": "2025-10-21T08:10:45.862Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionListParams/page.mdx": "2025-01-13T18:05:54.332Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaimListParams/page.mdx": "2025-10-31T09:41:30.053Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaimParams/page.mdx": "2025-10-31T09:41:30.058Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCollection/page.mdx": "2025-10-31T09:41:30.121Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionListParams/page.mdx": "2025-10-31T09:41:30.130Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionListResponse/page.mdx": "2025-10-21T08:10:45.875Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionParams/page.mdx": "2024-12-09T13:21:33.521Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionResponse/page.mdx": "2024-12-09T13:21:33.525Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateCampaign/page.mdx": "2025-10-21T08:10:45.696Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateClaim/page.mdx": "2024-12-09T13:21:33.425Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateCampaign/page.mdx": "2025-10-31T09:41:29.942Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateClaim/page.mdx": "2025-10-31T09:41:30.027Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateExchange/page.mdx": "2024-12-09T13:21:33.661Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateFulfillmentSetServiceZone/page.mdx": "2025-05-20T07:51:41.058Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateInventoryItem/page.mdx": "2024-12-09T13:21:33.793Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminExchangeListParams/page.mdx": "2025-01-13T17:30:28.012Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminExchangeListParams/page.mdx": "2025-10-31T09:41:30.405Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentProvider/page.mdx": "2024-12-09T13:21:33.737Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentProviderListParams/page.mdx": "2024-12-09T13:21:33.737Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentProviderListResponse/page.mdx": "2025-10-21T08:10:46.176Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentSet/page.mdx": "2025-05-20T07:51:41.062Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentSetResponse/page.mdx": "2025-04-11T09:04:46.795Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminGeoZone/page.mdx": "2025-05-20T07:51:41.063Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryLevelFilters/page.mdx": "2024-12-09T13:21:33.781Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryLevelFilters/page.mdx": "2025-10-31T09:41:30.537Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryLevelResponse/page.mdx": "2024-12-09T13:21:33.781Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminInvite/page.mdx": "2024-12-10T14:54:55.902Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminInviteResponse/page.mdx": "2024-12-10T14:54:55.907Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx": "2025-01-13T18:05:54.499Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListParams/page.mdx": "2025-10-31T09:41:30.586Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationListResponse/page.mdx": "2025-10-21T08:10:46.281Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationParams/page.mdx": "2024-12-09T13:21:33.825Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListListParams/page.mdx": "2025-01-13T18:05:54.660Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListListParams/page.mdx": "2025-10-31T09:41:30.923Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListListResponse/page.mdx": "2025-10-21T08:10:46.592Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListParams/page.mdx": "2024-12-09T13:21:34.177Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategoryListParams/page.mdx": "2025-01-13T18:05:54.682Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategoryListParams/page.mdx": "2025-10-31T09:41:30.968Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategoryParams/page.mdx": "2024-12-09T13:21:34.213Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTagListParams/page.mdx": "2025-01-13T18:05:54.701Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTagListParams/page.mdx": "2025-10-31T09:41:31.005Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTagListResponse/page.mdx": "2025-10-21T08:10:46.669Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTagParams/page.mdx": "2024-12-09T13:21:34.249Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTypeListParams/page.mdx": "2025-01-13T18:05:54.712Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTypeListParams/page.mdx": "2025-10-31T09:41:31.033Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTypeListResponse/page.mdx": "2025-10-21T08:10:46.696Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTypeParams/page.mdx": "2024-12-09T13:21:34.269Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminRequestExchange/page.mdx": "2024-12-09T13:21:33.673Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnFilters/page.mdx": "2025-04-11T09:04:47.555Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReasonListParams/page.mdx": "2025-04-11T09:04:47.519Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnFilters/page.mdx": "2025-10-31T09:41:31.413Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReasonListParams/page.mdx": "2025-10-31T09:41:31.371Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReasonListResponse/page.mdx": "2025-10-21T08:10:46.999Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReasonParams/page.mdx": "2024-12-09T13:21:34.525Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminServiceZoneDeleteResponse/page.mdx": "2025-04-11T09:04:46.793Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminServiceZoneResponse/page.mdx": "2025-05-20T07:51:41.067Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminShippingProfileListParams/page.mdx": "2025-04-11T09:04:47.650Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminShippingProfileListParams/page.mdx": "2025-10-31T09:41:31.538Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminStockLocation/page.mdx": "2025-04-11T09:04:47.656Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminStockLocationListResponse/page.mdx": "2025-10-21T08:10:47.172Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminStockLocationResponse/page.mdx": "2025-04-11T09:04:47.668Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegionListParams/page.mdx": "2025-05-20T07:51:41.068Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegionListParams/page.mdx": "2025-10-31T09:41:31.621Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegionParams/page.mdx": "2024-12-09T13:21:34.721Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateCampaign/page.mdx": "2025-10-21T08:10:45.697Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateCampaign/page.mdx": "2025-10-31T09:41:29.944Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateClaimInboundItem/page.mdx": "2024-12-09T13:21:33.429Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateClaimItem/page.mdx": "2024-12-09T13:21:33.425Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateClaimOutboundItem/page.mdx": "2024-12-09T13:21:33.433Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateClaimItem/page.mdx": "2025-10-31T09:41:30.030Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateClaimOutboundItem/page.mdx": "2025-10-31T09:41:30.039Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateExchangeInboundItem/page.mdx": "2024-12-09T13:21:33.661Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateExchangeOutboundItem/page.mdx": "2024-12-09T13:21:33.665Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateExchangeOutboundItem/page.mdx": "2025-10-31T09:41:30.389Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateFulfillmentSetServiceZone/page.mdx": "2025-05-20T07:51:41.069Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateInventoryItem/page.mdx": "2024-12-09T13:21:33.793Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateInventoryLevel/page.mdx": "2024-12-09T13:21:33.777Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.FindParams/page.mdx": "2024-12-09T13:21:33.541Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.FindParams/page.mdx": "2025-10-31T09:41:30.159Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.InventoryLevel/page.mdx": "2024-12-09T13:21:33.777Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx": "2024-12-09T13:21:33.541Z",
"references/types/HttpTypes/types/types.HttpTypes.AdminAcceptInvite/page.mdx": "2024-12-09T13:21:33.809Z",
@@ -2917,10 +2915,9 @@ export const generatedEditDates = {
"references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor/page.mdx": "2024-12-09T13:21:35.289Z",
"references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoaderOptions/page.mdx": "2025-05-22T12:22:35.332Z",
"references/types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProviderExports/page.mdx": "2024-12-09T13:21:35.369Z",
- "references/types/NotificationTypes/interfaces/types.NotificationTypes.CreateNotificationDTO/page.mdx": "2025-07-24T08:20:49.649Z",
+ "references/types/NotificationTypes/interfaces/types.NotificationTypes.CreateNotificationDTO/page.mdx": "2025-10-31T09:41:32.487Z",
"references/types/interfaces/types.AdminClaimAddItems/page.mdx": "2024-12-09T13:21:33.205Z",
"references/types/interfaces/types.AdminClaimUpdateItem/page.mdx": "2024-12-09T13:21:33.205Z",
- "references/types/interfaces/types.AdminExchangeAddItems/page.mdx": "2024-12-09T13:21:33.273Z",
"references/types/interfaces/types.AdminExchangeUpdateItem/page.mdx": "2024-12-09T13:21:33.273Z",
"references/types/interfaces/types.AdminUpdateFulfillmentSetServiceZoneCity/page.mdx": "2025-05-20T07:51:41.081Z",
"references/types/interfaces/types.AdminUpdateFulfillmentSetServiceZoneCountry/page.mdx": "2024-12-09T13:21:33.305Z",
@@ -2932,16 +2929,16 @@ export const generatedEditDates = {
"references/types/interfaces/types.AdminUpsertFulfillmentSetServiceZoneProvince/page.mdx": "2025-05-20T07:51:41.081Z",
"references/types/interfaces/types.AdminUpsertFulfillmentSetServiceZoneZip/page.mdx": "2025-05-20T07:51:41.081Z",
"references/types/interfaces/types.AdminUpsertGeoZone/page.mdx": "2024-12-09T13:21:33.297Z",
- "references/types/interfaces/types.BaseClaimListParams/page.mdx": "2025-01-13T17:30:27.781Z",
- "references/types/interfaces/types.BaseCollection/page.mdx": "2025-10-21T08:10:45.577Z",
- "references/types/interfaces/types.BaseCollectionListParams/page.mdx": "2025-01-13T18:05:54.199Z",
+ "references/types/interfaces/types.BaseClaimListParams/page.mdx": "2025-10-31T09:41:29.821Z",
+ "references/types/interfaces/types.BaseCollection/page.mdx": "2025-10-31T09:41:29.824Z",
+ "references/types/interfaces/types.BaseCollectionListParams/page.mdx": "2025-10-31T09:41:29.833Z",
"references/types/interfaces/types.BaseCollectionParams/page.mdx": "2024-12-09T13:21:33.229Z",
"references/types/interfaces/types.BaseExchangeItem/page.mdx": "2024-12-09T13:21:33.277Z",
"references/types/interfaces/types.BaseFulfillmentProvider/page.mdx": "2024-12-09T13:21:33.293Z",
- "references/types/interfaces/types.BaseProductCategoryListParams/page.mdx": "2025-01-13T18:05:55.105Z",
+ "references/types/interfaces/types.BaseProductCategoryListParams/page.mdx": "2025-10-31T09:41:31.837Z",
"references/types/interfaces/types.BaseProductCategoryParams/page.mdx": "2024-12-09T13:21:34.937Z",
- "references/types/interfaces/types.BaseProductTagListParams/page.mdx": "2025-01-13T17:30:28.765Z",
- "references/types/interfaces/types.BaseReturnReasonListParams/page.mdx": "2025-01-13T17:30:28.803Z",
+ "references/types/interfaces/types.BaseProductTagListParams/page.mdx": "2025-10-31T09:41:31.842Z",
+ "references/types/interfaces/types.BaseReturnReasonListParams/page.mdx": "2025-10-31T09:41:31.921Z",
"references/user/interfaces/user.IUserModuleService/page.mdx": "2024-11-25T17:49:59.560Z",
"references/user/types/user.Event/page.mdx": "2025-04-11T09:04:52.766Z",
"references/user/types/user.RawMessageFormat/page.mdx": "2024-12-09T13:22:04.696Z",
@@ -2951,88 +2948,88 @@ export const generatedEditDates = {
"references/workflows/types/workflows.HookHandler/page.mdx": "2024-12-09T13:22:04.832Z",
"references/workflows/types/workflows.WorkflowDataProperties/page.mdx": "2024-12-09T13:22:04.836Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateFulfillment/page.mdx": "2025-05-20T07:51:41.058Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx": "2025-01-13T18:05:54.349Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyListParams/page.mdx": "2025-10-31T09:41:30.174Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyParams/page.mdx": "2024-12-09T13:21:33.553Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCustomerFilters/page.mdx": "2025-01-13T18:05:54.378Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCustomerFilters/page.mdx": "2025-10-31T09:41:30.238Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminDraftOrderResponse/page.mdx": "2025-09-12T14:10:39.702Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillment/page.mdx": "2025-05-20T07:51:41.062Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentResponse/page.mdx": "2025-05-20T07:51:41.062Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetApiKeysParams/page.mdx": "2025-01-13T18:05:54.248Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetPaymentProvidersParams/page.mdx": "2025-01-13T18:05:54.624Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetApiKeysParams/page.mdx": "2025-10-31T09:41:29.932Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetPaymentProvidersParams/page.mdx": "2025-10-31T09:41:30.848Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetPromotionParams/page.mdx": "2024-12-09T13:21:34.445Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetPromotionRuleTypeParams/page.mdx": "2024-12-09T13:21:34.449Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetPromotionsParams/page.mdx": "2025-09-12T14:10:40.507Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetPromotionsRuleValueParams/page.mdx": "2025-04-11T09:04:47.448Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrder/page.mdx": "2025-10-21T08:10:46.314Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetPromotionRuleTypeParams/page.mdx": "2025-10-31T09:41:31.271Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetPromotionsParams/page.mdx": "2025-10-31T09:41:31.268Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetPromotionsRuleValueParams/page.mdx": "2025-10-31T09:41:31.272Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrder/page.mdx": "2025-10-31T09:41:30.627Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChange/page.mdx": "2025-09-12T14:10:39.955Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChangeAction/page.mdx": "2025-09-12T14:10:39.964Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderFilters/page.mdx": "2025-03-04T13:33:51.000Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderFilters/page.mdx": "2025-10-31T09:41:30.717Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderFulfillment/page.mdx": "2024-12-09T13:21:33.901Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderItemsFilters/page.mdx": "2024-12-09T13:21:33.957Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderPreview/page.mdx": "2025-10-21T08:10:46.381Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderItemsFilters/page.mdx": "2025-10-31T09:41:30.719Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderPreview/page.mdx": "2025-10-31T09:41:30.698Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderPreviewResponse/page.mdx": "2025-09-12T14:10:40.046Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderResponse/page.mdx": "2025-09-12T14:10:40.030Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderShippingMethod/page.mdx": "2024-12-09T13:21:33.921Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentFilters/page.mdx": "2025-01-13T18:05:54.622Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentProviderFilters/page.mdx": "2025-01-13T18:05:54.612Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminPricePreferenceListParams/page.mdx": "2025-01-13T18:05:54.668Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentFilters/page.mdx": "2025-10-31T09:41:30.844Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentProviderFilters/page.mdx": "2025-10-31T09:41:30.830Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminPricePreferenceListParams/page.mdx": "2025-10-31T09:41:30.942Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminPricePreferenceParams/page.mdx": "2024-12-09T13:21:34.193Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductListParams/page.mdx": "2025-06-25T10:11:38.704Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductOptionParams/page.mdx": "2025-01-13T18:05:54.742Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariantParams/page.mdx": "2025-06-25T10:11:38.698Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminRegionFilters/page.mdx": "2025-04-11T09:04:47.476Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminSalesChannelListParams/page.mdx": "2025-04-11T09:04:47.593Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminStoreListParams/page.mdx": "2025-04-11T09:04:47.678Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductListParams/page.mdx": "2025-10-31T09:41:31.130Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductOptionParams/page.mdx": "2025-10-31T09:41:31.118Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariantParams/page.mdx": "2025-10-31T09:41:31.123Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminRegionFilters/page.mdx": "2025-10-31T09:41:31.322Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminSalesChannelListParams/page.mdx": "2025-10-31T09:41:31.461Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminStoreListParams/page.mdx": "2025-10-31T09:41:31.574Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminStoreParams/page.mdx": "2024-12-09T13:21:34.689Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminUserListParams/page.mdx": "2025-04-11T09:04:47.727Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminUserListParams/page.mdx": "2025-10-31T09:41:31.638Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUserParams/page.mdx": "2024-12-09T13:21:34.733Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.RefundReasonFilters/page.mdx": "2025-10-21T08:10:46.514Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.RefundReasonFilters/page.mdx": "2025-10-31T09:41:30.846Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreAddCartShippingMethods/page.mdx": "2024-12-09T13:21:33.397Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreCartShippingOption/page.mdx": "2025-03-04T13:33:50.841Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreCustomerFilters/page.mdx": "2025-01-13T18:05:54.396Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreGetCurrencyListParams/page.mdx": "2025-01-13T18:05:54.353Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreGetShippingOptionList/page.mdx": "2025-01-13T18:05:54.914Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreCustomerFilters/page.mdx": "2025-10-31T09:41:30.275Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreGetCurrencyListParams/page.mdx": "2025-10-31T09:41:30.183Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreGetShippingOptionList/page.mdx": "2025-10-31T09:41:31.525Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreInitializePaymentSession/page.mdx": "2025-02-11T11:36:49.652Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreOrder/page.mdx": "2025-10-21T08:10:46.437Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreOrderFilters/page.mdx": "2025-01-13T18:05:54.593Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreOrder/page.mdx": "2025-10-31T09:41:30.763Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreOrderFilters/page.mdx": "2025-10-31T09:41:30.793Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreOrderFulfillment/page.mdx": "2024-12-09T13:21:34.033Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreOrderResponse/page.mdx": "2025-09-12T14:10:40.088Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreOrderShippingMethod/page.mdx": "2024-12-23T13:57:05.476Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategoryListParams/page.mdx": "2025-01-13T18:05:54.692Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategoryListParams/page.mdx": "2025-10-31T09:41:30.990Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategoryParams/page.mdx": "2024-12-09T13:21:34.233Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductOptionParams/page.mdx": "2025-01-13T18:05:54.780Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductParams/page.mdx": "2025-05-20T07:51:41.073Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductTagListParams/page.mdx": "2025-01-13T18:05:54.706Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductOptionParams/page.mdx": "2025-10-31T09:41:31.207Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductParams/page.mdx": "2025-10-31T09:41:31.219Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductTagListParams/page.mdx": "2025-10-31T09:41:31.020Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductTagParams/page.mdx": "2024-12-09T13:21:34.261Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductVariantParams/page.mdx": "2025-01-13T18:05:54.784Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductVariantParams/page.mdx": "2025-10-31T09:41:31.216Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreShippingOptionListResponse/page.mdx": "2025-10-21T08:10:47.137Z",
- "references/types/interfaces/types.BaseCustomerFilters/page.mdx": "2025-01-13T18:05:54.210Z",
- "references/types/interfaces/types.BaseOrder/page.mdx": "2025-10-21T08:10:47.346Z",
+ "references/types/interfaces/types.BaseCustomerFilters/page.mdx": "2025-10-31T09:41:29.851Z",
+ "references/types/interfaces/types.BaseOrder/page.mdx": "2025-10-31T09:41:31.751Z",
"references/types/interfaces/types.BaseOrderChange/page.mdx": "2025-09-12T14:10:40.949Z",
"references/types/interfaces/types.BaseOrderChangeAction/page.mdx": "2025-09-12T14:10:40.958Z",
- "references/types/interfaces/types.BaseOrderFilters/page.mdx": "2025-01-13T18:05:55.058Z",
+ "references/types/interfaces/types.BaseOrderFilters/page.mdx": "2025-10-31T09:41:31.754Z",
"references/types/interfaces/types.BaseOrderFulfillment/page.mdx": "2024-12-09T13:21:34.817Z",
"references/types/interfaces/types.BaseOrderShippingDetail/page.mdx": "2024-12-23T13:57:05.840Z",
"references/types/interfaces/types.BaseOrderShippingMethod/page.mdx": "2024-12-23T13:57:05.833Z",
"references/types/interfaces/types.BaseOrderShippingMethodAdjustment/page.mdx": "2024-12-23T13:57:05.825Z",
"references/types/interfaces/types.BaseOrderShippingMethodTaxLine/page.mdx": "2024-12-23T13:57:05.829Z",
- "references/types/interfaces/types.BaseProductListParams/page.mdx": "2025-01-13T18:05:55.124Z",
- "references/types/interfaces/types.BaseProductOptionParams/page.mdx": "2025-01-13T18:05:55.125Z",
- "references/types/interfaces/types.BaseProductVariantParams/page.mdx": "2025-01-13T18:05:55.128Z",
+ "references/types/interfaces/types.BaseProductListParams/page.mdx": "2025-10-31T09:41:31.877Z",
+ "references/types/interfaces/types.BaseProductOptionParams/page.mdx": "2025-10-31T09:41:31.879Z",
+ "references/types/interfaces/types.BaseProductVariantParams/page.mdx": "2025-10-31T09:41:31.887Z",
"references/workflows/types/workflows.UnwrapWorkflowInputDataType/page.mdx": "2025-05-20T07:51:41.190Z",
"references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.linkCustomerGroupsToCustomerStep/page.mdx": "2025-01-13T18:05:49.504Z",
"references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.linkCustomerGroupsToCustomerWorkflow/page.mdx": "2025-09-18T17:04:39.012Z",
"references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.batchCustomerGroups/page.mdx": "2025-04-11T09:04:54.008Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchPriceListPrice/page.mdx": "2024-12-09T13:21:34.169Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchProductResponse/page.mdx": "2025-10-21T08:10:46.786Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchProductVariantResponse/page.mdx": "2025-10-21T08:10:46.800Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchProductResponse/page.mdx": "2025-10-31T09:41:31.150Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchProductVariantResponse/page.mdx": "2025-10-31T09:41:31.166Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateCollection/page.mdx": "2024-12-09T13:21:33.513Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePriceList/page.mdx": "2024-12-09T13:21:34.165Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePriceList/page.mdx": "2025-10-31T09:41:30.912Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePriceListPrice/page.mdx": "2024-12-09T13:21:34.161Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePricePreference/page.mdx": "2024-12-09T13:21:34.189Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateProductCategory/page.mdx": "2024-12-09T13:21:34.205Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminLinkPriceListProducts/page.mdx": "2024-12-09T13:21:34.169Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx": "2025-10-21T08:10:46.356Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderLineItem/page.mdx": "2025-10-31T09:41:30.671Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminPrice/page.mdx": "2024-12-09T13:21:34.185Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminPriceList/page.mdx": "2024-12-09T13:21:34.161Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListBatchResponse/page.mdx": "2024-12-09T13:21:34.185Z",
@@ -3041,14 +3038,14 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminPricePreference/page.mdx": "2024-12-09T13:21:34.185Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminPricePreferenceListResponse/page.mdx": "2025-10-21T08:10:46.606Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminPricePreferenceResponse/page.mdx": "2024-12-09T13:21:34.193Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProduct/page.mdx": "2025-10-21T08:10:46.732Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductOption/page.mdx": "2025-10-21T08:10:46.718Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductOptionDeleteResponse/page.mdx": "2025-10-21T08:10:46.813Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductResponse/page.mdx": "2025-10-21T08:10:46.779Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariant/page.mdx": "2025-10-21T08:10:46.714Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariantDeleteResponse/page.mdx": "2025-10-21T08:10:46.792Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariantInventoryLinkDeleteResponse/page.mdx": "2025-10-21T08:10:46.818Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariantResponse/page.mdx": "2025-10-21T08:10:46.788Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProduct/page.mdx": "2025-10-31T09:41:31.081Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductOption/page.mdx": "2025-10-31T09:41:31.067Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductOptionDeleteResponse/page.mdx": "2025-10-31T09:41:31.179Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductResponse/page.mdx": "2025-10-31T09:41:31.142Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariant/page.mdx": "2025-10-31T09:41:31.063Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariantDeleteResponse/page.mdx": "2025-10-31T09:41:31.157Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariantInventoryLinkDeleteResponse/page.mdx": "2025-10-31T09:41:31.184Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariantResponse/page.mdx": "2025-10-31T09:41:31.153Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminShippingOptionPrice/page.mdx": "2025-04-11T09:04:47.604Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateCollection/page.mdx": "2025-02-11T11:36:49.093Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateCollectionProducts/page.mdx": "2024-12-09T13:21:33.517Z",
@@ -3057,21 +3054,21 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdatePricePreference/page.mdx": "2024-12-09T13:21:34.189Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateProductCategory/page.mdx": "2024-12-09T13:21:34.205Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateProductCategoryProducts/page.mdx": "2024-12-09T13:21:34.209Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreCartLineItem/page.mdx": "2025-10-21T08:10:45.729Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreCollection/page.mdx": "2025-10-21T08:10:45.879Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreOrderLineItem/page.mdx": "2025-10-21T08:10:46.446Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProduct/page.mdx": "2025-10-21T08:10:46.823Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategory/page.mdx": "2025-10-21T08:10:46.641Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreCartLineItem/page.mdx": "2025-10-31T09:41:29.979Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreCollection/page.mdx": "2025-10-31T09:41:30.140Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreOrderLineItem/page.mdx": "2025-10-31T09:41:30.773Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProduct/page.mdx": "2025-10-31T09:41:31.193Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategory/page.mdx": "2025-10-31T09:41:30.985Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategoryListResponse/page.mdx": "2025-10-21T08:10:46.656Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategoryResponse/page.mdx": "2024-12-09T13:21:34.237Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductOption/page.mdx": "2025-10-21T08:10:46.830Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductResponse/page.mdx": "2025-10-21T08:10:46.856Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductVariant/page.mdx": "2025-10-21T08:10:46.827Z",
- "references/types/interfaces/types.BaseCartLineItem/page.mdx": "2025-10-21T08:10:45.532Z",
- "references/types/interfaces/types.BaseOrderLineItem/page.mdx": "2025-10-21T08:10:47.321Z",
- "references/types/interfaces/types.BaseProduct/page.mdx": "2025-10-21T08:10:47.450Z",
- "references/types/interfaces/types.BaseProductOption/page.mdx": "2025-10-21T08:10:47.457Z",
- "references/types/interfaces/types.BaseProductVariant/page.mdx": "2025-10-21T08:10:47.454Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductOption/page.mdx": "2025-10-31T09:41:31.200Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductResponse/page.mdx": "2025-10-31T09:41:31.227Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductVariant/page.mdx": "2025-10-31T09:41:31.197Z",
+ "references/types/interfaces/types.BaseCartLineItem/page.mdx": "2025-10-31T09:41:29.774Z",
+ "references/types/interfaces/types.BaseOrderLineItem/page.mdx": "2025-10-31T09:41:31.724Z",
+ "references/types/interfaces/types.BaseProduct/page.mdx": "2025-10-31T09:41:31.861Z",
+ "references/types/interfaces/types.BaseProductOption/page.mdx": "2025-10-31T09:41:31.868Z",
+ "references/types/interfaces/types.BaseProductVariant/page.mdx": "2025-10-31T09:41:31.865Z",
"references/cart/interfaces/cart.CreateCartDTO/page.mdx": "2025-06-25T10:11:34.997Z",
"references/cart/interfaces/cart.CreateLineItemDTO/page.mdx": "2025-06-25T10:11:35.024Z",
"references/cart/interfaces/cart.CreateLineItemForCartDTO/page.mdx": "2025-06-25T10:11:35.027Z",
@@ -3097,13 +3094,13 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCapturePayment/page.mdx": "2024-12-09T13:21:34.077Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateOrderFulfillment/page.mdx": "2025-02-11T11:36:49.481Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateOrderShipment/page.mdx": "2024-12-09T13:21:33.945Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePaymentCollection/page.mdx": "2024-12-09T13:21:34.081Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePaymentCollection/page.mdx": "2025-10-31T09:41:30.827Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminNotification/page.mdx": "2024-12-09T13:21:33.821Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminNotificationResponse/page.mdx": "2024-12-09T13:21:33.825Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderAddress/page.mdx": "2025-05-20T07:51:41.064Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChangesFilters/page.mdx": "2025-01-13T18:05:54.559Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChangesFilters/page.mdx": "2025-10-31T09:41:30.724Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderChangesResponse/page.mdx": "2025-09-12T14:10:40.034Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderItem/page.mdx": "2025-10-21T08:10:46.348Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderItem/page.mdx": "2025-10-31T09:41:30.663Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminPayment/page.mdx": "2025-10-21T08:10:46.477Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx": "2025-10-21T08:10:46.482Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollectionResponse/page.mdx": "2024-12-09T13:21:34.105Z",
@@ -3111,27 +3108,27 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentProvider/page.mdx": "2024-12-09T13:21:34.045Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentResponse/page.mdx": "2025-10-21T08:10:46.525Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentSession/page.mdx": "2025-10-21T08:10:46.486Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminRefundPayment/page.mdx": "2024-12-09T13:21:34.077Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminRefundPayment/page.mdx": "2025-10-31T09:41:30.826Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminRegion/page.mdx": "2025-04-11T09:04:47.467Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminRegionResponse/page.mdx": "2025-04-11T09:04:47.479Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreCart/page.mdx": "2025-10-21T08:10:45.718Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreCart/page.mdx": "2025-10-31T09:41:29.967Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreRegion/page.mdx": "2024-12-09T13:21:34.489Z",
"references/types/HttpTypes/types/types.HttpTypes.AdminOrderLineItemsListResponse/page.mdx": "2024-12-09T13:21:33.977Z",
"references/types/HttpTypes/types/types.HttpTypes.StoreRegionResponse/page.mdx": "2024-12-09T13:21:34.497Z",
"references/types/WorkflowTypes/OrderWorkflow/interfaces/types.WorkflowTypes.OrderWorkflow.CreateOrderFulfillmentWorkflowInput/page.mdx": "2025-04-11T09:04:48.734Z",
- "references/types/interfaces/types.BaseCart/page.mdx": "2025-10-21T08:10:45.518Z",
+ "references/types/interfaces/types.BaseCart/page.mdx": "2025-10-31T09:41:29.758Z",
"references/types/interfaces/types.BaseOrderChangesFilters/page.mdx": "2025-01-13T18:05:55.061Z",
- "references/types/interfaces/types.BaseOrderItemDetail/page.mdx": "2025-10-21T08:10:47.325Z",
- "references/types/interfaces/types.BaseOrderLineItemAdjustment/page.mdx": "2025-10-21T08:10:47.297Z",
- "references/types/interfaces/types.BaseOrderLineItemTaxLine/page.mdx": "2025-10-21T08:10:47.305Z",
+ "references/types/interfaces/types.BaseOrderItemDetail/page.mdx": "2025-10-31T09:41:31.728Z",
+ "references/types/interfaces/types.BaseOrderLineItemAdjustment/page.mdx": "2025-10-31T09:41:31.699Z",
+ "references/types/interfaces/types.BaseOrderLineItemTaxLine/page.mdx": "2025-10-31T09:41:31.707Z",
"references/types/interfaces/types.BasePaymentFilters/page.mdx": "2025-01-13T18:05:55.098Z",
"references/types/interfaces/types.BaseRegion/page.mdx": "2024-12-09T13:21:34.989Z",
"references/types/types/types.PrevLimit/page.mdx": "2024-11-06T21:08:40.426Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchUpdateProductVariant/page.mdx": "2024-12-09T13:21:34.321Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchUpdateProductVariant/page.mdx": "2025-10-31T09:41:31.107Z",
"references/types/types/types.PluralizationSpecialRules/page.mdx": "2024-12-09T13:21:32.837Z",
"references/types/types/types.UncountableRules/page.mdx": "2025-10-21T08:10:45.155Z",
"references/product/interfaces/product.FilterableProductProps/page.mdx": "2025-06-25T10:11:42.703Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchProductVariantRequest/page.mdx": "2024-12-09T13:21:34.309Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchProductVariantRequest/page.mdx": "2025-10-31T09:41:31.091Z",
"references/types/WorkflowTypes/ProductWorkflow/interfaces/types.WorkflowTypes.ProductWorkflow.ExportProductsDTO/page.mdx": "2025-06-25T10:11:40.398Z",
"app/integrations/guides/sanity/page.mdx": "2025-10-09T11:31:06.326Z",
"references/api_key/types/api_key.FindConfigOrder/page.mdx": "2024-11-25T17:49:28.715Z",
@@ -3141,7 +3138,7 @@ export const generatedEditDates = {
"references/customer/types/customer.FindConfigOrder/page.mdx": "2024-11-25T17:49:50.252Z",
"references/fulfillment/types/fulfillment.FindConfigOrder/page.mdx": "2024-11-25T17:49:50.688Z",
"references/inventory_next/types/inventory_next.FindConfigOrder/page.mdx": "2024-11-25T17:49:51.652Z",
- "references/js_sdk/admin/Order/methods/js_sdk.admin.Order.requestTransfer/page.mdx": "2025-09-12T14:10:49.026Z",
+ "references/js_sdk/admin/Order/methods/js_sdk.admin.Order.requestTransfer/page.mdx": "2025-10-31T09:41:41.711Z",
"references/medusa/types/medusa.FindConfigOrder/page.mdx": "2024-11-25T17:49:25.215Z",
"references/order/types/order.FindConfigOrder/page.mdx": "2024-11-25T17:49:55.760Z",
"references/payment/types/payment.FindConfigOrder/page.mdx": "2024-11-25T17:49:57.200Z",
@@ -3154,7 +3151,7 @@ export const generatedEditDates = {
"references/store/types/store.FindConfigOrder/page.mdx": "2024-11-25T17:49:59.160Z",
"references/tax/types/tax.FindConfigOrder/page.mdx": "2024-11-25T17:49:59.296Z",
"references/types/CommonTypes/types/types.CommonTypes.FindConfigOrder/page.mdx": "2024-11-25T17:49:25.371Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminRequestOrderTransfer/page.mdx": "2024-12-09T13:21:33.949Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminRequestOrderTransfer/page.mdx": "2025-10-31T09:41:30.706Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreAcceptOrderTransfer/page.mdx": "2024-12-09T13:21:34.033Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreDeclineOrderTransfer/page.mdx": "2024-12-09T13:21:34.037Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreRequestOrderTransfer/page.mdx": "2024-12-09T13:21:34.033Z",
@@ -3163,7 +3160,7 @@ export const generatedEditDates = {
"references/types/WorkflowTypes/OrderWorkflow/interfaces/types.WorkflowTypes.OrderWorkflow.RequestOrderTransferWorkflowInput/page.mdx": "2025-05-20T07:51:41.079Z",
"references/types/WorkflowTypes/OrderWorkflow/types/types.WorkflowTypes.OrderWorkflow.CancelTransferOrderRequestWorkflowInput/page.mdx": "2024-12-09T13:21:35.665Z",
"references/types/WorkflowTypes/OrderWorkflow/types/types.WorkflowTypes.OrderWorkflow.DeclineTransferOrderRequestWorkflowInput/page.mdx": "2024-12-09T13:21:35.681Z",
- "references/types/interfaces/types.AdminBatchUpdateProduct/page.mdx": "2025-02-24T10:48:38.495Z",
+ "references/types/interfaces/types.AdminBatchUpdateProduct/page.mdx": "2025-10-31T09:41:31.850Z",
"references/user/types/user.FindConfigOrder/page.mdx": "2024-11-25T17:49:59.504Z",
"references/api_key/interfaces/api_key.IMessageAggregator/page.mdx": "2024-11-25T17:49:28.763Z",
"references/auth/interfaces/auth.IMessageAggregator/page.mdx": "2024-11-25T17:49:28.915Z",
@@ -3189,7 +3186,7 @@ export const generatedEditDates = {
"references/modules/payment_models/page.mdx": "2025-02-11T11:36:58.760Z",
"references/modules/pricing/page.mdx": "2024-12-04T18:29:34.516Z",
"references/modules/pricing_models/page.mdx": "2024-12-23T08:25:09.220Z",
- "references/modules/product_models/page.mdx": "2025-01-27T11:43:58.840Z",
+ "references/modules/product_models/page.mdx": "2025-10-31T09:41:44.251Z",
"references/modules/promotion_models/page.mdx": "2025-10-21T08:10:58.272Z",
"references/modules/region/page.mdx": "2024-11-27T16:33:56.472Z",
"references/modules/sales_channel/page.mdx": "2024-11-25T17:49:58.852Z",
@@ -3210,13 +3207,13 @@ export const generatedEditDates = {
"references/pricing/interfaces/pricing.IBigNumber/page.mdx": "2024-12-09T13:22:02.976Z",
"references/pricing/interfaces/pricing.IMessageAggregator/page.mdx": "2024-11-25T17:49:57.864Z",
"references/product/interfaces/product.IMessageAggregator/page.mdx": "2024-11-25T17:49:58.428Z",
- "references/product/interfaces/product.ProductCategoryDTO/page.mdx": "2024-12-23T13:57:07.307Z",
- "references/product/interfaces/product.ProductCollectionDTO/page.mdx": "2024-12-23T13:57:07.313Z",
- "references/product/interfaces/product.ProductDTO/page.mdx": "2024-12-23T13:57:07.301Z",
+ "references/product/interfaces/product.ProductCategoryDTO/page.mdx": "2025-10-31T09:41:35.530Z",
+ "references/product/interfaces/product.ProductCollectionDTO/page.mdx": "2025-10-31T09:41:35.550Z",
+ "references/product/interfaces/product.ProductDTO/page.mdx": "2025-10-31T09:41:35.517Z",
"references/product/interfaces/product.ProductImageDTO/page.mdx": "2024-12-09T13:22:03.244Z",
- "references/product/interfaces/product.ProductOptionDTO/page.mdx": "2024-12-23T13:57:07.316Z",
- "references/product/interfaces/product.ProductTagDTO/page.mdx": "2024-12-23T13:57:07.311Z",
- "references/product/interfaces/product.ProductVariantDTO/page.mdx": "2024-12-23T13:57:07.304Z",
+ "references/product/interfaces/product.ProductOptionDTO/page.mdx": "2025-10-31T09:41:35.557Z",
+ "references/product/interfaces/product.ProductTagDTO/page.mdx": "2025-10-31T09:41:35.539Z",
+ "references/product/interfaces/product.ProductVariantDTO/page.mdx": "2025-10-31T09:41:35.523Z",
"references/promotion/interfaces/promotion.IBigNumber/page.mdx": "2024-12-09T13:22:03.888Z",
"references/promotion/interfaces/promotion.IMessageAggregator/page.mdx": "2024-11-25T17:49:58.700Z",
"references/region/interfaces/region.IMessageAggregator/page.mdx": "2024-11-25T17:49:58.836Z",
@@ -3228,7 +3225,7 @@ export const generatedEditDates = {
"references/tax/interfaces/tax.TaxCalculationContext/page.mdx": "2025-10-25T20:14:14.755Z",
"references/types/DmlTypes/types/types.DmlTypes.PropertyMetadata/page.mdx": "2024-12-17T16:57:19.924Z",
"references/types/DmlTypes/types/types.DmlTypes.RelationshipMetadata/page.mdx": "2024-12-10T14:54:55.439Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchProductRequest/page.mdx": "2025-02-24T10:48:37.908Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchProductRequest/page.mdx": "2025-10-31T09:41:31.088Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchProductVariantInventoryItemRequest/page.mdx": "2024-12-09T13:21:34.309Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateProduct/page.mdx": "2025-02-24T10:48:37.917Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateProductOption/page.mdx": "2024-12-09T13:21:34.325Z",
@@ -3239,18 +3236,18 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminExportProductResponse/page.mdx": "2024-12-09T13:21:34.361Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminImportProductRequest/page.mdx": "2024-12-09T13:21:34.301Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminImportProductResponse/page.mdx": "2025-05-20T07:51:41.063Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductImage/page.mdx": "2024-12-09T13:21:34.285Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductImage/page.mdx": "2025-10-31T09:41:31.071Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductOptionResponse/page.mdx": "2025-02-11T11:36:49.893Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductOptionValue/page.mdx": "2025-02-11T11:36:49.820Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTag/page.mdx": "2024-12-09T13:21:34.241Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTagResponse/page.mdx": "2024-12-09T13:21:34.249Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductType/page.mdx": "2024-12-09T13:21:34.261Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTypeResponse/page.mdx": "2024-12-09T13:21:34.273Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateProduct/page.mdx": "2025-02-24T10:48:37.923Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateProduct/page.mdx": "2025-10-31T09:41:31.109Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateProductOption/page.mdx": "2024-12-09T13:21:34.325Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateProductTag/page.mdx": "2024-12-09T13:21:34.245Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateProductType/page.mdx": "2024-12-09T13:21:34.265Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateProductVariant/page.mdx": "2024-12-09T13:21:34.317Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateProductVariant/page.mdx": "2025-10-31T09:41:31.105Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductImage/page.mdx": "2024-12-09T13:21:34.401Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductTag/page.mdx": "2024-12-09T13:21:34.253Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductType/page.mdx": "2024-12-09T13:21:34.277Z",
@@ -3292,14 +3289,14 @@ export const generatedEditDates = {
"references/pricing/types/pricing.FilterQueryProperties/page.mdx": "2024-12-23T12:30:30.704Z",
"references/product/types/product.Constructor/page.mdx": "2024-12-09T13:22:03.168Z",
"references/product/types/product.FilterQueryProperties/page.mdx": "2024-12-23T12:30:30.868Z",
- "references/product_models/variables/product_models.Product/page.mdx": "2025-10-25T20:14:21.636Z",
- "references/product_models/variables/product_models.ProductCategory/page.mdx": "2025-10-25T20:14:21.482Z",
- "references/product_models/variables/product_models.ProductCollection/page.mdx": "2025-10-25T20:14:21.492Z",
- "references/product_models/variables/product_models.ProductOption/page.mdx": "2025-10-25T20:14:21.528Z",
- "references/product_models/variables/product_models.ProductOptionValue/page.mdx": "2025-10-25T20:14:21.514Z",
- "references/product_models/variables/product_models.ProductTag/page.mdx": "2025-10-25T20:14:21.541Z",
- "references/product_models/variables/product_models.ProductType/page.mdx": "2025-10-25T20:14:21.563Z",
- "references/product_models/variables/product_models.ProductVariant/page.mdx": "2025-10-25T20:14:21.600Z",
+ "references/product_models/variables/product_models.Product/page.mdx": "2025-10-31T09:41:44.416Z",
+ "references/product_models/variables/product_models.ProductCategory/page.mdx": "2025-10-31T09:41:44.274Z",
+ "references/product_models/variables/product_models.ProductCollection/page.mdx": "2025-10-31T09:41:44.284Z",
+ "references/product_models/variables/product_models.ProductOption/page.mdx": "2025-10-31T09:41:44.323Z",
+ "references/product_models/variables/product_models.ProductOptionValue/page.mdx": "2025-10-31T09:41:44.311Z",
+ "references/product_models/variables/product_models.ProductTag/page.mdx": "2025-10-31T09:41:44.335Z",
+ "references/product_models/variables/product_models.ProductType/page.mdx": "2025-10-31T09:41:44.348Z",
+ "references/product_models/variables/product_models.ProductVariant/page.mdx": "2025-10-31T09:41:44.383Z",
"references/promotion/types/promotion.Constructor/page.mdx": "2024-12-09T13:22:03.708Z",
"references/promotion/types/promotion.FilterQueryProperties/page.mdx": "2024-12-23T12:30:31.117Z",
"references/region/types/region.Constructor/page.mdx": "2024-12-09T13:22:03.944Z",
@@ -3312,7 +3309,7 @@ export const generatedEditDates = {
"references/types/DmlTypes/types/types.DmlTypes.IsNullableRelation/page.mdx": "2024-12-09T13:21:32.993Z",
"references/types/types/types.FilterQueryProperties/page.mdx": "2024-12-23T12:30:28.129Z",
"references/cart/types/cart.FilterQuery/page.mdx": "2024-11-27T16:33:41.056Z",
- "references/currency_models/variables/currency_models.Currency/page.mdx": "2025-10-25T20:14:15.737Z",
+ "references/currency_models/variables/currency_models.Currency/page.mdx": "2025-10-31T09:41:38.814Z",
"references/customer/types/customer.FilterQuery/page.mdx": "2024-11-27T16:33:52.327Z",
"references/fulfillment/types/fulfillment.FilterQuery/page.mdx": "2024-11-27T16:33:52.465Z",
"references/inventory_next/types/inventory_next.FilterQuery/page.mdx": "2024-11-27T16:33:52.961Z",
@@ -3328,8 +3325,8 @@ export const generatedEditDates = {
"references/types/DmlTypes/types/types.DmlTypes.InferForeignKeys/page.mdx": "2025-02-24T10:48:36.703Z",
"references/types/DmlTypes/types/types.DmlTypes.InferSchemaFields/page.mdx": "2025-01-13T18:05:54.083Z",
"references/types/interfaces/types.BaseRepositoryService/page.mdx": "2024-12-09T13:21:32.969Z",
- "references/auth_models/variables/auth_models.AuthIdentity/page.mdx": "2025-10-25T20:14:15.609Z",
- "references/auth_models/variables/auth_models.ProviderIdentity/page.mdx": "2025-10-25T20:14:15.617Z",
+ "references/auth_models/variables/auth_models.AuthIdentity/page.mdx": "2025-10-31T09:41:38.699Z",
+ "references/auth_models/variables/auth_models.ProviderIdentity/page.mdx": "2025-10-31T09:41:38.702Z",
"references/dml/entity/DmlEntity/methods/dml.entity.DmlEntity.checks/page.mdx": "2024-12-09T13:21:55.464Z",
"references/helper_steps/functions/helper_steps.validatePresenceOfStep/page.mdx": "2025-01-13T17:30:22.855Z",
"references/js_sdk/admin/Order/methods/js_sdk.admin.Order.update/page.mdx": "2025-09-12T14:10:49.006Z",
@@ -3338,13 +3335,13 @@ export const generatedEditDates = {
"references/order/types/order.OrderChangeType/page.mdx": "2025-01-07T12:54:23.927Z",
"references/pricing/interfaces/pricing.RuleWithOperator/page.mdx": "2025-01-13T17:30:30.399Z",
"references/pricing/types/pricing.PricingRuleOperatorValues/page.mdx": "2024-12-04T18:29:34.568Z",
- "references/pricing_models/variables/pricing_models.Price/page.mdx": "2025-10-25T20:14:21.456Z",
- "references/pricing_models/variables/pricing_models.PriceList/page.mdx": "2025-10-25T20:14:21.432Z",
- "references/pricing_models/variables/pricing_models.PriceListRule/page.mdx": "2025-10-25T20:14:21.425Z",
- "references/pricing_models/variables/pricing_models.PricePreference/page.mdx": "2025-10-25T20:14:21.434Z",
- "references/pricing_models/variables/pricing_models.PriceRule/page.mdx": "2025-10-25T20:14:21.440Z",
- "references/pricing_models/variables/pricing_models.PriceSet/page.mdx": "2025-10-25T20:14:21.447Z",
- "references/product_models/variables/product_models.ProductImage/page.mdx": "2025-10-25T20:14:21.501Z",
+ "references/pricing_models/variables/pricing_models.Price/page.mdx": "2025-10-31T09:41:44.250Z",
+ "references/pricing_models/variables/pricing_models.PriceList/page.mdx": "2025-10-31T09:41:44.230Z",
+ "references/pricing_models/variables/pricing_models.PriceListRule/page.mdx": "2025-10-31T09:41:44.223Z",
+ "references/pricing_models/variables/pricing_models.PricePreference/page.mdx": "2025-10-31T09:41:44.231Z",
+ "references/pricing_models/variables/pricing_models.PriceRule/page.mdx": "2025-10-31T09:41:44.236Z",
+ "references/pricing_models/variables/pricing_models.PriceSet/page.mdx": "2025-10-31T09:41:44.243Z",
+ "references/product_models/variables/product_models.ProductImage/page.mdx": "2025-10-31T09:41:44.299Z",
"references/types/DmlTypes/types/types.DmlTypes.CheckConstraint/page.mdx": "2025-01-13T18:05:54.113Z",
"references/types/DmlTypes/types/types.DmlTypes.InferCheckConstraintsProperties/page.mdx": "2025-01-13T18:05:54.110Z",
"references/types/DmlTypes/types/types.DmlTypes.InferSchemaProperties/page.mdx": "2025-01-13T18:05:54.102Z",
@@ -3352,8 +3349,8 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.OrderAddress/page.mdx": "2025-05-20T07:51:41.070Z",
"references/types/WorkflowTypes/OrderWorkflow/types/types.WorkflowTypes.OrderWorkflow.UpdateOrderShippingAddressWorkflowInput/page.mdx": "2025-09-12T14:10:42.053Z",
"references/types/WorkflowTypes/OrderWorkflow/types/types.WorkflowTypes.OrderWorkflow.UpdateOrderWorkflowInput/page.mdx": "2025-09-12T14:10:42.051Z",
- "references/user_models/variables/user_models.Invite/page.mdx": "2025-10-25T20:14:21.788Z",
- "references/user_models/variables/user_models.User/page.mdx": "2025-10-25T20:14:21.790Z",
+ "references/user_models/variables/user_models.Invite/page.mdx": "2025-10-31T09:41:44.551Z",
+ "references/user_models/variables/user_models.User/page.mdx": "2025-10-31T09:41:44.552Z",
"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",
@@ -4905,14 +4902,14 @@ export const generatedEditDates = {
"references/product/interfaces/product.UpdateProductOptionDTO/page.mdx": "2024-12-09T13:22:03.292Z",
"references/product/interfaces/product.UpdateProductTagDTO/page.mdx": "2024-12-09T13:22:03.288Z",
"references/product/interfaces/product.UpdateProductTypeDTO/page.mdx": "2024-12-09T13:22:03.280Z",
- "references/product/interfaces/product.UpdateProductVariantDTO/page.mdx": "2024-12-09T13:22:03.304Z",
+ "references/product/interfaces/product.UpdateProductVariantDTO/page.mdx": "2025-10-31T09:41:35.634Z",
"references/product/interfaces/product.UpsertProductCategoryDTO/page.mdx": "2024-12-09T13:22:03.216Z",
"references/product/interfaces/product.UpsertProductCollectionDTO/page.mdx": "2024-12-09T13:22:03.276Z",
"references/product/interfaces/product.UpsertProductImageDTO/page.mdx": "2024-12-09T13:22:03.284Z",
"references/product/interfaces/product.UpsertProductOptionDTO/page.mdx": "2024-12-09T13:22:03.292Z",
"references/product/interfaces/product.UpsertProductTagDTO/page.mdx": "2024-12-09T13:22:03.288Z",
"references/product/interfaces/product.UpsertProductTypeDTO/page.mdx": "2024-12-09T13:22:03.280Z",
- "references/product/interfaces/product.UpsertProductVariantDTO/page.mdx": "2024-12-09T13:22:03.300Z",
+ "references/product/interfaces/product.UpsertProductVariantDTO/page.mdx": "2025-10-31T09:41:35.632Z",
"references/promotion/IBigNumber/methods/promotion.IBigNumber.toJSON/page.mdx": "2024-12-09T13:22:03.888Z",
"references/promotion/IBigNumber/methods/promotion.IBigNumber.valueOf/page.mdx": "2024-12-09T13:22:03.892Z",
"references/promotion/IMessageAggregator/methods/promotion.IMessageAggregator.clearMessages/page.mdx": "2025-02-11T11:36:53.998Z",
@@ -5094,7 +5091,7 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateCustomerAddress/page.mdx": "2025-05-20T07:51:41.057Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateFulfillmentShipment/page.mdx": "2024-12-09T13:21:33.769Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateProductVariantInventoryKit/page.mdx": "2024-12-09T13:21:34.313Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePromotion/page.mdx": "2025-10-21T08:10:46.875Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePromotion/page.mdx": "2025-10-31T09:41:31.250Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePromotionRule/page.mdx": "2025-06-25T10:11:38.801Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateRefundReason/page.mdx": "2025-10-21T08:10:46.917Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateRegion/page.mdx": "2025-04-11T09:04:47.470Z",
@@ -5112,7 +5109,7 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCurrencyResponse/page.mdx": "2024-12-09T13:21:33.557Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCustomer/page.mdx": "2025-05-20T07:51:41.058Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCustomerAddress/page.mdx": "2025-05-20T07:51:41.058Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCustomerAddressFilters/page.mdx": "2025-05-20T07:51:41.059Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCustomerAddressFilters/page.mdx": "2025-10-31T09:41:30.240Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCustomerAddressResponse/page.mdx": "2025-05-20T07:51:41.059Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCustomerResponse/page.mdx": "2025-05-20T07:51:41.059Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminDeletePaymentCollectionResponse/page.mdx": "2024-12-09T13:21:34.105Z",
@@ -5123,8 +5120,8 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentAddress/page.mdx": "2025-05-20T07:51:41.062Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentItem/page.mdx": "2024-12-09T13:21:33.761Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentLabel/page.mdx": "2024-12-09T13:21:33.761Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetFulfillmentProvidersParams/page.mdx": "2024-12-09T13:21:33.773Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetPromotionRuleParams/page.mdx": "2024-12-09T13:21:34.449Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetFulfillmentProvidersParams/page.mdx": "2025-10-31T09:41:30.474Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetPromotionRuleParams/page.mdx": "2025-10-31T09:41:31.269Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminInitiateReceiveReturn/page.mdx": "2025-04-11T09:04:47.547Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminInitiateReturnRequest/page.mdx": "2025-04-11T09:04:47.535Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminMarkPaymentCollectionAsPaid/page.mdx": "2024-12-09T13:21:34.081Z",
@@ -5137,7 +5134,7 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminPromotion/page.mdx": "2025-10-21T08:10:46.860Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionResponse/page.mdx": "2025-06-25T10:11:38.827Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminPromotionRule/page.mdx": "2025-06-25T10:11:38.793Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminReceiveItems/page.mdx": "2025-04-11T09:04:47.548Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminReceiveItems/page.mdx": "2025-10-31T09:41:31.405Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminRefund/page.mdx": "2025-10-21T08:10:46.489Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminRefundReason/page.mdx": "2025-10-21T08:10:46.915Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminRefundResponse/page.mdx": "2025-10-21T08:10:46.528Z",
@@ -5145,7 +5142,7 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminRegionCountryFilters/page.mdx": "2025-01-13T18:05:54.826Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReason/page.mdx": "2025-04-11T09:04:47.509Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReasonResponse/page.mdx": "2025-04-11T09:04:47.522Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminRevokeApiKey/page.mdx": "2024-12-09T13:21:33.329Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminRevokeApiKey/page.mdx": "2025-10-31T09:41:29.926Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminRuleAttributeOption/page.mdx": "2025-04-11T09:04:47.420Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminRuleOperatorOption/page.mdx": "2025-04-11T09:04:47.421Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminRuleValueOption/page.mdx": "2024-12-09T13:21:34.429Z",
@@ -5169,11 +5166,11 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateCustomer/page.mdx": "2024-12-09T13:21:33.589Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateCustomerAddress/page.mdx": "2025-05-20T07:51:41.068Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateDismissItems/page.mdx": "2025-04-11T09:04:47.552Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdatePromotion/page.mdx": "2025-10-21T08:10:46.877Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdatePromotion/page.mdx": "2025-10-31T09:41:31.256Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdatePromotionRule/page.mdx": "2025-01-13T17:30:28.450Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateReceiveItems/page.mdx": "2025-04-11T09:04:47.551Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateRegion/page.mdx": "2025-04-11T09:04:47.471Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateReturnItems/page.mdx": "2025-04-11T09:04:47.539Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateReturnItems/page.mdx": "2025-10-31T09:41:31.395Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateReturnRequest/page.mdx": "2025-04-11T09:04:47.544Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateSalesChannel/page.mdx": "2025-04-11T09:04:47.587Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateSalesChannelProducts/page.mdx": "2025-04-11T09:04:47.589Z",
@@ -5226,14 +5223,14 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.StorePaymentCollectionFilters/page.mdx": "2025-01-13T18:05:54.644Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StorePaymentCollectionResponse/page.mdx": "2024-12-09T13:21:34.157Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StorePaymentProvider/page.mdx": "2024-12-09T13:21:34.125Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StorePaymentProviderFilters/page.mdx": "2024-12-09T13:21:34.141Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StorePaymentProviderFilters/page.mdx": "2025-10-31T09:41:30.885Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StorePaymentSession/page.mdx": "2025-10-21T08:10:46.547Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StorePaymentSessionFilters/page.mdx": "2025-01-13T18:05:54.649Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductOptionValue/page.mdx": "2024-12-23T13:57:05.648Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StorePromotion/page.mdx": "2025-10-21T08:10:46.914Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreRegionCountry/page.mdx": "2024-12-09T13:21:34.489Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreRegionCountryFilters/page.mdx": "2025-01-13T18:05:54.834Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreRegionFilters/page.mdx": "2025-01-13T18:05:54.833Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreRegionFilters/page.mdx": "2025-10-31T09:41:31.339Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreReturn/page.mdx": "2025-04-11T09:04:47.579Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreReturnItem/page.mdx": "2025-04-11T09:04:47.580Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreReturnReason/page.mdx": "2025-04-11T09:04:47.528Z",
@@ -5400,7 +5397,6 @@ export const generatedEditDates = {
"references/types/interfaces/types.AdminApiKey/page.mdx": "2024-12-09T13:21:33.133Z",
"references/types/interfaces/types.AdminCreateFulfillmentItem/page.mdx": "2024-12-09T13:21:33.313Z",
"references/types/interfaces/types.AdminCreateFulfillmentLabel/page.mdx": "2024-12-09T13:21:33.317Z",
- "references/types/interfaces/types.AdminCreateTaxRateRule/page.mdx": "2025-04-11T09:04:47.960Z",
"references/types/interfaces/types.AdminFulfillmentDeliveryAddress/page.mdx": "2025-05-20T07:51:41.081Z",
"references/types/interfaces/types.AdminUpdateStoreSupportedCurrency/page.mdx": "2024-12-09T13:21:35.013Z",
"references/types/interfaces/types.AdminUpsertStockLocationAddress/page.mdx": "2025-05-20T07:51:41.081Z",
@@ -5418,8 +5414,8 @@ export const generatedEditDates = {
"references/types/interfaces/types.BaseCustomerAddress/page.mdx": "2025-05-20T07:51:41.082Z",
"references/types/interfaces/types.BaseCustomerAddressFilters/page.mdx": "2025-05-20T07:51:41.082Z",
"references/types/interfaces/types.BaseFile/page.mdx": "2025-04-11T09:04:46.275Z",
- "references/types/interfaces/types.BaseLineItemAdjustment/page.mdx": "2025-10-21T08:10:45.542Z",
- "references/types/interfaces/types.BaseLineItemTaxLine/page.mdx": "2025-10-21T08:10:45.554Z",
+ "references/types/interfaces/types.BaseLineItemAdjustment/page.mdx": "2025-10-31T09:41:29.785Z",
+ "references/types/interfaces/types.BaseLineItemTaxLine/page.mdx": "2025-10-31T09:41:29.798Z",
"references/types/interfaces/types.BaseOrderAddress/page.mdx": "2025-05-20T07:51:41.083Z",
"references/types/interfaces/types.BaseOrderAdjustmentLine/page.mdx": "2024-12-09T13:21:34.765Z",
"references/types/interfaces/types.BaseOrderSummary/page.mdx": "2025-02-24T10:48:38.356Z",
@@ -5521,20 +5517,20 @@ export const generatedEditDates = {
"references/workflows/interfaces/workflows.ApplyStepOptions/page.mdx": "2025-09-12T14:10:46.875Z",
"references/workflows/types/workflows.WorkflowData/page.mdx": "2024-12-23T13:57:08.059Z",
"app/integrations/guides/resend/page.mdx": "2025-10-21T11:08:19.352Z",
- "references/api_key_models/variables/api_key_models.ApiKey/page.mdx": "2025-10-25T20:14:15.604Z",
+ "references/api_key_models/variables/api_key_models.ApiKey/page.mdx": "2025-10-31T09:41:38.695Z",
"references/cart/ICartModuleService/methods/cart.ICartModuleService.updateShippingMethods/page.mdx": "2025-10-21T08:10:43.389Z",
"references/cart/interfaces/cart.UpdateShippingMethodDTO/page.mdx": "2025-06-25T10:11:35.052Z",
- "references/cart_models/variables/cart_models.Address/page.mdx": "2025-10-25T20:14:15.622Z",
- "references/cart_models/variables/cart_models.Cart/page.mdx": "2025-10-25T20:14:15.642Z",
- "references/cart_models/variables/cart_models.LineItem/page.mdx": "2025-10-25T20:14:15.701Z",
- "references/cart_models/variables/cart_models.LineItemAdjustment/page.mdx": "2025-10-25T20:14:15.666Z",
- "references/cart_models/variables/cart_models.LineItemTaxLine/page.mdx": "2025-10-25T20:14:15.675Z",
- "references/cart_models/variables/cart_models.ShippingMethod/page.mdx": "2025-10-25T20:14:15.733Z",
- "references/cart_models/variables/cart_models.ShippingMethodAdjustment/page.mdx": "2025-10-25T20:14:15.708Z",
- "references/cart_models/variables/cart_models.ShippingMethodTaxLine/page.mdx": "2025-10-25T20:14:15.714Z",
+ "references/cart_models/variables/cart_models.Address/page.mdx": "2025-10-31T09:41:38.706Z",
+ "references/cart_models/variables/cart_models.Cart/page.mdx": "2025-10-31T09:41:38.729Z",
+ "references/cart_models/variables/cart_models.LineItem/page.mdx": "2025-10-31T09:41:38.782Z",
+ "references/cart_models/variables/cart_models.LineItemAdjustment/page.mdx": "2025-10-31T09:41:38.751Z",
+ "references/cart_models/variables/cart_models.LineItemTaxLine/page.mdx": "2025-10-31T09:41:38.760Z",
+ "references/cart_models/variables/cart_models.ShippingMethod/page.mdx": "2025-10-31T09:41:38.807Z",
+ "references/cart_models/variables/cart_models.ShippingMethodAdjustment/page.mdx": "2025-10-31T09:41:38.788Z",
+ "references/cart_models/variables/cart_models.ShippingMethodTaxLine/page.mdx": "2025-10-31T09:41:38.794Z",
"references/dml/Property/methods/dml.Property.autoincrement/page.mdx": "2024-12-10T14:55:08.589Z",
"references/dml/dml.Property/page.mdx": "2024-12-10T14:55:08.588Z",
- "references/sales_channel_models/variables/sales_channel_models.SalesChannel/page.mdx": "2025-10-25T20:14:21.729Z",
+ "references/sales_channel_models/variables/sales_channel_models.SalesChannel/page.mdx": "2025-10-31T09:41:44.499Z",
"references/store/types/store.Constructor/page.mdx": "2024-12-10T14:55:13.404Z",
"references/store/types/store.ExpandScalar/page.mdx": "2024-12-10T14:55:13.391Z",
"references/store/types/store.FilterQuery/page.mdx": "2024-12-10T14:55:13.397Z",
@@ -5547,8 +5543,8 @@ export const generatedEditDates = {
"references/store/types/store.Query/page.mdx": "2024-12-10T14:55:13.390Z",
"references/store/types/store.ReadonlyPrimary/page.mdx": "2024-12-10T14:55:13.392Z",
"references/store/types/store.Scalar/page.mdx": "2024-12-10T14:55:13.391Z",
- "references/store_models/variables/store_models.Store/page.mdx": "2025-10-25T20:14:21.747Z",
- "references/store_models/variables/store_models.StoreCurrency/page.mdx": "2025-10-25T20:14:21.744Z",
+ "references/store_models/variables/store_models.Store/page.mdx": "2025-10-31T09:41:44.515Z",
+ "references/store_models/variables/store_models.StoreCurrency/page.mdx": "2025-10-31T09:41:44.512Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreCalculatedPrice/page.mdx": "2025-03-04T13:33:51.211Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StorePrice/page.mdx": "2024-12-10T14:54:56.154Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StorePriceRule/page.mdx": "2024-12-10T14:54:56.155Z",
@@ -5569,10 +5565,10 @@ export const generatedEditDates = {
"references/core_flows/Fulfillment/Steps_Fulfillment/variables/core_flows.Fulfillment.Steps_Fulfillment.calculateShippingOptionsPricesStepId/page.mdx": "2024-12-17T16:57:22.226Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.calculateShippingOptionsPricesWorkflow/page.mdx": "2025-09-18T17:04:39.603Z",
"references/core_flows/Fulfillment/Workflows_Fulfillment/variables/core_flows.Fulfillment.Workflows_Fulfillment.calculateShippingOptionsPricesWorkflowId/page.mdx": "2024-12-17T16:57:22.302Z",
- "references/customer_models/variables/customer_models.Customer/page.mdx": "2025-10-25T20:14:15.768Z",
- "references/customer_models/variables/customer_models.CustomerAddress/page.mdx": "2025-10-25T20:14:15.745Z",
- "references/customer_models/variables/customer_models.CustomerGroup/page.mdx": "2025-10-25T20:14:15.757Z",
- "references/customer_models/variables/customer_models.CustomerGroupCustomer/page.mdx": "2025-10-25T20:14:15.751Z",
+ "references/customer_models/variables/customer_models.Customer/page.mdx": "2025-10-31T09:41:38.841Z",
+ "references/customer_models/variables/customer_models.CustomerAddress/page.mdx": "2025-10-31T09:41:38.823Z",
+ "references/customer_models/variables/customer_models.CustomerGroup/page.mdx": "2025-10-31T09:41:38.834Z",
+ "references/customer_models/variables/customer_models.CustomerGroupCustomer/page.mdx": "2025-10-31T09:41:38.829Z",
"references/dml/Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.computed/page.mdx": "2024-12-17T16:57:24.854Z",
"references/dml/Property_Types/methods/dml.Property_Types.float/page.mdx": "2025-10-21T08:10:53.052Z",
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.calculateShippingOptionsPrices/page.mdx": "2025-10-21T08:10:44.733Z",
@@ -5591,28 +5587,28 @@ export const generatedEditDates = {
"references/fulfillment/interfaces/fulfillment.ShippingMethodTaxLineDTO/page.mdx": "2025-06-25T10:11:35.926Z",
"references/fulfillment/interfaces/fulfillment.TaxLineDTO/page.mdx": "2024-12-17T16:57:24.925Z",
"references/fulfillment/types/fulfillment.CalculatedShippingOptionPrice/page.mdx": "2025-01-17T16:43:27.044Z",
- "references/inventory_next_models/variables/inventory_next_models.InventoryItem/page.mdx": "2025-10-25T20:14:16.501Z",
- "references/inventory_next_models/variables/inventory_next_models.InventoryLevel/page.mdx": "2025-10-25T20:14:16.508Z",
- "references/inventory_next_models/variables/inventory_next_models.ReservationItem/page.mdx": "2025-10-25T20:14:16.525Z",
- "references/payment_models/variables/payment_models.Capture/page.mdx": "2025-10-25T20:14:21.354Z",
- "references/payment_models/variables/payment_models.Payment/page.mdx": "2025-10-25T20:14:21.402Z",
- "references/payment_models/variables/payment_models.PaymentCollection/page.mdx": "2025-10-25T20:14:21.367Z",
- "references/payment_models/variables/payment_models.PaymentProvider/page.mdx": "2025-10-25T20:14:21.376Z",
- "references/payment_models/variables/payment_models.PaymentSession/page.mdx": "2025-10-25T20:14:21.387Z",
- "references/payment_models/variables/payment_models.Refund/page.mdx": "2025-10-25T20:14:21.419Z",
- "references/payment_models/variables/payment_models.RefundReason/page.mdx": "2025-10-25T20:14:21.410Z",
- "references/promotion_models/variables/promotion_models.ApplicationMethod/page.mdx": "2025-10-25T20:14:21.656Z",
- "references/promotion_models/variables/promotion_models.Campaign/page.mdx": "2025-10-25T20:14:21.676Z",
- "references/promotion_models/variables/promotion_models.CampaignBudget/page.mdx": "2025-10-25T20:14:21.667Z",
- "references/promotion_models/variables/promotion_models.Promotion/page.mdx": "2025-10-25T20:14:21.714Z",
- "references/promotion_models/variables/promotion_models.PromotionRule/page.mdx": "2025-10-25T20:14:21.700Z",
- "references/promotion_models/variables/promotion_models.PromotionRuleValue/page.mdx": "2025-10-25T20:14:21.682Z",
- "references/stock_location_next_models/variables/stock_location_next_models.StockLocation/page.mdx": "2025-10-25T20:14:21.739Z",
- "references/stock_location_next_models/variables/stock_location_next_models.StockLocationAddress/page.mdx": "2025-10-25T20:14:21.735Z",
- "references/tax_models/variables/tax_models.TaxProvider/page.mdx": "2025-10-25T20:14:21.754Z",
- "references/tax_models/variables/tax_models.TaxRate/page.mdx": "2025-10-25T20:14:21.770Z",
- "references/tax_models/variables/tax_models.TaxRateRule/page.mdx": "2025-10-25T20:14:21.763Z",
- "references/tax_models/variables/tax_models.TaxRegion/page.mdx": "2025-10-25T20:14:21.785Z",
+ "references/inventory_next_models/variables/inventory_next_models.InventoryItem/page.mdx": "2025-10-31T09:41:39.548Z",
+ "references/inventory_next_models/variables/inventory_next_models.InventoryLevel/page.mdx": "2025-10-31T09:41:39.555Z",
+ "references/inventory_next_models/variables/inventory_next_models.ReservationItem/page.mdx": "2025-10-31T09:41:39.561Z",
+ "references/payment_models/variables/payment_models.Capture/page.mdx": "2025-10-31T09:41:44.159Z",
+ "references/payment_models/variables/payment_models.Payment/page.mdx": "2025-10-31T09:41:44.203Z",
+ "references/payment_models/variables/payment_models.PaymentCollection/page.mdx": "2025-10-31T09:41:44.171Z",
+ "references/payment_models/variables/payment_models.PaymentProvider/page.mdx": "2025-10-31T09:41:44.179Z",
+ "references/payment_models/variables/payment_models.PaymentSession/page.mdx": "2025-10-31T09:41:44.190Z",
+ "references/payment_models/variables/payment_models.Refund/page.mdx": "2025-10-31T09:41:44.218Z",
+ "references/payment_models/variables/payment_models.RefundReason/page.mdx": "2025-10-31T09:41:44.210Z",
+ "references/promotion_models/variables/promotion_models.ApplicationMethod/page.mdx": "2025-10-31T09:41:44.434Z",
+ "references/promotion_models/variables/promotion_models.Campaign/page.mdx": "2025-10-31T09:41:44.451Z",
+ "references/promotion_models/variables/promotion_models.CampaignBudget/page.mdx": "2025-10-31T09:41:44.444Z",
+ "references/promotion_models/variables/promotion_models.Promotion/page.mdx": "2025-10-31T09:41:44.485Z",
+ "references/promotion_models/variables/promotion_models.PromotionRule/page.mdx": "2025-10-31T09:41:44.473Z",
+ "references/promotion_models/variables/promotion_models.PromotionRuleValue/page.mdx": "2025-10-31T09:41:44.457Z",
+ "references/stock_location_next_models/variables/stock_location_next_models.StockLocation/page.mdx": "2025-10-31T09:41:44.507Z",
+ "references/stock_location_next_models/variables/stock_location_next_models.StockLocationAddress/page.mdx": "2025-10-31T09:41:44.504Z",
+ "references/tax_models/variables/tax_models.TaxProvider/page.mdx": "2025-10-31T09:41:44.521Z",
+ "references/tax_models/variables/tax_models.TaxRate/page.mdx": "2025-10-31T09:41:44.535Z",
+ "references/tax_models/variables/tax_models.TaxRateRule/page.mdx": "2025-10-31T09:41:44.528Z",
+ "references/tax_models/variables/tax_models.TaxRegion/page.mdx": "2025-10-31T09:41:44.547Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreShippingOptionResponse/page.mdx": "2025-04-11T09:04:47.640Z",
"references/types/HttpTypes/types/types.HttpTypes.StoreCalculateShippingOptionPrice/page.mdx": "2025-04-11T09:04:47.634Z",
"references/types/WorkflowTypes/FulfillmentWorkflow/types/types.WorkflowTypes.FulfillmentWorkflow.CalculateShippingOptionsPricesWorkflowInput/page.mdx": "2024-12-17T16:57:21.219Z",
@@ -5633,18 +5629,18 @@ export const generatedEditDates = {
"references/core_flows/interfaces/core_flows.GetItemTaxLinesStepInput/page.mdx": "2025-06-25T10:11:34.425Z",
"references/dml/entity/types/dml.entity.DMLEntitySchemaBuilder/page.mdx": "2025-01-13T18:05:57.748Z",
"references/fulfillment/interfaces/fulfillment.OrderCreditLineDTO/page.mdx": "2025-09-12T14:10:38.673Z",
- "references/fulfillment_models/variables/fulfillment_models.Fulfillment/page.mdx": "2025-10-25T20:14:16.424Z",
- "references/fulfillment_models/variables/fulfillment_models.FulfillmentAddress/page.mdx": "2025-10-25T20:14:16.383Z",
- "references/fulfillment_models/variables/fulfillment_models.FulfillmentItem/page.mdx": "2025-10-25T20:14:16.391Z",
- "references/fulfillment_models/variables/fulfillment_models.FulfillmentLabel/page.mdx": "2025-10-25T20:14:16.398Z",
- "references/fulfillment_models/variables/fulfillment_models.FulfillmentProvider/page.mdx": "2025-10-25T20:14:16.400Z",
- "references/fulfillment_models/variables/fulfillment_models.FulfillmentSet/page.mdx": "2025-10-25T20:14:16.409Z",
- "references/fulfillment_models/variables/fulfillment_models.GeoZone/page.mdx": "2025-10-25T20:14:16.432Z",
- "references/fulfillment_models/variables/fulfillment_models.ServiceZone/page.mdx": "2025-10-25T20:14:16.448Z",
- "references/fulfillment_models/variables/fulfillment_models.ShippingOption/page.mdx": "2025-10-25T20:14:16.483Z",
- "references/fulfillment_models/variables/fulfillment_models.ShippingOptionRule/page.mdx": "2025-10-25T20:14:16.455Z",
- "references/fulfillment_models/variables/fulfillment_models.ShippingOptionType/page.mdx": "2025-10-25T20:14:16.462Z",
- "references/fulfillment_models/variables/fulfillment_models.ShippingProfile/page.mdx": "2025-10-25T20:14:16.490Z",
+ "references/fulfillment_models/variables/fulfillment_models.Fulfillment/page.mdx": "2025-10-31T09:41:39.477Z",
+ "references/fulfillment_models/variables/fulfillment_models.FulfillmentAddress/page.mdx": "2025-10-31T09:41:39.438Z",
+ "references/fulfillment_models/variables/fulfillment_models.FulfillmentItem/page.mdx": "2025-10-31T09:41:39.445Z",
+ "references/fulfillment_models/variables/fulfillment_models.FulfillmentLabel/page.mdx": "2025-10-31T09:41:39.452Z",
+ "references/fulfillment_models/variables/fulfillment_models.FulfillmentProvider/page.mdx": "2025-10-31T09:41:39.454Z",
+ "references/fulfillment_models/variables/fulfillment_models.FulfillmentSet/page.mdx": "2025-10-31T09:41:39.459Z",
+ "references/fulfillment_models/variables/fulfillment_models.GeoZone/page.mdx": "2025-10-31T09:41:39.484Z",
+ "references/fulfillment_models/variables/fulfillment_models.ServiceZone/page.mdx": "2025-10-31T09:41:39.495Z",
+ "references/fulfillment_models/variables/fulfillment_models.ShippingOption/page.mdx": "2025-10-31T09:41:39.528Z",
+ "references/fulfillment_models/variables/fulfillment_models.ShippingOptionRule/page.mdx": "2025-10-31T09:41:39.506Z",
+ "references/fulfillment_models/variables/fulfillment_models.ShippingOptionType/page.mdx": "2025-10-31T09:41:39.512Z",
+ "references/fulfillment_models/variables/fulfillment_models.ShippingProfile/page.mdx": "2025-10-31T09:41:39.538Z",
"references/js_sdk/admin/FulfillmentProvider/methods/js_sdk.admin.FulfillmentProvider.listFulfillmentOptions/page.mdx": "2025-10-21T08:10:54.424Z",
"references/order/interfaces/order.OrderCreditLineDTO/page.mdx": "2025-09-12T14:10:42.875Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentProviderOption/page.mdx": "2024-12-23T12:30:28.566Z",
@@ -5652,7 +5648,7 @@ export const generatedEditDates = {
"references/types/interfaces/types.BaseFulfillmentProviderOption/page.mdx": "2024-12-23T12:30:28.304Z",
"references/dml/modules/dml.entity/page.mdx": "2024-12-23T12:30:31.943Z",
"references/modules/region_models/page.mdx": "2024-12-23T08:25:09.956Z",
- "references/fulfillment_models/types/fulfillment_models.GeoZoneSchema/page.mdx": "2025-10-25T20:14:16.425Z",
+ "references/fulfillment_models/types/fulfillment_models.GeoZoneSchema/page.mdx": "2025-10-31T09:41:39.478Z",
"references/medusa/types/medusa.Logger/page.mdx": "2024-12-23T12:30:31.866Z",
"references/core_flows/core_flows.Api_Key/page.mdx": "2024-12-23T12:30:23.466Z",
"references/core_flows/core_flows.Cart/page.mdx": "2024-12-23T12:30:23.508Z",
@@ -5684,7 +5680,7 @@ export const generatedEditDates = {
"references/core_flows/core_flows.Tax/page.mdx": "2024-12-23T12:30:26.503Z",
"references/core_flows/core_flows.User/page.mdx": "2024-12-23T12:30:26.564Z",
"references/order/types/order.ReturnStatus/page.mdx": "2024-12-23T12:30:30.107Z",
- "references/fulfillment_models/types/fulfillment_models.ServiceZoneSchema/page.mdx": "2025-10-25T20:14:16.433Z",
+ "references/fulfillment_models/types/fulfillment_models.ServiceZoneSchema/page.mdx": "2025-10-31T09:41:39.485Z",
"app/commerce-modules/api-key/admin-widget-zones/page.mdx": "2024-12-24T08:29:56.989Z",
"app/commerce-modules/auth/admin-widget-zones/page.mdx": "2024-12-24T08:11:08.250Z",
"app/commerce-modules/customer/admin-widget-zones/page.mdx": "2024-12-24T08:07:15.439Z",
@@ -5702,7 +5698,7 @@ export const generatedEditDates = {
"app/commerce-modules/user/admin-widget-zones/page.mdx": "2024-12-24T08:48:14.186Z",
"app/commerce-modules/currency/links-to-other-modules/page.mdx": "2025-04-17T15:40:23.148Z",
"app/commerce-modules/customer/links-to-other-modules/page.mdx": "2025-04-17T15:43:54.168Z",
- "references/core_flows/Payment/Steps_Payment/functions/core_flows.Payment.Steps_Payment.refundPaymentsStep/page.mdx": "2025-10-25T20:14:00.567Z",
+ "references/core_flows/Payment/Steps_Payment/functions/core_flows.Payment.Steps_Payment.refundPaymentsStep/page.mdx": "2025-10-31T09:41:22.894Z",
"references/core_flows/Payment/Steps_Payment/variables/core_flows.Payment.Steps_Payment.refundPaymentsStepId/page.mdx": "2025-01-07T12:54:17.422Z",
"references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.refundPaymentsWorkflow/page.mdx": "2025-09-18T17:04:41.870Z",
"references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.validatePaymentsRefundStep/page.mdx": "2025-06-25T10:11:31.215Z",
@@ -5717,7 +5713,7 @@ export const generatedEditDates = {
"references/stock_location_next/IStockLocationService/methods/stock_location_next.IStockLocationService.upsertStockLocationAddresses/page.mdx": "2025-10-21T08:10:51.892Z",
"references/stock_location_next/interfaces/stock_location_next.FilterableStockLocationAddressProps/page.mdx": "2025-01-13T18:05:57.237Z",
"references/stock_location_next/types/stock_location_next.UpsertStockLocationAddressInput/page.mdx": "2025-01-17T16:43:30.453Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductListParams/page.mdx": "2025-05-20T07:51:41.073Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductListParams/page.mdx": "2025-10-31T09:41:31.224Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductPricingContext/page.mdx": "2025-05-20T07:51:41.073Z",
"references/types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationAddressProps/page.mdx": "2025-01-13T18:05:55.410Z",
"references/types/StockLocationTypes/types/types.StockLocationTypes.UpdateStockLocationAddressInput/page.mdx": "2025-01-07T12:54:23.057Z",
@@ -5781,7 +5777,7 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchInventoryItemsLocationLevelsResponse/page.mdx": "2025-01-27T11:43:53.942Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchUpdateInventoryItemLocationLevels/page.mdx": "2025-01-13T17:30:28.064Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchUpdateInventoryItemsLocationLevels/page.mdx": "2025-01-13T17:30:28.066Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariantInventoryItemLink/page.mdx": "2025-10-21T08:10:46.709Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariantInventoryItemLink/page.mdx": "2025-10-31T09:41:31.053Z",
"references/types/types/types.ExternalModuleDeclarationOverride/page.mdx": "2025-01-13T17:30:27.580Z",
"references/types/types/types.InternalModuleDeclarationOverride/page.mdx": "2025-01-13T17:30:27.579Z",
"references/core_flows/types/core_flows.CompleteOrdersWorkflowInput/page.mdx": "2025-01-13T17:30:26.254Z",
@@ -5821,7 +5817,7 @@ export const generatedEditDates = {
"references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.deleteRefundReasonsWorkflow/page.mdx": "2025-09-18T17:04:41.955Z",
"references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.getVariantAvailabilityStep/page.mdx": "2025-01-17T16:43:24.975Z",
"references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.updatePromotionsStatusWorkflow/page.mdx": "2025-10-21T08:10:40.177Z",
- "references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.updatePromotionsValidationStep/page.mdx": "2025-10-25T20:14:01.457Z",
+ "references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.updatePromotionsValidationStep/page.mdx": "2025-10-31T09:41:23.814Z",
"references/core_flows/interfaces/core_flows.ValidateCartStepInput/page.mdx": "2025-05-20T07:51:40.875Z",
"references/core_flows/interfaces/core_flows.ValidateProductInputStepInput/page.mdx": "2025-02-24T10:48:34.257Z",
"references/core_flows/types/core_flows.ThrowUnlessPaymentCollectionNotePaidInput/page.mdx": "2025-06-25T10:11:33.516Z",
@@ -5830,40 +5826,40 @@ export const generatedEditDates = {
"app/plugins/guides/wishlist/page.mdx": "2025-10-28T16:02:36.573Z",
"app/plugins/page.mdx": "2025-02-26T11:39:25.709Z",
"app/admin-components/components/data-table/page.mdx": "2025-03-03T14:55:58.556Z",
- "references/order_models/variables/order_models.Order/page.mdx": "2025-10-25T20:14:21.335Z",
- "references/order_models/variables/order_models.OrderAddress/page.mdx": "2025-10-25T20:14:21.300Z",
- "references/order_models/variables/order_models.OrderChange/page.mdx": "2025-10-25T20:14:21.316Z",
- "references/order_models/variables/order_models.OrderChangeAction/page.mdx": "2025-10-25T20:14:21.315Z",
- "references/order_models/variables/order_models.OrderClaim/page.mdx": "2025-10-25T20:14:21.303Z",
- "references/order_models/variables/order_models.OrderClaimItem/page.mdx": "2025-10-25T20:14:21.302Z",
- "references/order_models/variables/order_models.OrderClaimItemImage/page.mdx": "2025-10-25T20:14:21.301Z",
- "references/order_models/variables/order_models.OrderCreditLine/page.mdx": "2025-10-25T20:14:21.308Z",
- "references/order_models/variables/order_models.OrderExchange/page.mdx": "2025-10-25T20:14:21.310Z",
- "references/order_models/variables/order_models.OrderExchangeItem/page.mdx": "2025-10-25T20:14:21.309Z",
- "references/order_models/variables/order_models.OrderItem/page.mdx": "2025-10-25T20:14:21.322Z",
- "references/order_models/variables/order_models.OrderLineItem/page.mdx": "2025-10-25T20:14:21.314Z",
- "references/order_models/variables/order_models.OrderLineItemAdjustment/page.mdx": "2025-10-25T20:14:21.311Z",
- "references/order_models/variables/order_models.OrderLineItemTaxLine/page.mdx": "2025-10-25T20:14:21.313Z",
- "references/order_models/variables/order_models.OrderShipping/page.mdx": "2025-10-25T20:14:21.323Z",
- "references/order_models/variables/order_models.OrderShippingMethod/page.mdx": "2025-10-25T20:14:21.343Z",
- "references/order_models/variables/order_models.OrderShippingMethodAdjustment/page.mdx": "2025-10-25T20:14:21.341Z",
- "references/order_models/variables/order_models.OrderShippingMethodTaxLine/page.mdx": "2025-10-25T20:14:21.342Z",
- "references/order_models/variables/order_models.OrderSummary/page.mdx": "2025-10-25T20:14:21.328Z",
- "references/order_models/variables/order_models.OrderTransaction/page.mdx": "2025-10-25T20:14:21.344Z",
- "references/order_models/variables/order_models.Return/page.mdx": "2025-10-25T20:14:21.340Z",
- "references/order_models/variables/order_models.ReturnItem/page.mdx": "2025-10-25T20:14:21.336Z",
- "references/order_models/variables/order_models.ReturnReason/page.mdx": "2025-10-25T20:14:21.339Z",
+ "references/order_models/variables/order_models.Order/page.mdx": "2025-10-31T09:41:44.142Z",
+ "references/order_models/variables/order_models.OrderAddress/page.mdx": "2025-10-31T09:41:44.110Z",
+ "references/order_models/variables/order_models.OrderChange/page.mdx": "2025-10-31T09:41:44.124Z",
+ "references/order_models/variables/order_models.OrderChangeAction/page.mdx": "2025-10-31T09:41:44.123Z",
+ "references/order_models/variables/order_models.OrderClaim/page.mdx": "2025-10-31T09:41:44.113Z",
+ "references/order_models/variables/order_models.OrderClaimItem/page.mdx": "2025-10-31T09:41:44.112Z",
+ "references/order_models/variables/order_models.OrderClaimItemImage/page.mdx": "2025-10-31T09:41:44.111Z",
+ "references/order_models/variables/order_models.OrderCreditLine/page.mdx": "2025-10-31T09:41:44.118Z",
+ "references/order_models/variables/order_models.OrderExchange/page.mdx": "2025-10-31T09:41:44.120Z",
+ "references/order_models/variables/order_models.OrderExchangeItem/page.mdx": "2025-10-31T09:41:44.119Z",
+ "references/order_models/variables/order_models.OrderItem/page.mdx": "2025-10-31T09:41:44.130Z",
+ "references/order_models/variables/order_models.OrderLineItem/page.mdx": "2025-10-31T09:41:44.122Z",
+ "references/order_models/variables/order_models.OrderLineItemAdjustment/page.mdx": "2025-10-31T09:41:44.121Z",
+ "references/order_models/variables/order_models.OrderLineItemTaxLine/page.mdx": "2025-10-31T09:41:44.121Z",
+ "references/order_models/variables/order_models.OrderShipping/page.mdx": "2025-10-31T09:41:44.131Z",
+ "references/order_models/variables/order_models.OrderShippingMethod/page.mdx": "2025-10-31T09:41:44.149Z",
+ "references/order_models/variables/order_models.OrderShippingMethodAdjustment/page.mdx": "2025-10-31T09:41:44.147Z",
+ "references/order_models/variables/order_models.OrderShippingMethodTaxLine/page.mdx": "2025-10-31T09:41:44.148Z",
+ "references/order_models/variables/order_models.OrderSummary/page.mdx": "2025-10-31T09:41:44.135Z",
+ "references/order_models/variables/order_models.OrderTransaction/page.mdx": "2025-10-31T09:41:44.150Z",
+ "references/order_models/variables/order_models.Return/page.mdx": "2025-10-31T09:41:44.146Z",
+ "references/order_models/variables/order_models.ReturnItem/page.mdx": "2025-10-31T09:41:44.143Z",
+ "references/order_models/variables/order_models.ReturnReason/page.mdx": "2025-10-31T09:41:44.145Z",
"references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listAndCountPaymentMethods/page.mdx": "2025-10-21T08:10:50.309Z",
"references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listPaymentMethods/page.mdx": "2025-10-21T08:10:50.306Z",
"references/payment/interfaces/payment.FilterablePaymentMethodProps/page.mdx": "2025-02-24T10:48:40.957Z",
"references/payment/interfaces/payment.PaymentMethodDTO/page.mdx": "2025-01-27T11:43:55.854Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductTagListResponse/page.mdx": "2025-10-21T08:10:46.679Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductTagResponse/page.mdx": "2025-01-27T11:43:54.198Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductTypeListParams/page.mdx": "2025-01-27T11:43:54.211Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductTypeListParams/page.mdx": "2025-10-31T09:41:31.045Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductTypeListResponse/page.mdx": "2025-10-21T08:10:46.706Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductTypeParams/page.mdx": "2025-01-27T11:43:54.211Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductTypeResponse/page.mdx": "2025-01-27T11:43:54.212Z",
- "references/types/interfaces/types.BaseProductTypeListParams/page.mdx": "2025-01-27T11:43:54.550Z",
+ "references/types/interfaces/types.BaseProductTypeListParams/page.mdx": "2025-10-31T09:41:31.845Z",
"references/core_flows/Order/Steps_Order/variables/core_flows.Order.Steps_Order.updateOrderChangesStepId/page.mdx": "2025-01-27T11:43:49.278Z",
"app/commerce-modules/payment/account-holder/page.mdx": "2025-04-07T07:31:20.235Z",
"app/troubleshooting/test-errors/page.mdx": "2025-10-28T16:02:39.347Z",
@@ -5887,11 +5883,11 @@ export const generatedEditDates = {
"references/payment/types/payment.PaymentAccountHolderDTO/page.mdx": "2025-02-11T11:36:52.944Z",
"references/payment/types/payment.PaymentAddressDTO/page.mdx": "2025-02-11T11:36:52.940Z",
"references/payment/types/payment.PaymentCustomerDTO/page.mdx": "2025-02-11T11:36:52.942Z",
- "references/payment_models/variables/payment_models.AccountHolder/page.mdx": "2025-10-25T20:14:21.347Z",
+ "references/payment_models/variables/payment_models.AccountHolder/page.mdx": "2025-10-31T09:41:44.153Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreCartAddPromotion/page.mdx": "2025-02-11T11:36:48.999Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreCartPromotion/page.mdx": "2025-02-11T11:36:48.986Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreCartRemovePromotion/page.mdx": "2025-02-11T11:36:48.998Z",
- "references/core_flows/interfaces/core_flows.BatchProductWorkflowInput/page.mdx": "2025-02-24T10:48:34.249Z",
+ "references/core_flows/interfaces/core_flows.BatchProductWorkflowInput/page.mdx": "2025-10-31T09:41:26.299Z",
"references/core_flows/types/core_flows.UpdateOrderValidationStepInput/page.mdx": "2025-09-12T14:10:35.968Z",
"references/payment/types/payment.PaymentCollectionStatus/page.mdx": "2025-04-11T09:04:50.726Z",
"references/types/types/types.BasePaymentCollectionStatus/page.mdx": "2025-02-11T11:36:50.377Z",
@@ -5900,13 +5896,13 @@ export const generatedEditDates = {
"app/recipes/erp/page.mdx": "2025-05-20T07:51:40.720Z",
"app/recipes/erp/odoo/page.mdx": "2025-05-20T07:51:40.720Z",
"app/commerce-modules/product/selling-products/page.mdx": "2025-07-18T08:56:24.231Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.draftOrder/page.mdx": "2025-10-21T08:10:54.971Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.draftOrder/page.mdx": "2025-10-31T09:41:40.912Z",
"references/js_sdk/admin/Client/methods/js_sdk.admin.Client.throwError_/page.mdx": "2025-02-24T10:48:47.018Z",
"references/js_sdk/admin/CustomStorage/methods/js_sdk.admin.CustomStorage.getItem/page.mdx": "2025-02-24T10:48:47.069Z",
"references/js_sdk/admin/CustomStorage/methods/js_sdk.admin.CustomStorage.removeItem/page.mdx": "2025-02-24T10:48:47.072Z",
"references/js_sdk/admin/CustomStorage/methods/js_sdk.admin.CustomStorage.setItem/page.mdx": "2025-02-24T10:48:47.071Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.create/page.mdx": "2025-09-12T14:10:47.578Z",
- "references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.list/page.mdx": "2025-10-21T08:10:54.205Z",
+ "references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.list/page.mdx": "2025-10-31T09:41:40.117Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.retrieve/page.mdx": "2025-09-12T14:10:47.569Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.update/page.mdx": "2025-09-12T14:10:47.583Z",
"references/js_sdk/admin/DraftOrder/properties/js_sdk.admin.DraftOrder.client/page.mdx": "2025-08-14T12:59:52.425Z",
@@ -5924,8 +5920,8 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateDraftOrder/page.mdx": "2025-05-20T07:51:41.058Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateDraftOrderItem/page.mdx": "2025-02-24T10:48:37.276Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateDraftOrderShippingMethod/page.mdx": "2025-02-24T10:48:37.277Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminDraftOrder/page.mdx": "2025-10-21T08:10:46.020Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminDraftOrderListParams/page.mdx": "2025-02-24T10:48:37.288Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminDraftOrder/page.mdx": "2025-10-31T09:41:30.303Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminDraftOrderListParams/page.mdx": "2025-10-31T09:41:30.350Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminDraftOrderListResponse/page.mdx": "2025-10-21T08:10:46.079Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminDraftOrderParams/page.mdx": "2025-02-24T10:48:37.282Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateDraftOrder/page.mdx": "2025-05-20T07:51:41.069Z",
@@ -5996,9 +5992,9 @@ export const generatedEditDates = {
"app/examples/guides/quote-management/page.mdx": "2025-06-26T12:37:46.148Z",
"references/cart/interfaces/cart.CartCreditLineDTO/page.mdx": "2025-03-04T13:33:48.207Z",
"references/cart/interfaces/cart.UpdateLineItemWithoutSelectorDTO/page.mdx": "2025-06-25T10:11:35.041Z",
- "references/cart_models/variables/cart_models.CreditLine/page.mdx": "2025-10-25T20:14:15.657Z",
+ "references/cart_models/variables/cart_models.CreditLine/page.mdx": "2025-10-31T09:41:38.738Z",
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createCartCreditLinesWorkflow/page.mdx": "2025-09-18T17:04:38.550Z",
- "references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.deleteCartCreditLinesWorkflow/page.mdx": "2025-10-25T20:13:57.532Z",
+ "references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.deleteCartCreditLinesWorkflow/page.mdx": "2025-10-31T09:41:19.835Z",
"references/core_flows/Cart/Workflows_Cart/variables/core_flows.Cart.Workflows_Cart.createCartCreditLinesWorkflowId/page.mdx": "2025-03-04T13:33:40.515Z",
"references/core_flows/Cart/Workflows_Cart/variables/core_flows.Cart.Workflows_Cart.deleteCartCreditLinesWorkflowId/page.mdx": "2025-03-04T13:33:40.574Z",
"references/fulfillment/interfaces/fulfillment.CartCreditLineDTO/page.mdx": "2025-03-04T13:33:48.973Z",
@@ -6028,7 +6024,7 @@ export const generatedEditDates = {
"references/modules/event/page.mdx": "2025-03-17T15:24:03.021Z",
"references/modules/file_service/page.mdx": "2025-03-17T15:24:03.025Z",
"references/modules/notification_service/page.mdx": "2025-03-17T15:24:05.164Z",
- "references/notification_service/interfaces/notification_service.INotificationModuleService/page.mdx": "2025-10-21T08:10:48.944Z",
+ "references/notification_service/interfaces/notification_service.INotificationModuleService/page.mdx": "2025-10-31T09:41:33.500Z",
"app/nextjs-starter/guides/revalidate-cache/page.mdx": "2025-05-01T15:33:42.490Z",
"app/storefront-development/cart/totals/page.mdx": "2025-09-15T15:13:56.268Z",
"app/storefront-development/checkout/order-confirmation/page.mdx": "2025-08-14T15:58:36.610Z",
@@ -6077,7 +6073,7 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddDraftOrderItems/page.mdx": "2025-04-11T09:04:46.662Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddDraftOrderPromotions/page.mdx": "2025-04-11T09:04:46.663Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminAddDraftOrderShippingMethod/page.mdx": "2025-04-11T09:04:46.665Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminDraftOrderPreview/page.mdx": "2025-10-21T08:10:46.039Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminDraftOrderPreview/page.mdx": "2025-10-31T09:41:30.325Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminDraftOrderPreviewResponse/page.mdx": "2025-09-12T14:10:39.715Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminPlugin/page.mdx": "2025-04-11T09:04:47.144Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminPluginsListResponse/page.mdx": "2025-04-11T09:04:47.145Z",
@@ -6168,8 +6164,8 @@ export const generatedEditDates = {
"references/core_flows/Draft_Order/core_flows.Draft_Order.Workflows_Draft_Order/page.mdx": "2025-06-05T19:05:37.068Z",
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.registerOrderDeliveryStep/page.mdx": "2025-05-20T07:51:40.785Z",
"references/core_flows/Order/Steps_Order/variables/core_flows.Order.Steps_Order.registerOrderDeliveryStepId/page.mdx": "2025-04-23T16:21:19.272Z",
- "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderCreditLinesWorkflow/page.mdx": "2025-10-25T20:13:59.543Z",
- "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.validateOrderCreditLinesStep/page.mdx": "2025-10-25T20:13:59.536Z",
+ "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderCreditLinesWorkflow/page.mdx": "2025-10-31T09:41:21.845Z",
+ "references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.validateOrderCreditLinesStep/page.mdx": "2025-10-31T09:41:21.838Z",
"references/core_flows/Order/Workflows_Order/variables/core_flows.Order.Workflows_Order.createOrderCreditLinesWorkflowId/page.mdx": "2025-04-23T16:21:19.783Z",
"references/core_flows/core_flows.Draft_Order/page.mdx": "2025-04-23T16:21:18.488Z",
"references/core_flows/interfaces/core_flows.CancelDraftOrderEditWorkflowInput/page.mdx": "2025-04-24T08:23:57.279Z",
@@ -6180,7 +6176,7 @@ export const generatedEditDates = {
"references/core_flows/types/core_flows.FetchShippingOptionForOrderWorkflowOutput/page.mdx": "2025-04-23T16:21:21.821Z",
"references/core_flows/types/core_flows.RequestDraftOrderEditWorkflowInput/page.mdx": "2025-04-23T16:21:21.717Z",
"references/core_flows/types/core_flows.GenerateProductCsvStepOutput/page.mdx": "2025-04-23T16:21:22.403Z",
- "references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.convertDraftOrderStep/page.mdx": "2025-10-25T20:13:58.021Z",
+ "references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.convertDraftOrderStep/page.mdx": "2025-10-31T09:41:20.325Z",
"references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderStep/page.mdx": "2025-09-12T14:10:30.937Z",
"references/core_flows/interfaces/core_flows.AddDraftOrderPromotionWorkflowInput/page.mdx": "2025-04-24T08:23:57.277Z",
"references/core_flows/interfaces/core_flows.AddDraftOrderShippingMethodsWorkflowInput/page.mdx": "2025-04-24T08:23:57.278Z",
@@ -6232,7 +6228,7 @@ export const generatedEditDates = {
"references/events/events.Sales_Channel/page.mdx": "2025-05-20T07:51:40.897Z",
"references/events/events.User/page.mdx": "2025-05-20T07:51:40.897Z",
"app/how-to-tutorials/tutorials/saved-payment-methods/page.mdx": "2025-09-11T13:03:49.152Z",
- "references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refundPaymentAndRecreatePaymentSessionWorkflow/page.mdx": "2025-10-25T20:13:57.600Z",
+ "references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refundPaymentAndRecreatePaymentSessionWorkflow/page.mdx": "2025-10-31T09:41:19.892Z",
"references/core_flows/Cart/Workflows_Cart/variables/core_flows.Cart.Workflows_Cart.refundPaymentAndRecreatePaymentSessionWorkflowId/page.mdx": "2025-05-20T07:51:40.757Z",
"references/core_flows/Draft_Order/Workflows_Draft_Order/variables/core_flows.Draft_Order.Workflows_Draft_Order.convertDraftOrderWorkflowId/page.mdx": "2025-05-20T07:51:40.768Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.fetchShippingOptionForOrderWorkflow/page.mdx": "2025-09-18T17:04:40.776Z",
@@ -6242,9 +6238,9 @@ export const generatedEditDates = {
"references/core_flows/interfaces/core_flows.ProcessPaymentWorkflowInput/page.mdx": "2025-05-20T07:51:40.874Z",
"references/core_flows/interfaces/core_flows.refundPaymentAndRecreatePaymentSessionWorkflowInput/page.mdx": "2025-05-20T07:51:40.875Z",
"references/core_flows/types/core_flows.MaybeRefreshShippingMethodsWorkflowInput/page.mdx": "2025-05-20T07:51:40.880Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.taxProvider/page.mdx": "2025-10-21T08:10:55.329Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.taxProvider/page.mdx": "2025-10-31T09:41:41.283Z",
"references/js_sdk/admin/Product/methods/js_sdk.admin.Product.createImport/page.mdx": "2025-10-21T08:10:56.432Z",
- "references/js_sdk/admin/TaxProvider/methods/js_sdk.admin.TaxProvider.list/page.mdx": "2025-10-21T08:10:57.361Z",
+ "references/js_sdk/admin/TaxProvider/methods/js_sdk.admin.TaxProvider.list/page.mdx": "2025-10-31T09:41:43.426Z",
"references/js_sdk/admin/TaxProvider/properties/js_sdk.admin.TaxProvider.client/page.mdx": "2025-08-14T12:59:55.344Z",
"references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.update/page.mdx": "2025-10-21T08:10:57.477Z",
"references/js_sdk/admin/classes/js_sdk.admin.TaxProvider/page.mdx": "2025-05-20T07:51:40.953Z",
@@ -6252,7 +6248,7 @@ export const generatedEditDates = {
"references/tax/interfaces/tax.FilterableTaxProviderProps/page.mdx": "2025-05-20T07:51:41.051Z",
"references/tax/interfaces/tax.TaxProviderDTO/page.mdx": "2025-05-20T07:51:41.052Z",
"references/types/CommonTypes/types/types.CommonTypes.QueryContextType/page.mdx": "2025-05-20T07:51:41.055Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetTaxProvidersParams/page.mdx": "2025-05-20T07:51:41.063Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetTaxProvidersParams/page.mdx": "2025-10-31T09:41:31.582Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminImportProductsRequest/page.mdx": "2025-05-20T07:51:41.063Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminImportProductsResponse/page.mdx": "2025-05-20T07:51:41.063Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminTaxProvider/page.mdx": "2025-05-20T07:51:41.067Z",
@@ -6473,7 +6469,7 @@ export const generatedEditDates = {
"references/utils/utils.SearchUtils/page.mdx": "2025-05-20T07:51:41.155Z",
"references/dml/entity_builder/types/dml.entity_builder.DefineOptions/page.mdx": "2025-05-20T07:51:40.894Z",
"references/types/interfaces/types.IAuthProvider/page.mdx": "2025-05-20T07:51:41.084Z",
- "references/types/interfaces/types.IPaymentProvider/page.mdx": "2025-10-21T08:10:48.134Z",
+ "references/types/interfaces/types.IPaymentProvider/page.mdx": "2025-10-31T09:41:32.623Z",
"references/types/interfaces/types.WebhookActionResult/page.mdx": "2025-05-20T07:51:41.086Z",
"references/types/interfaces/types.WebhookActionData/page.mdx": "2025-05-20T07:51:41.086Z",
"app/commerce-modules/tax/tax-provider/page.mdx": "2025-10-22T07:14:23.461Z",
@@ -6575,7 +6571,7 @@ export const generatedEditDates = {
"references/js_sdk/admin/Views/methods/js_sdk.admin.Views.columns/page.mdx": "2025-10-21T08:10:57.659Z",
"references/js_sdk/admin/Views/methods/js_sdk.admin.Views.createConfiguration/page.mdx": "2025-10-21T08:10:57.669Z",
"references/js_sdk/admin/Views/methods/js_sdk.admin.Views.deleteConfiguration/page.mdx": "2025-10-21T08:10:57.675Z",
- "references/js_sdk/admin/Views/methods/js_sdk.admin.Views.listConfigurations/page.mdx": "2025-10-21T08:10:57.662Z",
+ "references/js_sdk/admin/Views/methods/js_sdk.admin.Views.listConfigurations/page.mdx": "2025-10-31T09:41:43.743Z",
"references/js_sdk/admin/Views/methods/js_sdk.admin.Views.retrieveActiveConfiguration/page.mdx": "2025-10-21T08:10:57.677Z",
"references/js_sdk/admin/Views/methods/js_sdk.admin.Views.retrieveConfiguration/page.mdx": "2025-10-21T08:10:57.671Z",
"references/js_sdk/admin/Views/methods/js_sdk.admin.Views.setActiveConfiguration/page.mdx": "2025-10-21T08:10:57.679Z",
@@ -6591,9 +6587,9 @@ export const generatedEditDates = {
"references/workflows/functions/workflows.resolveValue/page.mdx": "2025-09-12T14:10:46.882Z",
"references/workflows/types/workflows.FlowRetryStepOptions/page.mdx": "2025-09-12T14:10:46.852Z",
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.listShippingOptionsForOrderWorkflow/page.mdx": "2025-10-21T08:10:39.266Z",
- "references/core_flows/Settings/Steps_Settings/functions/core_flows.Settings.Steps_Settings.setActiveViewConfigurationStep/page.mdx": "2025-10-25T20:14:01.678Z",
- "references/core_flows/Settings/Steps_Settings/functions/core_flows.Settings.Steps_Settings.updateViewConfigurationStep/page.mdx": "2025-10-25T20:14:01.674Z",
- "references/core_flows/Settings/Workflows_Settings/functions/core_flows.Settings.Workflows_Settings.updateViewConfigurationWorkflow/page.mdx": "2025-10-25T20:14:01.690Z",
+ "references/core_flows/Settings/Steps_Settings/functions/core_flows.Settings.Steps_Settings.setActiveViewConfigurationStep/page.mdx": "2025-10-31T09:41:24.027Z",
+ "references/core_flows/Settings/Steps_Settings/functions/core_flows.Settings.Steps_Settings.updateViewConfigurationStep/page.mdx": "2025-10-31T09:41:24.024Z",
+ "references/core_flows/Settings/Workflows_Settings/functions/core_flows.Settings.Workflows_Settings.updateViewConfigurationWorkflow/page.mdx": "2025-10-31T09:41:24.043Z",
"references/core_flows/Shipping_Options/Workflows_Shipping_Options/functions/core_flows.Shipping_Options.Workflows_Shipping_Options.createShippingOptionTypesWorkflow/page.mdx": "2025-10-21T08:10:40.416Z",
"references/core_flows/Shipping_Options/Workflows_Shipping_Options/functions/core_flows.Shipping_Options.Workflows_Shipping_Options.deleteShippingOptionTypesWorkflow/page.mdx": "2025-10-21T08:10:40.420Z",
"references/core_flows/Shipping_Options/Workflows_Shipping_Options/functions/core_flows.Shipping_Options.Workflows_Shipping_Options.updateShippingOptionTypesWorkflow/page.mdx": "2025-10-21T08:10:40.429Z",
@@ -6606,7 +6602,7 @@ export const generatedEditDates = {
"references/core_flows/Locking/core_flows.Locking.Steps_Locking/page.mdx": "2025-09-15T09:52:14.217Z",
"app/integrations/guides/meilisearch/page.mdx": "2025-10-21T10:51:27.358Z",
"app/nextjs-starter/guides/storefront-returns/page.mdx": "2025-09-22T06:02:00.580Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.views/page.mdx": "2025-10-21T08:10:55.384Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.views/page.mdx": "2025-10-31T09:41:41.343Z",
"app/data-model-repository-reference/methods/create/page.mdx": "2025-10-28T16:02:14.959Z",
"app/data-model-repository-reference/methods/delete/page.mdx": "2025-10-28T16:02:17.380Z",
"app/data-model-repository-reference/methods/find/page.mdx": "2025-10-28T16:02:20.099Z",
@@ -6627,7 +6623,7 @@ export const generatedEditDates = {
"references/js_sdk/admin/RefundReason/methods/js_sdk.admin.RefundReason.update/page.mdx": "2025-10-21T08:10:56.632Z",
"references/promotion/interfaces/promotion.CampaignBudgetUsageDTO/page.mdx": "2025-10-21T08:10:51.300Z",
"references/promotion/types/promotion.CampaignBudgetUsageContext/page.mdx": "2025-10-21T08:10:51.298Z",
- "references/promotion_models/variables/promotion_models.CampaignBudgetUsage/page.mdx": "2025-10-25T20:14:21.660Z",
+ "references/promotion_models/variables/promotion_models.CampaignBudgetUsage/page.mdx": "2025-10-31T09:41:44.438Z",
"references/tax/ITaxModuleService/methods/tax.ITaxModuleService.getProvider/page.mdx": "2025-10-21T08:10:52.255Z",
"references/tax/ITaxProvider/methods/tax.ITaxProvider.getIdentifier/page.mdx": "2025-10-25T20:14:14.786Z",
"references/tax/ITaxProvider/methods/tax.ITaxProvider.getTaxLines/page.mdx": "2025-10-25T20:14:14.789Z",
@@ -6640,18 +6636,18 @@ export const generatedEditDates = {
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateCalculatedShippingOption/page.mdx": "2025-10-21T08:10:47.099Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateFlatRateShippingOption/page.mdx": "2025-10-21T08:10:47.097Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminRefundReasonDeleteResponse/page.mdx": "2025-10-21T08:10:46.935Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.AdminRefundReasonListParams/page.mdx": "2025-10-21T08:10:46.929Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminRefundReasonListParams/page.mdx": "2025-10-31T09:41:31.305Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminRefundReasonListResponse/page.mdx": "2025-10-21T08:10:46.933Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminRefundReasonParams/page.mdx": "2025-10-21T08:10:46.930Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminRefundReasonResponse/page.mdx": "2025-10-21T08:10:46.932Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateRefundReason/page.mdx": "2025-10-21T08:10:46.918Z",
- "references/types/HttpTypes/interfaces/types.HttpTypes.StoreCollectionListParams/page.mdx": "2025-10-21T08:10:45.883Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreCollectionListParams/page.mdx": "2025-10-31T09:41:30.144Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.StoreCollectionParams/page.mdx": "2025-10-21T08:10:45.884Z",
"references/types/HttpTypes/types/types.HttpTypes.AdminCreateShippingOption/page.mdx": "2025-10-21T08:10:47.100Z",
"references/types/HttpTypes/types/types.HttpTypes.StoreCartShippingOptionWithServiceZone/page.mdx": "2025-10-21T08:10:46.214Z",
"references/types/interfaces/types.AdminCreateShippingOptionBase/page.mdx": "2025-10-21T08:10:47.520Z",
"references/types/interfaces/types.BaseRefundReason/page.mdx": "2025-10-21T08:10:47.490Z",
- "references/types/interfaces/types.BaseRefundReasonListParams/page.mdx": "2025-10-21T08:10:47.492Z",
+ "references/types/interfaces/types.BaseRefundReasonListParams/page.mdx": "2025-10-31T09:41:31.905Z",
"references/types/interfaces/types.StoreFulfillmentAddress/page.mdx": "2025-10-21T08:10:45.670Z",
"references/types/types.CachingTypes/page.mdx": "2025-10-21T08:10:45.089Z",
"references/types/types/types.AdminBaseRefundReasonPayload/page.mdx": "2025-10-21T08:10:47.488Z",
@@ -6676,8 +6672,8 @@ export const generatedEditDates = {
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.softDeleteShippingOptionTypes/page.mdx": "2025-10-21T08:10:44.662Z",
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateShippingOptionTypes/page.mdx": "2025-10-21T08:10:44.643Z",
"references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.upsertShippingOptionTypes/page.mdx": "2025-10-21T08:10:44.648Z",
- "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.shippingOptionType/page.mdx": "2025-10-21T08:10:54.825Z",
- "references/js_sdk/admin/ShippingOptionType/methods/js_sdk.admin.ShippingOptionType.list/page.mdx": "2025-10-21T08:10:57.055Z",
+ "references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.shippingOptionType/page.mdx": "2025-10-31T09:41:40.767Z",
+ "references/js_sdk/admin/ShippingOptionType/methods/js_sdk.admin.ShippingOptionType.list/page.mdx": "2025-10-31T09:41:43.105Z",
"references/promotion/types/promotion.CampaignBudgetTypeValues/page.mdx": "2025-10-21T08:10:51.291Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminShippingOptionTypeListResponse/page.mdx": "2025-10-21T08:10:47.127Z",
"references/types/SettingsTypes/interfaces/types.SettingsTypes.ISettingsModuleService/page.mdx": "2025-10-21T08:10:48.225Z",
@@ -6685,5 +6681,36 @@ export const generatedEditDates = {
"references/utils/Fulfillment/variables/utils.Fulfillment.ShippingOptionTypeWorkflowEvents/page.mdx": "2025-10-21T08:10:52.748Z",
"references/utils/PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodAllocation/page.mdx": "2025-10-21T08:10:52.665Z",
"references/utils/PromotionUtils/enums/utils.PromotionUtils.CampaignBudgetType/page.mdx": "2025-10-21T08:10:52.672Z",
- "app/integrations/guides/avalara/page.mdx": "2025-10-22T09:56:11.929Z"
+ "app/integrations/guides/avalara/page.mdx": "2025-10-22T09:56:11.929Z",
+ "references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchImageVariants/page.mdx": "2025-10-31T09:41:42.515Z",
+ "references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchVariantImages/page.mdx": "2025-10-31T09:41:42.517Z",
+ "references/product/IProductModuleService/methods/product.IProductModuleService.addImageToVariant/page.mdx": "2025-10-31T09:41:35.918Z",
+ "references/product/IProductModuleService/methods/product.IProductModuleService.removeImageFromVariant/page.mdx": "2025-10-31T09:41:35.920Z",
+ "references/product_models/variables/product_models.ProductVariantProductImage/page.mdx": "2025-10-31T09:41:44.361Z",
+ "references/types/CommonTypes/interfaces/types.CommonTypes.MedusaCloudOptions/page.mdx": "2025-10-31T09:41:29.424Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchImageVariantRequest/page.mdx": "2025-10-31T09:41:31.113Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchImageVariantResponse/page.mdx": "2025-10-31T09:41:31.186Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchVariantImagesRequest/page.mdx": "2025-10-31T09:41:31.115Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchVariantImagesResponse/page.mdx": "2025-10-31T09:41:31.187Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaimActionsParams/page.mdx": "2025-10-31T09:41:30.055Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateOrderCreditLine/page.mdx": "2025-10-31T09:41:30.709Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateTaxRateRule/page.mdx": "2025-10-31T09:41:31.592Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentSetListParams/page.mdx": "2025-10-31T09:41:30.495Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetOrderDetailsParams/page.mdx": "2025-10-31T09:41:30.728Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetOrderParams/page.mdx": "2025-10-31T09:41:30.726Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminIndexDetailsResponse/page.mdx": "2025-10-31T09:41:30.524Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminIndexSyncPayload/page.mdx": "2025-10-31T09:41:30.523Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemsParams/page.mdx": "2025-10-31T09:41:30.558Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderExchangeListParams/page.mdx": "2025-10-31T09:41:30.407Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductExportParams/page.mdx": "2025-10-31T09:41:31.139Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductVariantResponse/page.mdx": "2025-10-31T09:41:31.230Z",
+ "references/types/HttpTypes/types/types.HttpTypes.StoreProductVariantListResponse/page.mdx": "2025-10-31T09:41:31.231Z",
+ "references/types/IndexTypes/interfaces/types.IndexTypes.IndexInfo/page.mdx": "2025-10-31T09:41:31.985Z",
+ "references/types/interfaces/types.RetrieveAccountHolderInput/page.mdx": "2025-10-31T09:41:32.548Z",
+ "references/types/interfaces/types.RetrieveAccountHolderOutput/page.mdx": "2025-10-31T09:41:32.579Z",
+ "references/core_flows/interfaces/core_flows.BatchProductVariantsWorkflowInput/page.mdx": "2025-10-31T09:41:26.286Z",
+ "references/core_flows/interfaces/core_flows.BatchProductVariantsWorkflowOutput/page.mdx": "2025-10-31T09:41:26.291Z",
+ "references/js_sdk/admin/Order/methods/js_sdk.admin.Order.listShippingOptions/page.mdx": "2025-10-31T09:41:41.731Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetViewConfigurationsParams/page.mdx": "2025-10-31T09:41:31.657Z",
+ "references/types/HttpTypes/interfaces/types.HttpTypes.AdminShippingOptionTypeListParams/page.mdx": "2025-10-31T09:41:31.507Z"
}
\ No newline at end of file
diff --git a/www/apps/resources/generated/files-map.mjs b/www/apps/resources/generated/files-map.mjs
index e9713dd139..385cfda4bf 100644
--- a/www/apps/resources/generated/files-map.mjs
+++ b/www/apps/resources/generated/files-map.mjs
@@ -12971,6 +12971,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batch/page.mdx",
"pathname": "/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batch"
},
+ {
+ "filePath": "/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchImageVariants/page.mdx",
+ "pathname": "/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchImageVariants"
+ },
+ {
+ "filePath": "/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchVariantImages/page.mdx",
+ "pathname": "/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchVariantImages"
+ },
{
"filePath": "/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchVariantInventoryItems/page.mdx",
"pathname": "/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchVariantInventoryItems"
@@ -16875,6 +16883,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/product/IModuleService/methods/product.IModuleService.__joinerConfig/page.mdx",
"pathname": "/references/product/IModuleService/methods/product.IModuleService.__joinerConfig"
},
+ {
+ "filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.addImageToVariant/page.mdx",
+ "pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.addImageToVariant"
+ },
{
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.createProductCategories/page.mdx",
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.createProductCategories"
@@ -17003,6 +17015,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.listProducts/page.mdx",
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.listProducts"
},
+ {
+ "filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.removeImageFromVariant/page.mdx",
+ "pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.removeImageFromVariant"
+ },
{
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.restoreProductCategories/page.mdx",
"pathname": "/references/product/IProductModuleService/methods/product.IProductModuleService.restoreProductCategories"
@@ -17503,6 +17519,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductVariant/page.mdx",
"pathname": "/references/product_models/variables/product_models.ProductVariant"
},
+ {
+ "filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductVariantProductImage/page.mdx",
+ "pathname": "/references/product_models/variables/product_models.ProductVariantProductImage"
+ },
{
"filePath": "/www/apps/resources/references/promotion/IBigNumber/methods/promotion.IBigNumber.toJSON/page.mdx",
"pathname": "/references/promotion/IBigNumber/methods/promotion.IBigNumber.toJSON"
@@ -19343,6 +19363,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/CommonTypes/interfaces/types.CommonTypes.HttpCompressionOptions/page.mdx",
"pathname": "/references/types/CommonTypes/interfaces/types.CommonTypes.HttpCompressionOptions"
},
+ {
+ "filePath": "/www/apps/resources/references/types/CommonTypes/interfaces/types.CommonTypes.MedusaCloudOptions/page.mdx",
+ "pathname": "/references/types/CommonTypes/interfaces/types.CommonTypes.MedusaCloudOptions"
+ },
{
"filePath": "/www/apps/resources/references/types/CommonTypes/interfaces/types.CommonTypes.ModuleImplementations/page.mdx",
"pathname": "/references/types/CommonTypes/interfaces/types.CommonTypes.ModuleImplementations"
@@ -19851,6 +19875,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchCreateInventoryItemsLocationLevels/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchCreateInventoryItemsLocationLevels"
},
+ {
+ "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchImageVariantRequest/page.mdx",
+ "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchImageVariantRequest"
+ },
+ {
+ "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchImageVariantResponse/page.mdx",
+ "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchImageVariantResponse"
+ },
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchInventoryItemLocationLevels/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchInventoryItemLocationLevels"
@@ -19911,6 +19943,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchUpdateProductVariant/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchUpdateProductVariant"
},
+ {
+ "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchVariantImagesRequest/page.mdx",
+ "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchVariantImagesRequest"
+ },
+ {
+ "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchVariantImagesResponse/page.mdx",
+ "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchVariantImagesResponse"
+ },
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCampaign"
@@ -19939,6 +19979,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaim/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaim"
},
+ {
+ "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaimActionsParams/page.mdx",
+ "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaimActionsParams"
+ },
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaimAddInboundShipping/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaimAddInboundShipping"
@@ -20099,6 +20143,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateInventoryItem/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateInventoryItem"
},
+ {
+ "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateOrderCreditLine/page.mdx",
+ "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateOrderCreditLine"
+ },
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateOrderFulfillment/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateOrderFulfillment"
@@ -20215,6 +20263,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateTaxRate/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateTaxRate"
},
+ {
+ "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateTaxRateRule/page.mdx",
+ "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateTaxRateRule"
+ },
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateTaxRegion/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateTaxRegion"
@@ -20407,10 +20459,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentProvider/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentProvider"
},
- {
- "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentProviderListParams/page.mdx",
- "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentProviderListParams"
- },
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentProviderListResponse/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentProviderListResponse"
@@ -20435,6 +20483,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentSetDeleteResponse/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentSetDeleteResponse"
},
+ {
+ "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentSetListParams/page.mdx",
+ "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentSetListParams"
+ },
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentSetResponse/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentSetResponse"
@@ -20471,6 +20523,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetInvitesParams/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetInvitesParams"
},
+ {
+ "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetOrderDetailsParams/page.mdx",
+ "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetOrderDetailsParams"
+ },
+ {
+ "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetOrderParams/page.mdx",
+ "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetOrderParams"
+ },
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetOrderShippingOptionList/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminGetOrderShippingOptionList"
@@ -20535,6 +20595,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminImportProductsResponse/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminImportProductsResponse"
},
+ {
+ "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminIndexDetailsResponse/page.mdx",
+ "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminIndexDetailsResponse"
+ },
+ {
+ "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminIndexSyncPayload/page.mdx",
+ "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminIndexSyncPayload"
+ },
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminInitiateOrderEditRequest/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminInitiateOrderEditRequest"
@@ -20551,14 +20619,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItem/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItem"
},
- {
- "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemParams/page.mdx",
- "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemParams"
- },
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemResponse/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemResponse"
},
+ {
+ "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemsParams/page.mdx",
+ "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemsParams"
+ },
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryLevel/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryLevel"
@@ -20639,6 +20707,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderEditResponse/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderEditResponse"
},
+ {
+ "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderExchangeListParams/page.mdx",
+ "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderExchangeListParams"
+ },
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderFilters/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderFilters"
@@ -20823,6 +20895,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductDeleteResponse/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductDeleteResponse"
},
+ {
+ "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductExportParams/page.mdx",
+ "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductExportParams"
+ },
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductImage/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductImage"
@@ -21979,6 +22055,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductVariantParams/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductVariantParams"
},
+ {
+ "filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductVariantResponse/page.mdx",
+ "pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.StoreProductVariantResponse"
+ },
{
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.StorePromotion/page.mdx",
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.StorePromotion"
@@ -22379,6 +22459,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/HttpTypes/types/types.HttpTypes.StoreProductStatus/page.mdx",
"pathname": "/references/types/HttpTypes/types/types.HttpTypes.StoreProductStatus"
},
+ {
+ "filePath": "/www/apps/resources/references/types/HttpTypes/types/types.HttpTypes.StoreProductVariantListResponse/page.mdx",
+ "pathname": "/references/types/HttpTypes/types/types.HttpTypes.StoreProductVariantListResponse"
+ },
{
"filePath": "/www/apps/resources/references/types/HttpTypes/types/types.HttpTypes.StoreRegionListResponse/page.mdx",
"pathname": "/references/types/HttpTypes/types/types.HttpTypes.StoreRegionListResponse"
@@ -22407,6 +22491,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/IndexTypes/interfaces/types.IndexTypes.IIndexService/page.mdx",
"pathname": "/references/types/IndexTypes/interfaces/types.IndexTypes.IIndexService"
},
+ {
+ "filePath": "/www/apps/resources/references/types/IndexTypes/interfaces/types.IndexTypes.IndexInfo/page.mdx",
+ "pathname": "/references/types/IndexTypes/interfaces/types.IndexTypes.IndexInfo"
+ },
{
"filePath": "/www/apps/resources/references/types/IndexTypes/interfaces/types.IndexTypes.IndexModuleOptions/page.mdx",
"pathname": "/references/types/IndexTypes/interfaces/types.IndexTypes.IndexModuleOptions"
@@ -23503,10 +23591,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/enums/types.ClaimReason/page.mdx",
"pathname": "/references/types/enums/types.ClaimReason"
},
- {
- "filePath": "/www/apps/resources/references/types/enums/types.ExchangeReason/page.mdx",
- "pathname": "/references/types/enums/types.ExchangeReason"
- },
{
"filePath": "/www/apps/resources/references/types/interfaces/types.AddToCartWorkflowInputDTO/page.mdx",
"pathname": "/references/types/interfaces/types.AddToCartWorkflowInputDTO"
@@ -23551,18 +23635,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/interfaces/types.AdminCreateShippingOptionBase/page.mdx",
"pathname": "/references/types/interfaces/types.AdminCreateShippingOptionBase"
},
- {
- "filePath": "/www/apps/resources/references/types/interfaces/types.AdminCreateTaxRateRule/page.mdx",
- "pathname": "/references/types/interfaces/types.AdminCreateTaxRateRule"
- },
{
"filePath": "/www/apps/resources/references/types/interfaces/types.AdminDeleteProductVariantInventoryItem/page.mdx",
"pathname": "/references/types/interfaces/types.AdminDeleteProductVariantInventoryItem"
},
- {
- "filePath": "/www/apps/resources/references/types/interfaces/types.AdminExchangeAddItems/page.mdx",
- "pathname": "/references/types/interfaces/types.AdminExchangeAddItems"
- },
{
"filePath": "/www/apps/resources/references/types/interfaces/types.AdminExchangeAddShippingMethod/page.mdx",
"pathname": "/references/types/interfaces/types.AdminExchangeAddShippingMethod"
@@ -24347,6 +24423,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/types/interfaces/types.RemoteNestedExpands/page.mdx",
"pathname": "/references/types/interfaces/types.RemoteNestedExpands"
},
+ {
+ "filePath": "/www/apps/resources/references/types/interfaces/types.RetrieveAccountHolderInput/page.mdx",
+ "pathname": "/references/types/interfaces/types.RetrieveAccountHolderInput"
+ },
+ {
+ "filePath": "/www/apps/resources/references/types/interfaces/types.RetrieveAccountHolderOutput/page.mdx",
+ "pathname": "/references/types/interfaces/types.RetrieveAccountHolderOutput"
+ },
{
"filePath": "/www/apps/resources/references/types/interfaces/types.RetrievePaymentInput/page.mdx",
"pathname": "/references/types/interfaces/types.RetrievePaymentInput"
diff --git a/www/apps/resources/generated/generated-commerce-modules-sidebar.mjs b/www/apps/resources/generated/generated-commerce-modules-sidebar.mjs
index 572ade1169..cacd6d1fc6 100644
--- a/www/apps/resources/generated/generated-commerce-modules-sidebar.mjs
+++ b/www/apps/resources/generated/generated-commerce-modules-sidebar.mjs
@@ -12687,6 +12687,15 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"title": "Methods",
"autogenerate_path": "/references/product/IProductModuleService/methods",
"children": [
+ {
+ "loaded": true,
+ "isPathHref": true,
+ "type": "link",
+ "path": "/references/product/addImageToVariant",
+ "title": "addImageToVariant",
+ "description": "",
+ "children": []
+ },
{
"loaded": true,
"isPathHref": true,
@@ -12975,6 +12984,15 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"description": "",
"children": []
},
+ {
+ "loaded": true,
+ "isPathHref": true,
+ "type": "link",
+ "path": "/references/product/removeImageFromVariant",
+ "title": "removeImageFromVariant",
+ "description": "",
+ "children": []
+ },
{
"loaded": true,
"isPathHref": true,
@@ -13437,6 +13455,15 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"title": "ProductVariant",
"description": "",
"children": []
+ },
+ {
+ "loaded": true,
+ "isPathHref": true,
+ "type": "link",
+ "path": "/references/product/models/ProductVariantProductImage",
+ "title": "ProductVariantProductImage",
+ "description": "",
+ "children": []
}
]
}
diff --git a/www/apps/resources/generated/slug-changes.mjs b/www/apps/resources/generated/slug-changes.mjs
index 2a37f63741..a77cb159a3 100644
--- a/www/apps/resources/generated/slug-changes.mjs
+++ b/www/apps/resources/generated/slug-changes.mjs
@@ -6519,6 +6519,11 @@ export const slugChanges = [
"newSlug": "/references/pricing/models/PriceSet",
"filePath": "/www/apps/resources/references/pricing_models/variables/pricing_models.PriceSet/page.mdx"
},
+ {
+ "origSlug": "/references/product/IProductModuleService/methods/product.IProductModuleService.addImageToVariant",
+ "newSlug": "/references/product/addImageToVariant",
+ "filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.addImageToVariant/page.mdx"
+ },
{
"origSlug": "/references/product/IProductModuleService/methods/product.IProductModuleService.createProductCategories",
"newSlug": "/references/product/createProductCategories",
@@ -6679,6 +6684,11 @@ export const slugChanges = [
"newSlug": "/references/product/listProducts",
"filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.listProducts/page.mdx"
},
+ {
+ "origSlug": "/references/product/IProductModuleService/methods/product.IProductModuleService.removeImageFromVariant",
+ "newSlug": "/references/product/removeImageFromVariant",
+ "filePath": "/www/apps/resources/references/product/IProductModuleService/methods/product.IProductModuleService.removeImageFromVariant/page.mdx"
+ },
{
"origSlug": "/references/product/IProductModuleService/methods/product.IProductModuleService.restoreProductCategories",
"newSlug": "/references/product/restoreProductCategories",
@@ -6924,6 +6934,11 @@ export const slugChanges = [
"newSlug": "/references/product/models/ProductVariant",
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductVariant/page.mdx"
},
+ {
+ "origSlug": "/references/product_models/variables/product_models.ProductVariantProductImage",
+ "newSlug": "/references/product/models/ProductVariantProductImage",
+ "filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductVariantProductImage/page.mdx"
+ },
{
"origSlug": "/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.addPromotionBuyRules",
"newSlug": "/references/promotion/addPromotionBuyRules",
diff --git a/www/apps/resources/references/api_key_models/variables/api_key_models.ApiKey/page.mdx b/www/apps/resources/references/api_key_models/variables/api_key_models.ApiKey/page.mdx
index 75cf3d1afa..ad1a25feb2 100644
--- a/www/apps/resources/references/api_key_models/variables/api_key_models.ApiKey/page.mdx
+++ b/www/apps/resources/references/api_key_models/variables/api_key_models.ApiKey/page.mdx
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the ApiKey data model. It belongs to the API Key Module.
-
+
diff --git a/www/apps/resources/references/auth_models/variables/auth_models.AuthIdentity/page.mdx b/www/apps/resources/references/auth_models/variables/auth_models.AuthIdentity/page.mdx
index 4fbe8cd401..8b42e29027 100644
--- a/www/apps/resources/references/auth_models/variables/auth_models.AuthIdentity/page.mdx
+++ b/www/apps/resources/references/auth_models/variables/auth_models.AuthIdentity/page.mdx
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the AuthIdentity data model. It belongs to the Auth Module.
-
+
diff --git a/www/apps/resources/references/auth_models/variables/auth_models.ProviderIdentity/page.mdx b/www/apps/resources/references/auth_models/variables/auth_models.ProviderIdentity/page.mdx
index 54c41f886a..7f833828fe 100644
--- a/www/apps/resources/references/auth_models/variables/auth_models.ProviderIdentity/page.mdx
+++ b/www/apps/resources/references/auth_models/variables/auth_models.ProviderIdentity/page.mdx
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the ProviderIdentity data model. It belongs to the Auth Module.
-
+
diff --git a/www/apps/resources/references/cart_models/variables/cart_models.Address/page.mdx b/www/apps/resources/references/cart_models/variables/cart_models.Address/page.mdx
index d82ce75af5..008d28a1a5 100644
--- a/www/apps/resources/references/cart_models/variables/cart_models.Address/page.mdx
+++ b/www/apps/resources/references/cart_models/variables/cart_models.Address/page.mdx
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the Address data model. It belongs to the Cart Module.
-
+
diff --git a/www/apps/resources/references/cart_models/variables/cart_models.Cart/page.mdx b/www/apps/resources/references/cart_models/variables/cart_models.Cart/page.mdx
index c832177044..5e2fa4ce0c 100644
--- a/www/apps/resources/references/cart_models/variables/cart_models.Cart/page.mdx
+++ b/www/apps/resources/references/cart_models/variables/cart_models.Cart/page.mdx
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the Cart data model. It belongs to the Cart Module.
-
+
diff --git a/www/apps/resources/references/cart_models/variables/cart_models.CreditLine/page.mdx b/www/apps/resources/references/cart_models/variables/cart_models.CreditLine/page.mdx
index 858ad2932a..83be507f94 100644
--- a/www/apps/resources/references/cart_models/variables/cart_models.CreditLine/page.mdx
+++ b/www/apps/resources/references/cart_models/variables/cart_models.CreditLine/page.mdx
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the CreditLine data model. It belongs to the Cart Module.
-
+
diff --git a/www/apps/resources/references/cart_models/variables/cart_models.LineItem/page.mdx b/www/apps/resources/references/cart_models/variables/cart_models.LineItem/page.mdx
index 5df0043f0e..58577198f3 100644
--- a/www/apps/resources/references/cart_models/variables/cart_models.LineItem/page.mdx
+++ b/www/apps/resources/references/cart_models/variables/cart_models.LineItem/page.mdx
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the LineItem data model. It belongs to the Cart Module.
-
+
diff --git a/www/apps/resources/references/cart_models/variables/cart_models.LineItemAdjustment/page.mdx b/www/apps/resources/references/cart_models/variables/cart_models.LineItemAdjustment/page.mdx
index 3ebee120f5..c8f7f8344f 100644
--- a/www/apps/resources/references/cart_models/variables/cart_models.LineItemAdjustment/page.mdx
+++ b/www/apps/resources/references/cart_models/variables/cart_models.LineItemAdjustment/page.mdx
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the LineItemAdjustment data model. It belongs to the Cart Module.
-
+
diff --git a/www/apps/resources/references/cart_models/variables/cart_models.LineItemTaxLine/page.mdx b/www/apps/resources/references/cart_models/variables/cart_models.LineItemTaxLine/page.mdx
index c19dc466b0..3027b42971 100644
--- a/www/apps/resources/references/cart_models/variables/cart_models.LineItemTaxLine/page.mdx
+++ b/www/apps/resources/references/cart_models/variables/cart_models.LineItemTaxLine/page.mdx
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the LineItemTaxLine data model. It belongs to the Cart Module.
-
+
diff --git a/www/apps/resources/references/cart_models/variables/cart_models.ShippingMethod/page.mdx b/www/apps/resources/references/cart_models/variables/cart_models.ShippingMethod/page.mdx
index e1fa6db3ef..b41d33b041 100644
--- a/www/apps/resources/references/cart_models/variables/cart_models.ShippingMethod/page.mdx
+++ b/www/apps/resources/references/cart_models/variables/cart_models.ShippingMethod/page.mdx
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the ShippingMethod data model. It belongs to the Cart Module.
-
+
diff --git a/www/apps/resources/references/cart_models/variables/cart_models.ShippingMethodAdjustment/page.mdx b/www/apps/resources/references/cart_models/variables/cart_models.ShippingMethodAdjustment/page.mdx
index 7242a0f9b1..2248b842b2 100644
--- a/www/apps/resources/references/cart_models/variables/cart_models.ShippingMethodAdjustment/page.mdx
+++ b/www/apps/resources/references/cart_models/variables/cart_models.ShippingMethodAdjustment/page.mdx
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the ShippingMethodAdjustment data model. It belongs to the Cart Module.
-
+
diff --git a/www/apps/resources/references/cart_models/variables/cart_models.ShippingMethodTaxLine/page.mdx b/www/apps/resources/references/cart_models/variables/cart_models.ShippingMethodTaxLine/page.mdx
index 852b0874bc..6e180049ba 100644
--- a/www/apps/resources/references/cart_models/variables/cart_models.ShippingMethodTaxLine/page.mdx
+++ b/www/apps/resources/references/cart_models/variables/cart_models.ShippingMethodTaxLine/page.mdx
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the ShippingMethodTaxLine data model. It belongs to the Cart Module.
-
+
diff --git a/www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.createApiKeysWorkflow/page.mdx b/www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.createApiKeysWorkflow/page.mdx
index ab3ddf6f1f..b6975be01b 100644
--- a/www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.createApiKeysWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.createApiKeysWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow creates one or more API keys, which can be secret or publishable.
You can use this workflow within your customizations or your own custom workflows, allowing you to
create API keys within your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.deleteApiKeysWorkflow/page.mdx b/www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.deleteApiKeysWorkflow/page.mdx
index 1c90976508..f825bad4c5 100644
--- a/www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.deleteApiKeysWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.deleteApiKeysWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow deletes one or more secret or publishable API keys. It's used by t
You can use this workflow within your customizations or your own custom workflows, allowing you to
delete API keys within your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.linkSalesChannelsToApiKeyWorkflow/page.mdx b/www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.linkSalesChannelsToApiKeyWorkflow/page.mdx
index 5d783d1dee..e34df8ba00 100644
--- a/www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.linkSalesChannelsToApiKeyWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.linkSalesChannelsToApiKeyWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow manages the sales channels of a publishable API key. It's used by
You can use this workflow within your customizations or your own custom workflows, allowing you to
manage the sales channels of a publishable API key within your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.revokeApiKeysWorkflow/page.mdx b/www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.revokeApiKeysWorkflow/page.mdx
index bab330fbc2..8b40985746 100644
--- a/www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.revokeApiKeysWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.revokeApiKeysWorkflow/page.mdx
@@ -21,7 +21,7 @@ This workflow is used by the [Revoke API Key API Route](https://docs.medusajs.co
You can use this workflow within your customizations or your own custom workflows, allowing you to
revoke API keys within your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.updateApiKeysWorkflow/page.mdx b/www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.updateApiKeysWorkflow/page.mdx
index 6ccf9bd60c..d411b32c53 100644
--- a/www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.updateApiKeysWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.updateApiKeysWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow updates one or more secret or publishable API keys. It's used by t
You can use this workflow within your customizations or your own custom workflows, allowing you to
update API keys within your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Auth/Steps_Auth/functions/core_flows.Auth.Steps_Auth.setAuthAppMetadataStep/page.mdx b/www/apps/resources/references/core_flows/Auth/Steps_Auth/functions/core_flows.Auth.Steps_Auth.setAuthAppMetadataStep/page.mdx
index ff87dec898..33f582f85c 100644
--- a/www/apps/resources/references/core_flows/Auth/Steps_Auth/functions/core_flows.Auth.Steps_Auth.setAuthAppMetadataStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Auth/Steps_Auth/functions/core_flows.Auth.Steps_Auth.setAuthAppMetadataStep/page.mdx
@@ -16,7 +16,7 @@ This step sets the `app_metadata` property of an auth identity. This is useful t
associate a user (whether it's an admin user or customer) with an auth identity
that allows them to authenticate into Medusa.
-You can learn more about auth identites in
+You can learn more about auth identites in
[this documentation](https://docs.medusajs.com/resources/commerce-modules/auth/auth-identity-and-actor-types).
To use this for a custom actor type, check out [this guide](https://docs.medusajs.com/resources/commerce-modules/auth/create-actor-type)
diff --git a/www/apps/resources/references/core_flows/Auth/Workflows_Auth/functions/core_flows.Auth.Workflows_Auth.generateResetPasswordTokenWorkflow/page.mdx b/www/apps/resources/references/core_flows/Auth/Workflows_Auth/functions/core_flows.Auth.Workflows_Auth.generateResetPasswordTokenWorkflow/page.mdx
index 8bcbcf1dc4..c385dbc569 100644
--- a/www/apps/resources/references/core_flows/Auth/Workflows_Auth/functions/core_flows.Auth.Workflows_Auth.generateResetPasswordTokenWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Auth/Workflows_Auth/functions/core_flows.Auth.Workflows_Auth.generateResetPasswordTokenWorkflow/page.mdx
@@ -27,7 +27,7 @@ how to handle this event.
You can use this workflow within your customizations or your own custom workflows, allowing you to
generate reset password tokens within your custom flows.
-
+
## Examples
@@ -148,7 +148,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -162,12 +162,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.createCartsStep/page.mdx b/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.createCartsStep/page.mdx
index 9eb60a2512..ff0f397cce 100644
--- a/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.createCartsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.createCartsStep/page.mdx
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
"my-workflow",
() => {
const data = createCartsStep({
- "currency_code": "dzd"
+ "currency_code": "cve"
})
}
)
diff --git a/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.findOneOrAnyRegionStep/page.mdx b/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.findOneOrAnyRegionStep/page.mdx
index d521396958..507ebe3e16 100644
--- a/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.findOneOrAnyRegionStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.findOneOrAnyRegionStep/page.mdx
@@ -2,8 +2,6 @@
slug: /references/medusa-workflows/steps/findOneOrAnyRegionStep
sidebar_label: findOneOrAnyRegionStep
tags:
- - region
- - store
- step
---
@@ -31,7 +29,3 @@ const myWorkflow = createWorkflow(
## Input
-
-## Output
-
-`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="findOneOrAnyRegionStep"/>
diff --git a/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.findSalesChannelStep/page.mdx b/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.findSalesChannelStep/page.mdx
index 610b2fed50..3dbe5a762c 100644
--- a/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.findSalesChannelStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.findSalesChannelStep/page.mdx
@@ -2,8 +2,6 @@
slug: /references/medusa-workflows/steps/findSalesChannelStep
sidebar_label: findSalesChannelStep
tags:
- - sales channel
- - store
- step
---
diff --git a/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.getPromotionCodesToApply/page.mdx b/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.getPromotionCodesToApply/page.mdx
index 416d79a5df..b7a865ae12 100644
--- a/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.getPromotionCodesToApply/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.getPromotionCodesToApply/page.mdx
@@ -2,7 +2,6 @@
slug: /references/medusa-workflows/steps/getPromotionCodesToApply
sidebar_label: getPromotionCodesToApply
tags:
- - promotion
- step
---
diff --git a/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.getVariantPriceSetsStep/page.mdx b/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.getVariantPriceSetsStep/page.mdx
index 67d280e1ab..8355d60040 100644
--- a/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.getVariantPriceSetsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.getVariantPriceSetsStep/page.mdx
@@ -1,10 +1,6 @@
---
slug: /references/medusa-workflows/steps/getVariantPriceSetsStep
sidebar_label: getVariantPriceSetsStep
-tags:
- - pricing
- - query
- - step
---
import { TypeList, WorkflowDiagram } from "docs-ui"
diff --git a/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.getVariantsStep/page.mdx b/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.getVariantsStep/page.mdx
index 34deefcbd7..185ffbaa8d 100644
--- a/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.getVariantsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.getVariantsStep/page.mdx
@@ -27,4 +27,4 @@ const data = getVariantsStep({
## Output
-`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product collection. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product collection was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product collection was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product collection was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product type was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product type was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product type was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the product variant's requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="getVariantsStep"/>
+`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product collection. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product collection was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product collection was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product collection was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product type was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product type was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product type was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The thumbnail of the product variant form the product images.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the product variant's requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="getVariantsStep"/>
diff --git a/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.prepareAdjustmentsFromPromotionActionsStep/page.mdx b/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.prepareAdjustmentsFromPromotionActionsStep/page.mdx
index 9a8d8af094..a4f4dc4710 100644
--- a/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.prepareAdjustmentsFromPromotionActionsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.prepareAdjustmentsFromPromotionActionsStep/page.mdx
@@ -2,7 +2,7 @@
slug: /references/medusa-workflows/steps/prepareAdjustmentsFromPromotionActionsStep
sidebar_label: prepareAdjustmentsFromPromotionActionsStep
tags:
- - promotion
+ - query
- step
---
diff --git a/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.retrieveCartStep/page.mdx b/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.retrieveCartStep/page.mdx
index b379efa352..fcc0aebc29 100644
--- a/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.retrieveCartStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.retrieveCartStep/page.mdx
@@ -19,7 +19,7 @@ const myWorkflow = createWorkflow(
"my-workflow",
() => {
const data = retrieveCartStep({
- "id": "id_wm73qa502E9os"
+ "id": "id_6yfdwvd7Ql5VCMXKbx"
})
}
)
diff --git a/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateCartPromotionsStep/page.mdx b/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateCartPromotionsStep/page.mdx
index fd4d6f15eb..6c62ac549b 100644
--- a/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateCartPromotionsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateCartPromotionsStep/page.mdx
@@ -4,7 +4,6 @@ sidebar_label: updateCartPromotionsStep
tags:
- link
- remote query
- - promotion
- step
---
@@ -24,7 +23,7 @@ const myWorkflow = createWorkflow(
"my-workflow",
() => {
const data = updateCartPromotionsStep({
- "id": "id_6YN7cmJWHDhP"
+ "id": "id_rjYDM9OtxDGnbG1FBd"
})
}
)
diff --git a/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateAndReturnShippingMethodsDataStep/page.mdx b/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateAndReturnShippingMethodsDataStep/page.mdx
index 95f0f1b065..b907be85cd 100644
--- a/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateAndReturnShippingMethodsDataStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateAndReturnShippingMethodsDataStep/page.mdx
@@ -70,7 +70,7 @@ const data = validateAndReturnShippingMethodsDataStep({
## Input
-`","description":"The `data` property of the shipping option that the shipping method was \ncreated from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"method_data","type":"`Record`","description":"The `data` property of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[ValidateFulfillmentDataContext](../../../../../types/types/types.ValidateFulfillmentDataContext/page.mdx)","description":"The context to validate the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"[CartDTO](../../../../../fulfillment/interfaces/fulfillment.CartDTO/page.mdx)[`\"id\"`]","description":"The cart's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[CartDTO](../../../../../fulfillment/interfaces/fulfillment.CartDTO/page.mdx)[`\"shipping_address\"`]","description":"The cart's shipping address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[CartDTO](../../../../../fulfillment/interfaces/fulfillment.CartDTO/page.mdx)[`\"items\"`] & `object`","description":"The cart's items","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"variant","type":"`object`","description":"The item's variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`object`","description":"The item's product.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"from_location","type":"[StockLocationDTO](../../../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationDTO/page.mdx)","description":"Details about the location that items are being shipped from.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record` \\| `null`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"The associated address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"[FulfillmentSetDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentSetDTO/page.mdx)[]","description":"Fulfillment sets for the location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The deletion date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[StockLocationAddressDTO](../../../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationAddressDTO/page.mdx)","description":"The address of the stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="validateAndReturnShippingMethodsDataStep"/>
+`","description":"The `data` property of the shipping option that the shipping method was\ncreated from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"method_data","type":"`Record`","description":"The `data` property of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[ValidateFulfillmentDataContext](../../../../../types/types/types.ValidateFulfillmentDataContext/page.mdx)","description":"The context to validate the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"[CartDTO](../../../../../fulfillment/interfaces/fulfillment.CartDTO/page.mdx)[`\"id\"`]","description":"The cart's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[CartDTO](../../../../../fulfillment/interfaces/fulfillment.CartDTO/page.mdx)[`\"shipping_address\"`]","description":"The cart's shipping address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[CartDTO](../../../../../fulfillment/interfaces/fulfillment.CartDTO/page.mdx)[`\"items\"`] & `object`","description":"The cart's items","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"variant","type":"`object`","description":"The item's variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`object`","description":"The item's product.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"from_location","type":"[StockLocationDTO](../../../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationDTO/page.mdx)","description":"Details about the location that items are being shipped from.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record` \\| `null`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"The associated address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"[FulfillmentSetDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentSetDTO/page.mdx)[]","description":"Fulfillment sets for the location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The deletion date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[StockLocationAddressDTO](../../../../../types/StockLocationTypes/types/types.StockLocationTypes.StockLocationAddressDTO/page.mdx)","description":"The address of the stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="validateAndReturnShippingMethodsDataStep"/>
## Output
diff --git a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.addShippingMethodToCartWorkflow/page.mdx b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.addShippingMethodToCartWorkflow/page.mdx
index 9d8adae324..3c7fd10b28 100644
--- a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.addShippingMethodToCartWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.addShippingMethodToCartWorkflow/page.mdx
@@ -10,7 +10,6 @@ tags:
- event bus
- workflow
- query
- - pricing
- tax
- promotion
- link
@@ -29,7 +28,7 @@ This workflow adds a shipping method to a cart. It's executed by the
You can use this workflow within your own customizations or custom workflows, allowing you to wrap custom logic around adding a shipping method to the cart.
-
+
## Examples
@@ -178,7 +177,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -216,12 +215,8 @@ Handlers consuming this hook accept the following input.
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.addToCartWorkflow/page.mdx b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.addToCartWorkflow/page.mdx
index 678f556981..3ab423a225 100644
--- a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.addToCartWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.addToCartWorkflow/page.mdx
@@ -4,17 +4,16 @@ sidebar_label: addToCartWorkflow
sidebar_description: Add a line item to a cart.
tags:
- locking
- - query
- - pricing
- cart
- event bus
- workflow
- inventory
+ - query
- fulfillment
- - remote query
- tax
- promotion
- link
+ - remote query
- payment
- logger
---
@@ -31,7 +30,7 @@ This workflow adds a product variant to a cart as a line item. It's executed by
You can use this workflow within your own customizations or custom workflows, allowing you to wrap custom logic around adding an item to the cart.
For example, you can use this workflow to add a line item to the cart with a custom price.
-
+
## Examples
@@ -180,7 +179,7 @@ const myWorkflow = createWorkflow(
## Steps
- {\n return new StepResponse({\n location_id: \"sloc_123\", // Special price for in-store purchases\n });\n});\n```\n\nThe variants' prices will now be retrieved using the context you return.\n\n:::note\n\nLearn more about prices calculation context in the [Prices Calculation](https://docs.medusajs.com/resources/commerce-modules/pricing/price-calculation) documentation.\n\n:::","link":"#setPricingContext","depth":5},{"type":"when","condition":"{\n return !!variantIds.length\n }","depth":"6","steps":[{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":6},{"type":"step","name":"getVariantPriceSetsStep","description":"This step retrieves the calculated price sets of the specified variants.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.getVariantPriceSetsStep/page.mdx","depth":6},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.\nIf not valid, the step throws an error.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateVariantPricesStep/page.mdx","depth":6}]},{"type":"step","name":"validateLineItemPricesStep","description":"This step validates the specified line item objects to ensure they have prices.\nIf an item doesn't have a price, the step throws an error.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateLineItemPricesStep/page.mdx","depth":7},{"type":"step","name":"getLineItemActionsStep","description":"This step returns lists of cart line items to create or update based on the\nprovided input.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.getLineItemActionsStep/page.mdx","depth":8},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"Validate that a variant is in-stock before adding to the cart.","link":"../core_flows.Cart.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx","depth":9},{"type":"step","name":"createLineItemsStep","description":"This step creates line item in a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.createLineItemsStep/page.mdx","depth":10},{"type":"step","name":"updateLineItemsStep","description":"This step updates a cart's line items.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateLineItemsStep/page.mdx","depth":10},{"type":"workflow","name":"refreshCartItemsWorkflow","description":"Refresh a cart's details after an update.","link":"../core_flows.Cart.Workflows_Cart.refreshCartItemsWorkflow/page.mdx","depth":11},{"type":"step","name":"emitEventStep","description":"Emit an event.","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx","depth":12},{"type":"step","name":"releaseLockStep","description":"This step releases a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.releaseLockStep/page.mdx","depth":12}]}} />
+ {\n return new StepResponse({\n location_id: \"sloc_123\", // Special price for in-store purchases\n });\n});\n```\n\nThe variants' prices will now be retrieved using the context you return.\n\n:::note\n\nLearn more about prices calculation context in the [Prices Calculation](https://docs.medusajs.com/resources/commerce-modules/pricing/price-calculation) documentation.\n\n:::","link":"#setPricingContext","depth":4},{"type":"step","name":"validateLineItemPricesStep","description":"This step validates the specified line item objects to ensure they have prices.\nIf an item doesn't have a price, the step throws an error.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateLineItemPricesStep/page.mdx","depth":7},{"type":"step","name":"getLineItemActionsStep","description":"This step returns lists of cart line items to create or update based on the\nprovided input.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.getLineItemActionsStep/page.mdx","depth":8},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"Validate that a variant is in-stock before adding to the cart.","link":"../core_flows.Cart.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx","depth":9},{"type":"step","name":"createLineItemsStep","description":"This step creates line item in a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.createLineItemsStep/page.mdx","depth":10},{"type":"step","name":"updateLineItemsStep","description":"This step updates a cart's line items.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateLineItemsStep/page.mdx","depth":10},{"type":"workflow","name":"refreshCartItemsWorkflow","description":"Refresh a cart's details after an update.","link":"../core_flows.Cart.Workflows_Cart.refreshCartItemsWorkflow/page.mdx","depth":11},{"type":"step","name":"emitEventStep","description":"This step emits an event, which you can listen to in a [subscriber](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers). You can pass data to the\nsubscriber by including it in the `data` property.\n\nThe event is only emitted after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. \nIf the workflow fails, it won't emit the event at all.","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx","depth":12},{"type":"step","name":"releaseLockStep","description":"This step releases a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.releaseLockStep/page.mdx","depth":12}]}} />
## Input
@@ -267,18 +266,14 @@ addToCartWorkflow.hooks.setPricingContext(
Handlers consuming this hook accept the following input.
-`","description":"The associated variant's values for the product's options.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the line item requires shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Whether the line item is discountable.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the line item's price is tax inclusive. Learn more in\n[this documentation](https://docs.medusajs.com/resources/commerce-modules/pricing/tax-inclusive-pricing)","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the line item is a gift card.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compare_at_unit_price","type":"[BigNumberInput](../../../../../types/types/types.BigNumberInput/page.mdx)","description":"The original price of the item before a promotion or sale.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"[BigNumberInput](../../../../../types/types/types.BigNumberInput/page.mdx)","description":"The price of a single quantity of the item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Custom key-value pairs related to the item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="setPricingContext"/>
+`","description":"The associated variant's values for the product's options.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the line item requires shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Whether the line item is discountable.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the line item's price is tax inclusive. Learn more in\n[this documentation](https://docs.medusajs.com/resources/commerce-modules/pricing/tax-inclusive-pricing)","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the line item is a gift card.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compare_at_unit_price","type":"[BigNumberInput](../../../../../types/types/types.BigNumberInput/page.mdx)","description":"The original price of the item before a promotion or sale.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"[BigNumberInput](../../../../../types/types/types.BigNumberInput/page.mdx)","description":"The price of a single quantity of the item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Custom key-value pairs related to the item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="setPricingContext"/>
## Emitted Events
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.completeCartWorkflow/page.mdx b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.completeCartWorkflow/page.mdx
index d466839459..e5c5ed1b4e 100644
--- a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.completeCartWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.completeCartWorkflow/page.mdx
@@ -28,7 +28,7 @@ You can use this workflow within your own customizations or custom workflows, al
For example, in the [Subscriptions recipe](https://docs.medusajs.com/resources/recipes/subscriptions/examples/standard#create-workflow),
this workflow is used within another workflow that creates a subscription order.
-
+
## Examples
@@ -137,7 +137,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -179,12 +179,8 @@ Handlers consuming this hook accept the following input.
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx
index 7c790d0366..44f9bd49d2 100644
--- a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx
@@ -27,7 +27,7 @@ Learn more about the links between the product variant and sales channels and in
You can use this workflow within your own customizations or custom workflows, allowing you to check whether a product variant has enough inventory quantity before adding them to the cart.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createCartCreditLinesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createCartCreditLinesWorkflow/page.mdx
index f52badd877..4677f609f5 100644
--- a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createCartCreditLinesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createCartCreditLinesWorkflow/page.mdx
@@ -14,7 +14,7 @@ This documentation provides a reference to the `createCartCreditLinesWorkflow`.
This workflow creates one or more credit lines for a cart.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createCartWorkflow/page.mdx b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createCartWorkflow/page.mdx
index d729d97de1..761b514746 100644
--- a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createCartWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createCartWorkflow/page.mdx
@@ -3,21 +3,17 @@ slug: /references/medusa-workflows/createCartWorkflow
sidebar_label: createCartWorkflow
sidebar_description: Create a cart specifying region, items, and more.
tags:
- - sales channel
- - store
- - region
- customer
- - query
- - pricing
- cart
- event bus
- workflow
- inventory
- - remote query
- locking
- tax
- promotion
+ - query
- link
+ - remote query
- payment
- logger
---
@@ -35,7 +31,7 @@ This workflow has a hook that allows you to perform custom actions on the create
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around cart creation.
-
+
## Examples
@@ -176,7 +172,7 @@ const myWorkflow = createWorkflow(
## Steps
- {\n return new StepResponse({\n location_id: \"sloc_123\", // Special price for in-store purchases\n });\n});\n```\n\nThe variants' prices will now be retrieved using the context you return.\n\n:::note\n\nLearn more about prices calculation context in the [Prices Calculation](https://docs.medusajs.com/resources/commerce-modules/pricing/price-calculation) documentation.\n\n:::","link":"#setPricingContext","depth":2},{"type":"when","condition":"{\n return !!variantIds.length\n }","depth":"3","steps":[{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":3},{"type":"step","name":"getVariantPriceSetsStep","description":"This step retrieves the calculated price sets of the specified variants.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.getVariantPriceSetsStep/page.mdx","depth":3},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.\nIf not valid, the step throws an error.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateVariantPricesStep/page.mdx","depth":3}]},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"Validate that a variant is in-stock before adding to the cart.","link":"../core_flows.Cart.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx","depth":4},{"type":"step","name":"validateLineItemPricesStep","description":"This step validates the specified line item objects to ensure they have prices.\nIf an item doesn't have a price, the step throws an error.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateLineItemPricesStep/page.mdx","depth":5},{"type":"hook","name":"validate","description":"This hook is executed before all operations. You can consume this hook to perform any custom validation. If validation fails, you can throw an error to stop the workflow execution.","link":"#validate","depth":6},{"type":"step","name":"createCartsStep","description":"This step creates a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.createCartsStep/page.mdx","depth":7},{"type":"workflow","name":"updateTaxLinesWorkflow","description":"Update a cart's tax lines.","link":"../core_flows.Cart.Workflows_Cart.updateTaxLinesWorkflow/page.mdx","depth":8},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"Update a cart's applied promotions to add, replace, or remove them.","link":"../core_flows.Cart.Workflows_Cart.updateCartPromotionsWorkflow/page.mdx","depth":9},{"type":"workflow","name":"refreshPaymentCollectionForCartWorkflow","description":"Refresh a cart's payment collection details.","link":"../core_flows.Cart.Workflows_Cart.refreshPaymentCollectionForCartWorkflow/page.mdx","depth":10},{"type":"step","name":"emitEventStep","description":"Emit an event.","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx","depth":10},{"type":"hook","name":"cartCreated","description":"","link":"#cartCreated","depth":11}]}} />
+ {\n return new StepResponse({\n location_id: \"sloc_123\", // Special price for in-store purchases\n });\n});\n```\n\nThe variants' prices will now be retrieved using the context you return.\n\n:::note\n\nLearn more about prices calculation context in the [Prices Calculation](https://docs.medusajs.com/resources/commerce-modules/pricing/price-calculation) documentation.\n\n:::","link":"#setPricingContext","depth":2},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"Validate that a variant is in-stock before adding to the cart.","link":"../core_flows.Cart.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx","depth":3},{"type":"hook","name":"validate","description":"This hook is executed before all operations. You can consume this hook to perform any custom validation. If validation fails, you can throw an error to stop the workflow execution.","link":"#validate","depth":4},{"type":"step","name":"createCartsStep","description":"This step creates a cart.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.createCartsStep/page.mdx","depth":5},{"type":"workflow","name":"updateTaxLinesWorkflow","description":"Update a cart's tax lines.","link":"../core_flows.Cart.Workflows_Cart.updateTaxLinesWorkflow/page.mdx","depth":6},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"Update a cart's applied promotions to add, replace, or remove them.","link":"../core_flows.Cart.Workflows_Cart.updateCartPromotionsWorkflow/page.mdx","depth":7},{"type":"workflow","name":"refreshPaymentCollectionForCartWorkflow","description":"Refresh a cart's payment collection details.","link":"../core_flows.Cart.Workflows_Cart.refreshPaymentCollectionForCartWorkflow/page.mdx","depth":8},{"type":"step","name":"emitEventStep","description":"This step emits an event, which you can listen to in a [subscriber](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers). You can pass data to the\nsubscriber by including it in the `data` property.\n\nThe event is only emitted after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. \nIf the workflow fails, it won't emit the event at all.","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx","depth":8},{"type":"hook","name":"cartCreated","description":"","link":"#cartCreated","depth":9}]}} />
## Input
@@ -246,7 +242,7 @@ createCartWorkflow.hooks.setPricingContext(
Handlers consuming this hook accept the following input.
-`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variantIds","type":"(`undefined` \\| `string`)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"salesChannel","type":"[SalesChannelDTO](../../../../../sales_channel/interfaces/sales_channel.SalesChannelDTO/page.mdx)","description":"The sales channel details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the sales channel is disabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"locations","type":"[SalesChannelLocationDTO](../../../../../sales_channel/interfaces/sales_channel.SalesChannelLocationDTO/page.mdx)[]","description":"The locations of the sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customerData","type":"[FindOrCreateCustomerOutputStepOutput](../../../../interfaces/core_flows.FindOrCreateCustomerOutputStepOutput/page.mdx)","description":"The details of the customer found or created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"customer","type":"`null` \\| [CustomerDTO](../../../../../customer/interfaces/customer.CustomerDTO/page.mdx)","description":"The customer found or created, if any.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer found or created, if any.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="setPricingContext"/>
+`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"locations","type":"[SalesChannelLocationDTO](../../../../../sales_channel/interfaces/sales_channel.SalesChannelLocationDTO/page.mdx)[]","description":"The locations of the sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customerData","type":"[FindOrCreateCustomerOutputStepOutput](../../../../interfaces/core_flows.FindOrCreateCustomerOutputStepOutput/page.mdx)","description":"The details of the customer found or created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"customer","type":"`null` \\| [CustomerDTO](../../../../../customer/interfaces/customer.CustomerDTO/page.mdx)","description":"The customer found or created, if any.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the customer found or created, if any.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="setPricingContext"/>
### validate
@@ -268,7 +264,7 @@ createCartWorkflow.hooks.validate(
Handlers consuming this hook accept the following input.
-`","description":"Custom key-value pairs related to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[CreateCartCreateLineItemDTO](../../../../../types/interfaces/types.CreateCartCreateLineItemDTO/page.mdx)[]","description":"The items to be added to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promo_codes","type":"`string`[]","description":"The promotional codes applied on the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_data","type":"`Record`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\n\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"","optional":false,"defaultValue":"data.region.id","expandable":false,"children":[]},{"name":"items","type":"`any`[]","description":"","optional":false,"defaultValue":"data.lineItems","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`","description":"The ID of the sales channel through which the cart is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email address of the cart's customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the associated shipping address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the associated billing address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`string` \\| [CreateCartAddressDTO](../../../../../types/interfaces/types.CreateCartAddressDTO/page.mdx)","description":"The ID of an existing shipping address, or the details of a shipping address to create.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"`string` \\| [CreateCartAddressDTO](../../../../../types/interfaces/types.CreateCartAddressDTO/page.mdx)","description":"The ID of an existing billing address, or the details of a billing address to create.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"Custom key-value pairs related to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promo_codes","type":"`string`[]","description":"The promotional codes applied on the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_data","type":"`Record`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\n\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="validate"/>
+`","description":"Custom key-value pairs related to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[CreateCartCreateLineItemDTO](../../../../../types/interfaces/types.CreateCartCreateLineItemDTO/page.mdx)[]","description":"The items to be added to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promo_codes","type":"`string`[]","description":"The promotional codes applied on the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_data","type":"`Record`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\n\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"[CreateCartDTO](../../../../../cart/interfaces/cart.CreateCartDTO/page.mdx)","description":"The cart to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string`","description":"The currency code of the cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"The associated region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`","description":"The associated sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer that owns the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The associated shipping address's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The associated billing address's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`string` \\| [CreateAddressDTO](../../../../../cart/interfaces/cart.CreateAddressDTO/page.mdx)","description":"The shipping address of the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"`string` \\| [CreateAddressDTO](../../../../../cart/interfaces/cart.CreateAddressDTO/page.mdx)","description":"The billing address of the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[CreateLineItemDTO](../../../../../cart/interfaces/cart.CreateLineItemDTO/page.mdx)[]","description":"The items of the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="validate"/>
### cartCreated
@@ -290,18 +286,14 @@ createCartWorkflow.hooks.cartCreated(
Handlers consuming this hook accept the following input.
-`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`string` \\| `Date`","description":"When the cart was completed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the cart was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the cart was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="cartCreated"/>
+`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`string` \\| `Date`","description":"When the cart was completed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the cart was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the cart was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="cartCreated"/>
## Emitted Events
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createPaymentCollectionForCartWorkflow/page.mdx b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createPaymentCollectionForCartWorkflow/page.mdx
index 98bd9e581f..0984eccd01 100644
--- a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createPaymentCollectionForCartWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createPaymentCollectionForCartWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow creates a payment collection for a cart. It's executed by the
You can use this workflow within your own customizations or custom workflows, allowing you to wrap custom logic around adding creating a payment collection for a cart.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.deleteCartCreditLinesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.deleteCartCreditLinesWorkflow/page.mdx
index 5a44efe8f0..14a65bb6d6 100644
--- a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.deleteCartCreditLinesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.deleteCartCreditLinesWorkflow/page.mdx
@@ -14,7 +14,7 @@ This documentation provides a reference to the `deleteCartCreditLinesWorkflow`.
This workflow deletes one or more credit lines from a cart.
-
+
## Examples
@@ -36,7 +36,7 @@ export async function POST(
.run({
input: {
"id": [
- "id_U0PK0ogdIQd2NJb"
+ "id_gAPA9szKeYhiObNji4"
]
}
})
@@ -63,7 +63,7 @@ export default async function handleOrderPlaced({
.run({
input: {
"id": [
- "id_U0PK0ogdIQd2NJb"
+ "id_gAPA9szKeYhiObNji4"
]
}
})
@@ -90,7 +90,7 @@ export default async function myCustomJob(
.run({
input: {
"id": [
- "id_U0PK0ogdIQd2NJb"
+ "id_gAPA9szKeYhiObNji4"
]
}
})
@@ -118,7 +118,7 @@ const myWorkflow = createWorkflow(
.runAsStep({
input: {
"id": [
- "id_U0PK0ogdIQd2NJb"
+ "id_gAPA9szKeYhiObNji4"
]
}
})
diff --git a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWithPricingWorkflow/page.mdx b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWithPricingWorkflow/page.mdx
index 5351dbe0a5..bb362f4a65 100644
--- a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWithPricingWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWithPricingWorkflow/page.mdx
@@ -22,7 +22,7 @@ price of the shipping method being added to the cart.
You can use this workflow within your own customizations or custom workflows, allowing you to retrieve the shipping options of a cart and their prices
in your custom flows.
-
+
## Examples
@@ -234,4 +234,4 @@ listShippingOptionsForCartWithPricingWorkflow.hooks.setShippingOptionsContext(
Handlers consuming this hook accept the following input.
- | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="setShippingOptionsContext"/>
+ | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="setShippingOptionsContext"/>
diff --git a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWorkflow/page.mdx b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWorkflow/page.mdx
index 14eda82747..61bbc0f3b7 100644
--- a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWorkflow/page.mdx
@@ -25,7 +25,7 @@ use the [listShippingOptionsForCartWithPricingWorkflow](../core_flows.Cart.Workf
You can use this workflow within your own customizations or custom workflows, allowing you to wrap custom logic around to retrieve the shipping options of a cart
in your custom flows.
-
+
## Examples
@@ -203,7 +203,7 @@ listShippingOptionsForCartWorkflow.hooks.setPricingContext(
Handlers consuming this hook accept the following input.
- | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="setPricingContext"/>
+ | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="setPricingContext"/>
### setShippingOptionsContext
@@ -265,4 +265,4 @@ listShippingOptionsForCartWorkflow.hooks.setShippingOptionsContext(
Handlers consuming this hook accept the following input.
- | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="setShippingOptionsContext"/>
+ | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="setShippingOptionsContext"/>
diff --git a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refreshCartItemsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refreshCartItemsWorkflow/page.mdx
index 07ab1cae2d..6c50135565 100644
--- a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refreshCartItemsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refreshCartItemsWorkflow/page.mdx
@@ -5,14 +5,13 @@ sidebar_description: Refresh a cart's details after an update.
tags:
- locking
- query
- - pricing
- cart
- workflow
- fulfillment
- - remote query
- tax
- promotion
- link
+ - remote query
- payment
- logger
---
@@ -32,7 +31,7 @@ is added to the cart.
You can use this workflow within your own customizations or custom workflows, allowing you to refresh the cart after making updates to it in your
custom flows.
-
+
## Examples
@@ -141,7 +140,7 @@ const myWorkflow = createWorkflow(
## Steps
- {\n return new StepResponse({\n location_id: \"sloc_123\", // Special price for in-store purchases\n });\n});\n```\n\nThe variants' prices will now be retrieved using the context you return.\n\n:::note\n\nLearn more about prices calculation context in the [Prices Calculation](https://docs.medusajs.com/resources/commerce-modules/pricing/price-calculation) documentation.\n\n:::","link":"#setPricingContext","depth":2},{"type":"when","condition":"{\n return !!input.force_refresh\n }","depth":"3","steps":[{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":3},{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":3},{"type":"step","name":"getVariantPriceSetsStep","description":"This step retrieves the calculated price sets of the specified variants.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.getVariantPriceSetsStep/page.mdx","depth":3},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.\nIf not valid, the step throws an error.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateVariantPricesStep/page.mdx","depth":3},{"type":"step","name":"updateLineItemsStep","description":"This step updates a cart's line items.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateLineItemsStep/page.mdx","depth":3}]},{"type":"workflow","name":"refreshCartShippingMethodsWorkflow","description":"Refresh a cart's shipping methods after an update.","link":"../core_flows.Cart.Workflows_Cart.refreshCartShippingMethodsWorkflow/page.mdx","depth":4},{"type":"when","condition":"{\n return !!input.force_refresh\n }","depth":"5","steps":[{"type":"workflow","name":"updateTaxLinesWorkflow","description":"Update a cart's tax lines.","link":"../core_flows.Cart.Workflows_Cart.updateTaxLinesWorkflow/page.mdx","depth":5}]},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"Update a cart's applied promotions to add, replace, or remove them.","link":"../core_flows.Cart.Workflows_Cart.updateCartPromotionsWorkflow/page.mdx","depth":7},{"type":"hook","name":"beforeRefreshingPaymentCollection","description":"","link":"#beforeRefreshingPaymentCollection","depth":8},{"type":"workflow","name":"refreshPaymentCollectionForCartWorkflow","description":"Refresh a cart's payment collection details.","link":"../core_flows.Cart.Workflows_Cart.refreshPaymentCollectionForCartWorkflow/page.mdx","depth":9},{"type":"step","name":"releaseLockStep","description":"This step releases a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.releaseLockStep/page.mdx","depth":10}]}} />
+ {\n return new StepResponse({\n location_id: \"sloc_123\", // Special price for in-store purchases\n });\n});\n```\n\nThe variants' prices will now be retrieved using the context you return.\n\n:::note\n\nLearn more about prices calculation context in the [Prices Calculation](https://docs.medusajs.com/resources/commerce-modules/pricing/price-calculation) documentation.\n\n:::","link":"#setPricingContext","depth":2},{"type":"when","condition":"{\n return !!input.force_refresh\n }","depth":"3","steps":[{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":3},{"type":"step","name":"updateLineItemsStep","description":"This step updates a cart's line items.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.updateLineItemsStep/page.mdx","depth":3}]},{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":4},{"type":"workflow","name":"refreshCartShippingMethodsWorkflow","description":"Refresh a cart's shipping methods after an update.","link":"../core_flows.Cart.Workflows_Cart.refreshCartShippingMethodsWorkflow/page.mdx","depth":5},{"type":"when","condition":"{\n return !!input.force_refresh\n }","depth":"6","steps":[{"type":"workflow","name":"updateTaxLinesWorkflow","description":"Update a cart's tax lines.","link":"../core_flows.Cart.Workflows_Cart.updateTaxLinesWorkflow/page.mdx","depth":6}]},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"Update a cart's applied promotions to add, replace, or remove them.","link":"../core_flows.Cart.Workflows_Cart.updateCartPromotionsWorkflow/page.mdx","depth":8},{"type":"hook","name":"beforeRefreshingPaymentCollection","description":"","link":"#beforeRefreshingPaymentCollection","depth":9},{"type":"workflow","name":"refreshPaymentCollectionForCartWorkflow","description":"Refresh a cart's payment collection details.","link":"../core_flows.Cart.Workflows_Cart.refreshPaymentCollectionForCartWorkflow/page.mdx","depth":10},{"type":"step","name":"releaseLockStep","description":"This step releases a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.releaseLockStep/page.mdx","depth":11}]}} />
## Input
@@ -206,7 +205,7 @@ refreshCartItemsWorkflow.hooks.setPricingContext(
Handlers consuming this hook accept the following input.
- | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="setPricingContext"/>
+ | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="setPricingContext"/>
### beforeRefreshingPaymentCollection
@@ -228,4 +227,4 @@ refreshCartItemsWorkflow.hooks.beforeRefreshingPaymentCollection(
Handlers consuming this hook accept the following input.
-`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\n\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="beforeRefreshingPaymentCollection"/>
+`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\n\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="beforeRefreshingPaymentCollection"/>
diff --git a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refreshCartShippingMethodsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refreshCartShippingMethodsWorkflow/page.mdx
index 97432f7bb5..8191db4095 100644
--- a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refreshCartShippingMethodsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refreshCartShippingMethodsWorkflow/page.mdx
@@ -20,7 +20,7 @@ and retrieve their correct pricing after a cart update. This workflow is used by
You can use this workflow within your own customizations or custom workflows, allowing you to refresh the cart's shipping method after making updates to the cart.
-
+
## Examples
@@ -161,4 +161,4 @@ refreshCartShippingMethodsWorkflow.hooks.validate(
Handlers consuming this hook accept the following input.
-`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\n\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="validate"/>
+`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\n\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="validate"/>
diff --git a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refreshPaymentCollectionForCartWorkflow/page.mdx b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refreshPaymentCollectionForCartWorkflow/page.mdx
index 21409a74dc..4ce9a7daea 100644
--- a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refreshPaymentCollectionForCartWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refreshPaymentCollectionForCartWorkflow/page.mdx
@@ -3,7 +3,6 @@ slug: /references/medusa-workflows/refreshPaymentCollectionForCartWorkflow
sidebar_label: refreshPaymentCollectionForCartWorkflow
sidebar_description: Refresh a cart's payment collection details.
tags:
- - remote query
- locking
- payment
- workflow
@@ -26,7 +25,7 @@ payment collection after an update.
You can use this workflow within your own customizations or custom workflows, allowing you to refresh the cart's payment collection after making updates to it in your
custom flows.
-
+
## Examples
@@ -135,7 +134,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -167,4 +166,4 @@ refreshPaymentCollectionForCartWorkflow.hooks.validate(
Handlers consuming this hook accept the following input.
-
+
diff --git a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refundPaymentAndRecreatePaymentSessionWorkflow/page.mdx b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refundPaymentAndRecreatePaymentSessionWorkflow/page.mdx
index 6840663983..c9b0c3837f 100644
--- a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refundPaymentAndRecreatePaymentSessionWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.refundPaymentAndRecreatePaymentSessionWorkflow/page.mdx
@@ -18,7 +18,7 @@ This documentation provides a reference to the `refundPaymentAndRecreatePaymentS
This workflow refunds a payment and creates a new payment session.
-
+
## Examples
@@ -43,7 +43,7 @@ export async function POST(
"payment_collection_id": "{value}",
"provider_id": "{value}",
"payment_id": "{value}",
- "amount": 31
+ "amount": 45
}
})
@@ -72,7 +72,7 @@ export default async function handleOrderPlaced({
"payment_collection_id": "{value}",
"provider_id": "{value}",
"payment_id": "{value}",
- "amount": 31
+ "amount": 45
}
})
@@ -101,7 +101,7 @@ export default async function myCustomJob(
"payment_collection_id": "{value}",
"provider_id": "{value}",
"payment_id": "{value}",
- "amount": 31
+ "amount": 45
}
})
@@ -130,7 +130,7 @@ const myWorkflow = createWorkflow(
"payment_collection_id": "{value}",
"provider_id": "{value}",
"payment_id": "{value}",
- "amount": 31
+ "amount": 45
}
})
}
diff --git a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.transferCartCustomerWorkflow/page.mdx b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.transferCartCustomerWorkflow/page.mdx
index 0f335960da..decb558099 100644
--- a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.transferCartCustomerWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.transferCartCustomerWorkflow/page.mdx
@@ -8,12 +8,11 @@ tags:
- event bus
- workflow
- query
- - pricing
- fulfillment
- - remote query
- tax
- promotion
- link
+ - remote query
- payment
- logger
---
@@ -30,7 +29,7 @@ by the [Set Cart's Customer Store API Route](https://docs.medusajs.com/api/store
You can use this workflow within your own customizations or custom workflows, allowing you to set the cart's customer within your custom flows.
-
+
## Examples
@@ -143,7 +142,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -175,18 +174,14 @@ transferCartCustomerWorkflow.hooks.validate(
Handlers consuming this hook accept the following input.
-`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\n\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="validate"/>
+`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\n\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="validate"/>
## Emitted Events
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateCartPromotionsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateCartPromotionsWorkflow/page.mdx
index 290ddc4857..dd3907593f 100644
--- a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateCartPromotionsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateCartPromotionsWorkflow/page.mdx
@@ -3,11 +3,12 @@ slug: /references/medusa-workflows/updateCartPromotionsWorkflow
sidebar_label: updateCartPromotionsWorkflow
sidebar_description: Update a cart's applied promotions to add, replace, or remove them.
tags:
- - remote query
- locking
- promotion
+ - query
- cart
- link
+ - remote query
- workflow
---
@@ -23,7 +24,7 @@ that need to be applied to the cart's line items and shipping methods based on t
You can use this workflow within your own customizations or custom workflows, allowing you to update a cart's promotions within your custom flows.
-
+
## Examples
@@ -144,7 +145,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -176,4 +177,4 @@ updateCartPromotionsWorkflow.hooks.validate(
Handlers consuming this hook accept the following input.
-
+
diff --git a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateCartWorkflow/page.mdx b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateCartWorkflow/page.mdx
index 6dc760e30a..5b4c822abe 100644
--- a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateCartWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateCartWorkflow/page.mdx
@@ -5,18 +5,15 @@ sidebar_description: Update a cart's details, such as region, address, and more.
tags:
- locking
- query
- - sales channel
- - store
- customer
- event bus
- cart
- workflow
- - pricing
- fulfillment
- - remote query
- tax
- promotion
- link
+ - remote query
- payment
- logger
---
@@ -41,7 +38,7 @@ then update any associated details related to the cart in the workflow's hook.
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around updating a cart.
-
+
## Examples
@@ -202,7 +199,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -234,7 +231,7 @@ updateCartWorkflow.hooks.validate(
Handlers consuming this hook accept the following input.
-`","description":"Custom key-value pairs of data related to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [CreateAddressDTO](../../../../../cart/interfaces/cart.CreateAddressDTO/page.mdx) \\| [UpdateAddressDTO](../../../../../cart/interfaces/cart.UpdateAddressDTO/page.mdx)","description":"The cart's shipping address. You can either update the cart's existing shipping address, or create a new one.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"`null` \\| [CreateAddressDTO](../../../../../cart/interfaces/cart.CreateAddressDTO/page.mdx) \\| [UpdateAddressDTO](../../../../../cart/interfaces/cart.UpdateAddressDTO/page.mdx)","description":"The cart's billing address. You can either update the cart's existing billing address, or create a new one.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="validate"/>
+`","description":"Custom key-value pairs of data related to the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [CreateAddressDTO](../../../../../cart/interfaces/cart.CreateAddressDTO/page.mdx) \\| [UpdateAddressDTO](../../../../../cart/interfaces/cart.UpdateAddressDTO/page.mdx)","description":"The cart's shipping address. You can either update the cart's existing shipping address, or create a new one.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"`null` \\| [CreateAddressDTO](../../../../../cart/interfaces/cart.CreateAddressDTO/page.mdx) \\| [UpdateAddressDTO](../../../../../cart/interfaces/cart.UpdateAddressDTO/page.mdx)","description":"The cart's billing address. You can either update the cart's existing billing address, or create a new one.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="validate"/>
### cartUpdated
@@ -256,18 +253,14 @@ updateCartWorkflow.hooks.cartUpdated(
Handlers consuming this hook accept the following input.
- | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="cartUpdated"/>
+ | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="cartUpdated"/>
## Emitted Events
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateLineItemInCartWorkflow/page.mdx b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateLineItemInCartWorkflow/page.mdx
index fef0a9bd53..77fc4e78d4 100644
--- a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateLineItemInCartWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateLineItemInCartWorkflow/page.mdx
@@ -8,12 +8,11 @@ tags:
- event bus
- workflow
- query
- - pricing
- fulfillment
- - remote query
- tax
- promotion
- link
+ - remote query
- payment
- logger
- inventory
@@ -31,7 +30,7 @@ This workflow is executed by the [Update Line Item Store API Route](https://docs
You can use this workflow within your own customizations or custom workflows, allowing you to update a line item's details in your custom flows.
-
+
## Examples
@@ -156,7 +155,7 @@ const myWorkflow = createWorkflow(
## Steps
- {\n return new StepResponse({\n location_id: \"sloc_123\", // Special price for in-store purchases\n });\n});\n```\n\nThe variants' prices will now be retrieved using the context you return.\n\n:::note\n\nLearn more about prices calculation context in the [Prices Calculation](https://docs.medusajs.com/resources/commerce-modules/pricing/price-calculation) documentation.\n\n:::","link":"#setPricingContext","depth":4},{"type":"when","condition":"shouldRemoveItem","depth":"5","steps":[{"type":"workflow","name":"deleteLineItemsWorkflow","description":"Delete line items from a cart.","link":"../../../../Line_Item/Workflows_Line_Item/functions/core_flows.Line_Item.Workflows_Line_Item.deleteLineItemsWorkflow/page.mdx","depth":5}]},{"type":"when","condition":"{\n return !!variantIds.length && !shouldRemoveItem\n }","depth":"6","steps":[{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.\nIf not valid, the step throws an error.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateVariantPricesStep/page.mdx","depth":6}]},{"type":"when","condition":"!shouldRemoveItem","depth":"7","steps":[{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"Validate that a variant is in-stock before adding to the cart.","link":"../core_flows.Cart.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx","depth":7},{"type":"step","name":"updateLineItemsStepWithSelector","description":"This step updates line items.","link":"../../../../Line_Item/Steps_Line_Item/functions/core_flows.Line_Item.Steps_Line_Item.updateLineItemsStepWithSelector/page.mdx","depth":7},{"type":"workflow","name":"refreshCartItemsWorkflow","description":"Refresh a cart's details after an update.","link":"../core_flows.Cart.Workflows_Cart.refreshCartItemsWorkflow/page.mdx","depth":7}]},{"type":"step","name":"releaseLockStep","description":"This step releases a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.releaseLockStep/page.mdx","depth":8},{"type":"step","name":"emitEventStep","description":"Emit an event.","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx","depth":8}]}} />
+ {\n return new StepResponse({\n location_id: \"sloc_123\", // Special price for in-store purchases\n });\n});\n```\n\nThe variants' prices will now be retrieved using the context you return.\n\n:::note\n\nLearn more about prices calculation context in the [Prices Calculation](https://docs.medusajs.com/resources/commerce-modules/pricing/price-calculation) documentation.\n\n:::","link":"#setPricingContext","depth":4},{"type":"when","condition":"shouldRemoveItem","depth":"5","steps":[{"type":"workflow","name":"deleteLineItemsWorkflow","description":"Delete line items from a cart.","link":"../../../../Line_Item/Workflows_Line_Item/functions/core_flows.Line_Item.Workflows_Line_Item.deleteLineItemsWorkflow/page.mdx","depth":5}]},{"type":"when","condition":"{\n return !!variantIds.length && !shouldRemoveItem\n }","depth":"6","steps":[{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.\nIf not valid, the step throws an error.","link":"../../../Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateVariantPricesStep/page.mdx","depth":6}]},{"type":"when","condition":"!shouldRemoveItem","depth":"7","steps":[{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"Validate that a variant is in-stock before adding to the cart.","link":"../core_flows.Cart.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx","depth":7},{"type":"step","name":"updateLineItemsStepWithSelector","description":"This step updates line items.","link":"../../../../Line_Item/Steps_Line_Item/functions/core_flows.Line_Item.Steps_Line_Item.updateLineItemsStepWithSelector/page.mdx","depth":7},{"type":"workflow","name":"refreshCartItemsWorkflow","description":"Refresh a cart's details after an update.","link":"../core_flows.Cart.Workflows_Cart.refreshCartItemsWorkflow/page.mdx","depth":7}]},{"type":"step","name":"releaseLockStep","description":"This step releases a lock for a given key. Learn more about locks in the [Locking Module](https://docs.medusajs.com/resources/infrastructure-modules/locking)\nguide.","link":"../../../../Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.releaseLockStep/page.mdx","depth":8},{"type":"step","name":"emitEventStep","description":"This step emits an event, which you can listen to in a [subscriber](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers). You can pass data to the\nsubscriber by including it in the `data` property.\n\nThe event is only emitted after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. \nIf the workflow fails, it won't emit the event at all.","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx","depth":8}]}} />
## Input
@@ -188,7 +187,7 @@ updateLineItemInCartWorkflow.hooks.validate(
Handlers consuming this hook accept the following input.
-`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\n\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="validate"/>
+`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\n\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="validate"/>
### setPricingContext
@@ -243,18 +242,14 @@ updateLineItemInCartWorkflow.hooks.setPricingContext(
Handlers consuming this hook accept the following input.
-`","description":"The option values of the associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compare_at_unit_price","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The calculated price of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLineDTO](../../../../../cart/interfaces/cart.LineItemTaxLineDTO/page.mdx)[]","description":"The associated tax lines.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"adjustments","type":"[LineItemAdjustmentDTO](../../../../../cart/interfaces/cart.LineItemAdjustmentDTO/page.mdx)[]","description":"The associated adjustments.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the line item was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the line item was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`Date`","description":"When the line item was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variantIds","type":"(`undefined` \\| `string`)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_data","type":"`Record | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="setPricingContext"/>
+`","description":"The option values of the associated variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compare_at_unit_price","type":"[BigNumberValue](../../../../../cart/types/cart.BigNumberValue/page.mdx)","description":"The calculated price of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLineDTO](../../../../../cart/interfaces/cart.LineItemTaxLineDTO/page.mdx)[]","description":"The associated tax lines.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"adjustments","type":"[LineItemAdjustmentDTO](../../../../../cart/interfaces/cart.LineItemAdjustmentDTO/page.mdx)[]","description":"The associated adjustments.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the line item was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the line item was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`Date`","description":"When the line item was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variantIds","type":"(`undefined` \\| `string`)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_data","type":"`Record | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="setPricingContext"/>
## Emitted Events
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateTaxLinesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateTaxLinesWorkflow/page.mdx
index f9406e7952..a47593bad2 100644
--- a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateTaxLinesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateTaxLinesWorkflow/page.mdx
@@ -3,7 +3,6 @@ slug: /references/medusa-workflows/updateTaxLinesWorkflow
sidebar_label: updateTaxLinesWorkflow
sidebar_description: Update a cart's tax lines.
tags:
- - remote query
- locking
- tax
- cart
@@ -21,7 +20,7 @@ by the [Calculate Taxes Store API Route](https://docs.medusajs.com/api/store#car
You can use this workflow within your own customizations or custom workflows, allowing you to update a cart's tax lines in your custom flows.
-
+
## Examples
@@ -130,7 +129,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
diff --git a/www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx b/www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx
index 9d1d392d95..bb48305452 100644
--- a/www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx
@@ -12,7 +12,11 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
This documentation provides a reference to the `emitEventStep`. It belongs to the `@medusajs/medusa/core-flows` package.
-Emit an event.
+This step emits an event, which you can listen to in a [subscriber](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers). You can pass data to the
+subscriber by including it in the `data` property.
+
+The event is only emitted after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully.
+If the workflow fails, it won't emit the event at all.
## Example
diff --git a/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.batchLinksWorkflow/page.mdx b/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.batchLinksWorkflow/page.mdx
index df8a1c2253..9cdb897cfa 100644
--- a/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.batchLinksWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.batchLinksWorkflow/page.mdx
@@ -20,7 +20,7 @@ manage links within your custom flows.
Learn more about links in [this documentation](https://docs.medusajs.com/learn/fundamentals/module-links/link).
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.createLinksWorkflow/page.mdx b/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.createLinksWorkflow/page.mdx
index f0b6efe4bd..87e59efb45 100644
--- a/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.createLinksWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.createLinksWorkflow/page.mdx
@@ -20,7 +20,7 @@ create links within your custom flows.
Learn more about links in [this documentation](https://docs.medusajs.com/learn/fundamentals/module-links/link).
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.dismissLinksWorkflow/page.mdx b/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.dismissLinksWorkflow/page.mdx
index 4feb2cd964..dca80cd436 100644
--- a/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.dismissLinksWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.dismissLinksWorkflow/page.mdx
@@ -20,7 +20,7 @@ dismiss links within your custom flows.
Learn more about links in [this documentation](https://docs.medusajs.com/learn/fundamentals/module-links/link).
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.updateLinksWorkflow/page.mdx b/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.updateLinksWorkflow/page.mdx
index 734f911487..0788cccf05 100644
--- a/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.updateLinksWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.updateLinksWorkflow/page.mdx
@@ -20,7 +20,7 @@ update links within your custom flows.
Learn more about links in [this documentation](https://docs.medusajs.com/learn/fundamentals/module-links/link).
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAccountWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAccountWorkflow/page.mdx
index d27c1aa562..56945352c2 100644
--- a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAccountWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAccountWorkflow/page.mdx
@@ -21,10 +21,10 @@ This workflow creates a customer and attaches it to an auth identity. It's used
You can create an auth identity first using the [Retrieve Registration JWT Token API Route](https://docs.medusajs.com/api/store#auth\_postactor\_typeauth\_provider\_register).
Learn more about basic authentication flows in [this documentation](https://docs.medusajs.com/resources/commerce-modules/auth/authentication-route).
-You can use this workflow within your customizations or your own custom workflows, allowing you to
+You can use this workflow within your customizations or your own custom workflows, allowing you to
register or create customer accounts within your custom flows.
-
+
## Examples
@@ -153,7 +153,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -167,12 +167,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAddressesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAddressesWorkflow/page.mdx
index 8d4a6817f6..f998cc8afa 100644
--- a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAddressesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAddressesWorkflow/page.mdx
@@ -21,7 +21,7 @@ allows you to create custom data models linked to the addresses.
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around creating customer addresses.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomersWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomersWorkflow/page.mdx
index 9c9a438683..3a4b609b85 100644
--- a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomersWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomersWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow has a hook that allows you to perform custom actions on the create
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around creating customers.
-
+
## Examples
@@ -157,7 +157,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -199,12 +199,8 @@ Handlers consuming this hook accept the following input.
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomerAddressesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomerAddressesWorkflow/page.mdx
index f76bdd57fe..5be68642cb 100644
--- a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomerAddressesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomerAddressesWorkflow/page.mdx
@@ -28,7 +28,7 @@ relevant to that module.
You can use this workflow within your customizations or your own custom workflows, allowing you to
delete customer addresses in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomersWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomersWorkflow/page.mdx
index 5dcd866299..6aba30bd23 100644
--- a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomersWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomersWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow deletes one or more customers. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to
delete customers in your custom flows.
-
+
## Examples
@@ -137,7 +137,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -175,12 +175,8 @@ Handlers consuming this hook accept the following input.
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.removeCustomerAccountWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.removeCustomerAccountWorkflow/page.mdx
index d6a4db697c..02e5f43a6c 100644
--- a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.removeCustomerAccountWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.removeCustomerAccountWorkflow/page.mdx
@@ -29,7 +29,7 @@ custom actions after the customers are deleted.
:::
-
+
## Examples
@@ -138,7 +138,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -152,12 +152,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomerAddressesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomerAddressesWorkflow/page.mdx
index cfffd2903d..8ffce197fc 100644
--- a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomerAddressesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomerAddressesWorkflow/page.mdx
@@ -21,7 +21,7 @@ allows you to update custom data models linked to the addresses.
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around updating customer addresses.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomersWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomersWorkflow/page.mdx
index b929728ee6..55bf0f8016 100644
--- a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomersWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomersWorkflow/page.mdx
@@ -22,7 +22,7 @@ custom data models linked to the customers.
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around updating customers.
-
+
## Examples
@@ -151,7 +151,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -193,12 +193,8 @@ Handlers consuming this hook accept the following input.
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.createCustomerGroupsStep/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.createCustomerGroupsStep/page.mdx
index aea42ac01a..e6d092f5e0 100644
--- a/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.createCustomerGroupsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.createCustomerGroupsStep/page.mdx
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
"my-workflow",
() => {
const data = createCustomerGroupsStep({
- "name": "Loren"
+ "name": "Lurline"
})
}
)
diff --git a/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.createCustomerGroupsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.createCustomerGroupsWorkflow/page.mdx
index 253e641624..b75bb001d1 100644
--- a/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.createCustomerGroupsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.createCustomerGroupsWorkflow/page.mdx
@@ -20,7 +20,7 @@ You can use this workflow within your customizations or your own custom workflow
create customer groups within your custom flows. For example, you can create customer groups to segregate
customers by age group or purchase habits.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.deleteCustomerGroupsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.deleteCustomerGroupsWorkflow/page.mdx
index 8c201ca12e..ed96589b46 100644
--- a/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.deleteCustomerGroupsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.deleteCustomerGroupsWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow deletes one or more customer groups. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to
delete customer groups within your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.linkCustomerGroupsToCustomerWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.linkCustomerGroupsToCustomerWorkflow/page.mdx
index a1b2aeb794..47ec9615d4 100644
--- a/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.linkCustomerGroupsToCustomerWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.linkCustomerGroupsToCustomerWorkflow/page.mdx
@@ -13,13 +13,13 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
This documentation provides a reference to the `linkCustomerGroupsToCustomerWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
-This workflow manages the customer groups a customer is in. It's used by the
+This workflow manages the customer groups a customer is in. It's used by the
[Manage Groups of Customer Admin API Route](https://docs.medusajs.com/api/admin#customers\_postcustomersidcustomergroups).
You can use this workflow within your customizations or your own custom workflows, allowing you to
manage the customer groups of a customer in your custom flow.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.linkCustomersToCustomerGroupWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.linkCustomersToCustomerGroupWorkflow/page.mdx
index 20e7025099..03543a4d02 100644
--- a/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.linkCustomersToCustomerGroupWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.linkCustomersToCustomerGroupWorkflow/page.mdx
@@ -13,13 +13,13 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
This documentation provides a reference to the `linkCustomersToCustomerGroupWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
-This workflow manages the customers of a customer group. It's used by the
+This workflow manages the customers of a customer group. It's used by the
[Manage Customers of Group Admin API Route](https://docs.medusajs.com/api/admin#customer-groups\_postcustomergroupsidcustomers).
You can use this workflow within your customizations or your own custom workflows, allowing you to
manage the customers of a customer group within your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.updateCustomerGroupsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.updateCustomerGroupsWorkflow/page.mdx
index d70aee56c0..18366dcdd3 100644
--- a/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.updateCustomerGroupsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.updateCustomerGroupsWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow updates one or more customer groups. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to
update customer groups within your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Defaults/Workflows_Defaults/functions/core_flows.Defaults.Workflows_Defaults.createDefaultsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Defaults/Workflows_Defaults/functions/core_flows.Defaults.Workflows_Defaults.createDefaultsWorkflow/page.mdx
index 48818ce703..e686984a6e 100644
--- a/www/apps/resources/references/core_flows/Defaults/Workflows_Defaults/functions/core_flows.Defaults.Workflows_Defaults.createDefaultsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Defaults/Workflows_Defaults/functions/core_flows.Defaults.Workflows_Defaults.createDefaultsWorkflow/page.mdx
@@ -21,7 +21,7 @@ to create the default data, if not existing, when the application is first start
You can use this workflow within your customizations or your own custom workflows, allowing you to
create default data within your custom flows, such as seed scripts.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.addDraftOrderItemsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.addDraftOrderItemsWorkflow/page.mdx
index 667365d47b..8b278c5227 100644
--- a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.addDraftOrderItemsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.addDraftOrderItemsWorkflow/page.mdx
@@ -3,16 +3,11 @@ slug: /references/medusa-workflows/addDraftOrderItemsWorkflow
sidebar_label: addDraftOrderItemsWorkflow
sidebar_description: Add items to a draft order.
tags:
+ - locking
- order
- workflow
- - sales channel
- - store
- - region
- customer
- - query
- - pricing
- inventory
- - remote query
- tax
---
@@ -28,7 +23,7 @@ This workflow adds items to a draft order. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around adding items to
a draft order.
-
+
## Examples
@@ -153,7 +148,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
diff --git a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.addDraftOrderPromotionWorkflow/page.mdx b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.addDraftOrderPromotionWorkflow/page.mdx
index e1972dcdcd..c0a8923bf5 100644
--- a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.addDraftOrderPromotionWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.addDraftOrderPromotionWorkflow/page.mdx
@@ -3,6 +3,7 @@ slug: /references/medusa-workflows/addDraftOrderPromotionWorkflow
sidebar_label: addDraftOrderPromotionWorkflow
sidebar_description: Add promotions to a draft order.
tags:
+ - locking
- order
- workflow
---
@@ -19,7 +20,7 @@ This workflow adds promotions to a draft order. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around adding promotions to
a draft order.
-
+
## Examples
@@ -132,7 +133,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
diff --git a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.addDraftOrderShippingMethodsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.addDraftOrderShippingMethodsWorkflow/page.mdx
index 4ae45142a4..73c2e0e071 100644
--- a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.addDraftOrderShippingMethodsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.addDraftOrderShippingMethodsWorkflow/page.mdx
@@ -3,9 +3,9 @@ slug: /references/medusa-workflows/addDraftOrderShippingMethodsWorkflow
sidebar_label: addDraftOrderShippingMethodsWorkflow
sidebar_description: Add shipping methods to a draft order.
tags:
+ - locking
- order
- workflow
- - remote query
- tax
---
@@ -21,7 +21,7 @@ This workflow adds shipping methods to a draft order. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around adding shipping methods to
a draft order.
-
+
## Examples
@@ -138,7 +138,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
diff --git a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.beginDraftOrderEditWorkflow/page.mdx b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.beginDraftOrderEditWorkflow/page.mdx
index e80c23b18c..73b6c21b76 100644
--- a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.beginDraftOrderEditWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.beginDraftOrderEditWorkflow/page.mdx
@@ -3,6 +3,7 @@ slug: /references/medusa-workflows/beginDraftOrderEditWorkflow
sidebar_label: beginDraftOrderEditWorkflow
sidebar_description: Create a draft order edit request.
tags:
+ - locking
- order
- workflow
---
@@ -18,10 +19,10 @@ This workflow begins a draft order edit. It's used by the
The draft order edit can later be requested using [requestDraftOrderEditWorkflow](../core_flows.Draft_Order.Workflows_Draft_Order.requestDraftOrderEditWorkflow/page.mdx) or confirmed using [confirmDraftOrderEditWorkflow](../core_flows.Draft_Order.Workflows_Draft_Order.confirmDraftOrderEditWorkflow/page.mdx).
-You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
+You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
creating a draft order edit request.
-
+
## Examples
@@ -130,7 +131,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
diff --git a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.cancelDraftOrderEditWorkflow/page.mdx b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.cancelDraftOrderEditWorkflow/page.mdx
index 354c63c5af..03bee4e743 100644
--- a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.cancelDraftOrderEditWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.cancelDraftOrderEditWorkflow/page.mdx
@@ -3,6 +3,7 @@ slug: /references/medusa-workflows/cancelDraftOrderEditWorkflow
sidebar_label: cancelDraftOrderEditWorkflow
sidebar_description: Cancel a draft order edit.
tags:
+ - locking
- order
- workflow
---
@@ -19,7 +20,7 @@ This workflow cancels a draft order edit. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
cancelling a draft order edit.
-
+
## Examples
@@ -128,7 +129,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
diff --git a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.confirmDraftOrderEditWorkflow/page.mdx b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.confirmDraftOrderEditWorkflow/page.mdx
index b2e84c3926..2c1046761d 100644
--- a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.confirmDraftOrderEditWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.confirmDraftOrderEditWorkflow/page.mdx
@@ -3,11 +3,11 @@ slug: /references/medusa-workflows/confirmDraftOrderEditWorkflow
sidebar_label: confirmDraftOrderEditWorkflow
sidebar_description: Confirm a draft order edit.
tags:
+ - locking
- order
- inventory
- - locking
- workflow
- - remote query
+ - query
- payment
---
@@ -23,7 +23,7 @@ This workflow confirms a draft order edit. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
confirming a draft order edit.
-
+
## Examples
@@ -136,7 +136,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
diff --git a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.convertDraftOrderStep/page.mdx b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.convertDraftOrderStep/page.mdx
index c7ea36f3f1..0177050f95 100644
--- a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.convertDraftOrderStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.convertDraftOrderStep/page.mdx
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
"my-workflow",
() => {
const data = convertDraftOrderStep({
- "id": "id_oBvkcot59aLyI8wEuwxU"
+ "id": "id_VOj1WBZhvs6"
})
}
)
diff --git a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.convertDraftOrderWorkflow/page.mdx b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.convertDraftOrderWorkflow/page.mdx
index f65cd230dc..710296ca33 100644
--- a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.convertDraftOrderWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.convertDraftOrderWorkflow/page.mdx
@@ -3,6 +3,7 @@ slug: /references/medusa-workflows/convertDraftOrderWorkflow
sidebar_label: convertDraftOrderWorkflow
sidebar_description: Convert a draft order to a pending order.
tags:
+ - locking
- event bus
- workflow
---
@@ -19,7 +20,7 @@ This workflow converts a draft order to a pending order. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
converting a draft order to a pending order.
-
+
## Examples
@@ -128,7 +129,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -142,12 +143,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.deleteDraftOrdersWorkflow/page.mdx b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.deleteDraftOrdersWorkflow/page.mdx
index e9abf663df..06205298f8 100644
--- a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.deleteDraftOrdersWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.deleteDraftOrdersWorkflow/page.mdx
@@ -18,7 +18,7 @@ This workflow deletes draft orders. It's used by the [Delete Draft Order API rou
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around deleting a draft order.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.removeDraftOrderActionItemWorkflow/page.mdx b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.removeDraftOrderActionItemWorkflow/page.mdx
index 0e499789fe..058775a102 100644
--- a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.removeDraftOrderActionItemWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.removeDraftOrderActionItemWorkflow/page.mdx
@@ -3,6 +3,7 @@ slug: /references/medusa-workflows/removeDraftOrderActionItemWorkflow
sidebar_label: removeDraftOrderActionItemWorkflow
sidebar_description: Remove an item from a draft order edit.
tags:
+ - locking
- order
- workflow
---
@@ -19,7 +20,7 @@ This workflow removes an item that was added or updated in a draft order edit. I
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
removing an item from a draft order edit.
-
+
## Examples
@@ -132,7 +133,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
diff --git a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.removeDraftOrderActionShippingMethodWorkflow/page.mdx b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.removeDraftOrderActionShippingMethodWorkflow/page.mdx
index 33fae23318..39a49bdf0b 100644
--- a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.removeDraftOrderActionShippingMethodWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.removeDraftOrderActionShippingMethodWorkflow/page.mdx
@@ -3,6 +3,7 @@ slug: /references/medusa-workflows/removeDraftOrderActionShippingMethodWorkflow
sidebar_label: removeDraftOrderActionShippingMethodWorkflow
sidebar_description: Remove a shipping method from an edited draft order.
tags:
+ - locking
- order
- workflow
---
@@ -19,7 +20,7 @@ This workflow removes a shipping method that was added to an edited draft order.
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
removing a shipping method from an edited draft order.
-
+
## Examples
@@ -135,7 +136,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
diff --git a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.removeDraftOrderPromotionsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.removeDraftOrderPromotionsWorkflow/page.mdx
index 3c765a9321..5e03f32881 100644
--- a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.removeDraftOrderPromotionsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.removeDraftOrderPromotionsWorkflow/page.mdx
@@ -3,6 +3,7 @@ slug: /references/medusa-workflows/removeDraftOrderPromotionsWorkflow
sidebar_label: removeDraftOrderPromotionsWorkflow
sidebar_description: Remove promotions from a draft order edit.
tags:
+ - locking
- order
- workflow
---
@@ -19,7 +20,7 @@ This workflow removes promotions from a draft order edit. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
removing promotions from a draft order edit.
-
+
## Examples
@@ -132,7 +133,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
diff --git a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.removeDraftOrderShippingMethodWorkflow/page.mdx b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.removeDraftOrderShippingMethodWorkflow/page.mdx
index f05eb89683..2281ebdd16 100644
--- a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.removeDraftOrderShippingMethodWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.removeDraftOrderShippingMethodWorkflow/page.mdx
@@ -3,6 +3,7 @@ slug: /references/medusa-workflows/removeDraftOrderShippingMethodWorkflow
sidebar_label: removeDraftOrderShippingMethodWorkflow
sidebar_description: Remove an existing shipping method from a draft order edit.
tags:
+ - locking
- order
- workflow
---
@@ -19,7 +20,7 @@ This workflow removes an existing shipping method from a draft order edit. It's
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
removing a shipping method from a draft order edit.
-
+
## Examples
@@ -132,7 +133,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
diff --git a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.requestDraftOrderEditWorkflow/page.mdx b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.requestDraftOrderEditWorkflow/page.mdx
index d613b98957..066c9b7629 100644
--- a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.requestDraftOrderEditWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.requestDraftOrderEditWorkflow/page.mdx
@@ -3,9 +3,10 @@ slug: /references/medusa-workflows/requestDraftOrderEditWorkflow
sidebar_label: requestDraftOrderEditWorkflow
sidebar_description: Request a draft order edit.
tags:
+ - locking
- order
- workflow
- - remote query
+ - query
- payment
---
@@ -21,7 +22,7 @@ This workflow requests a draft order edit. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
requesting a draft order edit.
-
+
## Examples
@@ -134,7 +135,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
diff --git a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderActionItemWorkflow/page.mdx b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderActionItemWorkflow/page.mdx
index 1df811e1e3..12a02a6b3e 100644
--- a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderActionItemWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderActionItemWorkflow/page.mdx
@@ -3,6 +3,7 @@ slug: /references/medusa-workflows/updateDraftOrderActionItemWorkflow
sidebar_label: updateDraftOrderActionItemWorkflow
sidebar_description: Update a new item in a draft order edit.
tags:
+ - locking
- order
- workflow
---
@@ -19,7 +20,7 @@ This workflow updates a new item that was added to a draft order edit. It's used
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
updating a new item in a draft order edit.
-
+
## Examples
@@ -144,7 +145,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
diff --git a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderActionShippingMethodWorkflow/page.mdx b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderActionShippingMethodWorkflow/page.mdx
index 88b6a6f50f..4196261964 100644
--- a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderActionShippingMethodWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderActionShippingMethodWorkflow/page.mdx
@@ -3,6 +3,7 @@ slug: /references/medusa-workflows/updateDraftOrderActionShippingMethodWorkflow
sidebar_label: updateDraftOrderActionShippingMethodWorkflow
sidebar_description: Update a new shipping method in a draft order edit.
tags:
+ - locking
- order
- workflow
---
@@ -19,7 +20,7 @@ This workflow updates a new shipping method that was added to a draft order edit
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
updating a new shipping method in a draft order edit.
-
+
## Examples
@@ -147,7 +148,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
diff --git a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderItemWorkflow/page.mdx b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderItemWorkflow/page.mdx
index c6c05b6451..319732cf83 100644
--- a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderItemWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderItemWorkflow/page.mdx
@@ -3,6 +3,7 @@ slug: /references/medusa-workflows/updateDraftOrderItemWorkflow
sidebar_label: updateDraftOrderItemWorkflow
sidebar_description: Update an item in a draft order edit.
tags:
+ - locking
- order
- workflow
---
@@ -19,7 +20,7 @@ This workflow updates an item in a draft order edit. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
updating an item in a draft order edit.
-
+
## Examples
@@ -132,7 +133,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
diff --git a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderShippingMethodWorkflow/page.mdx b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderShippingMethodWorkflow/page.mdx
index 10ec5eddc5..27b8f0271d 100644
--- a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderShippingMethodWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderShippingMethodWorkflow/page.mdx
@@ -3,9 +3,9 @@ slug: /references/medusa-workflows/updateDraftOrderShippingMethodWorkflow
sidebar_label: updateDraftOrderShippingMethodWorkflow
sidebar_description: Update an existing shipping method in a draft order edit.
tags:
+ - locking
- order
- workflow
- - remote query
- tax
---
@@ -21,7 +21,7 @@ This workflow updates an existing shipping method in a draft order edit. It's us
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
updating an existing shipping method in a draft order edit.
-
+
## Examples
@@ -146,7 +146,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
diff --git a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderWorkflow/page.mdx b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderWorkflow/page.mdx
index 529be07d1e..deaa8c92d4 100644
--- a/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Draft_Order/Workflows_Draft_Order/functions/core_flows.Draft_Order.Workflows_Draft_Order.updateDraftOrderWorkflow/page.mdx
@@ -3,6 +3,7 @@ slug: /references/medusa-workflows/updateDraftOrderWorkflow
sidebar_label: updateDraftOrderWorkflow
sidebar_description: Update a draft order's details.
tags:
+ - locking
- order
- event bus
- workflow
@@ -17,7 +18,7 @@ This documentation provides a reference to the `updateDraftOrderWorkflow`. It be
This workflow updates a draft order's details. It's used by the
[Update Draft Order Admin API Route](https://docs.medusajs.com/api/admin#draft-orders\_postdraftordersid).
-This workflow doesn't update the draft order's items, shipping methods, or promotions. Instead, you have to
+This workflow doesn't update the draft order's items, shipping methods, or promotions. Instead, you have to
create a draft order edit using [beginDraftOrderEditWorkflow](../core_flows.Draft_Order.Workflows_Draft_Order.beginDraftOrderEditWorkflow/page.mdx) and make updates in the draft order edit.
Then, you can confirm the draft order edit using [confirmDraftOrderEditWorkflow](../core_flows.Draft_Order.Workflows_Draft_Order.confirmDraftOrderEditWorkflow/page.mdx) or request a draft order edit
using [requestDraftOrderEditWorkflow](../core_flows.Draft_Order.Workflows_Draft_Order.requestDraftOrderEditWorkflow/page.mdx).
@@ -25,7 +26,7 @@ using [requestDraftOrderEditWorkflow](../core_flows.Draft_Order.Workflows_Draft_
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
updating a draft order.
-
+
## Examples
@@ -142,7 +143,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -156,12 +157,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.uploadFilesStep/page.mdx b/www/apps/resources/references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.uploadFilesStep/page.mdx
index 958d83e4ab..d11bb55c1b 100644
--- a/www/apps/resources/references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.uploadFilesStep/page.mdx
+++ b/www/apps/resources/references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.uploadFilesStep/page.mdx
@@ -32,7 +32,7 @@ const data = uploadFilesStep({
## Input
-
+
## Output
diff --git a/www/apps/resources/references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.deleteFilesWorkflow/page.mdx b/www/apps/resources/references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.deleteFilesWorkflow/page.mdx
index bf4c3d3a31..dd01c537d1 100644
--- a/www/apps/resources/references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.deleteFilesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.deleteFilesWorkflow/page.mdx
@@ -22,7 +22,7 @@ in your application will be used to delete the file from storage.
You can use this workflow within your customizations or your own custom workflows, allowing you to
delete files within your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.uploadFilesWorkflow/page.mdx b/www/apps/resources/references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.uploadFilesWorkflow/page.mdx
index 68236322e6..f071ea6c2c 100644
--- a/www/apps/resources/references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.uploadFilesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.uploadFilesWorkflow/page.mdx
@@ -13,14 +13,14 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
This documentation provides a reference to the `uploadFilesWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
-This workflow uploads one or more files using the installed
+This workflow uploads one or more files using the installed
[File Module Provider](https://docs.medusajs.com/resources/infrastructure-modules/file). The workflow is used by the
[Upload Files Admin API Route](https://docs.medusajs.com/api/admin#uploads\_postuploads).
You can use this workflow within your customizations or your own custom workflows, allowing you to
upload files within your custom flows.
-
+
## Examples
@@ -153,7 +153,7 @@ const myWorkflow = createWorkflow(
## Input
-
+
## Output
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createFulfillmentSets/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createFulfillmentSets/page.mdx
index 5a09674eb9..7f7b32b0db 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createFulfillmentSets/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createFulfillmentSets/page.mdx
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
"my-workflow",
() => {
const data = createFulfillmentSets({
- "name": "Randall",
+ "name": "Georgette",
"type": "{value}"
})
}
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createServiceZonesStep/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createServiceZonesStep/page.mdx
index b4056ce9f2..3214e8e2e6 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createServiceZonesStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createServiceZonesStep/page.mdx
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
"my-workflow",
() => {
const data = createServiceZonesStep({
- "name": "Syble",
+ "name": "Frederik",
"fulfillment_set_id": "{value}"
})
}
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingOptionRulesStep/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingOptionRulesStep/page.mdx
index 329e3b2a3c..1ea4902b5e 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingOptionRulesStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingOptionRulesStep/page.mdx
@@ -24,7 +24,7 @@ const myWorkflow = createWorkflow(
const data = createShippingOptionRulesStep({
"data": [{
"attribute": "{value}",
- "operator": "gt",
+ "operator": "lt",
"value": "{value}",
"shipping_option_id": "{value}"
}]
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingOptionsPriceSetsStep/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingOptionsPriceSetsStep/page.mdx
index eabdd60f28..7abdb7f4e2 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingOptionsPriceSetsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingOptionsPriceSetsStep/page.mdx
@@ -29,10 +29,10 @@ const myWorkflow = createWorkflow(
"my-workflow",
() => {
const data = createShippingOptionsPriceSetsStep({
- "id": "id_XU1jAyQA0PU8BHzkcw",
+ "id": "id_igIfRnKlKVxul",
"prices": [{
- "currency_code": "usd",
- "amount": 45
+ "currency_code": "kpw",
+ "amount": 7
}]
})
}
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingProfilesStep/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingProfilesStep/page.mdx
index 4d0ada66af..64a1d04503 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingProfilesStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.createShippingProfilesStep/page.mdx
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
"my-workflow",
() => {
const data = createShippingProfilesStep({
- "name": "Nicklaus",
+ "name": "Hipolito",
"type": "{value}"
})
}
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.deleteShippingOptionRulesStep/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.deleteShippingOptionRulesStep/page.mdx
index b046e4c6e6..af7bdfacc2 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.deleteShippingOptionRulesStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Steps_Fulfillment/functions/core_flows.Fulfillment.Steps_Fulfillment.deleteShippingOptionRulesStep/page.mdx
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
() => {
const data = deleteShippingOptionRulesStep({
"ids": [
- "id_3OcqHJC1ZD72nB4"
+ "id_iGJwjksg6XRrH"
]
})
}
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.batchShippingOptionRulesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.batchShippingOptionRulesWorkflow/page.mdx
index 73bc9af7b5..d5b6d99cd4 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.batchShippingOptionRulesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.batchShippingOptionRulesWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow manages shipping option rules allowing you to create, update, or d
You can use this workflow within your own customizations or custom workflows, allowing you to
manage shipping option rules within your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.calculateShippingOptionsPricesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.calculateShippingOptionsPricesWorkflow/page.mdx
index 9d2d38748d..616ac087cd 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.calculateShippingOptionsPricesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.calculateShippingOptionsPricesWorkflow/page.mdx
@@ -26,7 +26,7 @@ This depends on the implementation of the fulfillment provider associated with t
You can use this workflow within your own customizations or custom workflows, allowing you to
calculate the prices of shipping options within your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.cancelFulfillmentWorkflow/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.cancelFulfillmentWorkflow/page.mdx
index d14165ee88..e7722de782 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.cancelFulfillmentWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.cancelFulfillmentWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow cancels a fulfillment. It's used by the
You can use this workflow within your own customizations or custom workflows, allowing you to
cancel a fulfillment within your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createFulfillmentWorkflow/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createFulfillmentWorkflow/page.mdx
index 5c23ce152a..60b938c756 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createFulfillmentWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createFulfillmentWorkflow/page.mdx
@@ -26,7 +26,7 @@ or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-wor
:::
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createReturnFulfillmentWorkflow/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createReturnFulfillmentWorkflow/page.mdx
index 2780e8e0e4..f90dd4af65 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createReturnFulfillmentWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createReturnFulfillmentWorkflow/page.mdx
@@ -26,7 +26,7 @@ or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-wor
:::
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createServiceZonesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createServiceZonesWorkflow/page.mdx
index 2c62b397fa..7834e4957b 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createServiceZonesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createServiceZonesWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow creates one or more service zones. It's used by the
You can use this workflow within your own customizations or custom workflows, allowing you to
create service zones within your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createShipmentWorkflow/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createShipmentWorkflow/page.mdx
index 8221f5c811..8e5c1fb336 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createShipmentWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createShipmentWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow creates shipments for a fulfillment. It's used by the
You can use this workflow within your own customizations or custom workflows, allowing you to
create shipments within your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createShippingOptionsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createShippingOptionsWorkflow/page.mdx
index 2ff8ed7484..f79e782af8 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createShippingOptionsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createShippingOptionsWorkflow/page.mdx
@@ -15,13 +15,13 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
This documentation provides a reference to the `createShippingOptionsWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
-This workflow creates one or more shipping options. It's used by the
+This workflow creates one or more shipping options. It's used by the
[Create Shipping Option Admin API Route](https://docs.medusajs.com/api/admin#shipping-options\_postshippingoptions).
You can use this workflow within your own customizations or custom workflows, allowing you to
create shipping options within your custom flows.
-
+
## Examples
@@ -29,7 +29,7 @@ To calculate a shipping option with flat rate prices:
:::note
-Learn more about adding rules to the shipping option's prices in the Pricing Module's
+Learn more about adding rules to the shipping option's prices in the Pricing Module's
[Price Rules](https://docs.medusajs.com/resources/commerce-modules/pricing/price-rules) documentation.
:::
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createShippingProfilesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createShippingProfilesWorkflow/page.mdx
index b3e71778f8..9460a6f391 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createShippingProfilesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.createShippingProfilesWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow creates one or more shipping profiles. It's used by the
You can use this workflow within your own customizations or custom workflows, allowing you to
create shipping profiles within your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.deleteFulfillmentSetsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.deleteFulfillmentSetsWorkflow/page.mdx
index daaa69e027..331f942a4f 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.deleteFulfillmentSetsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.deleteFulfillmentSetsWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow deletes one or more fulfillment sets. It's used by the
You can use this workflow within your own customizations or custom workflows, allowing you to
delete fulfillment sets within your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.deleteServiceZonesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.deleteServiceZonesWorkflow/page.mdx
index 4d367e8d1a..6c0c8ddf08 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.deleteServiceZonesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.deleteServiceZonesWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow deletes one or more service zones. It's used by the
You can use this workflow within your own customizations or custom workflows, allowing you to
delete service zones within your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.deleteShippingOptionsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.deleteShippingOptionsWorkflow/page.mdx
index 7d5557df63..b585e9b02f 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.deleteShippingOptionsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.deleteShippingOptionsWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow deletes one or more shipping options. It's used by the
You can use this workflow within your own customizations or custom workflows, allowing you to
delete shipping options within your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.markFulfillmentAsDeliveredWorkflow/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.markFulfillmentAsDeliveredWorkflow/page.mdx
index b6131361a0..a2e1377a0b 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.markFulfillmentAsDeliveredWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.markFulfillmentAsDeliveredWorkflow/page.mdx
@@ -16,10 +16,10 @@ This documentation provides a reference to the `markFulfillmentAsDeliveredWorkfl
This workflow marks a fulfillment as delivered. It's used by the markOrderFulfillmentAsDeliveredWorkflow.
-You can use this workflow within your customizations or your own custom workflows, allowing you
+You can use this workflow within your customizations or your own custom workflows, allowing you
to mark a fulfillment as delivered in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateFulfillmentWorkflow/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateFulfillmentWorkflow/page.mdx
index 8a9603df0a..101b1d804c 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateFulfillmentWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateFulfillmentWorkflow/page.mdx
@@ -13,13 +13,13 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
This documentation provides a reference to the `updateFulfillmentWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
-This workflow updates a fulfillment. It's used by other workflows that update a
+This workflow updates a fulfillment. It's used by other workflows that update a
fulfillment, such as [markFulfillmentAsDeliveredWorkflow](../core_flows.Fulfillment.Workflows_Fulfillment.markFulfillmentAsDeliveredWorkflow/page.mdx).
You can use this workflow within your own customizations or custom workflows, allowing you to
update a fulfillment within your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateServiceZonesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateServiceZonesWorkflow/page.mdx
index fadbf7578b..92c28ac6b5 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateServiceZonesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateServiceZonesWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow updates one or more service zones. It's used by the
You can use this workflow within your own customizations or custom workflows, allowing you to
update service zones within your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateShippingOptionsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateShippingOptionsWorkflow/page.mdx
index 44186e740f..a2ff461275 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateShippingOptionsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateShippingOptionsWorkflow/page.mdx
@@ -24,12 +24,12 @@ update shipping options within your custom flows.
:::note
-Learn more about adding rules to the shipping option's prices in the Pricing Module's
+Learn more about adding rules to the shipping option's prices in the Pricing Module's
[Price Rules](https://docs.medusajs.com/resources/commerce-modules/pricing/price-rules) documentation.
:::
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateShippingProfilesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateShippingProfilesWorkflow/page.mdx
index 5a8e8f6d7b..d35c227cf5 100644
--- a/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateShippingProfilesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Fulfillment/Workflows_Fulfillment/functions/core_flows.Fulfillment.Workflows_Fulfillment.updateShippingProfilesWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow updates one or more shipping profiles. It's used by the
You can use this workflow within your own customizations or custom workflows, allowing you to
update shipping profiles within your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.updateInventoryItemsStep/page.mdx b/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.updateInventoryItemsStep/page.mdx
index e9f48e9905..5e13d20f02 100644
--- a/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.updateInventoryItemsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.updateInventoryItemsStep/page.mdx
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
"my-workflow",
() => {
const data = updateInventoryItemsStep({
- "id": "id_uUf2n2EcBpwWt9F"
+ "id": "id_1ys5rW5wS4ga0WAV"
})
}
)
diff --git a/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryDeleteStep/page.mdx b/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryDeleteStep/page.mdx
index 49af880410..2218cd1b4c 100644
--- a/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryDeleteStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryDeleteStep/page.mdx
@@ -20,8 +20,8 @@ const myWorkflow = createWorkflow(
() => {
const data = validateInventoryDeleteStep({
"inventory_items": [{
- "id": "id_PdZZPjJACSpzAftDEr",
- "reserved_quantity": 43
+ "id": "id_ksFkwxniEeGigL",
+ "reserved_quantity": 13
}]
})
}
diff --git a/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryLocationsStep/page.mdx b/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryLocationsStep/page.mdx
index a0d34015d4..8cd8000a7d 100644
--- a/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryLocationsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Inventory/Steps_Inventory/functions/core_flows.Inventory.Steps_Inventory.validateInventoryLocationsStep/page.mdx
@@ -12,7 +12,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
This documentation provides a reference to the `validateInventoryLocationsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
-This step ensures that the inventory levels exist for each
+This step ensures that the inventory levels exist for each
specified pair of inventory item and location. If not,
the step will throw an error.
diff --git a/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.batchInventoryItemLevelsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.batchInventoryItemLevelsWorkflow/page.mdx
index dd4d02de57..dd84970713 100644
--- a/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.batchInventoryItemLevelsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.batchInventoryItemLevelsWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow creates, updates and deletes inventory levels in bulk.
You can use this workflow within your own customizations or custom workflows, allowing you
to manage inventory levels in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.bulkCreateDeleteLevelsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.bulkCreateDeleteLevelsWorkflow/page.mdx
index 8e2f9a50fb..16f61c4263 100644
--- a/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.bulkCreateDeleteLevelsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.bulkCreateDeleteLevelsWorkflow/page.mdx
@@ -22,7 +22,7 @@ Use `batchInventoryItemLevels` instead.
:::
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.createInventoryItemsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.createInventoryItemsWorkflow/page.mdx
index 222c9ef07d..4fb50b8966 100644
--- a/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.createInventoryItemsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.createInventoryItemsWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow creates one or more inventory items. It's used by the
You can use this workflow within your own customizations or custom workflows, allowing you
to create inventory items in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.createInventoryLevelsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.createInventoryLevelsWorkflow/page.mdx
index 1bebd1e616..38787aa1a7 100644
--- a/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.createInventoryLevelsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.createInventoryLevelsWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow creates one or more inventory levels. It's used by the
You can use this workflow within your own customizations or custom workflows, allowing you
to create inventory levels in your custom flows.
-
+
## Examples
@@ -141,7 +141,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
diff --git a/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.deleteInventoryItemWorkflow/page.mdx b/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.deleteInventoryItemWorkflow/page.mdx
index a8429c263c..7068830be9 100644
--- a/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.deleteInventoryItemWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.deleteInventoryItemWorkflow/page.mdx
@@ -21,7 +21,7 @@ This workflow deletes one or more inventory items. It's used by the
You can use this workflow within your own customizations or custom workflows, allowing you
to delete inventory items in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.deleteInventoryLevelsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.deleteInventoryLevelsWorkflow/page.mdx
index f79b791704..5593b1e4de 100644
--- a/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.deleteInventoryLevelsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.deleteInventoryLevelsWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow deletes one or more inventory levels. It's used by the
You can use this workflow within your own customizations or custom workflows, allowing you
to delete inventory levels in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.updateInventoryItemsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.updateInventoryItemsWorkflow/page.mdx
index f1b6d43004..6d8eaa0f01 100644
--- a/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.updateInventoryItemsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.updateInventoryItemsWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow updates one or more inventory items. It's used by the
You can use this workflow within your own customizations or custom workflows, allowing you
to update inventory items in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.updateInventoryLevelsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.updateInventoryLevelsWorkflow/page.mdx
index 58f1e90541..2b0fb57f48 100644
--- a/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.updateInventoryLevelsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.updateInventoryLevelsWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow updates one or more inventory levels. It's used by the
You can use this workflow within your own customizations or custom workflows, allowing you
to update inventory levels in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.acceptInviteWorkflow/page.mdx b/www/apps/resources/references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.acceptInviteWorkflow/page.mdx
index 1378044d81..93a672f1d9 100644
--- a/www/apps/resources/references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.acceptInviteWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.acceptInviteWorkflow/page.mdx
@@ -25,7 +25,7 @@ using the [Retrieve Registration JWT Token API Route](https://docs.medusajs.com/
You can use this workflow within your customizations or your own custom workflows, allowing you to
accept invites within your custom flows.
-
+
## Examples
@@ -158,7 +158,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -172,12 +172,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.createInvitesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.createInvitesWorkflow/page.mdx
index 0dd8c9913e..7f8b4c53ce 100644
--- a/www/apps/resources/references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.createInvitesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.createInvitesWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow creates one or more user invites. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to
create invites within your custom flows.
-
+
## Examples
@@ -137,7 +137,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -151,12 +151,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.deleteInvitesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.deleteInvitesWorkflow/page.mdx
index 1bb7e5a865..afb7e3901a 100644
--- a/www/apps/resources/references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.deleteInvitesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.deleteInvitesWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow deletes one or more user invites. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to
delete invites within your custom flows.
-
+
## Examples
@@ -129,7 +129,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -139,12 +139,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.refreshInviteTokensWorkflow/page.mdx b/www/apps/resources/references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.refreshInviteTokensWorkflow/page.mdx
index 1b95bdf65a..d71de33a9a 100644
--- a/www/apps/resources/references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.refreshInviteTokensWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Invite/Workflows_Invite/functions/core_flows.Invite.Workflows_Invite.refreshInviteTokensWorkflow/page.mdx
@@ -24,7 +24,7 @@ which you can listen to in a [Subscriber](https://docs.medusajs.com/learn/fundam
You can use this workflow within your customizations or your own custom workflows, allowing you to
refresh invite tokens within your custom flows.
-
+
## Examples
@@ -133,7 +133,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -147,12 +147,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Line_Item/Workflows_Line_Item/functions/core_flows.Line_Item.Workflows_Line_Item.deleteLineItemsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Line_Item/Workflows_Line_Item/functions/core_flows.Line_Item.Workflows_Line_Item.deleteLineItemsWorkflow/page.mdx
index fc8a01e20f..ca9789fb8d 100644
--- a/www/apps/resources/references/core_flows/Line_Item/Workflows_Line_Item/functions/core_flows.Line_Item.Workflows_Line_Item.deleteLineItemsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Line_Item/Workflows_Line_Item/functions/core_flows.Line_Item.Workflows_Line_Item.deleteLineItemsWorkflow/page.mdx
@@ -7,12 +7,11 @@ tags:
- cart
- workflow
- query
- - pricing
- fulfillment
- - remote query
- tax
- promotion
- link
+ - remote query
- payment
- logger
---
@@ -29,7 +28,7 @@ This workflow deletes line items from a cart. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to
delete line items from a cart within your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.acquireLockStep/page.mdx b/www/apps/resources/references/core_flows/Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.acquireLockStep/page.mdx
index cf41745ac1..2b173eb0a7 100644
--- a/www/apps/resources/references/core_flows/Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.acquireLockStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.acquireLockStep/page.mdx
@@ -26,4 +26,4 @@ const data = acquireLockStep({
## Input
-
+
diff --git a/www/apps/resources/references/core_flows/Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.releaseLockStep/page.mdx b/www/apps/resources/references/core_flows/Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.releaseLockStep/page.mdx
index df9d14e105..f5c1bedd9c 100644
--- a/www/apps/resources/references/core_flows/Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.releaseLockStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Locking/Steps_Locking/functions/core_flows.Locking.Steps_Locking.releaseLockStep/page.mdx
@@ -25,4 +25,4 @@ const data = releaseLockStep({
## Input
-
+
diff --git a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.addOrderTransactionStep/page.mdx b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.addOrderTransactionStep/page.mdx
index 63d14a891d..1128345481 100644
--- a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.addOrderTransactionStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.addOrderTransactionStep/page.mdx
@@ -23,8 +23,8 @@ const myWorkflow = createWorkflow(
() => {
const data = addOrderTransactionStep({
"order_id": "order_123",
- "amount": 30,
- "currency_code": "gel"
+ "amount": 48,
+ "currency_code": "mad"
})
}
)
diff --git a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.cancelOrderChangeStep/page.mdx b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.cancelOrderChangeStep/page.mdx
index 4a534adfbd..c1f1298365 100644
--- a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.cancelOrderChangeStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.cancelOrderChangeStep/page.mdx
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
"my-workflow",
() => {
const data = cancelOrderChangeStep({
- "id": "id_CJZtQPaqqeXa2AJHP"
+ "id": "id_vUYWTDdnihJ"
})
}
)
diff --git a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderClaimsStep/page.mdx b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderClaimsStep/page.mdx
index d78a0c1e28..7682a2d52b 100644
--- a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderClaimsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderClaimsStep/page.mdx
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
() => {
const data = createOrderClaimsStep([{
"order_id": "order_123",
- "type": "replace"
+ "type": "refund"
}])
}
)
diff --git a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.declineOrderChangeStep/page.mdx b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.declineOrderChangeStep/page.mdx
index c21d81afa6..1513981bfe 100644
--- a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.declineOrderChangeStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.declineOrderChangeStep/page.mdx
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
"my-workflow",
() => {
const data = declineOrderChangeStep({
- "id": "id_h9MMrNfPcISIdB"
+ "id": "id_Qtz4qmSTUMuY87Dbi1"
})
}
)
diff --git a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteClaimsStep/page.mdx b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteClaimsStep/page.mdx
index 19979cdde5..1f26058952 100644
--- a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteClaimsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteClaimsStep/page.mdx
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
() => {
const data = deleteClaimsStep({
"ids": [
- "id_Tw1SKTATEsdEbit"
+ "id_5jBPUyz67BuS0LuhQml"
]
})
}
diff --git a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteExchangesStep/page.mdx b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteExchangesStep/page.mdx
index 46c980efc8..6fdeac334a 100644
--- a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteExchangesStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteExchangesStep/page.mdx
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
() => {
const data = deleteExchangesStep({
"ids": [
- "id_P8Su5On6uBJVte"
+ "id_BYAArnRYHqFCnBcCyqw"
]
})
}
diff --git a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderChangeActionsStep/page.mdx b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderChangeActionsStep/page.mdx
index 346da040f4..7ad41d605b 100644
--- a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderChangeActionsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderChangeActionsStep/page.mdx
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
() => {
const data = deleteOrderChangeActionsStep({
"ids": [
- "id_vJBCQhkI2uKRu"
+ "id_wi6EtnxSoVagQM5xP19M"
]
})
}
diff --git a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderChangesStep/page.mdx b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderChangesStep/page.mdx
index c87cd885b8..078e1dea88 100644
--- a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderChangesStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderChangesStep/page.mdx
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
() => {
const data = deleteOrderChangesStep({
"ids": [
- "id_vUkJKpdQlQS0p"
+ "id_LrddVGdKrY7YROfkMqw"
]
})
}
diff --git a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderLineItems/page.mdx b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderLineItems/page.mdx
index 203e2dfd1f..19eadf0022 100644
--- a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderLineItems/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderLineItems/page.mdx
@@ -20,7 +20,7 @@ const myWorkflow = createWorkflow(
() => {
const data = deleteOrderLineItems({
"ids": [
- "id_uum8RDj4gRVRZXrrlNc"
+ "id_VH0CfUjyQp1"
]
})
}
diff --git a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderShippingMethods/page.mdx b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderShippingMethods/page.mdx
index e35f87362f..7a1b5f4fcd 100644
--- a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderShippingMethods/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteOrderShippingMethods/page.mdx
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
() => {
const data = deleteOrderShippingMethods({
"ids": [
- "id_GFUTy0dCb4Y"
+ "id_ZXlQapVLnuijTrr0EmMD"
]
})
}
diff --git a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteReturnsStep/page.mdx b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteReturnsStep/page.mdx
index 2989350927..18acb6a8ec 100644
--- a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteReturnsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.deleteReturnsStep/page.mdx
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
() => {
const data = deleteReturnsStep({
"ids": [
- "id_j4fnzaY4NZpA93kPU"
+ "id_p7ZzaKtUuZHFP"
]
})
}
diff --git a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangeActionsStep/page.mdx b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangeActionsStep/page.mdx
index 2b82e4aa2a..8d7d7e4446 100644
--- a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangeActionsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangeActionsStep/page.mdx
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
"my-workflow",
() => {
const data = updateOrderChangeActionsStep({
- "id": "id_eaBsTlbSnzkium"
+ "id": "id_3yVlz2QqC5b3T"
})
}
)
diff --git a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangesStep/page.mdx b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangesStep/page.mdx
index 09744c7dec..dd0655630e 100644
--- a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangesStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderChangesStep/page.mdx
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
"my-workflow",
() => {
const data = updateOrderChangesStep({
- "id": "id_5nJ96eB3pDRoNwfKmK8s"
+ "id": "id_Eq0qbcDjmAJjsv"
})
}
)
diff --git a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderShippingMethodsStep/page.mdx b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderShippingMethodsStep/page.mdx
index e67100b8bb..bb2ca996b6 100644
--- a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderShippingMethodsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateOrderShippingMethodsStep/page.mdx
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
"my-workflow",
() => {
const data = updateOrderShippingMethodsStep({
- "id": "id_loH4IRfOlnH"
+ "id": "id_ejMmAzYW8VQto"
})
}
)
diff --git a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateReturnsStep/page.mdx b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateReturnsStep/page.mdx
index 870e154dfa..0906011810 100644
--- a/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateReturnsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateReturnsStep/page.mdx
@@ -21,7 +21,7 @@ const myWorkflow = createWorkflow(
"my-workflow",
() => {
const data = updateReturnsStep({
- "id": "id_pLV9PdrdprON0Q5"
+ "id": "id_4HWtDQyLsq3"
})
}
)
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.acceptOrderTransferWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.acceptOrderTransferWorkflow/page.mdx
index 6d825883af..d1e1ed5810 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.acceptOrderTransferWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.acceptOrderTransferWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow accepts an order transfer, requested previously by the [requestOrd
You can use this workflow within your customizations or your own custom workflows, allowing you to build a custom flow
around accepting an order transfer.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.addOrderLineItemsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.addOrderLineItemsWorkflow/page.mdx
index e1b6deef79..af5991bca4 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.addOrderLineItemsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.addOrderLineItemsWorkflow/page.mdx
@@ -3,12 +3,7 @@ slug: /references/medusa-workflows/addOrderLineItemsWorkflow
sidebar_label: addOrderLineItemsWorkflow
sidebar_description: Add line items to an order.
tags:
- - sales channel
- - store
- - region
- customer
- - query
- - pricing
- workflow
- inventory
---
@@ -25,7 +20,7 @@ an order. It's used by other workflows, such as [orderEditAddNewItemWorkflow](..
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around adding items to
an order.
-
+
## Examples
@@ -150,7 +145,7 @@ const myWorkflow = createWorkflow(
## Steps
- {\n return new StepResponse({\n location_id: \"sloc_123\", // Special price for in-store purchases\n });\n});\n```\n\nThe variants' prices will now be retrieved using the context you return.\n\n:::note\n\nLearn more about prices calculation context in the [Prices Calculation](https://docs.medusajs.com/resources/commerce-modules/pricing/price-calculation) documentation.\n\n:::","link":"#setPricingContext","depth":2},{"type":"when","condition":"{\n return !!variantIds.length\n }","depth":"3","steps":[{"type":"step","name":"useQueryGraphStep","description":"This step fetches data across modules using the Query.\n\nLearn more in the [Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx","depth":3},{"type":"step","name":"getVariantPriceSetsStep","description":"This step retrieves the calculated price sets of the specified variants.","link":"../../../../Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.getVariantPriceSetsStep/page.mdx","depth":3},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.\nIf not valid, the step throws an error.","link":"../../../../Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateVariantPricesStep/page.mdx","depth":3}]},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"Validate that a variant is in-stock before adding to the cart.","link":"../../../../Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx","depth":4},{"type":"step","name":"validateLineItemPricesStep","description":"This step validates the specified line item objects to ensure they have prices.\nIf an item doesn't have a price, the step throws an error.","link":"../../../../Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateLineItemPricesStep/page.mdx","depth":5}]}} />
+ {\n return new StepResponse({\n location_id: \"sloc_123\", // Special price for in-store purchases\n });\n});\n```\n\nThe variants' prices will now be retrieved using the context you return.\n\n:::note\n\nLearn more about prices calculation context in the [Prices Calculation](https://docs.medusajs.com/resources/commerce-modules/pricing/price-calculation) documentation.\n\n:::","link":"#setPricingContext","depth":2},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"Validate that a variant is in-stock before adding to the cart.","link":"../../../../Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx","depth":3}]}} />
## Input
@@ -220,4 +215,4 @@ addOrderLineItemsWorkflow.hooks.setPricingContext(
Handlers consuming this hook accept the following input.
- | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="setPricingContext"/>
+ | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="setPricingContext"/>
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.archiveOrderWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.archiveOrderWorkflow/page.mdx
index 44e26d2e0e..426dec3516 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.archiveOrderWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.archiveOrderWorkflow/page.mdx
@@ -14,12 +14,12 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
This documentation provides a reference to the `archiveOrderWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
-This workflow archives one or more orders. It's used by the
+This workflow archives one or more orders. It's used by the
[Archive Order Admin API Route](https://docs.medusajs.com/api/admin#orders\_postordersidarchive).
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around archiving orders.
-
+
## Examples
@@ -128,7 +128,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -142,12 +142,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginClaimOrderWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginClaimOrderWorkflow/page.mdx
index 91f2242437..de62235ff7 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginClaimOrderWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginClaimOrderWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow creates an order claim in requested state. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to create a claim
for an order in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginExchangeOrderWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginExchangeOrderWorkflow/page.mdx
index 7f6606127e..9e6cdaf41f 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginExchangeOrderWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginExchangeOrderWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow requests an order exchange. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to request an exchange
for an order in your custom flow.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginOrderEditOrderWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginOrderEditOrderWorkflow/page.mdx
index 2a9e708d3e..7b9dfa4b23 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginOrderEditOrderWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginOrderEditOrderWorkflow/page.mdx
@@ -23,7 +23,7 @@ order edit is confirmed using the [confirmOrderEditRequestWorkflow](../core_flow
You can use this workflow within your customizations or your own custom workflows, allowing you to create an order edit
for an order in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginReceiveReturnWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginReceiveReturnWorkflow/page.mdx
index 3baa3206c5..68c3048839 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginReceiveReturnWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginReceiveReturnWorkflow/page.mdx
@@ -22,7 +22,7 @@ You can confirm the return receival using the [confirmReturnRequestWorkflow](../
You can use this workflow within your customizations or your own custom workflows, allowing you
to receive a return in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginReturnOrderWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginReturnOrderWorkflow/page.mdx
index 9a9f85afc2..fa0bf583a5 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginReturnOrderWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.beginReturnOrderWorkflow/page.mdx
@@ -22,7 +22,7 @@ You can start the return receival using the [beginReceiveReturnWorkflow](../core
You can use this workflow within your customizations or your own custom workflows, allowing you
to create a return for an order in your custom flow.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelBeginOrderClaimWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelBeginOrderClaimWorkflow/page.mdx
index 6f90d1ec4b..66636124e4 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelBeginOrderClaimWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelBeginOrderClaimWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow cancels a requested order claim. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to cancel a claim
for an order in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelBeginOrderEditWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelBeginOrderEditWorkflow/page.mdx
index 13fde32804..82e967af7e 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelBeginOrderEditWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelBeginOrderEditWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow cancels a requested edit for an order. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to cancel an order edit
in your custom flow.
-
+
## Examples
@@ -129,7 +129,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -139,12 +139,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelBeginOrderExchangeWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelBeginOrderExchangeWorkflow/page.mdx
index 1870a8defd..0d2ad985cf 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelBeginOrderExchangeWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelBeginOrderExchangeWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow cancels a requested order exchange. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to cancel an exchange
for an order in your custom flow.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderChangeWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderChangeWorkflow/page.mdx
index 8e251a176d..944d0fab31 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderChangeWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderChangeWorkflow/page.mdx
@@ -15,10 +15,10 @@ This documentation provides a reference to the `cancelOrderChangeWorkflow`. It b
This workflow cancels an order change.
-You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
+You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
canceling an order change.
-
+
## Examples
@@ -39,7 +39,7 @@ export async function POST(
const { result } = await cancelOrderChangeWorkflow(req.scope)
.run({
input: {
- "id": "id_7qRAwUbxg3nak4KERwd"
+ "id": "id_eVUV2ccviQ2eDt"
}
})
@@ -64,7 +64,7 @@ export default async function handleOrderPlaced({
const { result } = await cancelOrderChangeWorkflow(container)
.run({
input: {
- "id": "id_7qRAwUbxg3nak4KERwd"
+ "id": "id_eVUV2ccviQ2eDt"
}
})
@@ -89,7 +89,7 @@ export default async function myCustomJob(
const { result } = await cancelOrderChangeWorkflow(container)
.run({
input: {
- "id": "id_7qRAwUbxg3nak4KERwd"
+ "id": "id_eVUV2ccviQ2eDt"
}
})
@@ -115,7 +115,7 @@ const myWorkflow = createWorkflow(
const result = cancelOrderChangeWorkflow
.runAsStep({
input: {
- "id": "id_7qRAwUbxg3nak4KERwd"
+ "id": "id_eVUV2ccviQ2eDt"
}
})
}
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderClaimWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderClaimWorkflow/page.mdx
index 95bd2d8d43..82211c6b03 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderClaimWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderClaimWorkflow/page.mdx
@@ -21,7 +21,7 @@ This workflow cancels a confirmed order claim. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to cancel a claim
for an order in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderExchangeWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderExchangeWorkflow/page.mdx
index b57589d464..5c61b46810 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderExchangeWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderExchangeWorkflow/page.mdx
@@ -21,7 +21,7 @@ This workflow cancels a confirmed exchange. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to cancel an exchange
for an order in your custom flow.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderFulfillmentWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderFulfillmentWorkflow/page.mdx
index 9daee32ef4..6bc33c36a2 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderFulfillmentWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderFulfillmentWorkflow/page.mdx
@@ -3,7 +3,6 @@ slug: /references/medusa-workflows/cancelOrderFulfillmentWorkflow
sidebar_label: cancelOrderFulfillmentWorkflow
sidebar_description: Cancel an order's fulfillment.
tags:
- - remote query
- inventory
- locking
- order
@@ -25,7 +24,7 @@ allows you to update custom data models linked to the fulfillment.
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around canceling a fulfillment.
-
+
## Examples
@@ -150,7 +149,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -182,18 +181,14 @@ cancelOrderFulfillmentWorkflow.hooks.orderFulfillmentCanceled(
Handlers consuming this hook accept the following input.
- | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="orderFulfillmentCanceled"/>
+ | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="orderFulfillmentCanceled"/>
## Emitted Events
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderTransferRequestWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderTransferRequestWorkflow/page.mdx
index 264d558a9a..be801d48ba 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderTransferRequestWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderTransferRequestWorkflow/page.mdx
@@ -20,7 +20,7 @@ and the [Cancel Transfer Request Admin API Route](https://docs.medusajs.com/api/
You can use this workflow within your customizations or your own custom workflows, allowing you to build a custom flow
around canceling an order transfer.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderWorkflow/page.mdx
index 54c4aec469..36fb2f064a 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderWorkflow/page.mdx
@@ -23,12 +23,12 @@ any uncaptured payments, and refund any captured payments.
This workflow is used by the [Cancel Order Admin API Route](https://docs.medusajs.com/api/admin#orders\_postordersidcancel).
-This workflow has a hook that allows you to perform custom actions on the canceled order. For example, you can
+This workflow has a hook that allows you to perform custom actions on the canceled order. For example, you can
make changes to custom models linked to the order.
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around canceling an order.
-
+
## Examples
@@ -137,7 +137,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -175,12 +175,8 @@ Handlers consuming this hook accept the following input.
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelRequestReturnValidationStep/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelRequestReturnValidationStep/page.mdx
index 0ac6a54620..c9f412c446 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelRequestReturnValidationStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelRequestReturnValidationStep/page.mdx
@@ -13,7 +13,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
This documentation provides a reference to the `cancelRequestReturnValidationStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step validates that a requested return can be canceled.
-If the order or return is canceled, or the order change is not active,
+If the order or return is canceled, or the order change is not active,
the step will throw an error.
:::note
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelReturnReceiveWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelReturnReceiveWorkflow/page.mdx
index e55407878b..7b7b6a0052 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelReturnReceiveWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelReturnReceiveWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow cancels a return receival. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you
to cancel a return receival in your custom flow.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelReturnRequestWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelReturnRequestWorkflow/page.mdx
index 81ef8dab0c..96fbb969dc 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelReturnRequestWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelReturnRequestWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow cancels a requested return. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you
to cancel a return request in your custom flow.
-
+
## Examples
@@ -129,7 +129,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelReturnWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelReturnWorkflow/page.mdx
index a1be1f219c..9d4ea3d63a 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelReturnWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelReturnWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow cancels a return. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you
to cancel a return in your custom flow.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.completeOrderWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.completeOrderWorkflow/page.mdx
index 9816f73e73..5ccd15f60f 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.completeOrderWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.completeOrderWorkflow/page.mdx
@@ -16,12 +16,12 @@ This documentation provides a reference to the `completeOrderWorkflow`. It belon
This workflow marks one or more orders as completed. It's used by the [Complete Cart Admin API Route](https://docs.medusajs.com/api/admin#orders\_postordersidcomplete).
-This workflow has a hook that allows you to perform custom actions on the completed orders. For example, you can pass under `additional_data` custom data that
+This workflow has a hook that allows you to perform custom actions on the completed orders. For example, you can pass under `additional_data` custom data that
allows you to update custom data models linked to the orders.
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around order completion.
-
+
## Examples
@@ -142,7 +142,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -184,12 +184,8 @@ Handlers consuming this hook accept the following input.
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmClaimRequestWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmClaimRequestWorkflow/page.mdx
index f85202a711..3da8d79ba0 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmClaimRequestWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmClaimRequestWorkflow/page.mdx
@@ -10,6 +10,7 @@ tags:
- event bus
- workflow
- fulfillment
+ - query
- payment
---
@@ -25,7 +26,7 @@ This workflow confirms a requested claim. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to confirm a claim
for an order in your custom flows.
-
+
## Examples
@@ -134,7 +135,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -148,12 +149,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmExchangeRequestWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmExchangeRequestWorkflow/page.mdx
index be7746fcd5..86fe270610 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmExchangeRequestWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmExchangeRequestWorkflow/page.mdx
@@ -10,6 +10,7 @@ tags:
- event bus
- workflow
- fulfillment
+ - query
- payment
---
@@ -25,7 +26,7 @@ This workflow confirms an exchange request. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to confirm an exchange
for an order in your custom flow.
-
+
## Examples
@@ -134,7 +135,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -148,12 +149,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmOrderEditRequestWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmOrderEditRequestWorkflow/page.mdx
index d4b6809929..48f825dc51 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmOrderEditRequestWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmOrderEditRequestWorkflow/page.mdx
@@ -8,7 +8,7 @@ tags:
- locking
- event bus
- workflow
- - remote query
+ - query
- payment
---
@@ -24,7 +24,7 @@ This workflow confirms an order edit request. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to confirm an order edit
in your custom flow.
-
+
## Examples
@@ -133,7 +133,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -147,12 +147,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmReturnReceiveWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmReturnReceiveWorkflow/page.mdx
index ecdab15ab8..813a5d72c3 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmReturnReceiveWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmReturnReceiveWorkflow/page.mdx
@@ -9,6 +9,7 @@ tags:
- event bus
- order
- workflow
+ - query
- payment
---
@@ -24,7 +25,7 @@ This workflow confirms a return receival request. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you
to confirm a return receival in your custom flow.
-
+
## Examples
@@ -133,7 +134,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -147,12 +148,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmReturnRequestWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmReturnRequestWorkflow/page.mdx
index 5c0e6cfd6f..7bfc499753 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmReturnRequestWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.confirmReturnRequestWorkflow/page.mdx
@@ -9,6 +9,7 @@ tags:
- event bus
- workflow
- fulfillment
+ - query
- payment
---
@@ -24,7 +25,7 @@ This workflow confirms a return request. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to confirm a return request
in your custom flow.
-
+
## Examples
@@ -133,7 +134,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -147,12 +148,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createAndCompleteReturnOrderWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createAndCompleteReturnOrderWorkflow/page.mdx
index 44220e209c..421bb607e0 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createAndCompleteReturnOrderWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createAndCompleteReturnOrderWorkflow/page.mdx
@@ -23,7 +23,7 @@ process it from the dashboard. This workflow is used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to create a return
for an order in your custom flow.
-
+
## Examples
@@ -223,12 +223,8 @@ Handlers consuming this hook accept the following input.
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createClaimShippingMethodWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createClaimShippingMethodWorkflow/page.mdx
index 2901c72445..a6204dae8a 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createClaimShippingMethodWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createClaimShippingMethodWorkflow/page.mdx
@@ -23,7 +23,7 @@ and the [Add Outbound Shipping Admin API Route](https://docs.medusajs.com/api/ad
You can use this workflow within your customizations or your own custom workflows, allowing you to create a shipping method
for a claim in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createExchangeShippingMethodWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createExchangeShippingMethodWorkflow/page.mdx
index 8bf010bb14..b61864ca77 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createExchangeShippingMethodWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createExchangeShippingMethodWorkflow/page.mdx
@@ -23,7 +23,7 @@ and the [Add Outbound Shipping Admin API Route](https://docs.medusajs.com/api/ad
You can use this workflow within your customizations or your own custom workflows, allowing you to create a shipping method
for an exchange in your custom flow.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrUpdateOrderPaymentCollectionWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrUpdateOrderPaymentCollectionWorkflow/page.mdx
index a73bb9048a..a64fefe4e8 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrUpdateOrderPaymentCollectionWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrUpdateOrderPaymentCollectionWorkflow/page.mdx
@@ -3,7 +3,7 @@ slug: /references/medusa-workflows/createOrUpdateOrderPaymentCollectionWorkflow
sidebar_label: createOrUpdateOrderPaymentCollectionWorkflow
sidebar_description: Create or update payment collection for an order.
tags:
- - remote query
+ - query
- payment
- workflow
---
@@ -20,7 +20,7 @@ such as [createOrderPaymentCollectionWorkflow](../core_flows.Order.Workflows_Ord
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
creating or updating payment collections for an order.
-
+
## Examples
@@ -136,7 +136,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderChangeActionsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderChangeActionsWorkflow/page.mdx
index 886a9792a1..083673a807 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderChangeActionsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderChangeActionsWorkflow/page.mdx
@@ -18,7 +18,7 @@ such as [requestItemReturnWorkflow](../core_flows.Order.Workflows_Order.requestI
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
creating an order change action.
-
+
## Examples
@@ -39,7 +39,7 @@ export async function POST(
const { result } = await createOrderChangeActionsWorkflow(req.scope)
.run({
input: [{
- "action": "RETURN_ITEM"
+ "action": "PROMOTION_ADD"
}]
})
@@ -64,7 +64,7 @@ export default async function handleOrderPlaced({
const { result } = await createOrderChangeActionsWorkflow(container)
.run({
input: [{
- "action": "RETURN_ITEM"
+ "action": "PROMOTION_ADD"
}]
})
@@ -89,7 +89,7 @@ export default async function myCustomJob(
const { result } = await createOrderChangeActionsWorkflow(container)
.run({
input: [{
- "action": "RETURN_ITEM"
+ "action": "PROMOTION_ADD"
}]
})
@@ -115,7 +115,7 @@ const myWorkflow = createWorkflow(
const result = createOrderChangeActionsWorkflow
.runAsStep({
input: [{
- "action": "RETURN_ITEM"
+ "action": "PROMOTION_ADD"
}]
})
}
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderChangeWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderChangeWorkflow/page.mdx
index ed8ef59188..ed955f7832 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderChangeWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderChangeWorkflow/page.mdx
@@ -15,10 +15,10 @@ This documentation provides a reference to the `createOrderChangeWorkflow`. It b
This workflow creates an order change.
-You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
+You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
creating an order change.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderCreditLinesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderCreditLinesWorkflow/page.mdx
index 6167bf0260..64d116fe21 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderCreditLinesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderCreditLinesWorkflow/page.mdx
@@ -13,7 +13,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
This documentation provides a reference to the `createOrderCreditLinesWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
-
+
## Examples
@@ -34,7 +34,7 @@ export async function POST(
const { result } = await createOrderCreditLinesWorkflow(req.scope)
.run({
input: {
- "id": "id_1NDTLjVl44x",
+ "id": "id_vZzZnIQQ5MwW0L",
"credit_lines": [
"{value}"
]
@@ -62,7 +62,7 @@ export default async function handleOrderPlaced({
const { result } = await createOrderCreditLinesWorkflow(container)
.run({
input: {
- "id": "id_1NDTLjVl44x",
+ "id": "id_vZzZnIQQ5MwW0L",
"credit_lines": [
"{value}"
]
@@ -90,7 +90,7 @@ export default async function myCustomJob(
const { result } = await createOrderCreditLinesWorkflow(container)
.run({
input: {
- "id": "id_1NDTLjVl44x",
+ "id": "id_vZzZnIQQ5MwW0L",
"credit_lines": [
"{value}"
]
@@ -119,7 +119,7 @@ const myWorkflow = createWorkflow(
const result = createOrderCreditLinesWorkflow
.runAsStep({
input: {
- "id": "id_1NDTLjVl44x",
+ "id": "id_vZzZnIQQ5MwW0L",
"credit_lines": [
"{value}"
]
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderEditShippingMethodWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderEditShippingMethodWorkflow/page.mdx
index cb2d54bb70..5af921b3ee 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderEditShippingMethodWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderEditShippingMethodWorkflow/page.mdx
@@ -4,7 +4,6 @@ sidebar_label: createOrderEditShippingMethodWorkflow
sidebar_description: Create a shipping method for an order edit.
tags:
- workflow
- - remote query
- tax
- order
---
@@ -21,7 +20,7 @@ This workflow creates a shipping method for an order edit. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to create a shipping method
for an order edit in your in your own custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderFulfillmentWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderFulfillmentWorkflow/page.mdx
index 7930852407..6dd672e19b 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderFulfillmentWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderFulfillmentWorkflow/page.mdx
@@ -3,7 +3,6 @@ slug: /references/medusa-workflows/createOrderFulfillmentWorkflow
sidebar_label: createOrderFulfillmentWorkflow
sidebar_description: Creates a fulfillment for an order.
tags:
- - remote query
- inventory
- locking
- order
@@ -26,7 +25,7 @@ allows you to create custom data models linked to the fulfillment.
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around creating a fulfillment.
-
+
## Examples
@@ -163,7 +162,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -205,12 +204,8 @@ Handlers consuming this hook accept the following input.
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderPaymentCollectionWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderPaymentCollectionWorkflow/page.mdx
index 3a6fd05c40..f270d26812 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderPaymentCollectionWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderPaymentCollectionWorkflow/page.mdx
@@ -3,7 +3,6 @@ slug: /references/medusa-workflows/createOrderPaymentCollectionWorkflow
sidebar_label: createOrderPaymentCollectionWorkflow
sidebar_description: Create a payment collection for an order.
tags:
- - remote query
- payment
- workflow
---
@@ -20,7 +19,7 @@ This workflow creates a payment collection for an order. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
creating a payment collection for an order.
-
+
## Examples
@@ -133,7 +132,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderShipmentWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderShipmentWorkflow/page.mdx
index 380331c36f..69766977dd 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderShipmentWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderShipmentWorkflow/page.mdx
@@ -3,7 +3,6 @@ slug: /references/medusa-workflows/createOrderShipmentWorkflow
sidebar_label: createOrderShipmentWorkflow
sidebar_description: Creates a shipment for an order.
tags:
- - remote query
- order
- event bus
- workflow
@@ -23,7 +22,7 @@ allows you to create custom data models linked to the shipment.
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around creating a shipment.
-
+
## Examples
@@ -164,7 +163,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -202,12 +201,8 @@ Handlers consuming this hook accept the following input.
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderWorkflow/page.mdx
index 73208b1475..809c193def 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderWorkflow/page.mdx
@@ -3,16 +3,10 @@ slug: /references/medusa-workflows/createOrderWorkflow
sidebar_label: createOrderWorkflow
sidebar_description: Create an order.
tags:
- - sales channel
- - store
- - region
- customer
- - pricing
- - query
- order
- workflow
- inventory
- - remote query
- tax
---
@@ -31,7 +25,7 @@ allows you to create custom data models linked to the order.
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around creating an order. For example,
you can create a workflow that imports orders from an external system, then uses this workflow to create the orders in Medusa.
-
+
## Examples
@@ -216,7 +210,7 @@ const myWorkflow = createWorkflow(
## Steps
- {\n return new StepResponse({\n location_id: \"sloc_123\", // Special price for in-store purchases\n });\n});\n```\n\nThe variants' prices will now be retrieved using the context you return.\n\n:::note\n\nLearn more about prices calculation context in the [Prices Calculation](https://docs.medusajs.com/resources/commerce-modules/pricing/price-calculation) documentation.\n\n:::","link":"#setPricingContext","depth":2},{"type":"when","condition":"{\n return !!variantIdsForPriceCalculation.length\n }","depth":"3","steps":[{"type":"step","name":"getVariantPriceSetsStep","description":"This step retrieves the calculated price sets of the specified variants.","link":"../../../../Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.getVariantPriceSetsStep/page.mdx","depth":3}]},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"Validate that a variant is in-stock before adding to the cart.","link":"../../../../Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx","depth":4},{"type":"step","name":"validateLineItemPricesStep","description":"This step validates the specified line item objects to ensure they have prices.\nIf an item doesn't have a price, the step throws an error.","link":"../../../../Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateLineItemPricesStep/page.mdx","depth":5},{"type":"step","name":"createOrdersStep","description":"This step creates one or more orders.","link":"../../../Steps_Order/functions/core_flows.Order.Steps_Order.createOrdersStep/page.mdx","depth":6},{"type":"workflow","name":"updateOrderTaxLinesWorkflow","description":"Update the tax lines of items and shipping methods in an order.","link":"../core_flows.Order.Workflows_Order.updateOrderTaxLinesWorkflow/page.mdx","depth":7},{"type":"hook","name":"orderCreated","description":"","link":"#orderCreated","depth":8}]}} />
+ {\n return new StepResponse({\n location_id: \"sloc_123\", // Special price for in-store purchases\n });\n});\n```\n\nThe variants' prices will now be retrieved using the context you return.\n\n:::note\n\nLearn more about prices calculation context in the [Prices Calculation](https://docs.medusajs.com/resources/commerce-modules/pricing/price-calculation) documentation.\n\n:::","link":"#setPricingContext","depth":2},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"Validate that a variant is in-stock before adding to the cart.","link":"../../../../Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.confirmVariantInventoryWorkflow/page.mdx","depth":4},{"type":"step","name":"validateLineItemPricesStep","description":"This step validates the specified line item objects to ensure they have prices.\nIf an item doesn't have a price, the step throws an error.","link":"../../../../Cart/Steps_Cart/functions/core_flows.Cart.Steps_Cart.validateLineItemPricesStep/page.mdx","depth":5},{"type":"step","name":"createOrdersStep","description":"This step creates one or more orders.","link":"../../../Steps_Order/functions/core_flows.Order.Steps_Order.createOrdersStep/page.mdx","depth":6},{"type":"workflow","name":"updateOrderTaxLinesWorkflow","description":"Update the tax lines of items and shipping methods in an order.","link":"../core_flows.Order.Workflows_Order.updateOrderTaxLinesWorkflow/page.mdx","depth":7},{"type":"hook","name":"orderCreated","description":"","link":"#orderCreated","depth":8}]}} />
## Input
@@ -286,7 +280,7 @@ createOrderWorkflow.hooks.setPricingContext(
Handlers consuming this hook accept the following input.
- | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="setPricingContext"/>
+ | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="setPricingContext"/>
### orderCreated
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrdersWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrdersWorkflow/page.mdx
index 57cba4a590..002c94d6b5 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrdersWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrdersWorkflow/page.mdx
@@ -10,7 +10,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
This documentation provides a reference to the `createOrdersWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createReturnShippingMethodWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createReturnShippingMethodWorkflow/page.mdx
index 832c100584..54b6527ac3 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createReturnShippingMethodWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createReturnShippingMethodWorkflow/page.mdx
@@ -22,7 +22,7 @@ This workflow creates a shipping method for a return. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you
to create a shipping method for a return in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.declineOrderChangeWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.declineOrderChangeWorkflow/page.mdx
index 0a3083b7ff..2ef3daca8a 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.declineOrderChangeWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.declineOrderChangeWorkflow/page.mdx
@@ -18,7 +18,7 @@ This workflow declines an order change.
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
declining an order change.
-
+
## Examples
@@ -39,7 +39,7 @@ export async function POST(
const { result } = await declineOrderChangeWorkflow(req.scope)
.run({
input: {
- "id": "id_k2g821FXfNZCdOu1T1"
+ "id": "id_XPCJXI6F3bUZRSu"
}
})
@@ -64,7 +64,7 @@ export default async function handleOrderPlaced({
const { result } = await declineOrderChangeWorkflow(container)
.run({
input: {
- "id": "id_k2g821FXfNZCdOu1T1"
+ "id": "id_XPCJXI6F3bUZRSu"
}
})
@@ -89,7 +89,7 @@ export default async function myCustomJob(
const { result } = await declineOrderChangeWorkflow(container)
.run({
input: {
- "id": "id_k2g821FXfNZCdOu1T1"
+ "id": "id_XPCJXI6F3bUZRSu"
}
})
@@ -115,7 +115,7 @@ const myWorkflow = createWorkflow(
const result = declineOrderChangeWorkflow
.runAsStep({
input: {
- "id": "id_k2g821FXfNZCdOu1T1"
+ "id": "id_XPCJXI6F3bUZRSu"
}
})
}
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.declineOrderTransferRequestWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.declineOrderTransferRequestWorkflow/page.mdx
index 79602e6e64..f2cd309e68 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.declineOrderTransferRequestWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.declineOrderTransferRequestWorkflow/page.mdx
@@ -18,7 +18,7 @@ This workflow declines a requested order transfer by its token. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around declining an order transfer request.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderChangeActionsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderChangeActionsWorkflow/page.mdx
index ddba585904..8bd6f56a64 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderChangeActionsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderChangeActionsWorkflow/page.mdx
@@ -18,7 +18,7 @@ This workflow deletes one or more order change actions.
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
deleting an order change action.
-
+
## Examples
@@ -40,7 +40,7 @@ export async function POST(
.run({
input: {
"ids": [
- "id_gopWYzOVgqiPeTNGXy"
+ "id_Xuddj86Z7H"
]
}
})
@@ -67,7 +67,7 @@ export default async function handleOrderPlaced({
.run({
input: {
"ids": [
- "id_gopWYzOVgqiPeTNGXy"
+ "id_Xuddj86Z7H"
]
}
})
@@ -94,7 +94,7 @@ export default async function myCustomJob(
.run({
input: {
"ids": [
- "id_gopWYzOVgqiPeTNGXy"
+ "id_Xuddj86Z7H"
]
}
})
@@ -122,7 +122,7 @@ const myWorkflow = createWorkflow(
.runAsStep({
input: {
"ids": [
- "id_gopWYzOVgqiPeTNGXy"
+ "id_Xuddj86Z7H"
]
}
})
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderChangeWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderChangeWorkflow/page.mdx
index 0eeaad3db8..75dec9def8 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderChangeWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderChangeWorkflow/page.mdx
@@ -18,7 +18,7 @@ This workflow deletes one or more order changes.
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
deleting an order change.
-
+
## Examples
@@ -40,7 +40,7 @@ export async function POST(
.run({
input: {
"ids": [
- "id_JDCk0pOmBgL5V"
+ "id_Ig7TtPlNHADYHd7"
]
}
})
@@ -67,7 +67,7 @@ export default async function handleOrderPlaced({
.run({
input: {
"ids": [
- "id_JDCk0pOmBgL5V"
+ "id_Ig7TtPlNHADYHd7"
]
}
})
@@ -94,7 +94,7 @@ export default async function myCustomJob(
.run({
input: {
"ids": [
- "id_JDCk0pOmBgL5V"
+ "id_Ig7TtPlNHADYHd7"
]
}
})
@@ -122,7 +122,7 @@ const myWorkflow = createWorkflow(
.runAsStep({
input: {
"ids": [
- "id_JDCk0pOmBgL5V"
+ "id_Ig7TtPlNHADYHd7"
]
}
})
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderPaymentCollections/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderPaymentCollections/page.mdx
index 1e1cc36723..9ca3582202 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderPaymentCollections/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.deleteOrderPaymentCollections/page.mdx
@@ -13,13 +13,13 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
This documentation provides a reference to the `deleteOrderPaymentCollections`. It belongs to the `@medusajs/medusa/core-flows` package.
-This workflow deletes one or more payment collections of an order. It's used by the
+This workflow deletes one or more payment collections of an order. It's used by the
[Delete Payment Collection API Route](https://docs.medusajs.com/api/admin#payment-collections\_deletepaymentcollectionsid).
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
deleting a payment collection of an order.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.dismissItemReturnRequestWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.dismissItemReturnRequestWorkflow/page.mdx
index 87e5ea47b7..9dc9c0b2ed 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.dismissItemReturnRequestWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.dismissItemReturnRequestWorkflow/page.mdx
@@ -22,7 +22,7 @@ A damaged item's quantity is dismissed, meaning it's not returned to the invento
You can use this workflow within your customizations or your own custom workflows, allowing you
to dismiss items from a return request in your custom flow.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.fetchShippingOptionForOrderWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.fetchShippingOptionForOrderWorkflow/page.mdx
index c4b9832b6a..40e2cd5338 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.fetchShippingOptionForOrderWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.fetchShippingOptionForOrderWorkflow/page.mdx
@@ -19,7 +19,7 @@ by other workflows, such as [createClaimShippingMethodWorkflow](../core_flows.Or
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around fetching
shipping options for an order.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.getOrderDetailWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.getOrderDetailWorkflow/page.mdx
index 5d60e13857..055250750c 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.getOrderDetailWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.getOrderDetailWorkflow/page.mdx
@@ -3,7 +3,6 @@ slug: /references/medusa-workflows/getOrderDetailWorkflow
sidebar_label: getOrderDetailWorkflow
sidebar_description: Retrieve an order's details.
tags:
- - remote query
- workflow
---
@@ -17,10 +16,10 @@ This workflow retrieves an order's details. It's used by many API routes, includ
[Get an Order Admin API Route](https://docs.medusajs.com/api/admin#orders\_getordersid), and
[Get an Order Store API Route](https://docs.medusajs.com/api/store#orders\_getordersid).
-You can use this workflow within your customizations or your own custom workflows, allowing you to retrieve an
+You can use this workflow within your customizations or your own custom workflows, allowing you to retrieve an
order's details in your custom flows.
-
+
## Examples
@@ -131,10 +130,6 @@ const myWorkflow = createWorkflow(
-## Steps
-
-
-
## Input
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.getOrdersListWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.getOrdersListWorkflow/page.mdx
index 282ebc0286..f0123afe0c 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.getOrdersListWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.getOrdersListWorkflow/page.mdx
@@ -13,7 +13,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
This documentation provides a reference to the `getOrdersListWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
-This workflow retrieves a list of orders. It's used by the
+This workflow retrieves a list of orders. It's used by the
[List Orders Admin API Route](https://docs.medusajs.com/api/admin#orders\_getorders), and the
[List Orders Store API Route](https://docs.medusajs.com/api/store#orders\_getorders).
@@ -21,7 +21,7 @@ You can use this workflow within your customizations or your own custom workflow
orders in your custom flows. For example, you can retrieve the list of orders to export them
to a third-party system.
-
+
## Examples
@@ -261,4 +261,4 @@ const myWorkflow = createWorkflow(
## Output
-`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the order was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`object`","description":"Pagination details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"count","type":"`number`","description":"The total number of orders.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"The number of items skipped before retrieving the returned orders.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"The number of items to retrieve.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="getOrdersListWorkflow"/>
+`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the order was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`object`","description":"Pagination details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"count","type":"`number`","description":"The total number of orders.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"The number of items skipped before retrieving the returned orders.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"The number of items to retrieve.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="getOrdersListWorkflow"/>
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.listShippingOptionsForOrderWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.listShippingOptionsForOrderWorkflow/page.mdx
index a38166464f..8b1a221d6a 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.listShippingOptionsForOrderWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.listShippingOptionsForOrderWorkflow/page.mdx
@@ -24,7 +24,7 @@ This is available starting from [Medusa v2.10.0](https://github.com/medusajs/med
:::
-
+
## Examples
@@ -138,3 +138,7 @@ const myWorkflow = createWorkflow(
## Input
+
+## Output
+
+
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.markOrderFulfillmentAsDeliveredWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.markOrderFulfillmentAsDeliveredWorkflow/page.mdx
index 7c7ca966c2..82d6b71e00 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.markOrderFulfillmentAsDeliveredWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.markOrderFulfillmentAsDeliveredWorkflow/page.mdx
@@ -3,10 +3,10 @@ slug: /references/medusa-workflows/markOrderFulfillmentAsDeliveredWorkflow
sidebar_label: markOrderFulfillmentAsDeliveredWorkflow
sidebar_description: Mark a fulfillment in an order as delivered.
tags:
- - remote query
- order
- event bus
- workflow
+ - remote query
- fulfillment
---
@@ -22,7 +22,7 @@ This workflow marks a fulfillment in an order as delivered. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
marking a fulfillment as delivered.
-
+
## Examples
@@ -135,7 +135,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -145,12 +145,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.markPaymentCollectionAsPaid/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.markPaymentCollectionAsPaid/page.mdx
index b448bb1747..d42e127231 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.markPaymentCollectionAsPaid/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.markPaymentCollectionAsPaid/page.mdx
@@ -3,11 +3,11 @@ slug: /references/medusa-workflows/markPaymentCollectionAsPaid
sidebar_label: markPaymentCollectionAsPaid
sidebar_description: Mark a payment collection for an order as paid.
tags:
- - remote query
- logger
- payment
- workflow
- link
+ - remote query
- order
- event bus
---
@@ -24,7 +24,7 @@ This workflow marks a payment collection for an order as paid. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
marking a payment collection for an order as paid.
-
+
## Examples
@@ -137,7 +137,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -151,12 +151,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.maybeRefreshShippingMethodsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.maybeRefreshShippingMethodsWorkflow/page.mdx
index 268dd513f0..d1b7be83c2 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.maybeRefreshShippingMethodsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.maybeRefreshShippingMethodsWorkflow/page.mdx
@@ -20,7 +20,7 @@ by other workflows, such as refreshExchangeShippingWorkflow.
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
refreshing shipping methods in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderClaimAddNewItemWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderClaimAddNewItemWorkflow/page.mdx
index d9ca3e3866..de419abaa5 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderClaimAddNewItemWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderClaimAddNewItemWorkflow/page.mdx
@@ -5,14 +5,8 @@ sidebar_description: Add outbound or new items to a claim.
tags:
- order
- workflow
- - sales channel
- - store
- - region
- customer
- - query
- - pricing
- inventory
- - remote query
- tax
---
@@ -28,7 +22,7 @@ This workflow adds outbound (or new) items to a claim. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to add outbound items to a claim
in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderClaimItemWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderClaimItemWorkflow/page.mdx
index 3a14321d7e..b02444851c 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderClaimItemWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderClaimItemWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow adds order items to a claim as claim items. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to add items to a claim
for an order in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderClaimRequestItemReturnWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderClaimRequestItemReturnWorkflow/page.mdx
index 7604625bcc..683d6591f3 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderClaimRequestItemReturnWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderClaimRequestItemReturnWorkflow/page.mdx
@@ -20,7 +20,7 @@ items are added to the claim as inbound items. The workflow is used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to request items to be returned
as part of a claim in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderEditAddNewItemWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderEditAddNewItemWorkflow/page.mdx
index 91d23a052a..fb4600a38a 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderEditAddNewItemWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderEditAddNewItemWorkflow/page.mdx
@@ -5,14 +5,8 @@ sidebar_description: Add new items to an order edit.
tags:
- order
- workflow
- - sales channel
- - store
- - region
- customer
- - query
- - pricing
- inventory
- - remote query
- tax
---
@@ -28,7 +22,7 @@ This workflow adds new items to an order edit. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to add new items to an order edit
in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderEditUpdateItemQuantityWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderEditUpdateItemQuantityWorkflow/page.mdx
index 88a4810e0b..7dc33a7f21 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderEditUpdateItemQuantityWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderEditUpdateItemQuantityWorkflow/page.mdx
@@ -21,7 +21,7 @@ You can also use this workflow to remove an item from an order by setting its qu
You can use this workflow within your customizations or your own custom workflows, allowing you to update the quantity of an existing
item in an order's edit in your custom flow.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderExchangeAddNewItemWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderExchangeAddNewItemWorkflow/page.mdx
index 3622652861..22a8e2af5f 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderExchangeAddNewItemWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderExchangeAddNewItemWorkflow/page.mdx
@@ -5,14 +5,8 @@ sidebar_description: Add new or outbound items to an exchange.
tags:
- order
- workflow
- - sales channel
- - store
- - region
- customer
- - query
- - pricing
- inventory
- - remote query
- tax
---
@@ -28,7 +22,7 @@ This workflow adds new or outbound items to an exchange. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to add new or outbound items
to an exchange in your custom flow.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderExchangeRequestItemReturnWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderExchangeRequestItemReturnWorkflow/page.mdx
index a880ebfd6e..0db8100b17 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderExchangeRequestItemReturnWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.orderExchangeRequestItemReturnWorkflow/page.mdx
@@ -19,7 +19,7 @@ by the [Add Inbound Items Admin API Route](https://docs.medusajs.com/api/admin#e
You can use this workflow within your customizations or your own custom workflows, allowing you to add inbound items
to be returned as part of an exchange in your custom flow.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.receiveAndCompleteReturnOrderWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.receiveAndCompleteReturnOrderWorkflow/page.mdx
index 732af17841..1a6e510a0c 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.receiveAndCompleteReturnOrderWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.receiveAndCompleteReturnOrderWorkflow/page.mdx
@@ -18,7 +18,7 @@ This workflow marks a return as received and completes it.
You can use this workflow within your customizations or your own custom workflows, allowing you
to receive and complete a return.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.receiveItemReturnRequestWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.receiveItemReturnRequestWorkflow/page.mdx
index e4e8fc18cd..8ec3532350 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.receiveItemReturnRequestWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.receiveItemReturnRequestWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow marks return items as received. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to mark return items as received
in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeAddItemClaimActionWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeAddItemClaimActionWorkflow/page.mdx
index d9f8c98acc..d5497ec994 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeAddItemClaimActionWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeAddItemClaimActionWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow removes outbound (new) items from a claim. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to remove outbound items from a claim
in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeClaimShippingMethodWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeClaimShippingMethodWorkflow/page.mdx
index d43e84c8e2..35e187ede9 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeClaimShippingMethodWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeClaimShippingMethodWorkflow/page.mdx
@@ -21,7 +21,7 @@ or [Remove Outbound Shipping Method](https://docs.medusajs.com/api/admin#claims\
You can use this workflow within your customizations or your own custom workflows, allowing you to remove shipping methods from a claim
in your own custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeExchangeShippingMethodWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeExchangeShippingMethodWorkflow/page.mdx
index 509d35b2fb..192f06bc59 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeExchangeShippingMethodWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeExchangeShippingMethodWorkflow/page.mdx
@@ -21,7 +21,7 @@ the [Remove Outbound Shipping Admin API Route](https://docs.medusajs.com/api/adm
You can use this workflow within your customizations or your own custom workflows, allowing you to remove an inbound or outbound shipping method
from an exchange in your custom flow.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeItemClaimActionWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeItemClaimActionWorkflow/page.mdx
index f276dbb57a..4c7701e8e9 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeItemClaimActionWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeItemClaimActionWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow removes order items from a claim. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to remove order items from a claim
in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeItemExchangeActionWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeItemExchangeActionWorkflow/page.mdx
index 5f47f2e07c..aaa4e09924 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeItemExchangeActionWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeItemExchangeActionWorkflow/page.mdx
@@ -20,7 +20,7 @@ the [Remove Outbound Item API Route](https://docs.medusajs.com/api/admin#exchang
You can use this workflow within your customizations or your own custom workflows, allowing you to remove an outbound or new item
from an exchange in your custom flow.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeItemOrderEditActionWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeItemOrderEditActionWorkflow/page.mdx
index aad402b405..056f644c21 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeItemOrderEditActionWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeItemOrderEditActionWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow removes an item that was added to an order edit. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to remove an item that was
added to an order edit in your custom flow.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeItemReceiveReturnActionWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeItemReceiveReturnActionWorkflow/page.mdx
index ae36bd505d..ae80216eca 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeItemReceiveReturnActionWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeItemReceiveReturnActionWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow removes an item from a return receival. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to remove an item from a return receival
in your custom flow.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeItemReturnActionWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeItemReturnActionWorkflow/page.mdx
index 5356716390..4b47e637fe 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeItemReturnActionWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeItemReturnActionWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow removes a return item. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you
to remove an item from a return request in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeOrderEditShippingMethodWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeOrderEditShippingMethodWorkflow/page.mdx
index 4051c83bfd..76e9ca18a0 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeOrderEditShippingMethodWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeOrderEditShippingMethodWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow removes a shipping method of an order edit. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to remove a
shipping method from an order edit in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeReturnShippingMethodWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeReturnShippingMethodWorkflow/page.mdx
index 7c070a6c34..34f80486d0 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeReturnShippingMethodWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.removeReturnShippingMethodWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow removes a shipping method from a return. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you
to remove a shipping method from a return in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.requestItemReturnWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.requestItemReturnWorkflow/page.mdx
index 09205265f7..f804eb7a3b 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.requestItemReturnWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.requestItemReturnWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow adds items to a return. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to add items to a return
in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.requestOrderEditRequestWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.requestOrderEditRequestWorkflow/page.mdx
index e846fb1a9a..94b0415bf3 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.requestOrderEditRequestWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.requestOrderEditRequestWorkflow/page.mdx
@@ -20,7 +20,7 @@ the [Request Order Edit Admin API Route](https://docs.medusajs.com/api/admin#ord
You can use this workflow within your customizations or your own custom workflows, allowing you to request an order edit
in your custom flows.
-
+
## Examples
@@ -129,7 +129,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -143,12 +143,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.requestOrderTransferWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.requestOrderTransferWorkflow/page.mdx
index 6132564e94..e84282c747 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.requestOrderTransferWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.requestOrderTransferWorkflow/page.mdx
@@ -23,7 +23,7 @@ and the [Request Order Transfer Admin API Route](https://docs.medusajs.com/api/a
You can use this workflow within your customizations or your own custom workflows, allowing you to build a custom flow around requesting an order transfer.
-
+
## Examples
@@ -140,7 +140,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -154,12 +154,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.throwUnlessStatusIsNotPaid/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.throwUnlessStatusIsNotPaid/page.mdx
index 811fc9e6ff..5f10479d1f 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.throwUnlessStatusIsNotPaid/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.throwUnlessStatusIsNotPaid/page.mdx
@@ -23,15 +23,15 @@ const myWorkflow = createWorkflow(
() => {
const data = throwUnlessStatusIsNotPaid({
"paymentCollection": {
- "id": "id_1rkji8toNwFZ",
- "currency_code": "stn",
+ "id": "id_RVj6hpeuXoXYOyO",
+ "currency_code": "usd",
"amount": {
- "numeric": 1
+ "numeric": 14
},
- "status": "partially_captured",
+ "status": "not_paid",
"payment_providers": [{
- "id": "id_5F5AxBi8bSEk",
- "is_enabled": true
+ "id": "id_50PuDZrIASzVIn",
+ "is_enabled": false
}]
}
})
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateClaimAddItemWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateClaimAddItemWorkflow/page.mdx
index 121f20de93..fb7a2ab11a 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateClaimAddItemWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateClaimAddItemWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow updates a claim's new or outbound item. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to update a claim's new or outbound item
in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateClaimItemWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateClaimItemWorkflow/page.mdx
index c412c78ce9..45b583026d 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateClaimItemWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateClaimItemWorkflow/page.mdx
@@ -20,7 +20,7 @@ It's used by the [Update Claim Item Admin API Route](https://docs.medusajs.com/a
You can use this workflow within your customizations or your own custom workflows, allowing you to update a claim item
in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateClaimShippingMethodWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateClaimShippingMethodWorkflow/page.mdx
index 78076c83a3..12360083ce 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateClaimShippingMethodWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateClaimShippingMethodWorkflow/page.mdx
@@ -21,7 +21,7 @@ and the [Update Outbound Shipping Admin API Route](https://docs.medusajs.com/api
You can use this workflow within your customizations or your own custom workflows, allowing you to update a claim's shipping method
in your own custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateExchangeAddItemWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateExchangeAddItemWorkflow/page.mdx
index c0d4985385..e822401f70 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateExchangeAddItemWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateExchangeAddItemWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow updates an outbound or new item in the exchange. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to update an outbound or new item
in an exchange in your custom flow.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateExchangeShippingMethodWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateExchangeShippingMethodWorkflow/page.mdx
index 992c1b763b..2e4b04c4ff 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateExchangeShippingMethodWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateExchangeShippingMethodWorkflow/page.mdx
@@ -21,7 +21,7 @@ or the [Outbound Inbound Shipping Admin API Route](https://docs.medusajs.com/api
You can use this workflow within your customizations or your own custom workflows, allowing you to update an exchange's
inbound or outbound shipping method in your custom flow.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderChangeActionsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderChangeActionsWorkflow/page.mdx
index 1616a35741..a50de3721c 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderChangeActionsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderChangeActionsWorkflow/page.mdx
@@ -18,7 +18,7 @@ This workflow updates one or more order change actions.
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
updating order change actions.
-
+
## Examples
@@ -39,7 +39,7 @@ export async function POST(
const { result } = await updateOrderChangeActionsWorkflow(req.scope)
.run({
input: [{
- "id": "id_qa5cOb98GOR"
+ "id": "id_N4l6m4YnLHSKCDr"
}]
})
@@ -64,7 +64,7 @@ export default async function handleOrderPlaced({
const { result } = await updateOrderChangeActionsWorkflow(container)
.run({
input: [{
- "id": "id_qa5cOb98GOR"
+ "id": "id_N4l6m4YnLHSKCDr"
}]
})
@@ -89,7 +89,7 @@ export default async function myCustomJob(
const { result } = await updateOrderChangeActionsWorkflow(container)
.run({
input: [{
- "id": "id_qa5cOb98GOR"
+ "id": "id_N4l6m4YnLHSKCDr"
}]
})
@@ -115,7 +115,7 @@ const myWorkflow = createWorkflow(
const result = updateOrderChangeActionsWorkflow
.runAsStep({
input: [{
- "id": "id_qa5cOb98GOR"
+ "id": "id_N4l6m4YnLHSKCDr"
}]
})
}
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderChangesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderChangesWorkflow/page.mdx
index 84f931c9c2..1155952513 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderChangesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderChangesWorkflow/page.mdx
@@ -18,7 +18,7 @@ This workflow updates one or more order changes.
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
updating order changes.
-
+
## Examples
@@ -39,7 +39,7 @@ export async function POST(
const { result } = await updateOrderChangesWorkflow(req.scope)
.run({
input: [{
- "id": "id_QLfQATZBg8cayLA"
+ "id": "id_1C6LZsFpLVV"
}]
})
@@ -64,7 +64,7 @@ export default async function handleOrderPlaced({
const { result } = await updateOrderChangesWorkflow(container)
.run({
input: [{
- "id": "id_QLfQATZBg8cayLA"
+ "id": "id_1C6LZsFpLVV"
}]
})
@@ -89,7 +89,7 @@ export default async function myCustomJob(
const { result } = await updateOrderChangesWorkflow(container)
.run({
input: [{
- "id": "id_QLfQATZBg8cayLA"
+ "id": "id_1C6LZsFpLVV"
}]
})
@@ -115,7 +115,7 @@ const myWorkflow = createWorkflow(
const result = updateOrderChangesWorkflow
.runAsStep({
input: [{
- "id": "id_QLfQATZBg8cayLA"
+ "id": "id_1C6LZsFpLVV"
}]
})
}
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderEditAddItemWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderEditAddItemWorkflow/page.mdx
index bf7767427c..c00c08d68f 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderEditAddItemWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderEditAddItemWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow updates a new item in an order edit. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to update a new item in an order edit
in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderEditItemQuantityWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderEditItemQuantityWorkflow/page.mdx
index 15ee58b3d7..9c912a3654 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderEditItemQuantityWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderEditItemQuantityWorkflow/page.mdx
@@ -18,7 +18,7 @@ This workflow updates an existing order item that was previously added to the or
You can use this workflow within your customizations or your own custom workflows, allowing you to update the quantity
of an existing item in an order edit in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderEditShippingMethodWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderEditShippingMethodWorkflow/page.mdx
index ffb2fd8e90..8e7a42a8d7 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderEditShippingMethodWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderEditShippingMethodWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow updates an order edit's shipping method. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to update an order edit's shipping method
in your custom flow.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderTaxLinesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderTaxLinesWorkflow/page.mdx
index 7ec738bb47..5a20961f88 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderTaxLinesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderTaxLinesWorkflow/page.mdx
@@ -3,7 +3,6 @@ slug: /references/medusa-workflows/updateOrderTaxLinesWorkflow
sidebar_label: updateOrderTaxLinesWorkflow
sidebar_description: Update the tax lines of items and shipping methods in an order.
tags:
- - remote query
- tax
- order
- workflow
@@ -22,7 +21,7 @@ tax lines.
You can use this workflow within your customizations or your own custom workflows, allowing you to update an
order's tax lines in your custom flows.
-
+
## Examples
@@ -135,7 +134,7 @@ const myWorkflow = createWorkflow(
## Steps
- 0\n }","depth":"2","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx) instead.\n\n:::","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useRemoteQueryStep/page.mdx","depth":2}]},{"type":"when","condition":"{\n return input.shipping_method_ids!?.length > 0\n }","depth":"3","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/learn/fundamentals/module-links/query).\n\n:::note\n\nThis step is deprecated. Use [useQueryGraphStep](../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useQueryGraphStep/page.mdx) instead.\n\n:::","link":"../../../../Common/Steps_Common/functions/core_flows.Common.Steps_Common.useRemoteQueryStep/page.mdx","depth":3}]},{"type":"step","name":"getItemTaxLinesStep","description":"This step retrieves the tax lines for an order or cart's line items and shipping methods.\n\n:::note\n\nYou can retrieve an order, cart, item, shipping method, and address details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query),\nor [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep).\n\n:::","link":"../../../../Tax/Steps_Tax/functions/core_flows.Tax.Steps_Tax.getItemTaxLinesStep/page.mdx","depth":4},{"type":"step","name":"setOrderTaxLinesForItemsStep","description":"This step sets the tax lines of an order's items and shipping methods.\n\n:::note\n\nYou can retrieve an order's details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query),\nor [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep).\n\n:::","link":"../../../Steps_Order/functions/core_flows.Order.Steps_Order.setOrderTaxLinesForItemsStep/page.mdx","depth":5}]}} />
+
## Input
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderWorkflow/page.mdx
index e2319cb4a1..a522bb304d 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateOrderWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow updates an order's general details, such as its email or addresses
You can use this workflow within your customizations or your own custom workflows, allowing you to update an
order's details in your custom flows.
-
+
## Examples
@@ -137,7 +137,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -151,12 +151,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateReceiveItemReturnRequestWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateReceiveItemReturnRequestWorkflow/page.mdx
index 02200a0bf2..0e6a902b59 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateReceiveItemReturnRequestWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateReceiveItemReturnRequestWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow updates an item in a return receival request. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to update an item in a return receival request
in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateRequestItemReturnWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateRequestItemReturnWorkflow/page.mdx
index 1ab1ff05ef..b70c1e8e37 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateRequestItemReturnWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateRequestItemReturnWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow updates a requested item in a return. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to update an
item in a return in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateReturnShippingMethodWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateReturnShippingMethodWorkflow/page.mdx
index 74c8097011..bbf5f8c232 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateReturnShippingMethodWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateReturnShippingMethodWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow updates the shipping method of a return. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you
to update the shipping method of a return in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateReturnWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateReturnWorkflow/page.mdx
index cbfdf7e89e..fa4243e6a9 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateReturnWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.updateReturnWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow updates a return's details. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you
to update a return in your custom flow.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.validateOrderCreditLinesStep/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.validateOrderCreditLinesStep/page.mdx
index dd92812644..c6704eddfc 100644
--- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.validateOrderCreditLinesStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.validateOrderCreditLinesStep/page.mdx
@@ -21,90 +21,90 @@ const myWorkflow = createWorkflow(
() => {
const data = validateOrderCreditLinesStep({
"order": {
- "id": "id_6JeNlJUn8ENhVQfLw",
- "version": 46,
- "display_id": 38,
- "status": "pending",
- "currency_code": "aed",
- "created_at": "2026-05-06T14:22:59.991Z",
- "updated_at": "2026-09-02T23:00:01.277Z",
+ "id": "id_nqQmCJQymY",
+ "version": 11,
+ "display_id": 43,
+ "status": "canceled",
+ "currency_code": "xpf",
+ "created_at": "2026-10-18T17:14:09.854Z",
+ "updated_at": "2025-12-28T22:48:23.241Z",
"original_item_total": {
- "numeric": 46
+ "numeric": 28
},
"original_item_subtotal": {
- "numeric": 39
+ "numeric": 44
},
"original_item_tax_total": {
- "numeric": 29
+ "numeric": 17
},
"item_total": {
- "numeric": 1
- },
- "item_subtotal": {
- "numeric": 8
- },
- "item_tax_total": {
"numeric": 48
},
- "item_discount_total": {
+ "item_subtotal": {
+ "numeric": 35
+ },
+ "item_tax_total": {
"numeric": 5
},
+ "item_discount_total": {
+ "numeric": 26
+ },
"original_total": {
- "numeric": 6
+ "numeric": 28
},
"original_subtotal": {
- "numeric": 38
+ "numeric": 13
},
"original_tax_total": {
- "numeric": 36
+ "numeric": 49
},
"total": {
- "numeric": 27
+ "numeric": 43
},
"subtotal": {
- "numeric": 40
+ "numeric": 1
},
"tax_total": {
- "numeric": 22
+ "numeric": 23
},
"discount_subtotal": {
- "numeric": 45
+ "numeric": 15
},
"discount_total": {
"numeric": 17
},
"discount_tax_total": {
- "numeric": 0
+ "numeric": 21
},
"credit_line_total": {
- "numeric": 27
+ "numeric": 15
},
"gift_card_total": {
- "numeric": 3
+ "numeric": 50
},
"gift_card_tax_total": {
- "numeric": 5
+ "numeric": 29
},
"shipping_total": {
- "numeric": 8
+ "numeric": 20
},
"shipping_subtotal": {
- "numeric": 24
+ "numeric": 14
},
"shipping_tax_total": {
- "numeric": 30
+ "numeric": 42
},
"shipping_discount_total": {
- "numeric": 40
+ "numeric": 29
},
"original_shipping_total": {
- "numeric": 44
+ "numeric": 2
},
"original_shipping_subtotal": {
- "numeric": 28
+ "numeric": 38
},
"original_shipping_tax_total": {
- "numeric": 15
+ "numeric": 29
}
},
"creditLines": [
diff --git a/www/apps/resources/references/core_flows/Payment/Steps_Payment/functions/core_flows.Payment.Steps_Payment.refundPaymentsStep/page.mdx b/www/apps/resources/references/core_flows/Payment/Steps_Payment/functions/core_flows.Payment.Steps_Payment.refundPaymentsStep/page.mdx
index e204b8144b..01b6f63cd4 100644
--- a/www/apps/resources/references/core_flows/Payment/Steps_Payment/functions/core_flows.Payment.Steps_Payment.refundPaymentsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Payment/Steps_Payment/functions/core_flows.Payment.Steps_Payment.refundPaymentsStep/page.mdx
@@ -24,7 +24,7 @@ const myWorkflow = createWorkflow(
() => {
const data = refundPaymentsStep({
"payment_id": "{value}",
- "amount": 17
+ "amount": 39
})
}
)
diff --git a/www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.capturePaymentWorkflow/page.mdx b/www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.capturePaymentWorkflow/page.mdx
index 682acec1e9..ffe643c176 100644
--- a/www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.capturePaymentWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.capturePaymentWorkflow/page.mdx
@@ -22,7 +22,7 @@ This workflow captures a payment. It's used by the
You can use this workflow within your own customizations or custom workflows, allowing you
to capture a payment in your custom flows.
-
+
## Examples
@@ -131,7 +131,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -145,12 +145,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.processPaymentWorkflow/page.mdx b/www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.processPaymentWorkflow/page.mdx
index 9426ec793a..339fc65e5f 100644
--- a/www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.processPaymentWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.processPaymentWorkflow/page.mdx
@@ -19,7 +19,7 @@ capture the payment, or authorize the payment session. It's used when a
You can use this workflow within your own customizations or custom workflows, allowing you
to process a payment in your custom flows based on a webhook action.
-
+
## Examples
@@ -150,12 +150,8 @@ const myWorkflow = createWorkflow(
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.refundPaymentWorkflow/page.mdx b/www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.refundPaymentWorkflow/page.mdx
index 8a6f948492..fe71d6a9a2 100644
--- a/www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.refundPaymentWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.refundPaymentWorkflow/page.mdx
@@ -22,7 +22,7 @@ This workflow refunds a payment. It's used by the
You can use this workflow within your own customizations or custom workflows, allowing you
to refund a payment in your custom flows.
-
+
## Examples
@@ -131,22 +131,18 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
-
+
## Emitted Events
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.refundPaymentsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.refundPaymentsWorkflow/page.mdx
index 285b0e6cbd..48566ac934 100644
--- a/www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.refundPaymentsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.refundPaymentsWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow refunds payments.
You can use this workflow within your customizations or your own custom workflows, allowing you to
refund payments in your custom flow.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.validateRefundPaymentExceedsCapturedAmountStep/page.mdx b/www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.validateRefundPaymentExceedsCapturedAmountStep/page.mdx
new file mode 100644
index 0000000000..e030892770
--- /dev/null
+++ b/www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.validateRefundPaymentExceedsCapturedAmountStep/page.mdx
@@ -0,0 +1,43 @@
+---
+slug: /references/medusa-workflows/validateRefundPaymentExceedsCapturedAmountStep
+sidebar_label: validateRefundPaymentExceedsCapturedAmountStep
+sidebar_description: ""
+tags:
+ - step
+---
+
+import { TypeList, WorkflowDiagram } from "docs-ui"
+
+# validateRefundPaymentExceedsCapturedAmountStep - Medusa Core Workflows Reference
+
+This documentation provides a reference to the `validateRefundPaymentExceedsCapturedAmountStep`. It belongs to the `@medusajs/medusa/core-flows` package.
+
+This step validates that an order refund credit line can be issued
+
+```ts title="src/workflows/my-workflow.ts"
+import { createWorkflow } from "@medusajs/framework/workflows-sdk"
+import { validateRefundPaymentExceedsCapturedAmountStep } from "@medusajs/medusa/core-flows"
+
+const myWorkflow = createWorkflow(
+ "my-workflow",
+ () => {
+ const data = validateRefundPaymentExceedsCapturedAmountStep({
+ "payment": {
+ "id": "id_VQ2bsaJk5c",
+ "amount": {
+ "numeric": 30
+ },
+ "currency_code": "omr",
+ "provider_id": "{value}",
+ "payment_collection_id": "{value}"
+ },
+ "refundAmount": 17
+ })
+ }
+)
+```
+
+
+## Input
+
+`","description":"The data relevant for the payment provider to process the payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the payment was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the payment was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_at","type":"`string` \\| `Date`","description":"When the payment was captured.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the payment was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The sum of the associated captures' amounts.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../payment/types/payment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_captured_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The sum of the associated captures' raw amounts.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../payment/types/payment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"refunded_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The sum of the associated refunds' amounts.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../payment/types/payment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_refunded_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The sum of the associated refunds' raw amounts.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../payment/types/payment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"captures","type":"[CaptureDTO](../../../../../payment/interfaces/payment.CaptureDTO/page.mdx)[]","description":"The associated captures.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the capture.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The captured amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the capture.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"[PaymentDTO](../../../../../payment/interfaces/payment.PaymentDTO/page.mdx)","description":"The associated payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The raw captured amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who the capture was created by. For example,\nthe ID of a user.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"refunds","type":"[RefundDTO](../../../../../payment/interfaces/payment.RefundDTO/page.mdx)[]","description":"The associated refunds.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the refund","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The refunded amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the refund.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"[PaymentDTO](../../../../../payment/interfaces/payment.PaymentDTO/page.mdx)","description":"The associated payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The raw refunded amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_reason_id","type":"`null` \\| `string`","description":"The id of the refund\\_reason that is associated with the refund","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_reason","type":"`null` \\| [RefundReasonDTO](../../../../../payment/interfaces/payment.RefundReasonDTO/page.mdx)","description":"The id of the refund\\_reason that is associated with the refund","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`null` \\| `string`","description":"A field to add some additional information about the refund","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the refund. For example,\nthe user's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_collection","type":"[PaymentCollectionDTO](../../../../../payment/interfaces/payment.PaymentCollectionDTO/page.mdx)","description":"The associated payment collection.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The ISO 3 character currency code of the payment sessions and payments associated with payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The total amount to be authorized and captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../../../../payment/types/payment.PaymentCollectionStatus/page.mdx)","description":"The status of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProviderDTO](../../../../../payment/interfaces/payment.PaymentProviderDTO/page.mdx)[]","description":"The payment provider used to process the associated payment sessions and payments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"authorized_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The amount authorized within the associated payment sessions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The amount refunded within the associated payments.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The amount captured within the associated payments.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`string` \\| `Date`","description":"When the payment collection was completed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the payment collection was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the payment collection was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSessionDTO](../../../../../payment/interfaces/payment.PaymentSessionDTO/page.mdx)[]","description":"The associated payment sessions.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[PaymentDTO](../../../../../payment/interfaces/payment.PaymentDTO/page.mdx)[]","description":"The associated payments.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"payment_session","type":"[PaymentSessionDTO](../../../../../payment/interfaces/payment.PaymentSessionDTO/page.mdx)","description":"The payment session from which the payment is created.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The amount to authorize.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the associated payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data necessary for the payment provider to process the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentSessionStatus](../../../../../payment/types/payment.PaymentSessionStatus/page.mdx)","description":"The status of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the payment session was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the payment session was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the associated payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record`","description":"The context necessary for the payment provider.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_at","type":"`Date`","description":"When the payment session was authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollectionDTO](../../../../../payment/interfaces/payment.PaymentCollectionDTO/page.mdx)","description":"The payment collection the session is associated with.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"payment","type":"[PaymentDTO](../../../../../payment/interfaces/payment.PaymentDTO/page.mdx)","description":"The payment created from the session.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"refundAmount","type":"[BigNumberInput](../../../../../types/types/types.BigNumberInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../types/types/types.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":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="validateRefundPaymentExceedsCapturedAmountStep"/>
diff --git a/www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.validateRefundStep/page.mdx b/www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.validateRefundStep/page.mdx
deleted file mode 100644
index 7cb4e83b78..0000000000
--- a/www/apps/resources/references/core_flows/Payment/Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.validateRefundStep/page.mdx
+++ /dev/null
@@ -1,43 +0,0 @@
----
-slug: /references/medusa-workflows/validateRefundStep
-sidebar_label: validateRefundStep
-sidebar_description: ""
-tags:
- - step
----
-
-import { TypeList, WorkflowDiagram } from "docs-ui"
-
-# validateRefundStep - Medusa Core Workflows Reference
-
-This documentation provides a reference to the `validateRefundStep`. It belongs to the `@medusajs/medusa/core-flows` package.
-
-This step validates that the refund is valid for the order.
-If the order does not have an outstanding balance to refund, the step throws an error.
-
-:::note
-
-You can retrieve an order or payment's details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query),
-or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep).
-
-:::
-
-## Example
-
-```ts
-const data = validateRefundStep({
- order: {
- id: "order_123",
- // other order details...
- },
- payment: {
- id: "payment_123",
- // other payment details...
- },
- amount: 10
-})
-```
-
-## Input
-
-`","description":"The metadata of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was declined","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The canceled by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was canceled","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order change was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order change was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"`\"return\"` \\| `\"exchange\"` \\| `\"claim\"` \\| `\"edit\"` \\| `\"transfer\"`","description":"The type of the order change","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region the order belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer on the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`","description":"The ID of the sales channel the order belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[OrderAddressDTO](../../../../../fulfillment/interfaces/fulfillment.OrderAddressDTO/page.mdx)","description":"The associated shipping address.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the 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 lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO\\_3166-2) 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`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address","type":"[OrderAddressDTO](../../../../../fulfillment/interfaces/fulfillment.OrderAddressDTO/page.mdx)","description":"The associated billing address.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the 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 lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO\\_3166-2) 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`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"items","type":"[OrderLineItemDTO](../../../../../fulfillment/interfaces/fulfillment.OrderLineItemDTO/page.mdx)[]","description":"The associated order details / line items.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Indicates whether the line item is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Indicates whether the line item price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The unit price of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"[OrderItemDTO](../../../../../fulfillment/interfaces/fulfillment.OrderItemDTO/page.mdx)","description":"The details of the item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date when the line item was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date when the line item was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subtitle of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The thumbnail of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The ID of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The ID of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"`null` \\| `string`","description":"The title of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"`null` \\| `string`","description":"The description of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"`null` \\| `string`","description":"The subtitle of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type_id","type":"`null` \\| `string`","description":"The ID of the type of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"`null` \\| `string`","description":"The type of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collection","type":"`null` \\| `string`","description":"The collection of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_handle","type":"`null` \\| `string`","description":"The handle of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_sku","type":"`null` \\| `string`","description":"The SKU (stock keeping unit) of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_barcode","type":"`null` \\| `string`","description":"The barcode of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_title","type":"`null` \\| `string`","description":"The title of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_option_values","type":"`null` \\| `Record`","description":"The option values of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compare_at_unit_price","type":"`number`","description":"The compare at unit price of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[OrderLineItemTaxLineDTO](../../../../../fulfillment/interfaces/fulfillment.OrderLineItemTaxLineDTO/page.mdx)[]","description":"The associated tax lines.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"adjustments","type":"[OrderLineItemAdjustmentDTO](../../../../../fulfillment/interfaces/fulfillment.OrderLineItemAdjustmentDTO/page.mdx)[]","description":"The associated adjustments.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_methods","type":"[OrderShippingMethodDTO](../../../../../fulfillment/interfaces/fulfillment.OrderShippingMethodDTO/page.mdx)[]","description":"The associated shipping methods","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","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":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The ID of the shipping option the method was created from.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"Additional data needed for fulfillment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[OrderShippingMethodTaxLineDTO](../../../../../fulfillment/interfaces/fulfillment.OrderShippingMethodTaxLineDTO/page.mdx)[]","description":"The associated tax lines.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"adjustments","type":"[OrderShippingMethodAdjustmentDTO](../../../../../fulfillment/interfaces/fulfillment.OrderShippingMethodAdjustmentDTO/page.mdx)[]","description":"The associated adjustments.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"transactions","type":"[OrderTransactionDTO](../../../../../fulfillment/interfaces/fulfillment.OrderTransactionDTO/page.mdx)[]","description":"The tramsactions associated with the order","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the transaction","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":"version","type":"`number`","description":"The associated order version","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The amount of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The reference of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the reference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the transaction was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the transaction was updated","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"credit_lines","type":"[OrderCreditLineDTO](../../../../../fulfillment/interfaces/fulfillment.OrderCreditLineDTO/page.mdx)[]","description":"The credit lines for an order","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order credit line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the credit line belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The amount of the credit line.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`null` \\| `string`","description":"The reference model name that the credit line is generated from","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`null` \\| `string`","description":"The reference model id that the credit line is generated from","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the order detail","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date when the order credit line was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date when the order credit line was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"summary","type":"[OrderSummaryDTO](../../../../../fulfillment/interfaces/fulfillment.OrderSummaryDTO/page.mdx)","description":"The summary of the order totals.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"pending_difference","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"current_order_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_order_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transaction_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"paid_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"credit_line_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"accounting_total","type":"[BigNumberValue](../../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_pending_difference","type":"[BigNumberRawValue](../../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_current_order_total","type":"[BigNumberRawValue](../../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_order_total","type":"[BigNumberRawValue](../../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_transaction_total","type":"[BigNumberRawValue](../../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_paid_total","type":"[BigNumberRawValue](../../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_refunded_total","type":"[BigNumberRawValue](../../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_credit_line_total","type":"[BigNumberRawValue](../../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_accounting_total","type":"[BigNumberRawValue](../../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_draft_order","type":"`boolean`","description":"Whether the order is a draft order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the order was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment","type":"[PaymentDTO](../../../../../payment/interfaces/payment.PaymentDTO/page.mdx)","description":"The order's payment details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The payment's total amount.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../payment/types/payment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"currency_code","type":"`string`","description":"The ISO 3 character currency code of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the associated payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the associated payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The raw amount of the payment.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../payment/types/payment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"authorized_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The authorized amount of the payment.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../payment/types/payment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_authorized_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The raw authorized amount of the payment.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../payment/types/payment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"data","type":"`Record`","description":"The data relevant for the payment provider to process the payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the payment was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the payment was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_at","type":"`string` \\| `Date`","description":"When the payment was captured.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the payment was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The sum of the associated captures' amounts.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../payment/types/payment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_captured_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The sum of the associated captures' raw amounts.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../payment/types/payment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"refunded_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The sum of the associated refunds' amounts.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../payment/types/payment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_refunded_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The sum of the associated refunds' raw amounts.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../payment/types/payment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"captures","type":"[CaptureDTO](../../../../../payment/interfaces/payment.CaptureDTO/page.mdx)[]","description":"The associated captures.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the capture.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The captured amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the capture.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"[PaymentDTO](../../../../../payment/interfaces/payment.PaymentDTO/page.mdx)","description":"The associated payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The raw captured amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who the capture was created by. For example,\nthe ID of a user.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"refunds","type":"[RefundDTO](../../../../../payment/interfaces/payment.RefundDTO/page.mdx)[]","description":"The associated refunds.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the refund","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The refunded amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the refund.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"[PaymentDTO](../../../../../payment/interfaces/payment.PaymentDTO/page.mdx)","description":"The associated payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The raw refunded amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_reason_id","type":"`null` \\| `string`","description":"The id of the refund\\_reason that is associated with the refund","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_reason","type":"`null` \\| [RefundReasonDTO](../../../../../payment/interfaces/payment.RefundReasonDTO/page.mdx)","description":"The id of the refund\\_reason that is associated with the refund","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`null` \\| `string`","description":"A field to add some additional information about the refund","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the refund. For example,\nthe user's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_collection","type":"[PaymentCollectionDTO](../../../../../payment/interfaces/payment.PaymentCollectionDTO/page.mdx)","description":"The associated payment collection.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The ISO 3 character currency code of the payment sessions and payments associated with payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The total amount to be authorized and captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../../../../payment/types/payment.PaymentCollectionStatus/page.mdx)","description":"The status of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProviderDTO](../../../../../payment/interfaces/payment.PaymentProviderDTO/page.mdx)[]","description":"The payment provider used to process the associated payment sessions and payments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"authorized_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The amount authorized within the associated payment sessions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The amount refunded within the associated payments.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The amount captured within the associated payments.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`string` \\| `Date`","description":"When the payment collection was completed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the payment collection was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the payment collection was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSessionDTO](../../../../../payment/interfaces/payment.PaymentSessionDTO/page.mdx)[]","description":"The associated payment sessions.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[PaymentDTO](../../../../../payment/interfaces/payment.PaymentDTO/page.mdx)[]","description":"The associated payments.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"payment_session","type":"[PaymentSessionDTO](../../../../../payment/interfaces/payment.PaymentSessionDTO/page.mdx)","description":"The payment session from which the payment is created.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The amount to authorize.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the associated payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data necessary for the payment provider to process the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentSessionStatus](../../../../../payment/types/payment.PaymentSessionStatus/page.mdx)","description":"The status of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the payment session was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the payment session was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the associated payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record`","description":"The context necessary for the payment provider.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_at","type":"`Date`","description":"When the payment session was authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollectionDTO](../../../../../payment/interfaces/payment.PaymentCollectionDTO/page.mdx)","description":"The payment collection the session is associated with.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"payment","type":"[PaymentDTO](../../../../../payment/interfaces/payment.PaymentDTO/page.mdx)","description":"The payment created from the session.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"amount","type":"[BigNumberInput](../../../../../types/types/types.BigNumberInput/page.mdx)","description":"The amound to refund.","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/types/types.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":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="validateRefundStep"/>
diff --git a/www/apps/resources/references/core_flows/Payment/core_flows.Payment.Workflows_Payment/page.mdx b/www/apps/resources/references/core_flows/Payment/core_flows.Payment.Workflows_Payment/page.mdx
index d4aa5b38e3..f7224d2cc4 100644
--- a/www/apps/resources/references/core_flows/Payment/core_flows.Payment.Workflows_Payment/page.mdx
+++ b/www/apps/resources/references/core_flows/Payment/core_flows.Payment.Workflows_Payment/page.mdx
@@ -7,4 +7,4 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
- [refundPaymentsWorkflow](../Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.refundPaymentsWorkflow/page.mdx)
- [refundPaymentWorkflow](../Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.refundPaymentWorkflow/page.mdx)
- [validatePaymentsRefundStep](../Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.validatePaymentsRefundStep/page.mdx)
-- [validateRefundStep](../Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.validateRefundStep/page.mdx)
+- [validateRefundPaymentExceedsCapturedAmountStep](../Workflows_Payment/functions/core_flows.Payment.Workflows_Payment.validateRefundPaymentExceedsCapturedAmountStep/page.mdx)
diff --git a/www/apps/resources/references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.createPaymentSessionStep/page.mdx b/www/apps/resources/references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.createPaymentSessionStep/page.mdx
index ca1dc688f0..6dadd2aa3d 100644
--- a/www/apps/resources/references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.createPaymentSessionStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.createPaymentSessionStep/page.mdx
@@ -24,8 +24,8 @@ const myWorkflow = createWorkflow(
const data = createPaymentSessionStep({
"payment_collection_id": "{value}",
"provider_id": "{value}",
- "amount": 48,
- "currency_code": "krw"
+ "amount": 19,
+ "currency_code": "bgn"
})
}
)
diff --git a/www/apps/resources/references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.deletePaymentSessionsStep/page.mdx b/www/apps/resources/references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.deletePaymentSessionsStep/page.mdx
index 1a217c61ce..1252e9235a 100644
--- a/www/apps/resources/references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.deletePaymentSessionsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.deletePaymentSessionsStep/page.mdx
@@ -27,7 +27,7 @@ const myWorkflow = createWorkflow(
() => {
const data = deletePaymentSessionsStep({
"ids": [
- "id_fvXlhEPmeXoP"
+ "id_6Xpgmbi57STew6"
]
})
}
diff --git a/www/apps/resources/references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.updateRefundReasonsStep/page.mdx b/www/apps/resources/references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.updateRefundReasonsStep/page.mdx
index c181375329..115ca6d174 100644
--- a/www/apps/resources/references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.updateRefundReasonsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Payment_Collection/Steps_Payment_Collection/functions/core_flows.Payment_Collection.Steps_Payment_Collection.updateRefundReasonsStep/page.mdx
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
"my-workflow",
() => {
const data = updateRefundReasonsStep({
- "id": "id_KXnK1q2jRxL1Q9te"
+ "id": "id_SKp7AUql5aut"
})
}
)
diff --git a/www/apps/resources/references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.createPaymentSessionsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.createPaymentSessionsWorkflow/page.mdx
index 5544444bea..706ada7d55 100644
--- a/www/apps/resources/references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.createPaymentSessionsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.createPaymentSessionsWorkflow/page.mdx
@@ -21,7 +21,7 @@ This workflow creates payment sessions. It's used by the
You can use this workflow within your own customizations or custom workflows, allowing you
to create payment sessions in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.createRefundReasonsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.createRefundReasonsWorkflow/page.mdx
index 76b1c42363..24e01afbf3 100644
--- a/www/apps/resources/references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.createRefundReasonsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.createRefundReasonsWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow creates one or more refund reasons. It's used by the
You can use this workflow within your own customizations or custom workflows, allowing you
to create refund reasons in your custom flows.
-
+
## Examples
@@ -41,7 +41,8 @@ export async function POST(
.run({
input: {
data: [{
- label: "damaged",
+ label: "Damaged",
+ code: "damaged"
}]
}
})
@@ -68,7 +69,8 @@ export default async function handleOrderPlaced({
.run({
input: {
data: [{
- label: "damaged",
+ label: "Damaged",
+ code: "damaged"
}]
}
})
@@ -95,7 +97,8 @@ export default async function myCustomJob(
.run({
input: {
data: [{
- label: "damaged",
+ label: "Damaged",
+ code: "damaged"
}]
}
})
@@ -123,7 +126,8 @@ const myWorkflow = createWorkflow(
.runAsStep({
input: {
data: [{
- label: "damaged",
+ label: "Damaged",
+ code: "damaged"
}]
}
})
diff --git a/www/apps/resources/references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.deletePaymentSessionsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.deletePaymentSessionsWorkflow/page.mdx
index b985abbfd1..76735cd055 100644
--- a/www/apps/resources/references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.deletePaymentSessionsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.deletePaymentSessionsWorkflow/page.mdx
@@ -20,7 +20,7 @@ refreshPaymentCollectionForCartWorkflow to delete payment sessions when the cart
You can use this workflow within your own customizations or custom workflows, allowing you
to delete payment sessions in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.deleteRefundReasonsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.deleteRefundReasonsWorkflow/page.mdx
index 0afa94d7fe..6b69a9a432 100644
--- a/www/apps/resources/references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.deleteRefundReasonsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.deleteRefundReasonsWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow deletes one or more refund reasons. It's used by the
You can use this workflow within your own customizations or custom workflows, allowing you
to delete refund reasons in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.updateRefundReasonsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.updateRefundReasonsWorkflow/page.mdx
index 66d9902bcf..58d2898931 100644
--- a/www/apps/resources/references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.updateRefundReasonsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Payment_Collection/Workflows_Payment_Collection/functions/core_flows.Payment_Collection.Workflows_Payment_Collection.updateRefundReasonsWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow updates one or more refund reasons. It's used by the
You can use this workflow within your own customizations or custom workflows, allowing you
to update refund reasons in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.validatePriceListsStep/page.mdx b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.validatePriceListsStep/page.mdx
index 9b192dc0f0..e540cb6a23 100644
--- a/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.validatePriceListsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Price_List/Steps_Price_List/functions/core_flows.Price_List.Steps_Price_List.validatePriceListsStep/page.mdx
@@ -23,7 +23,7 @@ const myWorkflow = createWorkflow(
"my-workflow",
() => {
const data = validatePriceListsStep({
- "id": "id_IeS7qnl0C6UcgE"
+ "id": "id_5y6g0sgFShmWEjDVll"
})
}
)
diff --git a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.batchPriceListPricesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.batchPriceListPricesWorkflow/page.mdx
index 3dd614a9a8..1a19b9fc45 100644
--- a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.batchPriceListPricesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.batchPriceListPricesWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow manages a price list's prices by creating, updating, or removing t
You can use this workflow within your customizations or your own custom workflows, allowing you to
manage price lists' prices in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.createPriceListPricesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.createPriceListPricesWorkflow/page.mdx
index 7475c482fd..9a68aca530 100644
--- a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.createPriceListPricesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.createPriceListPricesWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow creates prices in price lists. It's used by other workflows, such
You can use this workflow within your customizations or your own custom workflows, allowing you to
create prices in price lists in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.createPriceListsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.createPriceListsWorkflow/page.mdx
index 4b315065fc..0fc4c5ab5a 100644
--- a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.createPriceListsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.createPriceListsWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow creates one or more price lists. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to
create price lists in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.deletePriceListsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.deletePriceListsWorkflow/page.mdx
index 5f83b67015..6194593139 100644
--- a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.deletePriceListsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.deletePriceListsWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow deletes one or more price lists. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to
delete price lists in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.removePriceListPricesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.removePriceListPricesWorkflow/page.mdx
index 0d7f2c8fca..9135d42839 100644
--- a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.removePriceListPricesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.removePriceListPricesWorkflow/page.mdx
@@ -19,7 +19,7 @@ as [batchPriceListPricesWorkflow](../core_flows.Price_List.Workflows_Price_List.
You can use this workflow within your customizations or your own custom workflows, allowing you to
remove prices in price lists in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.updatePriceListPricesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.updatePriceListPricesWorkflow/page.mdx
index 20b84eb882..1fb3f79b99 100644
--- a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.updatePriceListPricesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.updatePriceListPricesWorkflow/page.mdx
@@ -20,7 +20,7 @@ as [batchPriceListPricesWorkflow](../core_flows.Price_List.Workflows_Price_List.
You can use this workflow within your customizations or your own custom workflows, allowing you to
update prices in price lists in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.updatePriceListsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.updatePriceListsWorkflow/page.mdx
index 2cd6250a13..96c66f80ae 100644
--- a/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.updatePriceListsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Price_List/Workflows_Price_List/functions/core_flows.Price_List.Workflows_Price_List.updatePriceListsWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow updates one or more price lists. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to
update price lists in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.createPricePreferencesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.createPricePreferencesWorkflow/page.mdx
index 9796855d7a..3d9fcd90e0 100644
--- a/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.createPricePreferencesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.createPricePreferencesWorkflow/page.mdx
@@ -16,10 +16,10 @@ This documentation provides a reference to the `createPricePreferencesWorkflow`.
This workflow creates one or more price preferences. It's used by the
[Create Price Preferences Admin API Route](https://docs.medusajs.com/api/admin#price-preferences\_postpricepreferences).
-You can use this workflow within your customizations or your own custom workflows, allowing you to
+You can use this workflow within your customizations or your own custom workflows, allowing you to
create price preferences in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.deletePricePreferencesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.deletePricePreferencesWorkflow/page.mdx
index 19079d43ec..5c93e6b334 100644
--- a/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.deletePricePreferencesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.deletePricePreferencesWorkflow/page.mdx
@@ -20,7 +20,7 @@ This workflow deletes one or more price preferences. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to
delete price preferences in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.updatePricePreferencesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.updatePricePreferencesWorkflow/page.mdx
index cf5aceae73..2eff8e947c 100644
--- a/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.updatePricePreferencesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Pricing/Workflows_Pricing/functions/core_flows.Pricing.Workflows_Pricing.updatePricePreferencesWorkflow/page.mdx
@@ -19,7 +19,7 @@ This workflow updates one or more price preferences. It's used by the
You can use this workflow within your customizations or your own custom workflows, allowing you to
update price preferences in your custom flows.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.addImageToVariantsStep/page.mdx b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.addImageToVariantsStep/page.mdx
new file mode 100644
index 0000000000..8409ce1baf
--- /dev/null
+++ b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.addImageToVariantsStep/page.mdx
@@ -0,0 +1,38 @@
+---
+slug: /references/medusa-workflows/steps/addImageToVariantsStep
+sidebar_label: addImageToVariantsStep
+tags:
+ - product
+ - step
+---
+
+import { TypeList, WorkflowDiagram } from "docs-ui"
+
+# addImageToVariantsStep - Medusa Core Workflows Reference
+
+This documentation provides a reference to the `addImageToVariantsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
+
+This step adds an image to one or more product variants.
+
+:::note
+
+This is available starting from [Medusa v2.11.2](https://github.com/medusajs/medusa/releases/tag/v2.11.2).
+
+:::
+
+## Example
+
+```ts
+const data = addImageToVariantsStep({
+ image_id: "img_123",
+ add: ["variant_123", "variant_456"]
+})
+```
+
+## Input
+
+
+
+## Output
+
+
diff --git a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.addImagesToVariantStep/page.mdx b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.addImagesToVariantStep/page.mdx
new file mode 100644
index 0000000000..38bbe30faf
--- /dev/null
+++ b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.addImagesToVariantStep/page.mdx
@@ -0,0 +1,38 @@
+---
+slug: /references/medusa-workflows/steps/addImagesToVariantStep
+sidebar_label: addImagesToVariantStep
+tags:
+ - product
+ - step
+---
+
+import { TypeList, WorkflowDiagram } from "docs-ui"
+
+# addImagesToVariantStep - Medusa Core Workflows Reference
+
+This documentation provides a reference to the `addImagesToVariantStep`. It belongs to the `@medusajs/medusa/core-flows` package.
+
+This step adds one or more images to a product variant.
+
+:::note
+
+This is available starting from [Medusa v2.11.2](https://github.com/medusajs/medusa/releases/tag/v2.11.2).
+
+:::
+
+## Example
+
+```ts
+const data = addImagesToVariantStep({
+ variant_id: "variant_123",
+ add: ["img_123", "img_456"]
+})
+```
+
+## Input
+
+
+
+## Output
+
+
diff --git a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createCollectionsStep/page.mdx b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createCollectionsStep/page.mdx
index 73f19d57a2..78e10ce3da 100644
--- a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createCollectionsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createCollectionsStep/page.mdx
@@ -22,7 +22,7 @@ const myWorkflow = createWorkflow(
"my-workflow",
() => {
const data = createCollectionsStep([{
- "title": "vinitor"
+ "title": "vociferor"
}])
}
)
@@ -35,4 +35,4 @@ const myWorkflow = createWorkflow(
## Output
-`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="createCollectionsStep"/>
+`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="createCollectionsStep"/>
diff --git a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductOptionsStep/page.mdx b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductOptionsStep/page.mdx
index c5865ffc14..226ccca724 100644
--- a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductOptionsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductOptionsStep/page.mdx
@@ -29,4 +29,4 @@ const data = createProductOptionsStep([{
## Output
-`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="createProductOptionsStep"/>
+`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="createProductOptionsStep"/>
diff --git a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductTagsStep/page.mdx b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductTagsStep/page.mdx
index 9c504881ad..e9135ced75 100644
--- a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductTagsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductTagsStep/page.mdx
@@ -35,4 +35,4 @@ const myWorkflow = createWorkflow(
## Output
-`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="createProductTagsStep"/>
+`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="createProductTagsStep"/>
diff --git a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductVariantsStep/page.mdx b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductVariantsStep/page.mdx
index 43c24f446f..9ff0c425b4 100644
--- a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductVariantsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductVariantsStep/page.mdx
@@ -32,4 +32,4 @@ const data = createProductVariantsStep([{
## Output
-`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product collection. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product collection was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product collection was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product collection was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product type was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product type was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product type was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the product variant's requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="createProductVariantsStep"/>
+`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product collection. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product collection was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product collection was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product collection was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product type was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product type was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product type was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The thumbnail of the product variant form the product images.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the product variant's requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="createProductVariantsStep"/>
diff --git a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductsStep/page.mdx b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductsStep/page.mdx
index b075b71d1d..06883eb1d2 100644
--- a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.createProductsStep/page.mdx
@@ -42,4 +42,4 @@ const data = createProductsStep([{
## Output
-`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option value was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option value was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)","description":"The associated product option. It may only be available if the `option` relation is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`null` \\| `string`","description":"The associated product option id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option value was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="createProductsStep"/>
+`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option value was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option value was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)","description":"The associated product option. It may only be available if the `option` relation is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`null` \\| `string`","description":"The associated product option id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option value was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="createProductsStep"/>
diff --git a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.generateProductCsvStep/page.mdx b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.generateProductCsvStep/page.mdx
index 9d595e3fff..53d0625989 100644
--- a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.generateProductCsvStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.generateProductCsvStep/page.mdx
@@ -30,7 +30,7 @@ const data = generateProductCsvStep(products)
## Input
-`","description":"The price's raw amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity that must be available in the cart for the price to be applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity allowed to be available in the cart for the price to be applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the price set this price belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the price was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the price was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the price was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`null` \\| [AdminProductOptionValue](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductOptionValue/page.mdx)[]","description":"The variant's values for the associated product's options.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The option value's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The option's value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [AdminProductOption](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductOption/page.mdx)","description":"The option's details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`null` \\| `string`","description":"The ID of the option.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the option value was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the option value was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the option value was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"The variant's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`null` \\| `string`","description":"The variant's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The variant's SKU.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The variant's barcode.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The variant's EAN.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The variant's UPC.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`null` \\| `boolean`","description":"Whether the variant can be ordered even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`null` \\| `boolean`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant\nis always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The variant's HS code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The variant's origin country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The variant's MID code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The variant's material.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The variant's weight.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The variant's length.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The variant's height.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The variant's width.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [AdminProduct](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProduct/page.mdx)","description":"The product that this variant belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"variants","type":"`null` \\| [AdminProductVariant](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariant/page.mdx)[]","description":"The product's variants.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [AdminProductType](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductType/page.mdx)","description":"The product's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`null` \\| [AdminProductOption](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductOption/page.mdx)[]","description":"The product's options.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"`null` \\| [AdminProductImage](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductImage/page.mdx)[]","description":"The product's images.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The product's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product's handle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The product's subtitle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The product's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx)","description":"The product's status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The product's width.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The product's weight.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The product's length.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The product's height.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The product's origin country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The product's HS code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The product's MID code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The product's material.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the associated product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the associated product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in external systems.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string`","description":"The date the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string`","description":"The date the product was update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [AdminCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCollection/page.mdx)","description":"The product's collection.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [AdminProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx)[]","description":"The product's categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"`null` \\| [AdminSalesChannel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminSalesChannel/page.mdx)[]","description":"The sales channels that the product is available in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile","type":"`null` \\| [AdminShippingProfile](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminShippingProfile/page.mdx)","description":"The shipping profile that the product is available in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`null` \\| [AdminProductTag](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductTag/page.mdx)[]","description":"The product's tags.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"inventory_items","type":"`null` \\| [AdminProductVariantInventoryItemLink](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariantInventoryItemLink/page.mdx)[]","description":"The variant's inventory items.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the pivot record.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string`","description":"The ID of the variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The ID of the inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[AdminProductVariant](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariant/page.mdx)","description":"The variant that the inventory item is linked to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory","type":"[AdminInventoryItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItem/page.mdx)","description":"The inventory item that is linked to the variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"required_quantity","type":"`number`","description":"The quantity of the inventory item that is required to fulfill the variant.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"inventory_quantity","type":"`null` \\| `number`","description":"The variant's inventory quantity if `manage_inventory` is enabled.\nThis field is only retrieved in the [Get Product](https://docs.medusajs.com/api/store#products\\_getproductsid)\nand [List Products](https://docs.medusajs.com/api/store#products\\_getproducts) API routes if you\npass `+variants.inventory_quantity` in the `fields` query parameter.\n\nLearn more in the [Retrieve Product Variant's Inventory](https://docs.medusajs.com/resources/storefront-development/products/inventory) storefront guide.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"The variant's ranking among its siblings.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The ID of the product that the variant belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_price","type":"[BaseCalculatedPriceSet](../../../../../types/interfaces/types.BaseCalculatedPriceSet/page.mdx)","description":"The variant's calculated price for the provided context.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_amount","type":"`null` \\| `number`","description":"The amount of the calculated price, or `null` if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_amount","type":"`null` \\| `number`","description":"The amount of the original price, or `null` if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_amount_with_tax","type":"`null` \\| `number`","description":"The amount of the original price with taxes included. If the original price is tax inclusive, this field will be the same as `original_amount`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_amount_without_tax","type":"`null` \\| `number`","description":"The amount of the original price without taxes included. If the original price is tax exclusive, this field will be the same as `original_amount`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"The currency code of the calculated price, or null if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_calculated_price_price_list","type":"`boolean`","description":"Whether the calculated price is associated with a price list. During the calculation process, if no valid price list is found,\nthe calculated price is set to the original price, which doesn't belong to a price list. In that case, the value of this property is `false`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_calculated_price_tax_inclusive","type":"`boolean`","description":"Whether the calculated price is tax inclusive.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_amount_with_tax","type":"`null` \\| `number`","description":"The amount of the calculated price with taxes included. If the calculated price is tax inclusive, this field will be the same as `calculated_amount`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_amount_without_tax","type":"`null` \\| `number`","description":"The amount of the calculated price without taxes included. If the calculated price is tax exclusive, this field will be the same as `calculated_amount`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_original_price_price_list","type":"`boolean`","description":"Whether the original price is associated with a price list. During the calculation process, if the price list of the calculated price is of type override,\nthe original price will be the same as the calculated price. In that case, the value of this property is `true`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_original_price_tax_inclusive","type":"`boolean`","description":"Whether the original price is tax inclusive.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_price","type":"`object`","description":"The details of the calculated price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_price","type":"`object`","description":"The details of the original price.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"`null` \\| [AdminProductType](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductType/page.mdx)","description":"The product's type.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The product type's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The product type's value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the product type was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the product type was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the product type was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`null` \\| [AdminProductOption](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductOption/page.mdx)[]","description":"The product's options.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The option's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [AdminProduct](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProduct/page.mdx)","description":"The associated product's details.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"variants","type":"`null` \\| [AdminProductVariant](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariant/page.mdx)[]","description":"The product's variants.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [AdminProductType](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductType/page.mdx)","description":"The product's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`null` \\| [AdminProductOption](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductOption/page.mdx)[]","description":"The product's options.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"`null` \\| [AdminProductImage](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductImage/page.mdx)[]","description":"The product's images.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The product's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product's handle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The product's subtitle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The product's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx)","description":"The product's status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The product's width.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The product's weight.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The product's length.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The product's height.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The product's origin country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The product's HS code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The product's MID code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The product's material.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the associated product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the associated product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in external systems.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string`","description":"The date the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string`","description":"The date the product was update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [AdminCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCollection/page.mdx)","description":"The product's collection.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [AdminProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx)[]","description":"The product's categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"`null` \\| [AdminSalesChannel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminSalesChannel/page.mdx)[]","description":"The sales channels that the product is available in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile","type":"`null` \\| [AdminShippingProfile](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminShippingProfile/page.mdx)","description":"The shipping profile that the product is available in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`null` \\| [AdminProductTag](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductTag/page.mdx)[]","description":"The product's tags.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"values","type":"[AdminProductOptionValue](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductOptionValue/page.mdx)[]","description":"The option's values.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The option value's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The option's value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [AdminProductOption](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductOption/page.mdx)","description":"The option's details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`null` \\| `string`","description":"The ID of the option.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the option value was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the option value was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the option value was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_id","type":"`null` \\| `string`","description":"The ID of the product that the option belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the option was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the option was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"`null` \\| [AdminProductImage](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductImage/page.mdx)[]","description":"The product's images.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The image's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The image's URL.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the image was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the image was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"The product's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The product's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product's handle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The product's subtitle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The product's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx)","description":"The product's status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The product's width.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The product's weight.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The product's length.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The product's height.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The product's origin country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The product's HS code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The product's MID code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The product's material.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the associated product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the associated product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in external systems.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string`","description":"The date the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string`","description":"The date the product was update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [AdminCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCollection/page.mdx)","description":"The product's collection.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The collection's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The collection's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The collection's handle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the collection was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the collection was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the collection was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[BaseProduct](../../../../../types/interfaces/types.BaseProduct/page.mdx)[]","description":"The collection's products.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The product's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The product's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product's handle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The product's subtitle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The product's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx)","description":"The product's status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The product's width.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The product's weight.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The product's length.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The product's height.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The product's origin country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The product's HS code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The product's MID code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The product's material.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the associated product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the associated product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"`null` \\| [BaseProductVariant](../../../../../types/interfaces/types.BaseProductVariant/page.mdx)[]","description":"The product's variants.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`null` \\| [BaseProductOption](../../../../../types/interfaces/types.BaseProductOption/page.mdx)[]","description":"The product's options.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"`null` \\| [BaseProductImage](../../../../../types/interfaces/types.BaseProductImage/page.mdx)[]","description":"The product's images.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in external systems.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string`","description":"The date the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string`","description":"The date the product was update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [BaseCollection](../../../../../types/interfaces/types.BaseCollection/page.mdx)","description":"The product's collection.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [BaseProductCategory](../../../../../types/interfaces/types.BaseProductCategory/page.mdx)[]","description":"The product's categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [BaseProductType](../../../../../types/interfaces/types.BaseProductType/page.mdx)","description":"The product's type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`null` \\| [BaseProductTag](../../../../../types/interfaces/types.BaseProductTag/page.mdx)[]","description":"The product's tags.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"categories","type":"`null` \\| [AdminProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx)[]","description":"The product's categories.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"category_children","type":"[AdminProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx)[]","description":"The category's children.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"category_children","type":"[AdminProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx)[]","description":"The category's children.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [AdminProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx)","description":"The parent category's details.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The category's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The category's name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The category's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product category's unique handle. Can be used to create\nhuman-readable URLs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the category is internal.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`null` \\| `number`","description":"The category's ranking among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The ID of the category's parent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the category was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[AdminProduct](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProduct/page.mdx)[]","description":"The products that belong to this category.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_category","type":"`null` \\| [AdminProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx)","description":"The parent category's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"category_children","type":"[AdminProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx)[]","description":"The category's children.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [AdminProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx)","description":"The parent category's details.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The category's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The category's name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The category's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product category's unique handle. Can be used to create\nhuman-readable URLs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the category is internal.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`null` \\| `number`","description":"The category's ranking among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The ID of the category's parent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the category was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[AdminProduct](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProduct/page.mdx)[]","description":"The products that belong to this category.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"The category's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The category's name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The category's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product category's unique handle. Can be used to create\nhuman-readable URLs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the category is internal.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`null` \\| `number`","description":"The category's ranking among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The ID of the category's parent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the category was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[AdminProduct](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProduct/page.mdx)[]","description":"The products that belong to this category.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"variants","type":"`null` \\| [AdminProductVariant](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariant/page.mdx)[]","description":"The product's variants.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [AdminProductType](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductType/page.mdx)","description":"The product's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`null` \\| [AdminProductOption](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductOption/page.mdx)[]","description":"The product's options.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"`null` \\| [AdminProductImage](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductImage/page.mdx)[]","description":"The product's images.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The product's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product's handle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The product's subtitle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The product's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx)","description":"The product's status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The product's width.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The product's weight.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The product's length.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The product's height.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The product's origin country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The product's HS code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The product's MID code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The product's material.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the associated product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the associated product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in external systems.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string`","description":"The date the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string`","description":"The date the product was update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [AdminCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCollection/page.mdx)","description":"The product's collection.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [AdminProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx)[]","description":"The product's categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"`null` \\| [AdminSalesChannel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminSalesChannel/page.mdx)[]","description":"The sales channels that the product is available in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile","type":"`null` \\| [AdminShippingProfile](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminShippingProfile/page.mdx)","description":"The shipping profile that the product is available in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`null` \\| [AdminProductTag](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductTag/page.mdx)[]","description":"The product's tags.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"`null` \\| [AdminSalesChannel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminSalesChannel/page.mdx)[]","description":"The sales channels that the product is available in.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The sales channel's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The sales channel's name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The sales channel's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the sales channel is disabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Custom key-value pairs that can be added to the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The sales channel's creation date.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The sales channel's last updated date.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The sales channel's deletion date.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_profile","type":"`null` \\| [AdminShippingProfile](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminShippingProfile/page.mdx)","description":"The shipping profile that the product is available in.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"The type of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Custom key-value pairs that can be added to the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date when the shipping profile was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date when the shipping profile was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date when the shipping profile was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tags","type":"`null` \\| [AdminProductTag](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductTag/page.mdx)[]","description":"The product's tags.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The tag's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The tag's value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the tag was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the tag was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the tag was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="generateProductCsvStep"/>
+`","description":"The price's raw amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity that must be available in the cart for the price to be applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity allowed to be available in the cart for the price to be applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the price set this price belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the price was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the price was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the price was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`null` \\| [AdminProductOptionValue](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductOptionValue/page.mdx)[]","description":"The variant's values for the associated product's options.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The option value's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The option's value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [AdminProductOption](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductOption/page.mdx)","description":"The option's details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`null` \\| `string`","description":"The ID of the option.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the option value was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the option value was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the option value was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"The variant's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`null` \\| `string`","description":"The variant's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The variant's SKU.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The variant's barcode.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The variant's EAN.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The variant's UPC.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The variant's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`null` \\| `boolean`","description":"Whether the variant can be ordered even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`null` \\| `boolean`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant\nis always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The variant's HS code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The variant's origin country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The variant's MID code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The variant's material.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The variant's weight.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The variant's length.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The variant's height.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The variant's width.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [AdminProduct](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProduct/page.mdx)","description":"The product that this variant belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"variants","type":"`null` \\| [AdminProductVariant](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariant/page.mdx)[]","description":"The product's variants.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [AdminProductType](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductType/page.mdx)","description":"The product's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`null` \\| [AdminProductOption](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductOption/page.mdx)[]","description":"The product's options.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"`null` \\| [AdminProductImage](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductImage/page.mdx)[]","description":"The product's images.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The product's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product's handle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The product's subtitle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The product's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx)","description":"The product's status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The product's width.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The product's weight.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The product's length.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The product's height.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The product's origin country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The product's HS code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The product's MID code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The product's material.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the associated product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the associated product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in external systems.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string`","description":"The date the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string`","description":"The date the product was update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [AdminCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCollection/page.mdx)","description":"The product's collection.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [AdminProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx)[]","description":"The product's categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"`null` \\| [AdminSalesChannel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminSalesChannel/page.mdx)[]","description":"The sales channels that the product is available in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile","type":"`null` \\| [AdminShippingProfile](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminShippingProfile/page.mdx)","description":"The shipping profile that the product is available in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`null` \\| [AdminProductTag](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductTag/page.mdx)[]","description":"The product's tags.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"inventory_items","type":"`null` \\| [AdminProductVariantInventoryItemLink](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariantInventoryItemLink/page.mdx)[]","description":"The variant's inventory items.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the pivot record.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string`","description":"The ID of the variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The ID of the inventory item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[AdminProductVariant](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariant/page.mdx)","description":"The variant that the inventory item is linked to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory","type":"[AdminInventoryItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItem/page.mdx)","description":"The inventory item that is linked to the variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"required_quantity","type":"`number`","description":"The quantity of the inventory item that is required to fulfill the variant.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"`null` \\| [AdminProductImage](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductImage/page.mdx)[]","description":"The variant's images.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The image's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The image's URL.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [AdminProduct](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProduct/page.mdx)","description":"The product that the image belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"`null` \\| [AdminProductVariant](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariant/page.mdx)[]","description":"The variants that the image is scoped to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the image was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the image was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"inventory_quantity","type":"`null` \\| `number`","description":"The variant's inventory quantity if `manage_inventory` is enabled.\nThis field is only retrieved in the [Get Product](https://docs.medusajs.com/api/store#products\\_getproductsid)\nand [List Products](https://docs.medusajs.com/api/store#products\\_getproducts) API routes if you\npass `+variants.inventory_quantity` in the `fields` query parameter.\n\nLearn more in the [Retrieve Product Variant's Inventory](https://docs.medusajs.com/resources/storefront-development/products/inventory) storefront guide.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"The variant's ranking among its siblings.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The ID of the product that the variant belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_price","type":"[BaseCalculatedPriceSet](../../../../../types/interfaces/types.BaseCalculatedPriceSet/page.mdx)","description":"The variant's calculated price for the provided context.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_amount","type":"`null` \\| `number`","description":"The amount of the calculated price, or `null` if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_amount","type":"`null` \\| `number`","description":"The amount of the original price, or `null` if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_amount_with_tax","type":"`null` \\| `number`","description":"The amount of the original price with taxes included. If the original price is tax inclusive, this field will be the same as `original_amount`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_amount_without_tax","type":"`null` \\| `number`","description":"The amount of the original price without taxes included. If the original price is tax exclusive, this field will be the same as `original_amount`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"The currency code of the calculated price, or null if there isn't a calculated price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_calculated_price_price_list","type":"`boolean`","description":"Whether the calculated price is associated with a price list. During the calculation process, if no valid price list is found,\nthe calculated price is set to the original price, which doesn't belong to a price list. In that case, the value of this property is `false`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_calculated_price_tax_inclusive","type":"`boolean`","description":"Whether the calculated price is tax inclusive.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_amount_with_tax","type":"`null` \\| `number`","description":"The amount of the calculated price with taxes included. If the calculated price is tax inclusive, this field will be the same as `calculated_amount`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_amount_without_tax","type":"`null` \\| `number`","description":"The amount of the calculated price without taxes included. If the calculated price is tax exclusive, this field will be the same as `calculated_amount`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_original_price_price_list","type":"`boolean`","description":"Whether the original price is associated with a price list. During the calculation process, if the price list of the calculated price is of type override,\nthe original price will be the same as the calculated price. In that case, the value of this property is `true`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_original_price_tax_inclusive","type":"`boolean`","description":"Whether the original price is tax inclusive.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_price","type":"`object`","description":"The details of the calculated price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_price","type":"`object`","description":"The details of the original price.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"`null` \\| [AdminProductType](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductType/page.mdx)","description":"The product's type.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The product type's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The product type's value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the product type was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the product type was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the product type was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`null` \\| [AdminProductOption](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductOption/page.mdx)[]","description":"The product's options.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The option's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [AdminProduct](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProduct/page.mdx)","description":"The associated product's details.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"variants","type":"`null` \\| [AdminProductVariant](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariant/page.mdx)[]","description":"The product's variants.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [AdminProductType](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductType/page.mdx)","description":"The product's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`null` \\| [AdminProductOption](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductOption/page.mdx)[]","description":"The product's options.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"`null` \\| [AdminProductImage](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductImage/page.mdx)[]","description":"The product's images.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The product's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product's handle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The product's subtitle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The product's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx)","description":"The product's status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The product's width.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The product's weight.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The product's length.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The product's height.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The product's origin country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The product's HS code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The product's MID code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The product's material.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the associated product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the associated product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in external systems.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string`","description":"The date the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string`","description":"The date the product was update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [AdminCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCollection/page.mdx)","description":"The product's collection.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [AdminProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx)[]","description":"The product's categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"`null` \\| [AdminSalesChannel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminSalesChannel/page.mdx)[]","description":"The sales channels that the product is available in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile","type":"`null` \\| [AdminShippingProfile](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminShippingProfile/page.mdx)","description":"The shipping profile that the product is available in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`null` \\| [AdminProductTag](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductTag/page.mdx)[]","description":"The product's tags.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"values","type":"[AdminProductOptionValue](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductOptionValue/page.mdx)[]","description":"The option's values.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The option value's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The option's value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [AdminProductOption](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductOption/page.mdx)","description":"The option's details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`null` \\| `string`","description":"The ID of the option.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the option value was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the option value was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the option value was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_id","type":"`null` \\| `string`","description":"The ID of the product that the option belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the option was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the option was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"`null` \\| [AdminProductImage](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductImage/page.mdx)[]","description":"The product's images.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The image's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The image's URL.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [AdminProduct](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProduct/page.mdx)","description":"The product that the image belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"variants","type":"`null` \\| [AdminProductVariant](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariant/page.mdx)[]","description":"The product's variants.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [AdminProductType](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductType/page.mdx)","description":"The product's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`null` \\| [AdminProductOption](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductOption/page.mdx)[]","description":"The product's options.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"`null` \\| [AdminProductImage](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductImage/page.mdx)[]","description":"The product's images.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The product's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product's handle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The product's subtitle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The product's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx)","description":"The product's status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The product's width.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The product's weight.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The product's length.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The product's height.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The product's origin country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The product's HS code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The product's MID code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The product's material.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the associated product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the associated product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in external systems.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string`","description":"The date the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string`","description":"The date the product was update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [AdminCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCollection/page.mdx)","description":"The product's collection.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [AdminProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx)[]","description":"The product's categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"`null` \\| [AdminSalesChannel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminSalesChannel/page.mdx)[]","description":"The sales channels that the product is available in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile","type":"`null` \\| [AdminShippingProfile](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminShippingProfile/page.mdx)","description":"The shipping profile that the product is available in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`null` \\| [AdminProductTag](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductTag/page.mdx)[]","description":"The product's tags.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variants","type":"`null` \\| [AdminProductVariant](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariant/page.mdx)[]","description":"The variants that the image is scoped to.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"prices","type":"`null` \\| [AdminPrice](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPrice/page.mdx)[]","description":"The product variant's prices.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`null` \\| [AdminProductOptionValue](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductOptionValue/page.mdx)[]","description":"The variant's values for the associated product's options.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The variant's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`null` \\| `string`","description":"The variant's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The variant's SKU.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The variant's barcode.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The variant's EAN.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The variant's UPC.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The variant's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`null` \\| `boolean`","description":"Whether the variant can be ordered even if it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`null` \\| `boolean`","description":"Whether Medusa manages the variant's inventory. If disabled, the variant\nis always considered in stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The variant's HS code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The variant's origin country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The variant's MID code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The variant's material.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The variant's weight.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The variant's length.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The variant's height.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The variant's width.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [AdminProduct](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProduct/page.mdx)","description":"The product that this variant belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_items","type":"`null` \\| [AdminProductVariantInventoryItemLink](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariantInventoryItemLink/page.mdx)[]","description":"The variant's inventory items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"`null` \\| [AdminProductImage](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductImage/page.mdx)[]","description":"The variant's images.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_quantity","type":"`null` \\| `number`","description":"The variant's inventory quantity if `manage_inventory` is enabled.\nThis field is only retrieved in the [Get Product](https://docs.medusajs.com/api/store#products\\_getproductsid)\nand [List Products](https://docs.medusajs.com/api/store#products\\_getproducts) API routes if you\npass `+variants.inventory_quantity` in the `fields` query parameter.\n\nLearn more in the [Retrieve Product Variant's Inventory](https://docs.medusajs.com/resources/storefront-development/products/inventory) storefront guide.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"The variant's ranking among its siblings.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The ID of the product that the variant belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"calculated_price","type":"[BaseCalculatedPriceSet](../../../../../types/interfaces/types.BaseCalculatedPriceSet/page.mdx)","description":"The variant's calculated price for the provided context.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string`","description":"The date the image was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the image was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"The product's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The product's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product's handle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The product's subtitle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The product's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx)","description":"The product's status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The product's width.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The product's weight.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The product's length.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The product's height.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The product's origin country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The product's HS code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The product's MID code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The product's material.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the associated product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the associated product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in external systems.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string`","description":"The date the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string`","description":"The date the product was update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [AdminCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCollection/page.mdx)","description":"The product's collection.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The collection's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The collection's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The collection's handle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the collection was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the collection was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the collection was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[BaseProduct](../../../../../types/interfaces/types.BaseProduct/page.mdx)[]","description":"The collection's products.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The product's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The product's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product's handle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The product's subtitle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The product's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx)","description":"The product's status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The product's width.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The product's weight.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The product's length.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The product's height.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The product's origin country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The product's HS code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The product's MID code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The product's material.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the associated product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the associated product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"`null` \\| [BaseProductVariant](../../../../../types/interfaces/types.BaseProductVariant/page.mdx)[]","description":"The product's variants.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`null` \\| [BaseProductOption](../../../../../types/interfaces/types.BaseProductOption/page.mdx)[]","description":"The product's options.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"`null` \\| [BaseProductImage](../../../../../types/interfaces/types.BaseProductImage/page.mdx)[]","description":"The product's images.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in external systems.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string`","description":"The date the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string`","description":"The date the product was update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [BaseCollection](../../../../../types/interfaces/types.BaseCollection/page.mdx)","description":"The product's collection.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [BaseProductCategory](../../../../../types/interfaces/types.BaseProductCategory/page.mdx)[]","description":"The product's categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [BaseProductType](../../../../../types/interfaces/types.BaseProductType/page.mdx)","description":"The product's type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`null` \\| [BaseProductTag](../../../../../types/interfaces/types.BaseProductTag/page.mdx)[]","description":"The product's tags.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"categories","type":"`null` \\| [AdminProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx)[]","description":"The product's categories.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"category_children","type":"[AdminProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx)[]","description":"The category's children.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"category_children","type":"[AdminProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx)[]","description":"The category's children.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [AdminProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx)","description":"The parent category's details.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The category's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The category's name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The category's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product category's unique handle. Can be used to create\nhuman-readable URLs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the category is internal.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`null` \\| `number`","description":"The category's ranking among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The ID of the category's parent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the category was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[AdminProduct](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProduct/page.mdx)[]","description":"The products that belong to this category.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_category","type":"`null` \\| [AdminProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx)","description":"The parent category's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"category_children","type":"[AdminProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx)[]","description":"The category's children.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [AdminProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx)","description":"The parent category's details.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The category's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The category's name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The category's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product category's unique handle. Can be used to create\nhuman-readable URLs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the category is internal.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`null` \\| `number`","description":"The category's ranking among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The ID of the category's parent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the category was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[AdminProduct](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProduct/page.mdx)[]","description":"The products that belong to this category.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"The category's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The category's name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The category's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product category's unique handle. Can be used to create\nhuman-readable URLs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the category is internal.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`null` \\| `number`","description":"The category's ranking among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The ID of the category's parent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the category was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[AdminProduct](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProduct/page.mdx)[]","description":"The products that belong to this category.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"variants","type":"`null` \\| [AdminProductVariant](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductVariant/page.mdx)[]","description":"The product's variants.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [AdminProductType](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductType/page.mdx)","description":"The product's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`null` \\| [AdminProductOption](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductOption/page.mdx)[]","description":"The product's options.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"`null` \\| [AdminProductImage](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductImage/page.mdx)[]","description":"The product's images.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The product's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product's handle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The product's subtitle.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The product's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx)","description":"The product's status.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The product's width.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The product's weight.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The product's length.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The product's height.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The product's origin country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The product's HS code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The product's MID code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The product's material.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the associated product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the associated product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in external systems.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string`","description":"The date the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string`","description":"The date the product was update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [AdminCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCollection/page.mdx)","description":"The product's collection.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [AdminProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategory/page.mdx)[]","description":"The product's categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"`null` \\| [AdminSalesChannel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminSalesChannel/page.mdx)[]","description":"The sales channels that the product is available in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile","type":"`null` \\| [AdminShippingProfile](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminShippingProfile/page.mdx)","description":"The shipping profile that the product is available in.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`null` \\| [AdminProductTag](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductTag/page.mdx)[]","description":"The product's tags.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"`null` \\| [AdminSalesChannel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminSalesChannel/page.mdx)[]","description":"The sales channels that the product is available in.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The sales channel's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The sales channel's name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The sales channel's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the sales channel is disabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Custom key-value pairs that can be added to the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The sales channel's creation date.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The sales channel's last updated date.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The sales channel's deletion date.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_profile","type":"`null` \\| [AdminShippingProfile](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminShippingProfile/page.mdx)","description":"The shipping profile that the product is available in.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"The type of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Custom key-value pairs that can be added to the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date when the shipping profile was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date when the shipping profile was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date when the shipping profile was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tags","type":"`null` \\| [AdminProductTag](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductTag/page.mdx)[]","description":"The product's tags.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The tag's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The tag's value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the tag was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the tag was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the tag was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="generateProductCsvStep"/>
## Output
diff --git a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.getProductsStep/page.mdx b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.getProductsStep/page.mdx
index 3d8c3b1550..dd91e2a680 100644
--- a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.getProductsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.getProductsStep/page.mdx
@@ -33,4 +33,4 @@ const myWorkflow = createWorkflow(
## Output
-`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option value was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option value was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)","description":"The associated product option. It may only be available if the `option` relation is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`null` \\| `string`","description":"The associated product option id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option value was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="getProductsStep"/>
+`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option value was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option value was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)","description":"The associated product option. It may only be available if the `option` relation is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`null` \\| `string`","description":"The associated product option id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option value was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="getProductsStep"/>
diff --git a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.removeImageFromVariantsStep/page.mdx b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.removeImageFromVariantsStep/page.mdx
new file mode 100644
index 0000000000..70a84d7f61
--- /dev/null
+++ b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.removeImageFromVariantsStep/page.mdx
@@ -0,0 +1,38 @@
+---
+slug: /references/medusa-workflows/steps/removeImageFromVariantsStep
+sidebar_label: removeImageFromVariantsStep
+tags:
+ - product
+ - step
+---
+
+import { TypeList, WorkflowDiagram } from "docs-ui"
+
+# removeImageFromVariantsStep - Medusa Core Workflows Reference
+
+This documentation provides a reference to the `removeImageFromVariantsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
+
+This step removes an image from one or more product variants.
+
+:::note
+
+This is available starting from [Medusa v2.11.2](https://github.com/medusajs/medusa/releases/tag/v2.11.2).
+
+:::
+
+## Example
+
+```ts
+const data = removeImageFromVariantsStep({
+ image_id: "img_123",
+ remove: ["variant_123", "variant_456"]
+})
+```
+
+## Input
+
+
+
+## Output
+
+
diff --git a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.removeImagesFromVariantStep/page.mdx b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.removeImagesFromVariantStep/page.mdx
new file mode 100644
index 0000000000..e9ac331858
--- /dev/null
+++ b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.removeImagesFromVariantStep/page.mdx
@@ -0,0 +1,38 @@
+---
+slug: /references/medusa-workflows/steps/removeImagesFromVariantStep
+sidebar_label: removeImagesFromVariantStep
+tags:
+ - product
+ - step
+---
+
+import { TypeList, WorkflowDiagram } from "docs-ui"
+
+# removeImagesFromVariantStep - Medusa Core Workflows Reference
+
+This documentation provides a reference to the `removeImagesFromVariantStep`. It belongs to the `@medusajs/medusa/core-flows` package.
+
+This step removes one or more images from a product variant.
+
+:::note
+
+This is available starting from [Medusa v2.11.2](https://github.com/medusajs/medusa/releases/tag/v2.11.2).
+
+:::
+
+## Example
+
+```ts
+const data = removeImagesFromVariantStep({
+ variant_id: "variant_123",
+ remove: ["img_123", "img_456"]
+})
+```
+
+## Input
+
+
+
+## Output
+
+
diff --git a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateCollectionsStep/page.mdx b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateCollectionsStep/page.mdx
index 5f01f20c30..68f0d74f7d 100644
--- a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateCollectionsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateCollectionsStep/page.mdx
@@ -33,4 +33,4 @@ const data = updateCollectionsStep({
## Output
-`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="updateCollectionsStep"/>
+`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="updateCollectionsStep"/>
diff --git a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductOptionsStep/page.mdx b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductOptionsStep/page.mdx
index c649b513a0..1cd8150a2a 100644
--- a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductOptionsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductOptionsStep/page.mdx
@@ -33,4 +33,4 @@ const data = updateProductOptionsStep({
## Output
-`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="updateProductOptionsStep"/>
+`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="updateProductOptionsStep"/>
diff --git a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductTagsStep/page.mdx b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductTagsStep/page.mdx
index 3a53af115b..82c6b9ff70 100644
--- a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductTagsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductTagsStep/page.mdx
@@ -33,4 +33,4 @@ const data = updateProductTagsStep({
## Output
-`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="updateProductTagsStep"/>
+`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="updateProductTagsStep"/>
diff --git a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductVariantsStep/page.mdx b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductVariantsStep/page.mdx
index 65540a157b..63070dc256 100644
--- a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductVariantsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductVariantsStep/page.mdx
@@ -44,8 +44,8 @@ const data = updateProductVariantsStep({
## Input
-`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"update","type":"[UpdateProductVariantDTO](../../../../../product/interfaces/product.UpdateProductVariantDTO/page.mdx)","description":"The data to update the product variants with.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record`","description":"The product variant options to associate with the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_variants","type":"[UpsertProductVariantDTO](../../../../../product/interfaces/product.UpsertProductVariantDTO/page.mdx)[]","description":"The data to create or update product variants.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product variant to update.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record`","description":"The product variant options to associate with the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="updateProductVariantsStep"/>
+`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"update","type":"[UpdateProductVariantDTO](../../../../../product/interfaces/product.UpdateProductVariantDTO/page.mdx)","description":"The data to update the product variants with.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The thumbnail of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record`","description":"The product variant options to associate with the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_variants","type":"[UpsertProductVariantDTO](../../../../../product/interfaces/product.UpsertProductVariantDTO/page.mdx)[]","description":"The data to create or update product variants.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product variant to update.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The thumbnail of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record`","description":"The product variant options to associate with the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="updateProductVariantsStep"/>
## Output
-`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product collection. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product collection was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product collection was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product collection was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product type was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product type was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product type was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the product variant's requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="updateProductVariantsStep"/>
+`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product collection. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product collection was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product collection was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product collection was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product type was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product type was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product type was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The thumbnail of the product variant form the product images.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the product variant's requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="updateProductVariantsStep"/>
diff --git a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductsStep/page.mdx b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductsStep/page.mdx
index f16ee83b2d..08dff82dea 100644
--- a/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductsStep/page.mdx
+++ b/www/apps/resources/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.updateProductsStep/page.mdx
@@ -44,8 +44,8 @@ const data = updateProductsStep({
## Input
-`","description":"The product variant options to associate with the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"products","type":"[UpsertProductDTO](../../../../../product/interfaces/product.UpsertProductDTO/page.mdx)[]","description":"The data to create or update products.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product to update. If not provided, a product\nis created instead. In that case, the `title` property is required.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.\nIf not supplied, the value of the `handle` attribute of the product is set to the slug version of the `title` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[UpsertProductImageDTO](../../../../../product/interfaces/product.UpsertProductImageDTO/page.mdx)[]","description":"The associated images to create or update.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The product image's ID. If not provided, the image is created. In\nthat case, the `url` property is required.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The new URL of the product image.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The id of the product in an external system","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The product type to associate with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The product collection to associate with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tag_ids","type":"`string`[]","description":"The tags to associate with the product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"category_ids","type":"`string`[]","description":"The product categories to associate with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[UpsertProductOptionDTO](../../../../../product/interfaces/product.UpsertProductOptionDTO/page.mdx)[]","description":"The associated options to create or update.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product option to update. If not provided, the product\noption is created. In that case, the `title` and `values` properties are\nrequired.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The product option's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"`string`[]","description":"The product option values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The ID of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variants","type":"[UpsertProductVariantDTO](../../../../../product/interfaces/product.UpsertProductVariantDTO/page.mdx)[]","description":"The product variants to be created and associated with the product.\nYou can also update existing product variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product variant to update.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record`","description":"The product variant options to associate with the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="updateProductsStep"/>
+`","description":"The product variant options to associate with the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"products","type":"[UpsertProductDTO](../../../../../product/interfaces/product.UpsertProductDTO/page.mdx)[]","description":"The data to create or update products.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product to update. If not provided, a product\nis created instead. In that case, the `title` property is required.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.\nIf not supplied, the value of the `handle` attribute of the product is set to the slug version of the `title` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[UpsertProductImageDTO](../../../../../product/interfaces/product.UpsertProductImageDTO/page.mdx)[]","description":"The associated images to create or update.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The product image's ID. If not provided, the image is created. In\nthat case, the `url` property is required.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The new URL of the product image.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The id of the product in an external system","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The product type to associate with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The product collection to associate with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tag_ids","type":"`string`[]","description":"The tags to associate with the product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"category_ids","type":"`string`[]","description":"The product categories to associate with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[UpsertProductOptionDTO](../../../../../product/interfaces/product.UpsertProductOptionDTO/page.mdx)[]","description":"The associated options to create or update.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product option to update. If not provided, the product\noption is created. In that case, the `title` and `values` properties are\nrequired.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The product option's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"`string`[]","description":"The product option values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The ID of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variants","type":"[UpsertProductVariantDTO](../../../../../product/interfaces/product.UpsertProductVariantDTO/page.mdx)[]","description":"The product variants to be created and associated with the product.\nYou can also update existing product variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product variant to update.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The thumbnail of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record`","description":"The product variant options to associate with the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="updateProductsStep"/>
## Output
-`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option value was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option value was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)","description":"The associated product option. It may only be available if the `option` relation is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`null` \\| `string`","description":"The associated product option id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option value was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="updateProductsStep"/>
+`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option value was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option value was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)","description":"The associated product option. It may only be available if the `option` relation is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`null` \\| `string`","description":"The associated product option id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option value was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="updateProductsStep"/>
diff --git a/www/apps/resources/references/core_flows/Product/Steps_Product/variables/core_flows.Product.Steps_Product.addImageToVariantsStepId/page.mdx b/www/apps/resources/references/core_flows/Product/Steps_Product/variables/core_flows.Product.Steps_Product.addImageToVariantsStepId/page.mdx
new file mode 100644
index 0000000000..99aa6fa9ee
--- /dev/null
+++ b/www/apps/resources/references/core_flows/Product/Steps_Product/variables/core_flows.Product.Steps_Product.addImageToVariantsStepId/page.mdx
@@ -0,0 +1,5 @@
+import { TypeList, WorkflowDiagram } from "docs-ui"
+
+# addImageToVariantsStepId
+
+ `Const` **addImageToVariantsStepId**: `"add-image-to-variants"`
diff --git a/www/apps/resources/references/core_flows/Product/Steps_Product/variables/core_flows.Product.Steps_Product.addImagesToVariantStepId/page.mdx b/www/apps/resources/references/core_flows/Product/Steps_Product/variables/core_flows.Product.Steps_Product.addImagesToVariantStepId/page.mdx
new file mode 100644
index 0000000000..13f14c66f3
--- /dev/null
+++ b/www/apps/resources/references/core_flows/Product/Steps_Product/variables/core_flows.Product.Steps_Product.addImagesToVariantStepId/page.mdx
@@ -0,0 +1,5 @@
+import { TypeList, WorkflowDiagram } from "docs-ui"
+
+# addImagesToVariantStepId
+
+ `Const` **addImagesToVariantStepId**: `"add-images-to-variant"`
diff --git a/www/apps/resources/references/core_flows/Product/Steps_Product/variables/core_flows.Product.Steps_Product.removeImageFromVariantsStepId/page.mdx b/www/apps/resources/references/core_flows/Product/Steps_Product/variables/core_flows.Product.Steps_Product.removeImageFromVariantsStepId/page.mdx
new file mode 100644
index 0000000000..610a60ab30
--- /dev/null
+++ b/www/apps/resources/references/core_flows/Product/Steps_Product/variables/core_flows.Product.Steps_Product.removeImageFromVariantsStepId/page.mdx
@@ -0,0 +1,5 @@
+import { TypeList, WorkflowDiagram } from "docs-ui"
+
+# removeImageFromVariantsStepId
+
+ `Const` **removeImageFromVariantsStepId**: `"remove-image-from-variants"`
diff --git a/www/apps/resources/references/core_flows/Product/Steps_Product/variables/core_flows.Product.Steps_Product.removeImagesFromVariantStepId/page.mdx b/www/apps/resources/references/core_flows/Product/Steps_Product/variables/core_flows.Product.Steps_Product.removeImagesFromVariantStepId/page.mdx
new file mode 100644
index 0000000000..519a0128de
--- /dev/null
+++ b/www/apps/resources/references/core_flows/Product/Steps_Product/variables/core_flows.Product.Steps_Product.removeImagesFromVariantStepId/page.mdx
@@ -0,0 +1,5 @@
+import { TypeList, WorkflowDiagram } from "docs-ui"
+
+# removeImagesFromVariantStepId
+
+ `Const` **removeImagesFromVariantStepId**: `"remove-images-from-variant"`
diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchImageVariantsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchImageVariantsWorkflow/page.mdx
new file mode 100644
index 0000000000..f9cd661940
--- /dev/null
+++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchImageVariantsWorkflow/page.mdx
@@ -0,0 +1,153 @@
+---
+slug: /references/medusa-workflows/batchImageVariantsWorkflow
+sidebar_label: batchImageVariantsWorkflow
+sidebar_description: Manage image-variant associations in bulk.
+tags:
+ - product
+ - workflow
+---
+
+import { TypeList, WorkflowDiagram } from "docs-ui"
+
+# batchImageVariantsWorkflow - Medusa Core Workflows Reference
+
+This documentation provides a reference to the `batchImageVariantsWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
+
+This workflow manages the association between product images and variants in bulk.
+It's used by the [Batch Image Variants Admin API Route](https://docs.medusajs.com/api/admin#products\_postproductsidimagesimage\_idvariantsbatch).
+
+You can use this workflow within your own customizations or custom workflows to manage image-variant associations in bulk.
+This is also useful when writing a [seed script](https://docs.medusajs.com/learn/fundamentals/custom-cli-scripts/seed-data) or a custom import script.
+
+:::note
+
+This is available starting from [Medusa v2.11.2](https://github.com/medusajs/medusa/releases/tag/v2.11.2).
+
+:::
+
+
+
+## Examples
+
+
+
+
+```ts title="src/api/workflow/route.ts"
+import type {
+ MedusaRequest,
+ MedusaResponse,
+} from "@medusajs/framework/http"
+import { batchImageVariantsWorkflow } from "@medusajs/medusa/core-flows"
+
+export async function POST(
+ req: MedusaRequest,
+ res: MedusaResponse
+) {
+ const { result } = await batchImageVariantsWorkflow(req.scope)
+ .run({
+ input: {
+ image_id: "img_123",
+ add: ["variant_123", "variant_456"],
+ remove: ["variant_789"]
+ }
+ })
+
+ res.send(result)
+}
+```
+
+
+
+
+```ts title="src/subscribers/order-placed.ts"
+import {
+ type SubscriberConfig,
+ type SubscriberArgs,
+} from "@medusajs/framework"
+import { batchImageVariantsWorkflow } from "@medusajs/medusa/core-flows"
+
+export default async function handleOrderPlaced({
+ event: { data },
+ container,
+}: SubscriberArgs < { id: string } > ) {
+ const { result } = await batchImageVariantsWorkflow(container)
+ .run({
+ input: {
+ image_id: "img_123",
+ add: ["variant_123", "variant_456"],
+ remove: ["variant_789"]
+ }
+ })
+
+ console.log(result)
+}
+
+export const config: SubscriberConfig = {
+ event: "order.placed",
+}
+```
+
+
+
+
+```ts title="src/jobs/message-daily.ts"
+import { MedusaContainer } from "@medusajs/framework/types"
+import { batchImageVariantsWorkflow } from "@medusajs/medusa/core-flows"
+
+export default async function myCustomJob(
+ container: MedusaContainer
+) {
+ const { result } = await batchImageVariantsWorkflow(container)
+ .run({
+ input: {
+ image_id: "img_123",
+ add: ["variant_123", "variant_456"],
+ remove: ["variant_789"]
+ }
+ })
+
+ console.log(result)
+}
+
+export const config = {
+ name: "run-once-a-day",
+ schedule: "0 0 * * *",
+}
+```
+
+
+
+
+```ts title="src/workflows/my-workflow.ts"
+import { createWorkflow } from "@medusajs/framework/workflows-sdk"
+import { batchImageVariantsWorkflow } from "@medusajs/medusa/core-flows"
+
+const myWorkflow = createWorkflow(
+ "my-workflow",
+ () => {
+ const result = batchImageVariantsWorkflow
+ .runAsStep({
+ input: {
+ image_id: "img_123",
+ add: ["variant_123", "variant_456"],
+ remove: ["variant_789"]
+ }
+ })
+ }
+)
+```
+
+
+
+
+## Steps
+
+
+
+## Input
+
+
+
+## Output
+
+
diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchLinkProductsToCategoryWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchLinkProductsToCategoryWorkflow/page.mdx
index b66821f9e2..30b2f65fc6 100644
--- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchLinkProductsToCategoryWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchLinkProductsToCategoryWorkflow/page.mdx
@@ -18,7 +18,7 @@ This workflow manages the links between a category and products. It's used by th
You can use this workflow within your own customizations or custom workflows to manage the products in a category.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchLinkProductsToCollectionWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchLinkProductsToCollectionWorkflow/page.mdx
index f3f8824668..557caa649b 100644
--- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchLinkProductsToCollectionWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchLinkProductsToCollectionWorkflow/page.mdx
@@ -18,7 +18,7 @@ This workflow manages the links between a collection and products. It's used by
You can use this workflow within your own customizations or custom workflows to manage the products in a collection.
-
+
## Examples
diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchProductVariantsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchProductVariantsWorkflow/page.mdx
index 02da33f54a..cf62975f21 100644
--- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchProductVariantsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchProductVariantsWorkflow/page.mdx
@@ -25,7 +25,7 @@ This workflow creates, updates, and deletes product variants. It's used by the
You can use this workflow within your own customizations or custom workflows to manage the variants of a product. You can also
use this within a [seed script](https://docs.medusajs.com/learn/fundamentals/custom-cli-scripts/seed-data) or in a custom import script.
-
+
## Examples
@@ -198,22 +198,18 @@ const myWorkflow = createWorkflow(
## Input
-`","description":"The options of the variant. Each key is an option's title, and value\nis an option's value. If an option with the specified title doesn't exist,\na new one is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[CreateMoneyAmountDTO](../../../../../pricing/interfaces/pricing.CreateMoneyAmountDTO/page.mdx)[]","description":"The variant's prices.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| [BigNumberInput](../../../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| [BigNumberInput](../../../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"update","type":"[UpdateProductVariantWorkflowInputDTO](../../../../../types/types/types.UpdateProductVariantWorkflowInputDTO/page.mdx)[]","description":"Records to update in bulk.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product variant to update.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record`","description":"The product variant options to associate with the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[CreateMoneyAmountDTO](../../../../../pricing/interfaces/pricing.CreateMoneyAmountDTO/page.mdx)[]","description":"The variant's prices.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| [BigNumberInput](../../../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| [BigNumberInput](../../../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"delete","type":"`string`[]","description":"Records to delete in bulk.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="batchProductVariantsWorkflow"/>
+`","description":"The options of the variant. Each key is an option's title, and value\nis an option's value. If an option with the specified title doesn't exist,\na new one is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[CreateMoneyAmountDTO](../../../../../pricing/interfaces/pricing.CreateMoneyAmountDTO/page.mdx)[]","description":"The variant's prices.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| [BigNumberInput](../../../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| [BigNumberInput](../../../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"update","type":"[UpdateProductVariantWorkflowInputDTO](../../../../../types/types/types.UpdateProductVariantWorkflowInputDTO/page.mdx)[]","description":"Records to update in bulk.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product variant to update.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The thumbnail of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record`","description":"The product variant options to associate with the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[CreateMoneyAmountDTO](../../../../../pricing/interfaces/pricing.CreateMoneyAmountDTO/page.mdx)[]","description":"The variant's prices.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| [BigNumberInput](../../../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| [BigNumberInput](../../../../../pricing/types/pricing.BigNumberInput/page.mdx)","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"delete","type":"`string`[]","description":"Records to delete in bulk.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="batchProductVariantsWorkflow"/>
## Output
-`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The records that were updated in the bulk operation.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the product variant's requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option value was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option value was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)","description":"The associated product option. It may only be available if the `option` relation is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`null` \\| `string`","description":"The associated product option id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option value was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted","type":"`string`[]","description":"The IDs of the records deleted in the bulk operation.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="batchProductVariantsWorkflow"/>
+`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The records that were updated in the bulk operation.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The thumbnail of the product variant form the product images.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the product variant's requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option value was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option value was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)","description":"The associated product option. It may only be available if the `option` relation is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`null` \\| `string`","description":"The associated product option id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option value was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted","type":"`string`[]","description":"The IDs of the records deleted in the bulk operation.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="batchProductVariantsWorkflow"/>
## Emitted Events
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchProductsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchProductsWorkflow/page.mdx
index b6fb900501..0fc8b95037 100644
--- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchProductsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchProductsWorkflow/page.mdx
@@ -18,7 +18,7 @@ This workflow creates, updates, or deletes products. It's used by the
You can use this workflow within your own customizations or custom workflows to manage products in bulk. This is
also useful when writing a [seed script](https://docs.medusajs.com/learn/fundamentals/custom-cli-scripts/seed-data) or a custom import script.
-
+
## Examples
@@ -211,22 +211,18 @@ const myWorkflow = createWorkflow(
## Input
-`","description":"The options of the variant. Each key is an option's title, and value\nis an option's value. If an option with the specified title doesn't exist,\na new one is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[CreateMoneyAmountDTO](../../../../../pricing/interfaces/pricing.CreateMoneyAmountDTO/page.mdx)[]","description":"The variant's prices.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"update","type":"[UpdateProductWorkflowInputDTO](../../../../../types/types/types.UpdateProductWorkflowInputDTO/page.mdx)[]","description":"Records to update in bulk.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product to update. If not provided, a product\nis created instead. In that case, the `title` property is required.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.\nIf not supplied, the value of the `handle` attribute of the product is set to the slug version of the `title` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[UpsertProductImageDTO](../../../../../product/interfaces/product.UpsertProductImageDTO/page.mdx)[]","description":"The associated images to create or update.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The product image's ID. If not provided, the image is created. In\nthat case, the `url` property is required.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The new URL of the product image.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The id of the product in an external system","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The product type to associate with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The product collection to associate with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tag_ids","type":"`string`[]","description":"The tags to associate with the product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"category_ids","type":"`string`[]","description":"The product categories to associate with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[UpsertProductOptionDTO](../../../../../product/interfaces/product.UpsertProductOptionDTO/page.mdx)[]","description":"The associated options to create or update.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product option to update. If not provided, the product\noption is created. In that case, the `title` and `values` properties are\nrequired.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The product option's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"`string`[]","description":"The product option values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The ID of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variants","type":"[UpsertProductVariantDTO](../../../../../product/interfaces/product.UpsertProductVariantDTO/page.mdx)[]","description":"The product variants to be created and associated with the product.\nYou can also update existing product variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product variant to update.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record`","description":"The product variant options to associate with the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_profile_id","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"delete","type":"`string`[]","description":"Records to delete in bulk.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="batchProductsWorkflow"/>
+`","description":"The options of the variant. Each key is an option's title, and value\nis an option's value. If an option with the specified title doesn't exist,\na new one is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[CreateMoneyAmountDTO](../../../../../pricing/interfaces/pricing.CreateMoneyAmountDTO/page.mdx)[]","description":"The variant's prices.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"update","type":"[UpdateProductWorkflowInputDTO](../../../../../types/types/types.UpdateProductWorkflowInputDTO/page.mdx)[]","description":"Records to update in bulk.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product to update. If not provided, a product\nis created instead. In that case, the `title` property is required.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.\nIf not supplied, the value of the `handle` attribute of the product is set to the slug version of the `title` attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[UpsertProductImageDTO](../../../../../product/interfaces/product.UpsertProductImageDTO/page.mdx)[]","description":"The associated images to create or update.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The product image's ID. If not provided, the image is created. In\nthat case, the `url` property is required.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The new URL of the product image.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The id of the product in an external system","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The product type to associate with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The product collection to associate with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tag_ids","type":"`string`[]","description":"The tags to associate with the product","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"category_ids","type":"`string`[]","description":"The product categories to associate with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[UpsertProductOptionDTO](../../../../../product/interfaces/product.UpsertProductOptionDTO/page.mdx)[]","description":"The associated options to create or update.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product option to update. If not provided, the product\noption is created. In that case, the `title` and `values` properties are\nrequired.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The product option's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"`string`[]","description":"The product option values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The ID of the associated product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variants","type":"[UpsertProductVariantDTO](../../../../../product/interfaces/product.UpsertProductVariantDTO/page.mdx)[]","description":"The product variants to be created and associated with the product.\nYou can also update existing product variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product variant to update.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The thumbnail of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record`","description":"The product variant options to associate with the product variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_profile_id","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"delete","type":"`string`[]","description":"Records to delete in bulk.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="batchProductsWorkflow"/>
## Output
-`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="batchProductsWorkflow"/>
+`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="batchProductsWorkflow"/>
## Emitted Events
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchVariantImagesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchVariantImagesWorkflow/page.mdx
new file mode 100644
index 0000000000..78dcfdae05
--- /dev/null
+++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.batchVariantImagesWorkflow/page.mdx
@@ -0,0 +1,153 @@
+---
+slug: /references/medusa-workflows/batchVariantImagesWorkflow
+sidebar_label: batchVariantImagesWorkflow
+sidebar_description: Manage variant-image associations in bulk.
+tags:
+ - product
+ - workflow
+---
+
+import { TypeList, WorkflowDiagram } from "docs-ui"
+
+# batchVariantImagesWorkflow - Medusa Core Workflows Reference
+
+This documentation provides a reference to the `batchVariantImagesWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
+
+This workflow manages the association between product variants and images in bulk.
+It's used by the [Batch Variant Images Admin API Route](https://docs.medusajs.com/api/admin#products\_postproductsidvariantsvariant\_idimagesbatch).
+
+You can use this workflow within your own customizations or custom workflows to manage variant-image associations in bulk.
+This is also useful when writing a [seed script](https://docs.medusajs.com/learn/fundamentals/custom-cli-scripts/seed-data) or a custom import script.
+
+:::note
+
+This is available starting from [Medusa v2.11.2](https://github.com/medusajs/medusa/releases/tag/v2.11.2).
+
+:::
+
+
+
+## Examples
+
+
+
+
+```ts title="src/api/workflow/route.ts"
+import type {
+ MedusaRequest,
+ MedusaResponse,
+} from "@medusajs/framework/http"
+import { batchVariantImagesWorkflow } from "@medusajs/medusa/core-flows"
+
+export async function POST(
+ req: MedusaRequest,
+ res: MedusaResponse
+) {
+ const { result } = await batchVariantImagesWorkflow(req.scope)
+ .run({
+ input: {
+ variant_id: "variant_123",
+ add: ["img_123", "img_456"],
+ remove: ["img_789"]
+ }
+ })
+
+ res.send(result)
+}
+```
+
+
+
+
+```ts title="src/subscribers/order-placed.ts"
+import {
+ type SubscriberConfig,
+ type SubscriberArgs,
+} from "@medusajs/framework"
+import { batchVariantImagesWorkflow } from "@medusajs/medusa/core-flows"
+
+export default async function handleOrderPlaced({
+ event: { data },
+ container,
+}: SubscriberArgs < { id: string } > ) {
+ const { result } = await batchVariantImagesWorkflow(container)
+ .run({
+ input: {
+ variant_id: "variant_123",
+ add: ["img_123", "img_456"],
+ remove: ["img_789"]
+ }
+ })
+
+ console.log(result)
+}
+
+export const config: SubscriberConfig = {
+ event: "order.placed",
+}
+```
+
+
+
+
+```ts title="src/jobs/message-daily.ts"
+import { MedusaContainer } from "@medusajs/framework/types"
+import { batchVariantImagesWorkflow } from "@medusajs/medusa/core-flows"
+
+export default async function myCustomJob(
+ container: MedusaContainer
+) {
+ const { result } = await batchVariantImagesWorkflow(container)
+ .run({
+ input: {
+ variant_id: "variant_123",
+ add: ["img_123", "img_456"],
+ remove: ["img_789"]
+ }
+ })
+
+ console.log(result)
+}
+
+export const config = {
+ name: "run-once-a-day",
+ schedule: "0 0 * * *",
+}
+```
+
+
+
+
+```ts title="src/workflows/my-workflow.ts"
+import { createWorkflow } from "@medusajs/framework/workflows-sdk"
+import { batchVariantImagesWorkflow } from "@medusajs/medusa/core-flows"
+
+const myWorkflow = createWorkflow(
+ "my-workflow",
+ () => {
+ const result = batchVariantImagesWorkflow
+ .runAsStep({
+ input: {
+ variant_id: "variant_123",
+ add: ["img_123", "img_456"],
+ remove: ["img_789"]
+ }
+ })
+ }
+)
+```
+
+
+
+
+## Steps
+
+
+
+## Input
+
+
+
+## Output
+
+
diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createCollectionsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createCollectionsWorkflow/page.mdx
index 7e782e512b..a31f75c243 100644
--- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createCollectionsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createCollectionsWorkflow/page.mdx
@@ -14,15 +14,15 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
This documentation provides a reference to the `createCollectionsWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
-This workflow creates one or more collections. It's used by the
+This workflow creates one or more collections. It's used by the
[Create Collection Admin API Route](https://docs.medusajs.com/api/admin#collections\_postcollections).
-This workflow has a hook that allows you to perform custom actions on the created collections. For example, you can pass under `additional_data` custom data that
+This workflow has a hook that allows you to perform custom actions on the created collections. For example, you can pass under `additional_data` custom data that
allows you to create custom data models linked to the product collections.
You can also use this workflow within your own custom workflows, allowing you to wrap custom logic around product-collection creation.
-
+
## Examples
@@ -151,7 +151,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -159,7 +159,7 @@ const myWorkflow = createWorkflow(
## Output
-`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="createCollectionsWorkflow"/>
+`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="createCollectionsWorkflow"/>
## Hooks
@@ -193,12 +193,8 @@ Handlers consuming this hook accept the following input.
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductOptionsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductOptionsWorkflow/page.mdx
index de91949632..d58b1c7a36 100644
--- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductOptionsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductOptionsWorkflow/page.mdx
@@ -16,12 +16,12 @@ This documentation provides a reference to the `createProductOptionsWorkflow`. I
This workflow creates one or more product options. It's used by the [Create Product Option Admin API Route](https://docs.medusajs.com/api/admin#products\_postproductsidoptions).
-This workflow has a hook that allows you to perform custom actions on the created product options. For example, you can pass under `additional_data` custom data that
+This workflow has a hook that allows you to perform custom actions on the created product options. For example, you can pass under `additional_data` custom data that
allows you to create custom data models linked to the product options.
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around product-option creation.
-
+
## Examples
@@ -174,7 +174,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -182,7 +182,7 @@ const myWorkflow = createWorkflow(
## Output
-`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="createProductOptionsWorkflow"/>
+`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="createProductOptionsWorkflow"/>
## Hooks
@@ -216,12 +216,8 @@ Handlers consuming this hook accept the following input.
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTagsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTagsWorkflow/page.mdx
index 0e5d1b77df..66604656fd 100644
--- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTagsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTagsWorkflow/page.mdx
@@ -14,15 +14,15 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
This documentation provides a reference to the `createProductTagsWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
-This workflow creates one or more product tags. It's used by the
+This workflow creates one or more product tags. It's used by the
[Create Product Tag Admin API Route](https://docs.medusajs.com/api/admin#product-tags\_postproducttags).
-This workflow has a hook that allows you to perform custom actions on the created product tags. For example, you can pass under `additional_data` custom data that
+This workflow has a hook that allows you to perform custom actions on the created product tags. For example, you can pass under `additional_data` custom data that
allows you to create custom data models linked to the product tags.
You can also use this workflow within your own custom workflows, allowing you to wrap custom logic around product-tag creation.
-
+
## Examples
@@ -151,7 +151,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -159,7 +159,7 @@ const myWorkflow = createWorkflow(
## Output
-`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="createProductTagsWorkflow"/>
+`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="createProductTagsWorkflow"/>
## Hooks
@@ -193,12 +193,8 @@ Handlers consuming this hook accept the following input.
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTypesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTypesWorkflow/page.mdx
index 507cc58d6d..6171425272 100644
--- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTypesWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTypesWorkflow/page.mdx
@@ -14,15 +14,15 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
This documentation provides a reference to the `createProductTypesWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
-This workflow creates one or more product types. It's used by the
+This workflow creates one or more product types. It's used by the
[Create Product Type Admin API Route](https://docs.medusajs.com/api/admin#product-types\_postproducttypes).
-This workflow has a hook that allows you to perform custom actions on the created product types. For example, you can pass under `additional_data` custom data that
+This workflow has a hook that allows you to perform custom actions on the created product types. For example, you can pass under `additional_data` custom data that
allows you to create custom data models linked to the product types.
You can also use this workflow within your own custom workflows, allowing you to wrap custom logic around product-type creation.
-
+
## Examples
@@ -151,7 +151,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -193,12 +193,8 @@ Handlers consuming this hook accept the following input.
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductVariantsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductVariantsWorkflow/page.mdx
index 039851e6f2..fcd1533fed 100644
--- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductVariantsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductVariantsWorkflow/page.mdx
@@ -32,7 +32,7 @@ Learn more about adding rules to the product variant's prices in the Pricing Mod
:::
-
+
## Examples
@@ -197,7 +197,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -205,7 +205,7 @@ const myWorkflow = createWorkflow(
## Output
-`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product collection. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product collection was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product collection was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product collection was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product type was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product type was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product type was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the product variant's requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="createProductVariantsWorkflow"/>
+`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product collection. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product collection was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product collection was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product collection was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product type was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product type was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product type was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product tag.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The tile of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The SKU of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"The barcode of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"The EAN of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"The UPC of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the product variant can be ordered when it's out of stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether the product variant's inventory should be managed by the core system.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The thumbnail of the product variant form the product images.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Whether the product variant's requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="createProductVariantsWorkflow"/>
## Hooks
@@ -233,18 +233,14 @@ createProductVariantsWorkflow.hooks.productVariantsCreated(
Handlers consuming this hook accept the following input.
-`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="productVariantsCreated"/>
+`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="productVariantsCreated"/>
## Emitted Events
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
-:::note
-
The `emitEventStep` only emits the event after the workflow has finished successfully. So, even if it's executed in the middle of the workflow, it won't actually emit the event until the workflow has completed successfully. If the workflow fails, it won't emit the event at all.
-:::
-
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductsWorkflow/page.mdx
index 41c895d4e2..7ae375695b 100644
--- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductsWorkflow/page.mdx
+++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductsWorkflow/page.mdx
@@ -32,7 +32,7 @@ Learn more about adding rules to the product variant's prices in the Pricing Mod
:::
-
+
## Examples
@@ -229,7 +229,7 @@ const myWorkflow = createWorkflow(
## Steps
-
+
## Input
@@ -237,7 +237,7 @@ const myWorkflow = createWorkflow(
## Output
-`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValueDTO](../../../../../product/interfaces/product.ProductOptionValueDTO/page.mdx)[]","description":"The associated product option values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option value was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option value was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"`null` \\| [ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)","description":"The associated product option. It may only be available if the `option` relation is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`null` \\| `string`","description":"The associated product option id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option value was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product option was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product option was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product option was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The rank of the product image.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product image was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product image was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product image was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product category. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"Whether the product category is active.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_internal","type":"`boolean`","description":"Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`number`","description":"The ranking of the product category among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)","description":"The associated parent category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The associated parent category id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated child categories.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subttle of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the product is a gift card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../product/types/product.ProductStatus/page.mdx)","description":"The status of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The URL of the product's thumbnail.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The origin country of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The HS Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The MID Code of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material of the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collection","type":"`null` \\| [ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)","description":"The associated product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The associated product collection id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`null` \\| [ProductTypeDTO](../../../../../product/interfaces/product.ProductTypeDTO/page.mdx)","description":"The associated product type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The associated product type id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTagDTO](../../../../../product/interfaces/product.ProductTagDTO/page.mdx)[]","description":"The associated product tags.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariantDTO](../../../../../product/interfaces/product.ProductVariantDTO/page.mdx)[]","description":"The associated product variants.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"options","type":"[ProductOptionDTO](../../../../../product/interfaces/product.ProductOptionDTO/page.mdx)[]","description":"The associated product options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"images","type":"[ProductImageDTO](../../../../../product/interfaces/product.ProductImageDTO/page.mdx)[]","description":"The associated product images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`null` \\| [ProductCategoryDTO](../../../../../product/interfaces/product.ProductCategoryDTO/page.mdx)[]","description":"The associated product categories.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"The ranking of the product category among sibling categories.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product category was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discountable","type":"`boolean`","description":"Whether the product can be discounted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="createProductsWorkflow"/>
+