PlentyONE Shop Docs

Appearance

@plentymarkets/shop-api / doSubmitCancellation

Function: doSubmitCancellation() ​

doSubmitCancellation(context, params): Promise<Data<CancellationFormResponse>>

Defined in: api/doSubmitCancellation/index.ts:29

Method doSubmitCancellation - submit a cancellation form request.

Parameters ​

context ​

PlentysystemsIntegrationContext

params ​

CancellationFormParams

Returns ​

Promise<Data<CancellationFormResponse>>

Remarks ​

  • Calls POST /rest/storefront/cancellation This method is used to submit a cancellation form request.

Example ​

ts
const { data } = await sdk.plentysystems.doSubmitCancellation({
  email: 'customer@example.com',
  name: 'John Doe',
  orderId: 12345,
  reason: 'Changed my mind',
});