pixiDFUpdateOrderlineStatus
API call sets the orderline status
Since pixi version: LOU Official (6.3.0.4452) Additional notes: API call will also try to split the orderline when the quantity sent with @Qty parameter is lower than the current item quantity on the specified orderline.
NOTE: When setting "DFAPIAllowFullAccessWithoutSecret" is set to 1 in Control center the values for @SupplNr and @Secret do not need to be valid but still need to be send.
Sample parameter values when setting "DFAPIAllowFullAccessWithoutSecret" = 1 would be: @SupplNr = "foo", @Secret = "bar"
Request
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| Qty | integer | false | Orderline item quantity Type: int Default value: NULL Example: 123 Available from: LOU Official (6.3.0.4452) |
| Secret | string | true | This is the CustomerNr set in the Supplier table in web pixi (Suppliers section under purchasing). Can be "bar" but this has to be enabled in Control Center. Type: varchar(20) Default value: Example: abcdefg Available from: LOU Official (6.3.0.4452) |
| Status | string | true | Orderline status Type: varchar(3) Default value: Example: FUS Available from: LOU Official (6.3.0.4452) |
| SupplNr | string | true | SupplNr of the items, that should be retrieved. You can also submit "foo" to get all items, but this has to be enabled in Control Center beforehand. Type: varchar(4) Default value: Example: MGS Available from: LOU Official (6.3.0.4452) |
| DFShipDate | string | false | DF Ship date Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: LOU Official (6.3.0.4452) |
| BatchNumber | string | false | Batch number for items tagged with Batch Number Type: varchar(50) Default value: NULL Example: asdf1234 Available from: 23.08 (23.8.0.40260) |
| DFTrackingID | string | false | DF Tracking ID Type: varchar(100) Default value: NULL Example: abcdefg Available from: LOU Official (6.3.0.4452) |
| OrderlineRef | integer | false | Orderline ID Type: int Default value: 0 Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
| SerialNumber | string | false | Item serial number Type: varchar(50) Default value: NULL Example: abcdefg Available from: 23.08 (23.8.0.40260) |
| BestBeforeDate | string | false | Best before date for items tagged with Best Before Date Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: 23.08 (23.8.0.40260) |
| OrderHistoryKey | integer | false | OrderHistory record ID that you want to set the"ClientNotified" flag for Type: int Default value: 0 Example: 123 Available from: LOU Official (6.3.0.4452) |
| InvoiceNrExternal | string | false | External invoice number Type: varchar(20) Default value: NULL Example: abcdefg Available from: LOU Official (6.3.0.4452) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiDFUpdateOrderlineStatus>
<SupplNr>string</SupplNr>
<Secret>string</Secret>
<Status>string</Status>
<OrderHistoryKey>0</OrderHistoryKey>
<DFShipDate>string</DFShipDate>
<DFTrackingID>string</DFTrackingID>
<Qty>0</Qty>
<InvoiceNrExternal>string</InvoiceNrExternal>
<OrderlineRef>0</OrderlineRef>
<BatchNumber>string</BatchNumber>
<BestBeforeDate>string</BestBeforeDate>
<SerialNumber>string</SerialNumber>
</pixiDFUpdateOrderlineStatus>
</Body>
</Envelope>Response
1. Error set
| Name | Type | Description |
|---|---|---|
| Error | string | HTML error/success code Type: varchar Available from: 25.06 (25.6.0.58802) |
| ErrorMsg | string | Error/Success message Type: varchar Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiDFUpdateOrderlineStatusPost200TextXmlResponse>
<Error>string</Error>
<ErrorMsg>string</ErrorMsg>
</PixiDFUpdateOrderlineStatusPost200TextXmlResponse>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:pixiDFUpdateOrderlineStatus>
<Qty xsi:type="xsd:integer">123</Qty>
<Secret xsi:type="xsd:string">abcdefg</Secret> <!-- required -->
<Status xsi:type="xsd:string">FUS</Status> <!-- required -->
<SupplNr xsi:type="xsd:string">MGS</SupplNr> <!-- required -->
<DFShipDate xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</DFShipDate>
<BatchNumber xsi:type="xsd:string">asdf1234</BatchNumber>
<DFTrackingID xsi:type="xsd:string">abcdefg</DFTrackingID>
<OrderlineRef xsi:type="xsd:integer">123</OrderlineRef>
<SerialNumber xsi:type="xsd:string">abcdefg</SerialNumber>
<BestBeforeDate xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</BestBeforeDate>
<OrderHistoryKey xsi:type="xsd:integer">123</OrderHistoryKey>
<InvoiceNrExternal xsi:type="xsd:string">abcdefg</InvoiceNrExternal>
</ns1:pixiDFUpdateOrderlineStatus>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>PHP Example
<?php
getPixiSoapClientResponse('pixiDFUpdateOrderlineStatus', [
'Qty' => '123', // integer
'Secret' => 'abcdefg', // string (required)
'Status' => 'FUS', // string (required)
'SupplNr' => 'MGS', // string (required)
'DFShipDate' => 'YYYY-MM-DD hh:mm:ss', // string
'BatchNumber' => 'asdf1234', // string
'DFTrackingID' => 'abcdefg', // string
'OrderlineRef' => '123', // integer
'SerialNumber' => 'abcdefg', // string
'BestBeforeDate' => 'YYYY-MM-DD hh:mm:ss', // string
'OrderHistoryKey' => '123', // integer
'InvoiceNrExternal' => 'abcdefg', // 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);
}