pixiUpdateDelivery
API call updates the delivery header values
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: Closing a delivery:
With this API call it is possible to change the status of the delivery. It is important to know that when we close the delivery the items will **not automatically** be **added to stock**. Regardless of the setting BatchBinItemsOnDelivery value.
To put items to stock we suggest to use API call **pixiSetStockMultiple**.
A delivery can be **locked** by a **mobile user**. Indicating that a person is currently processing the delivery.
Request
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| Note | string | false | Delivery note (free text field for additional information about the delivery) Type: varchar(8000) Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
| Status | string | false | Delivery status. Valid values: NEW (new delivery), INV (invoiced), CLS (closed). Note: Closing delivery does not automatically add items to stock. Type: varchar(3) Default value: NULL Example: NEW Available from: LOU Official - Update 46 (6.9.46.27927) |
| SupplNr | string | false | (obsolete) Supplier number can not be changed on the delivery anymore Type: varchar(4) Default value: NULL Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927) |
| SDelHkey | integer | false | Delivery ID (SDelHKey from SDelHeader table). Either SDelHkey or DeliveryNumber must be provided. Type: int Default value: NULL Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
| UserName | string | false | Update user name (use when updating from web aplication). Defaults to API if not provided. Type: varchar(50) Default value: API Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927) |
| PiccoUser | string | false | Mobile user name (use when executing from a mobile device) Used for locking deliveries. Type: varchar(59) Default value: NULL Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927) |
| extOrderNr | string | false | External order numbers from supplier (Matching supplier order numbers for delivery are automatically populated, when updating the values get overwritten). Type: varchar(8000) Default value: NULL Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927) |
| LockDelivery | boolean | false | Lock the delivery while working on it Type: bit Default value: 0 Example: 0 or 1 Available from: LOU Official - Update 46 (6.9.46.27927) |
| extInvoiceNr | string | false | External invoice number for delivery (used for matching with external system) Type: varchar(25) Default value: NULL Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927) |
| DeliveryNumber | integer | false | Delivery number (SDelHNr from SDelHeader table). Either SDelHkey or DeliveryNumber must be provided. Type: int Default value: NULL Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
| ExternalReceiptNr | string | false | External receipt number from supplier (must be unique per supplier) Type: varchar(50) Default value: Example: EXT12345 Available from: 26.01 (26.1.0.63937) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiUpdateDelivery>
<SDelHkey>0</SDelHkey>
<SupplNr>string</SupplNr>
<DeliveryNumber>0</DeliveryNumber>
<Note>string</Note>
<extInvoiceNr>string</extInvoiceNr>
<extOrderNr>string</extOrderNr>
<UserName>string</UserName>
<PiccoUser>string</PiccoUser>
<Status>string</Status>
<LockDelivery>true</LockDelivery>
<ExternalReceiptNr>string</ExternalReceiptNr>
</pixiUpdateDelivery>
</Body>
</Envelope>Response
1. Call status
| Name | Type | Description |
|---|---|---|
| ReturnMSG | string | Return message description Type: VARCHAR Available from: / (26.3.0.65266) |
Response Example
<PixiUpdateDeliveryPost200TextXmlResponse>
<ReturnMSG>string</ReturnMSG>
</PixiUpdateDeliveryPost200TextXmlResponse>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:pixiUpdateDelivery>
<Note xsi:type="xsd:string"></Note>
<Status xsi:type="xsd:string">NEW</Status>
<SupplNr xsi:type="xsd:string">abcdefg</SupplNr>
<SDelHkey xsi:type="xsd:integer">123</SDelHkey>
<UserName xsi:type="xsd:string">abcdefg</UserName>
<PiccoUser xsi:type="xsd:string">abcdefg</PiccoUser>
<extOrderNr xsi:type="xsd:string">abcdefg</extOrderNr>
<LockDelivery xsi:type="xsd:boolean">0 or 1</LockDelivery>
<extInvoiceNr xsi:type="xsd:string">abcdefg</extInvoiceNr>
<DeliveryNumber xsi:type="xsd:integer">123</DeliveryNumber>
<ExternalReceiptNr xsi:type="xsd:string">EXT12345</ExternalReceiptNr>
</ns1:pixiUpdateDelivery>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>PHP Example
<?php
getPixiSoapClientResponse('pixiUpdateDelivery', [
'Note' => '', // string
'Status' => 'NEW', // string
'SupplNr' => 'abcdefg', // string
'SDelHkey' => '123', // integer
'UserName' => 'abcdefg', // string
'PiccoUser' => 'abcdefg', // string
'extOrderNr' => 'abcdefg', // string
'LockDelivery' => '0 or 1', // boolean
'extInvoiceNr' => 'abcdefg', // string
'DeliveryNumber' => '123', // integer
'ExternalReceiptNr' => 'EXT12345', // 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);
}