pixi Developer & Integration Documentation

pixiCancelOrder

Description

API call is used to cancel complete order (all orderlines are put in status "STO")


Request Parameters

# Name Type Required Example Description
1 OrderNr integer 1 123 Filter: pixi* order number
2 Status string 0 NLB Orderline status

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:pixiCancelOrder>
         <dem:OrderNr>123</dem:OrderNr>
         <dem:Status>NLB</dem:Status>
      </dem:pixiCancelOrder>
   </soapenv:Body>
</soapenv:Envelope>

Response


Body 1: Result

# Name Type Description
1 SuccessfulMessage string Success message

Body 2: Result

# Name Type Description
1 ErrorMessage string Error message

Additional Notes


Only status STO (Canceled) or NLB (items not avaliable) are possible tu use.
The API call will assign that status to all orderlines of the order , excluding:
	- orderlines that are in status AUS, STO, NLB, RET
	- orderlines that are currently assigned to a ship out box
	- orderlines that are already present on an invoice

In case all of the orderlines of the order have status STO, also the order status will change to CLOSED.

The Api call will exit with return value 0 when it was successfull. And with return value 1 in case of error.