@redotech/redo-api-schema 2.2.174 → 2.2.182

package/lib/openapi.d.ts

@@ -53,6 +53,20 @@ export interface paths {
       };
     };
   };
+  "/returns/{returnId}/process": {
+    /**
+     * Process return
+     * @description **BETA**: This endpoint is in beta and subject to change.
+     *
+     * Trigger processing of a return with specified products.
+     */
+    post: operations["Return process"];
+    parameters: {
+      path: {
+        returnId: components["parameters"]["return-id.param"];
+      };
+    };
+  };
   "/returns/{returnId}/status": {
     /**
      * Get return status
@@ -1425,6 +1439,70 @@ export interface operations {
       };
     };
   };
+  /**
+   * Process return
+   * @description **BETA**: This endpoint is in beta and subject to change.
+   *
+   * Trigger processing of a return with specified products.
+   */
+  "Return process": {
+    parameters: {
+      path: {
+        returnId: components["parameters"]["return-id.param"];
+      };
+    };
+    requestBody: {
+      content: {
+        "application/json": {
+          /** @description Notes to send to customer. These can be rejection notes or processing notes. */
+          customerNotes?: string;
+          /** @description Array of products to process or reject */
+          products: ({
+              /**
+               * @description Product ID found on the return
+               * @example 64e4d5e837572a4813b73e41
+               */
+              _id: string;
+              /** @description Processing details. You may only have one of reject or processInput. */
+              processInput?: ({
+                /** @description Adjustment amount. This will be the amount that is credited to the customer, overriding the original product value. */
+                newMerchantAdjustment?: number | null;
+                /** @description Whether to restock the item */
+                restock?: boolean;
+              }) | null;
+              /**
+               * @description Reject this product. You may only have one of reject or processInput.
+               * @default false
+               */
+              reject?: boolean;
+            })[];
+        };
+      };
+    };
+    responses: {
+      /** @description Processing request completed */
+      200: {
+        content: {
+          "application/json": {
+            /** @description Status message */
+            message?: string;
+          };
+        };
+      };
+      /** @description Bad request (e.g., missing products array) */
+      400: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+      /** @description Error */
+      default: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+    };
+  };
   /**
    * Get return status
    * @description Get return status.

package/lib/openapi.yaml

@@ -1603,6 +1603,88 @@ paths:
       tags:
         - Returns
     summary: Return comment
+  /returns/{returnId}/process:
+    description: Process return.
+    parameters:
+      - $ref: '#/components/parameters/return-id.param'
+    post:
+      description: |
+        **BETA**: This endpoint is in beta and subject to change.
+
+        Trigger processing of a return with specified products.
+      operationId: Return process
+      requestBody:
+        content:
+          application/json:
+            schema:
+              properties:
+                customerNotes:
+                  description: Notes to send to customer. These can be rejection notes or processing notes.
+                  type: string
+                products:
+                  description: Array of products to process or reject
+                  items:
+                    properties:
+                      _id:
+                        description: Product ID found on the return
+                        example: 64e4d5e837572a4813b73e41
+                        type: string
+                      processInput:
+                        description: Processing details. You may only have one of reject or processInput.
+                        nullable: true
+                        properties:
+                          newMerchantAdjustment:
+                            description: Adjustment amount. This will be the amount that is credited to the customer, overriding the original product value.
+                            nullable: true
+                            type: number
+                          restock:
+                            description: Whether to restock the item
+                            type: boolean
+                        type: object
+                      reject:
+                        default: false
+                        description: Reject this product. You may only have one of reject or processInput.
+                        type: boolean
+                    required:
+                      - _id
+                    type: object
+                  type: array
+              required:
+                - products
+              type: object
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties:
+                  message:
+                    description: Status message
+                    examples:
+                      - Processing triggered successfully
+                      - Successfully prepared some products to be processed, once all products are ready, processing will be triggered
+                    type: string
+                type: object
+          description: Processing request completed
+        '400':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Bad request (e.g., missing products array)
+        default:
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Error
+      security:
+        - Bearer: []
+      summary: Process return
+      tags:
+        - Returns
+    summary: Process return
   /returns/{returnId}/status:
     description: Return status.
     get:

package/package.json

@@ -31,5 +31,5 @@
       ]
     }
   },
-  "version": "2.2.174"
+  "version": "2.2.182"
 }