Description
API call that updates specific values on orderlines.
Request Parameters
| # |
Name |
Type |
Required |
Example |
Description |
| 1 |
OrderlineKey |
integer |
0 |
123 |
Orderline ID (to identify the line that will be updated) |
| 2 |
ArtName |
string |
0 |
abcdefg |
Item name displayed on the orderline |
| 3 |
Qty |
integer |
0 |
123 |
Quantity of the ordered item |
| 4 |
Price |
number |
0 |
9.99 |
Item price |
| 5 |
FullPrice |
number |
0 |
9.99 |
Full price for the orderline |
| 6 |
oItemSpecialNote |
string |
0 |
abcdefg |
Item special note |
| 7 |
DiscountValue |
number |
0 |
10.00 |
Discount value for item |
| 8 |
DiscountPerc |
string |
0 |
5.3 |
Discount percent for item |
| 9 |
DF_Type |
string |
0 |
abcdefg |
Direct fullfilement type |
| 10 |
SerialNumber |
string |
0 |
abcdefg |
Serial number for the item |
| 11 |
BundleOrderlineKey |
integer |
0 |
abcdefg |
BundleOrderline ID (to identify the line that will be updated) |
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:pixiUpdateOrderline>
<dem:OrderlineKey>123</dem:OrderlineKey>
<dem:ArtName>abcdefg</dem:ArtName>
<dem:Qty>123</dem:Qty>
<dem:Price>9.99</dem:Price>
<dem:FullPrice>9.99</dem:FullPrice>
<dem:oItemSpecialNote>abcdefg</dem:oItemSpecialNote>
<dem:DiscountValue>10.00</dem:DiscountValue>
<dem:DiscountPerc>5.3</dem:DiscountPerc>
<dem:DF_Type>abcdefg</dem:DF_Type>
<dem:SerialNumber>abcdefg</dem:SerialNumber>
<dem:BundleOrderlineKey>abcdefg</dem:BundleOrderlineKey>
</dem:pixiUpdateOrderline>
</soapenv:Body>
</soapenv:Envelope>
Response
Body 1: Result if the call was successfull or not
| # |
Name |
Type |
Description |
| 1 |
result |
integer |
Returns value 1 if the update was possible. In case the update of orderline is not allowed anymore the value is 0. |
Additional Notes
#####This API updates the values on orderline. Since the calculations of the actual values are done on the server it is important to provide only the values that need to be changed.
- The API responds with **1** when the update is performed. And with **0** when the update failes.
- It is only possible to update orderlines that do not have orderline staus:
- EIN
- AUS
- STO
- NLB
- RET
- When changing the prices of the orderline the **@Price** and **@FullPrice** parameters are treated as:
- In case of **B2C** order as Gross prices
- In case of **B2B** order as Net prices
---
#####Sample usages:
- Update item name, special note, DF_type or serial number
<pix:pixiUpdateOrderline>
<pix:OrderlineKey>6185</pix:OrderlineKey>
<pix:ArtName>Item name</pix:ArtName>
<pix:oItemSpecialNote>I am a special note</pix:oItemSpecialNote>
<pix:DF_Type>2</pix:DF_Type>
<pix:SerialNumber>SN0123456789</pix:SerialNumber>
</pix:pixiUpdateOrderline>
- Update orderline item quantity
<pix:pixiUpdateOrderline>
<pix:OrderlineKey>6185</pix:OrderlineKey>
<pix:Qty>10</pix:Qty>
</pix:pixiUpdateOrderline>
- Update orderline discount percent
<pix:pixiUpdateOrderline>
<pix:OrderlineKey>6185</pix:OrderlineKey>
<pix:DiscountPerc>20</pix:DiscountPerc>
</pix:pixiUpdateOrderline>
- Update orderline discount value
<pix:pixiUpdateOrderline>
<pix:OrderlineKey>6185</pix:OrderlineKey>
<pix:DiscountValue>200</pix:DiscountValue>
</pix:pixiUpdateOrderline>
- Update the orderline price _(no discount)_
<pix:pixiUpdateOrderline>
<pix:OrderlineKey>6185</pix:OrderlineKey>
<pix:Price>800</pix:Price>
<pix:FullPrice>800</pix:FullPrice>
</pix:pixiUpdateOrderline>
- Update orderline price _(discount will be automatically calculated to 20%)_
<pix:pixiUpdateOrderline>
<pix:OrderlineKey>6185</pix:OrderlineKey>
<pix:Price>800</pix:Price>
<pix:FullPrice>1000</pix:FullPrice>
</pix:pixiUpdateOrderline>
- Update bundle price _(discount will be automatically calculated to 10%)_
<pix:pixiUpdateOrderline>
<pix:BundleOrderlineKey>6190</pix:BundleOrderlineKey>
<pix:Price>29.99</pix:Price>
<pix:FullPrice>33.33</pix:FullPrice>
</pix:pixiUpdateOrderline>
