fa7c94b4cc
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
3.6 KiB
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>