pixiUpdateSOrderline
This API call updates an supplier orderline, by the given supplier orderline ID. The orderline ID can be received by the API call pixiGetSOrderlines.
Since pixi version: LOU Official (6.3.0.4452) Additional notes: General info
The API call is simulating the updating of supplier orderlines like in pixi* web buying.
There are certain limitations when updating the lines depending on the status of the supplier order.
When order is in status **NEW** or **BES** it is possible to update:
- **OrderQty**
- **SupplPrice**
In status **CON** the QtyNotDelivered can be set.
**EstimatedDelivery** and **Note** parameters have no status restrictions.
----------
**Important**
The parameter **QtyReceived** is no longer in use. The only way to set the received quantity is using the corresponding delivery for the supplier order.
When setting up a new OrderQty or SupplPrice the discounts set on the lines will be automatically applied when calculating the orderline total.
Note that modifying OrderQty or SupplPrice is not possible when order is has status confirmed or closed (CON, CLS).
Based on the line totals also the header values will get refreshed.
----------
Currently the automatic calculation of block prices and bonuses set per supplier are not considered when using the API call and need to be manually checked in pixi* web buying.
Request
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| Note | string | false | Adds a note to the given supplier orderline Type: varchar(1024) Default value: Example: abcdefg Available from: LOU Official (6.3.0.4452) |
| OrderQty | integer | false | Changes the ordered quantity (Only if supplier order is on statuses (NEW, BES) Type: int Default value: 0 Example: 123 Available from: LOU Official (6.3.0.4452) |
| UserName | string | true | Username which will be displayed in the update history Type: varchar(50) Default value: Example: abcdefg Available from: LOU Official (6.3.0.4452) |
| SupplPrice | number | false | Updates the supplier price for this item in this supplier orderline. The item supplier price itself is not changed for the item, only in this supplier order document. (Only if supplier order is on statuses (NEW, BES) Type: decimal Default value: NULL Example: 9.99 Available from: LOU Official - Update 46 (6.9.46.27927) |
| QtyReceived | integer | false | Obsolete - received quantity can only be set with delivery document Type: int Default value: 0 Example: 123 Available from: LOU Official (6.3.0.4452) |
| SorderlineKey | integer | true | Supplier orderline ID Type: int Default value: Example: 123 Available from: LOU Official (6.3.0.4452) |
| QtyNotDelivered | integer | false | Writes the quantity which was not delivered to the supplier orderline (Only updated when supplier order is on status CON, @SupplierPrice is NULL and @OrderQty IS NULL or 0) Type: int Default value: 0 Example: 123 Available from: LOU Official (6.3.0.4452) |
| EstimatedDelivery | string | false | Sets the estimated delivery date for this supplier orderline Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: LOU Official (6.3.0.4452) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiUpdateSOrderline>
<SorderlineKey>0</SorderlineKey>
<UserName>string</UserName>
<OrderQty>0</OrderQty>
<Note>string</Note>
<QtyReceived>0</QtyReceived>
<QtyNotDelivered>0</QtyNotDelivered>
<EstimatedDelivery>string</EstimatedDelivery>
<SupplPrice>0</SupplPrice>
</pixiUpdateSOrderline>
</Body>
</Envelope>Response
1. Status output
| Name | Type | Description |
|---|---|---|
| Message | string | Description of the status Type: varchar (200) Available from: 25.06 (25.6.0.58802) |
| ReturnCode | string | Execution status (OK/ERROR) Type: varchar (20) Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiUpdateSOrderlinePost200TextXmlResponse>
<ReturnCode>string</ReturnCode>
<Message>string</Message>
</PixiUpdateSOrderlinePost200TextXmlResponse>HTTP Example
POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
# echo -n '{{username}}:{{password}}' | base64 | pbcopy
Authorization: Basic {{token}}
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="https://apigateway.descartes.com/tms/pixi/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:pixiUpdateSOrderline>
<Note xsi:type="xsd:string">abcdefg</Note>
<OrderQty xsi:type="xsd:integer">123</OrderQty>
<UserName xsi:type="xsd:string">abcdefg</UserName> <!-- required -->
<SupplPrice xsi:type="xsd:number">9.99</SupplPrice>
<QtyReceived xsi:type="xsd:integer">123</QtyReceived>
<SorderlineKey xsi:type="xsd:integer">123</SorderlineKey> <!-- required -->
<QtyNotDelivered xsi:type="xsd:integer">123</QtyNotDelivered>
<EstimatedDelivery xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</EstimatedDelivery>
</ns1:pixiUpdateSOrderline>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>PHP Example
<?php
getPixiSoapClientResponse('pixiUpdateSOrderline', [
'Note' => 'abcdefg', // string
'OrderQty' => '123', // integer
'UserName' => 'abcdefg', // string (required)
'SupplPrice' => '9.99', // number
'QtyReceived' => '123', // integer
'SorderlineKey' => '123', // integer (required)
'QtyNotDelivered' => '123', // integer
'EstimatedDelivery' => 'YYYY-MM-DD hh:mm:ss', // string
]);
function getPixiSoapClientResponse(string $method, array $arguments = [])
{
$soapArguments = [];
foreach ($arguments as $key => $value) {
$soapArguments[] = new SoapVar($value, null, '', '', $key);
}
$soapClient = new SoapClient(null, [
'login' => '...',
'password' => '...',
'uri' => 'https://apigateway.descartes.com/tms/pixi/',
'location' => 'https://apigateway.descartes.com/tms/pixi/',
]);
return $soapClient->__call($method, $soapArguments);
}