medusa-store/docs/content/references/js-client/classes/OrdersResource.md

Class: OrdersResource

Hierarchy

• default

  ↳ OrdersResource

Methods

lookupOrder

▸ lookupOrder(payload, customHeaders?): ResponsePromise<StoreOrdersRes>

Description

Look up an order using order details

Parameters

Name	Type	Description
payload	StoreGetOrdersParams	details used to look up the order
customHeaders	Record<string, any>

Returns

ResponsePromise<StoreOrdersRes>

Defined in

medusa-js/src/resources/orders.ts:41

---

retrieve

▸ retrieve(id, customHeaders?): ResponsePromise<StoreOrdersRes>

Description

Retrieves an order

Parameters

Name	Type	Description
id	string	is required
customHeaders	Record<string, any>

Returns

ResponsePromise<StoreOrdersRes>

Defined in

medusa-js/src/resources/orders.ts:13

---

retrieveByCartId

▸ retrieveByCartId(cart_id, customHeaders?): ResponsePromise<StoreOrdersRes>

Description

Retrieves an order by cart id

Parameters

Name	Type	Description
cart_id	string	is required
customHeaders	Record<string, any>

Returns

ResponsePromise<StoreOrdersRes>

Defined in

medusa-js/src/resources/orders.ts:27