pixi Developer & Integration Documentation

pixiDFUpdateOrderlineStatus

Description

API call sets the orderline status


Request Parameters

# Name Type Required Example Description
1 SupplNr string 1 MGS SupplNr of the items, that should be retrieved. You can also submit "foo" to get all items, but this has to be enabled in Control Center beforehand.
2 Secret string 1 abcdefg This is the CustomerNr set in the Supplier table in web pixi (Suppliers section under purchasing). Can be "bar" but this has to be enabled in Control Center.
3 Status string 1 FUS Orderline status
4 OrderHistoryKey integer 0 123 OrderHistory record ID that you want to set the"ClientNotified" flag for
5 DFShipDate string 0 YYYY-MM-DD hh:mm:ss DF Ship date
6 DFTrackingID string 0 abcdefg DF Tracking ID
7 Qty integer 0 123 Orderline item quantity
8 InvoiceNrExternal string 0 abcdefg External invoice number
9 OrderlineRef integer 0 123 Orderline ID
10 BatchNumber string 0 asdf1234 Batch number for items tagged with Batch Number
11 BestBeforeDate string 0 YYYY-MM-DD hh:mm:ss Best before date for items tagged with Best Before Date
12 SerialNumber string 0 abcdefg Item serial number

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:pixiDFUpdateOrderlineStatus>
         <dem:SupplNr>MGS</dem:SupplNr>
         <dem:Secret>abcdefg</dem:Secret>
         <dem:Status>FUS</dem:Status>
         <dem:OrderHistoryKey>123</dem:OrderHistoryKey>
         <dem:DFShipDate>YYYY-MM-DD hh:mm:ss</dem:DFShipDate>
         <dem:DFTrackingID>abcdefg</dem:DFTrackingID>
         <dem:Qty>123</dem:Qty>
         <dem:InvoiceNrExternal>abcdefg</dem:InvoiceNrExternal>
         <dem:OrderlineRef>123</dem:OrderlineRef>
         <dem:BatchNumber>asdf1234</dem:BatchNumber>
         <dem:BestBeforeDate>YYYY-MM-DD hh:mm:ss</dem:BestBeforeDate>
         <dem:SerialNumber>abcdefg</dem:SerialNumber>
      </dem:pixiDFUpdateOrderlineStatus>
   </soapenv:Body>
</soapenv:Envelope>

Response


Body 1: Error set

# Name Type Description
1 Error string HTML error/success code
2 ErrorMsg string Error/Success message

Additional Notes

API call will also try to split the orderline when the quantity sent with @Qty parameter is lower than the current item quantity on the specified orderline.

NOTE: When setting "DFAPIAllowFullAccessWithoutSecret" is set to 1 in Control center the values for @SupplNr and @Secret do not need to be valid but still need to be send. 

Sample parameter values when setting "DFAPIAllowFullAccessWithoutSecret" = 1 would be: @SupplNr = "foo", @Secret = "bar"