pixi Developer & Integration Documentation

pixiSetOrderShippingLock

Description

API call to set order shipping lock.


Request Parameters

# Name Type Required Example Description
1 OrderNr integer 1 123 Order to set shipping lock
2 Locked boolean 0 0 or 1 1 = Order Shipping Lock set, 0 = Order Shipping Lock released
3 UserName string 0 abcdefg User that updated the order shipping lock
4 Reason string 0 abcdefg Released / Locked reason

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:pixiSetOrderShippingLock>
         <dem:OrderNr>123</dem:OrderNr>
         <dem:Locked>0 or 1</dem:Locked>
         <dem:UserName>abcdefg</dem:UserName>
         <dem:Reason>abcdefg</dem:Reason>
      </dem:pixiSetOrderShippingLock>
   </soapenv:Body>
</soapenv:Envelope>

Response


Body 1: Result Set.

# Name Type Description
1 ReturnCode string Return code (OK / INFO / ERROR)
2 ErrorMessage string Return description message.

Additional Notes

In case when the reason is empty we add Order was locked by / Order was unlocked by + UserName.