@plentymarkets/shop-api / getReturns

Function: getReturns()

getReturns(context, params): Promise<Data<PaginatedResult<Order>>>

Method getReturns - Used to get return orders.

Parameters

• context: PlentysystemsIntegrationContext

• params: ReturnsParams

page: page number items: number of items

Returns

Promise<Data<PaginatedResult<Order>>>

A list of return orders.

Remarks

• Calls /rest/io/customer/order/return
• Method should be used to get the return orders.

Example

const { data } = await useSdk().plentysystems.getReturns({
    page: 1,
    items: 5
});

Defined in

api/getReturns/index.ts:26