Description
Returns a status indicating whether additional order lines can be added to an existing order. The result depends on the order payment type and the current statuses of the existing order lines. Use this call to validate whether an order is eligible to receive new lines before attempting to add them.
For cash or credit card orders (payment type K or C), new order lines can be added only if all existing lines are in one of the following statuses: NEW, ANG, HAL, MIN, OPH, BES, STO, or NLB. For all other payment types, new order lines can be added only if no existing lines have a completed or shipped status (EIN or AUS).
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
1 |
PixiOrderNr |
int |
1 |
123 |
The pixi order number to check. |
2 |
CanAdd |
bit |
1 |
0 |
Output parameter. Returns 1 if orderlines can be added to the order, or 0 if not. Pass 0 in the request; the value is overwritten by the procedure. |
3 |
SupressOutput |
bit |
0 |
0 |
When set to 1, the result set is suppressed and only the output parameter is returned. Default is 0. |
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:pipiCanAddOrderlines>
<dem:PixiOrderNr>123</dem:PixiOrderNr>
<dem:CanAdd>0</dem:CanAdd>
<dem:SupressOutput>0</dem:SupressOutput>
</dem:pipiCanAddOrderlines>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: Result
# |
Name |
Type |
Description |
1 |
CanAdd |
bit |
Indicates whether orderlines can be added to the order. 1 = orderlines can be added; 0 = orderlines cannot be added. |
2 |
OrderNr |
int |
The pixi order number from the request. |
3 |
ErrorMessage |
varchar(60) |
Error message description. Currently always returns NULL. |
Additional Notes
The procedure applies different validation rules depending on the order payment type:
Cash and credit card orders (APayment = K or C):
Orderlines can be added only if all existing lines are in one of the following statuses:
NEW, ANG, HAL, MIN, OPH, BES, STO, NLB.
All other payment types:
Orderlines can be added only if no existing lines are in status EIN (dispatched) or AUS (shipped out).
If the order does not exist, CanAdd returns 0.
When SupressOutput = 1, the result set (Body 1) is not returned. Only the CanAdd output parameter value is available via the SOAP response.