pixi Developer & Integration Documentation

pixiCanCancelOrderline

Description

Use this function to determine, whether a given order line is in a state where it is possible to cancel it.

Important: If the requirement is to prohibit cancellations once orders are on picklist, this API Call current is not sufficient. See section On Picklist instead.

Request Parameters

#

Name

Type

Required

Example

Description

1

OrderlineKey

integer

0

123

[optional] Inspected orderline's ID


Request body

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
   <soapenv:Header/>
   <soapenv:Body>
      <dem:pixiCanCancelOrderline>
         <dem:OrderlineKey>123</dem:OrderlineKey>
      </dem:pixiCanCancelOrderline>
   </soapenv:Body>
</soapenv:Envelope>


Response


Body 1:

#

Name

Type

Description

0

return

integer

1 - it is possible to cancel, 0 - it is not possible to cancel


Additional Notes



On Picklist

If your goal or requirement is to prevent cancellations for orders that are on picklists call pixiGetOrderlineExtended for the affected @OrderNrExternal or the target line(s); no separate pixiCanCancelOrderline call is needed. Allow cancellation only when every affected row has Status = ANG or HAL and PicklistNr is NULL / Empty. If a row is missing, has another status, or has any PicklistNr value, do not cancel.