Description
Updates the quantity allocation for a specific location on a supplier order line. Both ordered quantity and undelivered quantity can be updated independently. If a quantity parameter is omitted or sent as NULL, the corresponding value is left unchanged.
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
1 |
AppName |
string |
1 |
MyApp |
Name of the application executing the API call. |
2 |
UserId |
int |
0 |
42 |
ID of the user executing the API call. Either UserId or UserName must be provided. |
3 |
UserName |
string |
1 |
jsmith |
Username of the user executing the API call. Either UserId or UserName must be provided. |
4 |
SupplierOrderLineLocQtyId |
int |
1 |
131 |
ID of the supplier order line location quantity record to update. |
5 |
ConsiderPackageUnits |
bit |
0 |
0 |
Apply packing units to the quantity. 0 = no (default), 1 = yes. |
6 |
ConsiderMinOrderQty |
bit |
0 |
0 |
Apply minimum order quantity rules. 0 = no (default), 1 = yes. |
7 |
Qty |
int |
0 |
10 |
New ordered quantity. If NULL or omitted, the existing value is unchanged. |
8 |
UndeliveredQty |
int |
0 |
5 |
New undelivered quantity. If NULL or omitted, the existing value is unchanged. |
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:pixiSupplierOrderLineLocQtyUpdate>
<dem:AppName>MyApp</dem:AppName>
<dem:UserId>42</dem:UserId>
<dem:UserName>jsmith</dem:UserName>
<dem:SupplierOrderLineLocQtyId>131</dem:SupplierOrderLineLocQtyId>
<dem:ConsiderPackageUnits>0</dem:ConsiderPackageUnits>
<dem:ConsiderMinOrderQty>0</dem:ConsiderMinOrderQty>
<dem:Qty>10</dem:Qty>
<dem:UndeliveredQty>5</dem:UndeliveredQty>
</dem:pixiSupplierOrderLineLocQtyUpdate>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: Updated Record
Returned on success.
# |
Name |
Type |
Description |
1 |
Updated_SupplierOrderLineId |
int |
ID of the supplier order line that was updated. |
2 |
Updated_SupplierOrderLineLocQtyId |
int |
ID of the supplier order line location quantity record that was updated. |
Body 2: Error Information
Returned instead of Body 1 when an unexpected error occurs.
# |
Name |
Type |
Description |
1 |
ReturnCode |
string |
Always "ERROR" on failure. |
2 |
ErrorMessage |
string |
Description of the error. |
Additional Notes
Either UserId or UserName must be provided.
At least one of Qty or UndeliveredQty should be provided for a meaningful update.
Qty and UndeliveredQty behaviour:
- If the parameter is NULL or omitted, the existing value is left unchanged.
- If the parameter is provided, the existing value is overwritten.
ConsiderPackageUnits and ConsiderMinOrderQty apply the same rounding logic
as used in supplier order suggestions.