@redotech/redo-api-schema 2.2.155 → 2.2.161

package/lib/openapi.d.ts

@@ -575,12 +575,20 @@ export interface components {
        * @description Exchange order
        */
       exchange?: {
+        /** @description Total quantity of all exchange items */
+        itemCount?: number;
         /** Line items */
         items: {
             /** ID */
             id: string;
+            /** @description Price details for the exchange item */
+            price?: {
+              amount?: string;
+              currency?: string;
+              tax?: string;
+            };
             /** Product */
-            product: components["schemas"]["product.schema"];
+            product?: components["schemas"]["product.schema"];
             /** Quantity */
             quantity: components["schemas"]["item-quantity.schema"];
             variant: components["schemas"]["product-variant.schema"];
@@ -591,11 +599,20 @@ export interface components {
            * @description ID of external order
            */
           externalId?: string;
-          id?: string;
         };
         /** Provision */
         provision: components["schemas"]["exchange-provision.schema"];
+        /** @description Total tax for exchange items */
+        totalTax?: {
+          amount?: string;
+          currency?: string;
+        };
       };
+      /**
+       * External Order IDs
+       * @description Array of external order IDs associated with this return
+       */
+      externalOrderIds?: string[];
       /**
        * Gift cards
        * @description Gift card(s) created for return
@@ -620,58 +637,87 @@ export interface components {
        */
       id: string;
       /** @description Return items */
-      items: ({
-          /** Exchange item */
+      items: {
+          /** @description Customer's comment about the return */
+          customerComment?: string;
+          /**
+           * Exchange item
+           * @description Exchange item details if this return item is being exchanged
+           */
           exchangeItem?: {
-            /**
-             * ID
-             * @description ID of exchange line item
-             */
-            id?: string;
+            product?: {
+              externalId?: string;
+              name?: string;
+            };
+            quantity?: number;
+            variant?: {
+              externalId?: string;
+              name?: string;
+            };
           };
+          /** @description Whether this is a green return (no physical return required) */
+          greenReturn?: boolean;
           /**
            * ID
            * @description Return item ID.
            */
-          id?: string;
+          id: string;
           /**
            * Order item
            * @description Order line item
            */
-          orderItem?: {
+          orderItem: {
             /**
              * ID
-             * @description Line item ID in original order. Note: There can be more than return item for an original line item, with different quantity, return reasons, etc.
+             * @description Line item reference ID in format: {orderId}/{lineItemIndex}
+             */
+            id: string;
+            /**
+             * Line Item ID
+             * @description Original Shopify line item ID
              */
-            id?: string;
+            line_item_id?: string;
           };
-          /** Quantity */
-          quantity: components["schemas"]["item-quantity.schema"];
-          /** @description Return reason */
+          /** @description Product ID */
+          productId?: string;
+          /** @description Quantity of items being returned */
+          quantity: number;
+          /** @description Primary return reason */
           reason: string;
-          /** @description Refund */
+          /** @description Return reason code */
+          reasonCode?: string;
+          /** @description Array of return reasons */
+          reasons?: string[];
+          /** @description Refund details */
           refund?: {
             /** Amount */
             amount: components["schemas"]["money.schema"];
-            /** Planned amount */
-            pendingAmount: components["schemas"]["money.schema"];
-            /**
-             * Taxes
-             * @description Taxes.
-             */
-            pendingTaxAmount: components["schemas"]["money.schema"];
-            /**
-             * Taxes
-             * @description Taxes.
-             */
-            taxAmount: components["schemas"]["money.schema"];
-            /**
-             * @description Refund method
-             * @enum {string}
-             */
-            type: "credit" | "refund";
+            /** @description Refund strategy */
+            type?: string;
           };
-        })[];
+          /** @description Product SKU */
+          sku?: string;
+          /** @description Return item status */
+          status?: string;
+          /** @description Product variant ID */
+          variantId?: string;
+        }[];
+      /**
+       * Notes
+       * @description Teammembers generated notes and comments on the return
+       */
+      notes?: {
+          /**
+           * Image URL
+           * @description Optional image URL attached to the note
+           */
+          image?: string;
+          /**
+           * Message
+           * @description The note text
+           */
+          message: string;
+        }[];
       /**
        * Order
        * @description Original order.
@@ -688,24 +734,17 @@ export interface components {
        * Shipment
        * @description Shipment, if has been made
        */
-      shipment?: {
-        /**
-         * Carrier
-         * @description Carrier code
-         */
-        carrier?: string;
-        /**
-         * Status
-         * @description Status of shipment
-         * @enum {string}
-         */
-        status?: "pre_transit" | "transit" | "delivered" | "cancelled" | "flagged";
-        /**
-         * Tracker
-         * @description Tracking number
-         */
-        tracker?: string;
-      };
+      shipment?: components["schemas"]["return-shipment.schema"];
+      /**
+       * Shipments
+       * @description Array of all shipments associated with this return
+       */
+      shipments?: components["schemas"]["return-shipment.schema"][];
+      /**
+       * Shopify Order IDs
+       * @description Array of Shopify order IDs (deprecated, use externalOrderIds)
+       */
+      shopifyOrderIds?: string[];
       source: {
         /**
          * Email address
@@ -734,6 +773,28 @@ export interface components {
        * @description Return status.
        */
       status: components["schemas"]["return-status.schema"];
+      /**
+       * Totals
+       * @description Calculated totals for the return
+       */
+      totals?: {
+        /** @description The upsell amount for the exchange order */
+        charge: {
+          amount: components["schemas"]["money.schema"];
+        };
+        /** @description Total value of new items in exchange */
+        exchange: {
+          amount: components["schemas"]["money.schema"];
+        };
+        /** @description Total refund amount excluding shipping */
+        refund: {
+          amount: components["schemas"]["money.schema"];
+        };
+        /** @description Total store credit amount */
+        storeCredit: {
+          amount: components["schemas"]["money.schema"];
+        };
+      };
       /**
        * Type
        * @description Return type.
@@ -746,6 +807,28 @@ export interface components {
        */
       updatedAt: string;
     };
+    /**
+     * Return Shipment
+     * @description Return shipment tracking information
+     */
+    "return-shipment.schema": {
+      /**
+       * Carrier
+       * @description Carrier code
+       */
+      carrier?: string;
+      /**
+       * Status
+       * @description Status of shipment
+       * @enum {string}
+       */
+      status?: "unknown" | "pre_transit" | "in_transit" | "out_for_delivery" | "available_for_pickup" | "cancelled" | "delivered" | "error" | "failure" | "return_to_sender" | "expired";
+      /**
+       * Tracker
+       * @description Tracking number
+       */
+      tracker?: string;
+    };
     /**
      * Return status
      * @description Return status.

package/lib/openapi.yaml

@@ -33,6 +33,8 @@ components:
       in: header
       name: X-Page-Size
       schema:
+        maximum: 500
+        minimum: 1
         type: integer
     return-id.param:
       description: Return ID
@@ -540,12 +542,25 @@ components:
         exchange:
           description: Exchange order
           properties:
+            itemCount:
+              description: Total quantity of all exchange items
+              type: integer
             items:
               items:
                 properties:
                   id:
                     title: ID
                     type: string
+                  price:
+                    description: Price details for the exchange item
+                    properties:
+                      amount:
+                        type: string
+                      currency:
+                        type: string
+                      tax:
+                        type: string
+                    type: object
                   product:
                     $ref: '#/components/schemas/product.schema'
                     title: Product
@@ -557,7 +572,6 @@ components:
                 required:
                   - id
                   - quantity
-                  - product
                   - variant
               title: Line items
               type: array
@@ -567,17 +581,29 @@ components:
                   description: ID of external order
                   title: External ID
                   type: string
-                id:
-                  type: string
               type: object
             provision:
               $ref: '#/components/schemas/exchange-provision.schema'
               title: Provision
+            totalTax:
+              description: Total tax for exchange items
+              properties:
+                amount:
+                  type: string
+                currency:
+                  type: string
+              type: object
           required:
             - items
             - provision
           title: Exchange
           type: object
+        externalOrderIds:
+          description: Array of external order IDs associated with this return
+          items:
+            type: string
+          title: External Order IDs
+          type: array
         giftCards:
           description: Gift card(s) created for return
           items:
@@ -610,16 +636,33 @@ components:
           description: Return items
           items:
             properties:
+              customerComment:
+                description: Customer's comment about the return
+                type: string
               exchangeItem:
+                description: Exchange item details if this return item is being exchanged
                 properties:
-                  id:
-                    description: ID of exchange line item
-                    title: ID
-                    type: string
-                required:
-                  - string
+                  product:
+                    properties:
+                      externalId:
+                        type: string
+                      name:
+                        type: string
+                    type: object
+                  quantity:
+                    type: integer
+                  variant:
+                    properties:
+                      externalId:
+                        type: string
+                      name:
+                        type: string
+                    type: object
                 title: Exchange item
                 type: object
+              greenReturn:
+                description: Whether this is a green return (no physical return required)
+                type: boolean
               id:
                 description: Return item ID.
                 title: ID
@@ -628,58 +671,82 @@ components:
                 description: Order line item
                 properties:
                   id:
-                    description: 'Line item ID in original order. Note: There can be more than return item for an original line item, with different quantity, return reasons, etc.'
+                    description: 'Line item reference ID in format: {orderId}/{lineItemIndex}'
                     title: ID
                     type: string
+                  line_item_id:
+                    description: Original Shopify line item ID
+                    title: Line Item ID
+                    type: string
                 required:
-                  - index
+                  - id
                 title: Order item
                 type: object
+              productId:
+                description: Product ID
+                type: string
               quantity:
-                $ref: '#/components/schemas/item-quantity.schema'
-                title: Quantity
+                description: Quantity of items being returned
+                type: integer
               reason:
-                description: Return reason
+                description: Primary return reason
                 examples:
                   - Too big
                   - Other
                 type: string
+              reasonCode:
+                description: Return reason code
+                type: string
+              reasons:
+                description: Array of return reasons
+                items:
+                  type: string
+                type: array
               refund:
-                description: Refund
+                description: Refund details
                 properties:
                   amount:
                     $ref: '#/components/schemas/money.schema'
                     title: Amount
-                  pendingAmount:
-                    $ref: '#/components/schemas/money.schema'
-                    title: Planned amount
-                  pendingTaxAmount:
-                    $ref: '#/components/schemas/money.schema'
-                    description: Taxes.
-                    title: Taxes
-                  taxAmount:
-                    $ref: '#/components/schemas/money.schema'
-                    description: Taxes.
-                    title: Taxes
                   type:
-                    description: Refund method
-                    enum:
-                      - credit
-                      - refund
+                    description: Refund strategy
                     type: string
                 required:
                   - amount
-                  - pendingAmount
-                  - pendingTaxAmount
-                  - taxAmount
-                  - type
                 type: object
+              sku:
+                description: Product SKU
+                type: string
+              status:
+                description: Return item status
+                type: string
+              variantId:
+                description: Product variant ID
+                type: string
             required:
-              - item
+              - id
+              - orderItem
               - quantity
               - reason
             type: object
           type: array
+        notes:
+          description: Teammembers generated notes and comments on the return
+          items:
+            properties:
+              image:
+                description: Optional image URL attached to the note
+                title: Image URL
+                type: string
+              message:
+                description: The note text
+                title: Message
+                type: string
+            required:
+              - message
+            type: object
+          title: Notes
+          type: array
         order:
           description: Original order.
           properties:
@@ -693,28 +760,21 @@ components:
           title: Order
           type: object
         shipment:
+          $ref: '#/components/schemas/return-shipment.schema'
           description: Shipment, if has been made
-          properties:
-            carrier:
-              description: Carrier code
-              title: Carrier
-              type: string
-            status:
-              description: Status of shipment
-              enum:
-                - pre_transit
-                - transit
-                - delivered
-                - cancelled
-                - flagged
-              title: Status
-              type: string
-            tracker:
-              description: Tracking number
-              title: Tracker
-              type: string
           title: Shipment
-          type: object
+        shipments:
+          description: Array of all shipments associated with this return
+          items:
+            $ref: '#/components/schemas/return-shipment.schema'
+          title: Shipments
+          type: array
+        shopifyOrderIds:
+          description: Array of Shopify order IDs (deprecated, use externalOrderIds)
+          items:
+            type: string
+          title: Shopify Order IDs
+          type: array
         source:
           properties:
             emailAddress:
@@ -744,6 +804,48 @@ components:
           $ref: '#/components/schemas/return-status.schema'
           description: Return status.
           title: Status
+        totals:
+          description: Calculated totals for the return
+          properties:
+            charge:
+              description: The upsell amount for the exchange order
+              properties:
+                amount:
+                  $ref: '#/components/schemas/money.schema'
+              required:
+                - amount
+              type: object
+            exchange:
+              description: Total value of new items in exchange
+              properties:
+                amount:
+                  $ref: '#/components/schemas/money.schema'
+              required:
+                - amount
+              type: object
+            refund:
+              description: Total refund amount excluding shipping
+              properties:
+                amount:
+                  $ref: '#/components/schemas/money.schema'
+              required:
+                - amount
+              type: object
+            storeCredit:
+              description: Total store credit amount
+              properties:
+                amount:
+                  $ref: '#/components/schemas/money.schema'
+              required:
+                - amount
+              type: object
+          required:
+            - refund
+            - exchange
+            - storeCredit
+            - charge
+          title: Totals
+          type: object
         type:
           $ref: '#/components/schemas/return-type.schema'
           description: Return type.
@@ -765,6 +867,35 @@ components:
         - updatedAt
       title: Return
       type: object
+    return-shipment.schema:
+      description: Return shipment tracking information
+      properties:
+        carrier:
+          description: Carrier code
+          title: Carrier
+          type: string
+        status:
+          description: Status of shipment
+          enum:
+            - unknown
+            - pre_transit
+            - in_transit
+            - out_for_delivery
+            - available_for_pickup
+            - cancelled
+            - delivered
+            - error
+            - failure
+            - return_to_sender
+            - expired
+          title: Status
+          type: string
+        tracker:
+          description: Tracking number
+          title: Tracker
+          type: string
+      title: Return Shipment
+      type: object
     return-status-update.schema:
       description: |
         Return status.

package/package.json

@@ -31,5 +31,5 @@
       ]
     }
   },
-  "version": "2.2.155"
+  "version": "2.2.161"
 }