OrdersResource

orders.OrdersResource

Methods

confirmRequest

confirmRequest(payload, customHeaders?): ResponsePromise

Parameters

payloadStorePostCustomersCustomerAcceptClaimReqRequired

signed token to grant access

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise

ResponsePromiseResponsePromiseRequired

Description

Grant access to a list of orders

---

lookupOrder

lookupOrder(payload, customHeaders?): ResponsePromise<StoreOrdersRes>

Parameters

payloadStoreGetOrdersParamsRequired

details used to look up the order

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<StoreOrdersRes>

ResponsePromiseResponsePromise<StoreOrdersRes>Required

Description

Look up an order using order details

---

requestCustomerOrders

requestCustomerOrders(payload, customHeaders?): ResponsePromise

Parameters

payloadStorePostCustomersCustomerOrderClaimReqRequired

display ids of orders to request

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise

ResponsePromiseResponsePromiseRequired

Description

Request access to a list of orders

---

retrieve

retrieve(id, customHeaders?): ResponsePromise<StoreOrdersRes>

Parameters

idstringRequired

is required

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<StoreOrdersRes>

ResponsePromiseResponsePromise<StoreOrdersRes>Required

Description

Retrieves an order

---

retrieveByCartId

retrieveByCartId(cart_id, customHeaders?): ResponsePromise<StoreOrdersRes>

Parameters

cart_idstringRequired

is required

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<StoreOrdersRes>

ResponsePromiseResponsePromise<StoreOrdersRes>Required

Description

Retrieves an order by cart id