Class: OrdersResource
Hierarchy
defaultCopy to Clipboard↳
OrdersResourceCopy to Clipboard
Methods
confirmRequest
▸ confirmRequest(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<anyCopy to Clipboard>
DescriptionCopy to Clipboard
Grant access to a list of orders
Parameters
| Name | Type | Description |
|---|---|---|
payloadCopy to Clipboard | StorePostCustomersCustomerAcceptClaimReqCopy to Clipboard | signed token to grant access |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<anyCopy to Clipboard>
Defined in
medusa-js/src/resources/orders.ts:78
lookupOrder
▸ lookupOrder(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreOrdersResCopy to Clipboard>
DescriptionCopy to Clipboard
Look up an order using order details
Parameters
| Name | Type | Description |
|---|---|---|
payloadCopy to Clipboard | StoreGetOrdersParamsCopy to Clipboard | details used to look up the order |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<StoreOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/orders.ts:46
requestCustomerOrders
▸ requestCustomerOrders(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<anyCopy to Clipboard>
DescriptionCopy to Clipboard
Request access to a list of orders
Parameters
| Name | Type | Description |
|---|---|---|
payloadCopy to Clipboard | StorePostCustomersCustomerOrderClaimReqCopy to Clipboard | display ids of orders to request |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<anyCopy to Clipboard>
Defined in
medusa-js/src/resources/orders.ts:64
retrieve
▸ retrieve(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreOrdersResCopy to Clipboard>
DescriptionCopy to Clipboard
Retrieves an order
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | is required |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<StoreOrdersResCopy to Clipboard>
Defined in
medusa-js/src/resources/orders.ts:18
retrieveByCartId
▸ retrieveByCartId(cart_idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreOrdersResCopy to Clipboard>
DescriptionCopy to Clipboard
Retrieves an order by cart id
Parameters
| Name | Type | Description |
|---|---|---|
cart_idCopy to Clipboard | stringCopy to Clipboard | is required |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<StoreOrdersResCopy to Clipboard>