daea35fe73
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
4.0 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Class: OrdersResource
Hierarchy
-
default↳
OrdersResource
Methods
confirmRequest
▸ confirmRequest(payload, customHeaders?): ResponsePromise
Parameters
| Name | Type | Description |
|---|---|---|
payload |
StorePostCustomersCustomerAcceptClaimReq |
signed token to grant access |
customHeaders |
Record<string, any> |
Returns
Description
Grant access to a list of orders
Defined in
packages/medusa-js/src/resources/orders.ts:78
lookupOrder
▸ lookupOrder(payload, customHeaders?): ResponsePromise<StoreOrdersRes>
Parameters
| Name | Type | Description |
|---|---|---|
payload |
StoreGetOrdersParams |
details used to look up the order |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<StoreOrdersRes>
Description
Look up an order using order details
Defined in
packages/medusa-js/src/resources/orders.ts:46
requestCustomerOrders
▸ requestCustomerOrders(payload, customHeaders?): ResponsePromise
Parameters
| Name | Type | Description |
|---|---|---|
payload |
StorePostCustomersCustomerOrderClaimReq |
display ids of orders to request |
customHeaders |
Record<string, any> |
Returns
Description
Request access to a list of orders
Defined in
packages/medusa-js/src/resources/orders.ts:64
retrieve
▸ retrieve(id, customHeaders?): ResponsePromise<StoreOrdersRes>
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
is required |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<StoreOrdersRes>
Description
Retrieves an order
Defined in
packages/medusa-js/src/resources/orders.ts:18
retrieveByCartId
▸ retrieveByCartId(cart_id, customHeaders?): ResponsePromise<StoreOrdersRes>
Parameters
| Name | Type | Description |
|---|---|---|
cart_id |
string |
is required |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<StoreOrdersRes>
Description
Retrieves an order by cart id