feat: Add requested_at + open status to return (#8391)

* feat: Add requested_at + open status to return

* Update return in confirm claim workflow

* Revert snapshot

* feat: Change OrderChangeType

* fix test

packages/core/core-flows/src/order/workflows/claim/confirm-claim-request.ts

@@ -5,7 +5,12 @@ import {
   OrderClaimDTO,
   OrderDTO,
 } from "@medusajs/types"
-import { ChangeActionType, Modules, OrderChangeStatus } from "@medusajs/utils"
+import {
+  ChangeActionType,
+  Modules,
+  OrderChangeStatus,
+  ReturnStatus,
+} from "@medusajs/utils"
 import {
   WorkflowResponse,
   createStep,
@@ -17,7 +22,7 @@ import {
 import { createRemoteLinkStep, useRemoteQueryStep } from "../../../common"
 import { createFulfillmentWorkflow } from "../../../fulfillment/workflows/create-fulfillment"
 import { createReturnFulfillmentWorkflow } from "../../../fulfillment/workflows/create-return-fulfillment"
-import { previewOrderChangeStep } from "../../steps"
+import { previewOrderChangeStep, updateReturnsStep } from "../../steps"
 import { createOrderClaimItemsFromActionsStep } from "../../steps/claim/create-claim-items-from-actions"
 import { confirmOrderChanges } from "../../steps/confirm-order-changes"
 import { createReturnItemsFromActionsStep } from "../../steps/return/create-return-items-from-actions"
@@ -239,6 +244,14 @@ export const confirmClaimRequestWorkflow = createWorkflow(
       }
     )
 
+    updateReturnsStep([
+      {
+        id: returnId,
+        status: ReturnStatus.REQUESTED,
+        requested_at: new Date(),
+      },
+    ])
+
     const claimId = transform({ createClaimItems }, ({ createClaimItems }) => {
       return createClaimItems?.[0]?.claim_id
     })

packages/core/core-flows/src/order/workflows/return/begin-receive-return.ts

@@ -60,7 +60,7 @@ export const beginReceiveReturnWorkflow = createWorkflow(
       { orderReturn, order, input },
       ({ orderReturn, order, input }) => {
         return {
-          change_type: "return" as const,
+          change_type: "return_receive" as const,
           order_id: order.id,
           return_id: orderReturn.id,
           created_by: input.created_by,

packages/core/core-flows/src/order/workflows/return/begin-return.ts

@@ -45,7 +45,7 @@ export const beginReturnOrderWorkflow = createWorkflow(
       { created, input },
       ({ created, input }) => {
         return {
-          change_type: "return" as const,
+          change_type: "return_request" as const,
           order_id: input.order_id,
           return_id: created[0].id,
           created_by: input.created_by,

packages/core/core-flows/src/order/workflows/return/confirm-return-request.ts

@@ -4,17 +4,23 @@ import {
   OrderDTO,
   ReturnDTO,
 } from "@medusajs/types"
-import { ChangeActionType, Modules, OrderChangeStatus } from "@medusajs/utils"
+import {
+  ChangeActionType,
+  Modules,
+  OrderChangeStatus,
+  ReturnStatus,
+} from "@medusajs/utils"
 import {
   WorkflowResponse,
   createStep,
   createWorkflow,
+  parallelize,
   transform,
   when,
 } from "@medusajs/workflows-sdk"
 import { createRemoteLinkStep, useRemoteQueryStep } from "../../../common"
 import { createReturnFulfillmentWorkflow } from "../../../fulfillment/workflows/create-return-fulfillment"
-import { previewOrderChangeStep } from "../../steps"
+import { previewOrderChangeStep, updateReturnsStep } from "../../steps"
 import { confirmOrderChanges } from "../../steps/confirm-order-changes"
 import { createReturnItemsFromActionsStep } from "../../steps/return/create-return-items-from-actions"
 import {
@@ -232,7 +238,16 @@ export const confirmReturnRequestWorkflow = createWorkflow(
       createRemoteLinkStep(link)
     })
 
-    confirmOrderChanges({ changes: [orderChange], orderId: order.id })
+    parallelize(
+      updateReturnsStep([
+        {
+          id: orderReturn.id,
+          status: ReturnStatus.REQUESTED,
+          requested_at: new Date(),
+        },
+      ]),
+      confirmOrderChanges({ changes: [orderChange], orderId: order.id })
+    )
 
     return new WorkflowResponse(orderPreview)
   }

packages/core/types/src/order/mutations.ts

@@ -259,7 +259,12 @@ export interface CreateOrderChangeDTO {
   return_id?: string
   claim_id?: string
   exchange_id?: string
-  change_type?: "return" | "exchange" | "claim" | "edit"
+  change_type?:
+    | "return_request"
+    | "return_receive"
+    | "exchange"
+    | "claim"
+    | "edit"
   description?: string
   internal_note?: string | null
   requested_by?: string
@@ -437,6 +442,13 @@ export interface CreateOrderReturnDTO extends BaseOrderBundledActionsDTO {
   exchange_id?: string
 }
 
+export type ReturnStatus =
+  | "open"
+  | "requested"
+  | "received"
+  | "partially_received"
+  | "canceled"
+
 export interface UpdateReturnDTO {
   id: string
   location_id?: string
@@ -453,6 +465,8 @@ export interface UpdateReturnDTO {
     return_id?: string | null
     metadata?: Record<string, unknown> | null
   }[]
+  status?: ReturnStatus
+  requested_at?: Date
 }
 
 export interface UpdateOrderClaimDTO {

packages/core/utils/src/order/order-change.ts

@@ -22,7 +22,8 @@ export enum OrderChangeStatus {
 }
 
 export enum OrderChangeType {
-  RETURN = "return",
+  RETURN_REQUEST = "return_request",
+  RETURN_RECEIVE = "return_receive",
   EXCHANGE = "exchange",
   CLAIM = "claim",
   EDIT = "edit",

packages/core/utils/src/order/status.ts

@@ -36,6 +36,10 @@ export enum OrderStatus {
  * The return's status.
  */
 export enum ReturnStatus {
+  /**
+   * The return is open.
+   */
+  OPEN = "open",
   /**
    * The return is requested.
    */