Skip to content

Commit 0db5bf6

Browse files
fix(js-sdk): add missing admin order archive and complete methods (medusajs#12944)
* fix(js-sdk): add missing admin order archive and complete methods * Create cuddly-rice-shave.md --------- Co-authored-by: Oli Juhl <[email protected]>
1 parent 1ef7075 commit 0db5bf6

File tree

2 files changed

+70
-2
lines changed

2 files changed

+70
-2
lines changed

.changeset/cuddly-rice-shave.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@medusajs/js-sdk": patch
3+
---
4+
5+
fix(js-sdk): add missing admin order archive and complete methods

packages/core/js-sdk/src/admin/order.ts

Lines changed: 65 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,37 @@ export class Order {
194194
)
195195
}
196196

197+
/**
198+
* This method archives an order. It sends a request to the
199+
* [Archive Order](https://docs.medusajs.com/api/admin#orders_postordersidarchive)
200+
* API route.
201+
*
202+
* @param id - The order's ID.
203+
* @param queryParams - Configure the fields to retrieve in the order.
204+
* @param headers - Headers to pass in the request
205+
* @returns The order's details.
206+
*
207+
* @example
208+
* sdk.admin.order.archive("order_123")
209+
* .then(({ order }) => {
210+
* console.log(order)
211+
* })
212+
*/
213+
async archive(
214+
id: string,
215+
queryParams?: SelectParams,
216+
headers?: ClientHeaders
217+
) {
218+
return await this.client.fetch<HttpTypes.AdminOrderResponse>(
219+
`/admin/orders/${id}/archive`,
220+
{
221+
method: "POST",
222+
query: queryParams,
223+
headers,
224+
}
225+
)
226+
}
227+
197228
/**
198229
* This method cancels an order. It sends a request to the
199230
* [Cancel Order](https://docs.medusajs.com/api/admin#orders_postordersidcancel)
@@ -219,6 +250,38 @@ export class Order {
219250
)
220251
}
221252

253+
/**
254+
* This method completes an order. It sends a request to the
255+
* [Complete Order](https://docs.medusajs.com/api/admin#orders_postordersidcomplete)
256+
* API route.
257+
*
258+
* @param id - The order's ID.
259+
* @param headers - Headers to pass in the request.
260+
* @returns The order's details.
261+
*
262+
* @example
263+
* sdk.admin.order.complete("order_123")
264+
* .then(({ order }) => {
265+
* console.log(order)
266+
* })
267+
*/
268+
async complete(
269+
id: string,
270+
body: HttpTypes.AdditionalData,
271+
queryParams?: SelectParams,
272+
headers?: ClientHeaders
273+
) {
274+
return await this.client.fetch<HttpTypes.AdminOrderResponse>(
275+
`/admin/orders/${id}/complete`,
276+
{
277+
method: "POST",
278+
body,
279+
query: queryParams,
280+
headers,
281+
}
282+
)
283+
}
284+
222285
/**
223286
* This method requests an order transfer. It sends a request to the
224287
* [Request Order Transfer](https://docs.medusajs.com/api/admin#orders_postordersidrequesttransfer)
@@ -504,13 +567,13 @@ export class Order {
504567
/**
505568
* This method creates a credit line for an order. It sends a request to the
506569
* [Create Credit Line](https://docs.medusajs.com/api/admin#orders_postordersidcredit-lines) API route.
507-
*
570+
*
508571
* @param orderId - The order's ID.
509572
* @param body - The credit line's details.
510573
* @param query - Configure the fields to retrieve in the order.
511574
* @param headers - Headers to pass in the request
512575
* @returns The order's details.
513-
*
576+
*
514577
* @example
515578
* sdk.admin.order.createCreditLine(
516579
* "order_123",

0 commit comments

Comments
 (0)