Description
API call that updates the order values
Request Parameters
| # |
Name |
Type |
Required |
Example |
Description |
| 1 |
OrderNr |
integer |
0 |
123 |
Filter: pixi order number |
| 2 |
OrderNrExternal |
string |
0 |
abc123 |
Filter: Shop order number |
| 3 |
ShipCosts |
number |
0 |
9.99 |
Shipping costs for the order |
| 4 |
ShipDate |
string |
0 |
YYYY-MM-DD hh:mm:ss |
Preferred shipping date |
| 5 |
ShopNote |
string |
0 |
abc |
Note received with this order from the shop (aka ShopComment). |
| 6 |
VoucherID |
string |
0 |
abc |
ID of the voucher (must be provided with Voucher Amount) |
| 7 |
VoucherAmount |
number |
0 |
5.00 |
Amount covered with the associated voucher (cannot be provided without VoucherID) |
| 8 |
PaymentType |
string |
0 |
K |
Payment type code |
| 9 |
AddressRemarks |
string |
0 |
abc |
Details for delivery to end customer |
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:pixiUpdateOrder>
<dem:OrderNr>123</dem:OrderNr>
<dem:OrderNrExternal>abc123</dem:OrderNrExternal>
<dem:ShipCosts>9.99</dem:ShipCosts>
<dem:ShipDate>YYYY-MM-DD hh:mm:ss</dem:ShipDate>
<dem:ShopNote>abc</dem:ShopNote>
<dem:VoucherID>abc</dem:VoucherID>
<dem:VoucherAmount>5.00</dem:VoucherAmount>
<dem:PaymentType>K</dem:PaymentType>
<dem:AddressRemarks>abc</dem:AddressRemarks>
</dem:pixiUpdateOrder>
</soapenv:Body>
</soapenv:Envelope>
Response
Body 1: Update status response
| # |
Name |
Type |
Description |
| 1 |
Status |
string |
Update status (Error/Success) |
| 2 |
Message |
string |
Detail status description |
Additional Notes
To **identify** the order that needs to be updated one of the "filter" conditions need to be provided.
**Important:**
Only orders that have status "OPEN, HOLD" can be updated.
When all orderlines are on invoice/s the order can not be updated anymore.
**Parameter @ShipDate**
- When you send empty as string, existing value in OrderHeader will be deleted (set to NULL).
- When you send as NULL, existing value in OrderHeader will not be changed.
**Result messages:**
- Success - Order with OrderNr: 138288 was updated. Error - Parameter
- OrderNr/OrderNrExternal is mandatory parameter and needs to be
provided.
- Error - Order with OrderNr: -100 (XYZ) does not exist.
- Error - Order with OrderNr: 138288 (ABS_279300286) can not be updated
anymore.|
