pixi Developer & Integration Documentation

pixiCancelOrderline

Description

API call cancels or sets to not available one single orderline or bundle with reletaed items on it, when status is not in Final State, item in box or already on invoice line.


Request Parameters

# Name Type Required Example Description
1 OrderlineKey integer 0 123 Orderline ID
2 Status string 0 NLB Orderline status
3 BundleOrderlineKey integer 0 123 BundleOrderline ID from OrderLines table, if set then change will be done only on given Bundle and items in the bundle

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:pixiCancelOrderline>
         <dem:OrderlineKey>123</dem:OrderlineKey>
         <dem:Status>NLB</dem:Status>
         <dem:BundleOrderlineKey>123</dem:BundleOrderlineKey>
      </dem:pixiCancelOrderline>
   </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

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