Skip to main content

Class: OrdersResource

Hierarchy

  • default

    OrdersResource

Methods

confirmRequest

confirmRequest(payload, customHeaders?): ResponsePromise<any>

Description

Grant access to a list of orders

Parameters

NameTypeDescription
payloadStorePostCustomersCustomerAcceptClaimReqsigned token to grant access
customHeadersRecord<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

NameTypeDescription
payloadStoreGetOrdersParamsdetails used to look up the order
customHeadersRecord<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

NameTypeDescription
payloadStorePostCustomersCustomerOrderClaimReqdisplay ids of orders to request
customHeadersRecord<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

NameTypeDescription
idstringis required
customHeadersRecord<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

NameTypeDescription
cart_idstringis required
customHeadersRecord<string, any>

Returns

ResponsePromise<StoreOrdersRes>

Defined in

medusa-js/src/resources/orders.ts:32