feat(medusa-js, medusa-react): Support expand fields in order retriev…

…al (#2353)
medusajs · Oct 11, 2022 · 9e7b635 · 9e7b635
1 parent 3df8f70
commit 9e7b635
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 5 deletions.
diff --git a/.changeset/sour-beers-grow.md b/.changeset/sour-beers-grow.md
@@ -0,0 +1,6 @@
+---
+"@medusajs/medusa-js": patch
+"medusa-react": patch
+---
+
+feat(medusa-js, medusa-react): add expand fields to get order
diff --git a/packages/medusa-js/src/resources/admin/orders.ts b/packages/medusa-js/src/resources/admin/orders.ts
@@ -16,6 +16,7 @@ import {
   AdminPostOrdersOrderSwapsSwapFulfillmentsReq,
   AdminPostOrdersOrderSwapsSwapShipmentsReq,
 } from "@medusajs/medusa"
+import { FindParams } from "@medusajs/medusa/dist/types/common"
 import qs from "qs"
 import { ResponsePromise } from "../../typings"
 import BaseResource from "../base"
@@ -32,9 +33,16 @@ class AdminOrdersResource extends BaseResource {
 
   retrieve(
     id: string,
+    query?: FindParams,
     customHeaders: Record<string, any> = {}
   ): ResponsePromise<AdminOrdersRes> {
-    const path = `/admin/orders/${id}`
+    let path = `/admin/orders/${id}`
+
+    if (query) {
+      const queryString = qs.stringify(query)
+      path = `/admin/orders/${id}?${queryString}`
+    }
+
     return this.client.request("GET", path, undefined, {}, customHeaders)
   }
 

diff --git a/packages/medusa-react/src/hooks/admin/orders/queries.ts b/packages/medusa-react/src/hooks/admin/orders/queries.ts
@@ -4,14 +4,20 @@ import {
   AdminGetOrdersParams,
 } from "@medusajs/medusa"
 import { Response } from "@medusajs/medusa-js"
+import { FindParams } from "@medusajs/medusa/dist/types/common"
 import { useQuery } from "react-query"
 import { useMedusa } from "../../../contexts"
 import { UseQueryOptionsWrapper } from "../../../types"
 import { queryKeysFactory } from "../../utils/index"
 
 const ADMIN_ORDERS_QUERY_KEY = `admin_orders` as const
 
-export const adminOrderKeys = queryKeysFactory(ADMIN_ORDERS_QUERY_KEY)
+export const adminOrderKeys = {
+  ...queryKeysFactory(ADMIN_ORDERS_QUERY_KEY),
+  detailOrder(id: string, query?: FindParams) {
+    return [...this.detail(id), { ...(query || {}) }]
+  }
+}
 
 type OrderQueryKeys = typeof adminOrderKeys
 
@@ -34,16 +40,17 @@ export const useAdminOrders = (
 
 export const useAdminOrder = (
   id: string,
+  query?: FindParams,
   options?: UseQueryOptionsWrapper<
     Response<AdminOrdersRes>,
     Error,
-    ReturnType<OrderQueryKeys["detail"]>
+    ReturnType<OrderQueryKeys["detailOrder"]>
   >
 ) => {
   const { client } = useMedusa()
   const { data, ...rest } = useQuery(
-    adminOrderKeys.detail(id),
-    () => client.admin.orders.retrieve(id),
+    adminOrderKeys.detailOrder(id, query),
+    () => client.admin.orders.retrieve(id, query),
     options
   )
   return { ...data, ...rest } as const