pixiGetItemsStockHistory
API call returns stock movement details
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
DateTo | string | false | End date of item stock movements Type: datetime Default value: Current date time Example: YYYY-MM-DD hh:mm:ss Available from: LOU Official - Update 46 (6.9.46.27927) |
IbilKey | integer | false | Get data from IBILkey further Type: int Default value: 0 Example: 0 Available from: 22.02 (22.2.0.64904) |
DateFrom | string | true | Start date of item stock movements Type: datetime Default value: Example: YYYY-MM-DD hh:mm:ss Available from: LOU Official - Update 46 (6.9.46.27927) |
Location | string | false | Location ID Type: varchar(3) Default value: NULL Example: 001 Available from: LOU Official - Update 46 (6.9.46.27927) |
RowCount | integer | false | Rows to retun data Type: int Default value: 1000 Example: 1000 Available from: 22.02 (22.2.0.64904) |
DeliveryNumber | integer | false | Delivery number Type: int Default value: NULL Example: 123 Available from: 18.05 (8.4.41.34394) |
OrderNumberExternal | string | false | Order number external Type: varchar(50) Default value: NULL Example: abcdefg Available from: 18.05 (8.4.41.34394) |
RelocateTransactionID | string | false | Relocate transaction ID Type: uniqueidentifier Default value: NULL Example: UNIQUEIDENTIFIER Available from: 18.05 (8.4.41.34394) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetItemsStockHistory>
<DateFrom>string</DateFrom>
<DateTo>string</DateTo>
<Location>string</Location>
<OrderNumberExternal>string</OrderNumberExternal>
<DeliveryNumber>0</DeliveryNumber>
<RelocateTransactionID>string</RelocateTransactionID>
<RowCount>0</RowCount>
<IbilKey>0</IbilKey>
</pixiGetItemsStockHistory>
</Body>
</Envelope>
Response
1. Stock movement details
Name | Type | Description |
---|---|---|
Qty | integer | Quantity connected to stock movement Type: int Available from: 25.06 (25.6.0.58802) |
LocID | string | Location code Type: varchar Available from: 25.06 (25.6.0.58802) |
EANUPC | string | Item barcode Type: varchar Available from: 25.06 (25.6.0.58802) |
Reason | string | Manually entered reason for stock movement Type: varchar Available from: 25.06 (25.6.0.58802) |
SMType | string | Stock Movement Type Code Type: varchar Available from: 25.06 (25.6.0.58802) |
BinName | string | Bin name Type: varchar Available from: 25.06 (25.6.0.58802) |
IBILkey | integer | Internal ID for this stock movement (can be used for INSERT OR REPLACE queries) Type: int Available from: 25.06 (25.6.0.58802) |
ItemKey | integer | pixi* item ID Type: int Available from: 25.06 (25.6.0.58802) |
ItemNrInt | string | Shop item number Type: varchar Available from: 25.06 (25.6.0.58802) |
UpdateEmp | string | User who last updated the record Type: varchar Available from: 25.06 (25.6.0.58802) |
UpdateDate | string | Last update date of the record Type: datetime Available from: 25.06 (25.6.0.58802) |
BatchNumber | string | Item batch number Type: varchar Available from: 25.06 (25.6.0.58802) |
ItemNrSuppl | string | Supplier item number Type: varchar Available from: 25.06 (25.6.0.58802) |
SMOperation | string | Stock Movement Operation (Application/Action) Type: varchar Available from: 25.06 (25.6.0.58802) |
ForOrderline | integer | Connected orderline ID Type: int Available from: 25.06 (25.6.0.58802) |
BestBeforeDate | string | Item best before date Type: datetime Available from: 25.06 (25.6.0.58802) |
DeliveryNumber | integer | Delivery number Type: int Available from: 25.06 (25.6.0.58802) |
OrderNrExternal | string | Order number external Type: varchar Available from: 25.06 (25.6.0.58802) |
RelocateTransactionID | string | Relocate transaction ID Type: uniqueidentifier Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetItemsStockHistoryPost200TextXmlResponse>
<IBILkey>0</IBILkey>
<ItemKey>0</ItemKey>
<ItemNrInt>string</ItemNrInt>
<EANUPC>string</EANUPC>
<ItemNrSuppl>string</ItemNrSuppl>
<Qty>0</Qty>
<UpdateEmp>string</UpdateEmp>
<UpdateDate>string</UpdateDate>
<BinName>string</BinName>
<LocID>string</LocID>
<ForOrderline>0</ForOrderline>
<Reason>string</Reason>
<SMType>string</SMType>
<SMOperation>string</SMOperation>
<BatchNumber>string</BatchNumber>
<BestBeforeDate>string</BestBeforeDate>
<RelocateTransactionID>string</RelocateTransactionID>
<DeliveryNumber>0</DeliveryNumber>
<OrderNrExternal>string</OrderNrExternal>
</PixiGetItemsStockHistoryPost200TextXmlResponse>
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:pixiGetItemsStockHistory>
<DateTo xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</DateTo>
<IbilKey xsi:type="xsd:integer">0</IbilKey>
<DateFrom xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</DateFrom> <!-- required -->
<Location xsi:type="xsd:string">001</Location>
<RowCount xsi:type="xsd:integer">1000</RowCount>
<DeliveryNumber xsi:type="xsd:integer">123</DeliveryNumber>
<OrderNumberExternal xsi:type="xsd:string">abcdefg</OrderNumberExternal>
<RelocateTransactionID xsi:type="xsd:string">UNIQUEIDENTIFIER</RelocateTransactionID>
</ns1:pixiGetItemsStockHistory>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetItemsStockHistory', [
'DateTo' => 'YYYY-MM-DD hh:mm:ss', // string
'IbilKey' => '0', // integer
'DateFrom' => 'YYYY-MM-DD hh:mm:ss', // string (required)
'Location' => '001', // string
'RowCount' => '1000', // integer
'DeliveryNumber' => '123', // integer
'OrderNumberExternal' => 'abcdefg', // string
'RelocateTransactionID' => 'UNIQUEIDENTIFIER', // 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);
}