PlentyONE Shop Docs

Appearance

@plentymarkets/shop-api / doMakeOrderReturn

Function: doMakeOrderReturn() ​

doMakeOrderReturn(context, params): Promise<Data<Order>>

Defined in: api/doMakeOrderReturn/index.ts:28

Method doMakeOrderReturn - Used to execute the order return.

Parameters ​

context ​

PlentysystemsIntegrationContext

params ​

MakeOrderReturnParams

params: a string derived from the url of the order

Returns ​

Promise<Data<Order>>

Order

Remarks ​

  • Calls /rest/storefront/returns
  • Method should be used to execute the order return.

Example ​

ts
const { data } = await useSdk().plentysystems.doMakeOrderReturn({
  orderId: 123456,
  orderAccessKey: 'ABCDEFGH',
  110: {
    quantitiy: 2,
    returnReasonId: 1,
  }
});