3b28f46705
* added reference for JS Client * added reference for JS Client * added reference for JS Client
2.3 KiB
2.3 KiB
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
packages/medusa-js/src/resources/orders.ts:35
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
packages/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>