PlentyONE Shop Docs

Appearance

@plentymarkets/shop-api / getOrders

Function: getOrders() ​

getOrders(context, params): Promise<Data<GetOrdersResponse>>

Defined in: api/getOrders/index.ts:27

Method getOrders - Used to get the orders from the user.

Parameters ​

context ​

PlentysystemsIntegrationContext

params ​

UseUserOrderSearchParams

Returns ​

Promise<Data<GetOrdersResponse>>

Remarks ​

  • Calls /rest/storefront/orders
  • This method is used to get the orders from the user.

Example ​

ts
const { data } = await useSdk().plentysystems.getOrders({
    page: 0
});