Class: OrdersResource
Hierarchy
default↳
OrdersResource
Methods
confirmRequest
▸ confirmRequest(payload, customHeaders?): ResponsePromise<any>
Description
Grant access to a list of orders
Parameters
| Name | Type | Description |
|---|---|---|
payload | StorePostCustomersCustomerAcceptClaimReq | signed token to grant access |
customHeaders | Record<string, any> |
Returns
ResponsePromise<any>
Defined in
medusa-js/src/resources/orders.ts:78
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:46
requestCustomerOrders
▸ requestCustomerOrders(payload, customHeaders?): ResponsePromise<any>
Description
Request access to a list of orders
Parameters
| Name | Type | Description |
|---|---|---|
payload | StorePostCustomersCustomerOrderClaimReq | display ids of orders to request |
customHeaders | Record<string, any> |
Returns
ResponsePromise<any>
Defined in
medusa-js/src/resources/orders.ts:64
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:18
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>