pixiReport_StockMovementsForItemsWithBnBbd
API call that exposes pixi* report: "Stock Movements for Items with BN/BBD"
Since pixi version: AVA 17.07 (8.4.31.30601) Additional notes: This report shows the history of stock movements per bin and item with TAG for batch number and/ or best before date in custom time frame. With the different filter parameters you have the possibility to see stock movements of a certain location or stock movement type. Additionally you can select a user and the report will show you all stock movements of items that were made by one of your employees. Supplier price is from the time of the stock movement. Column "Summe EK" displays supplier price multiplied by moved stock quantity.
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
LocID | string | false | Search by location ID Type: varchar(3) Default value: Empty (all records shown) Example: 001 Available from: AVA 17.07 (8.4.31.30601) |
DateTo | string | false | End of stock movement peroid Type: datetime Default value: End of current day Example: YYYY-MM-DD hh:mm:ss Available from: AVA 17.07 (8.4.31.30601) |
SMTKey | integer | false | Search by stock movement ID Type: int Default value: Empty (all records shown) Example: 123 Available from: AVA 17.07 (8.4.31.30601) |
ItemTag | integer | false | Search by item tag ID Type: int Default value: Empty (all records shown) Example: -6 (Batch Number) or -7 (Best Before Date) Available from: AVA 17.07 (8.4.31.30601) |
SupplNr | string | false | Search by Supplier Type: varchar(4) Default value: Empty (all records shown) Example: 12ab Available from: 21.10 (21.10.0.61843) |
Category | string | false | Search by category Type: varchar(4) Default value: Empty (all records shown) Example: 12ab Available from: AVA 17.07 (8.4.31.30601) |
DateFrom | string | false | Start of stock movement peroid Type: datetime Default value: Start of current day Example: YYYY-MM-DD hh:mm:ss Available from: AVA 17.07 (8.4.31.30601) |
UserName | string | false | Search by user name Type: varchar(100) Default value: Empty (all records shown) Example: asdf Available from: AVA 17.07 (8.4.31.30601) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiReport_StockMovementsForItemsWithBnBbd>
<DateFrom>string</DateFrom>
<DateTo>string</DateTo>
<SMTKey>0</SMTKey>
<UserName>string</UserName>
<LocID>string</LocID>
<ItemTag>0</ItemTag>
<Category>string</Category>
<SupplNr>string</SupplNr>
</pixiReport_StockMovementsForItemsWithBnBbd>
</Body>
</Envelope>
Response
1. Report "Stock Movements for Items with BN/BBD" output columns
Name | Type | Description |
---|---|---|
Date | string | Date of stock movement Type: datetime Available from: 25.06 (25.6.0.58802) |
Stock | integer | Physical stock of the item Type: int Available from: 25.06 (25.6.0.58802) |
EANUPC | string | Item barcode Type: varchar Available from: 25.06 (25.6.0.58802) |
BinName | string | Bin name Type: varchar Available from: 25.06 (25.6.0.58802) |
ItemKey | integer | Item Id Type: int Available from: 25.06 (25.6.0.58802) |
SMTName | string | Stock movement type name Type: varchar Available from: 25.06 (25.6.0.58802) |
SMTType | string | Stock movement type code Type: varchar Available from: 25.06 (25.6.0.58802) |
SupplNr | string | Supplier number (code) Type: varchar Available from: 25.06 (25.6.0.58802) |
ItemName | string | Item name Type: varchar Available from: 25.06 (25.6.0.58802) |
MovedQty | integer | Quantity of moved item Type: int Available from: 25.06 (25.6.0.58802) |
UserName | string | User that made the stock movement Type: varchar Available from: 25.06 (25.6.0.58802) |
ItemNrInt | string | Shop item number Type: varchar Available from: 25.06 (25.6.0.58802) |
BatchNumber | string | Batch number of the item Type: varchar Available from: 25.06 (25.6.0.58802) |
BestBeforeDate | string | Best before date of the item Type: datetime Available from: 25.06 (25.6.0.58802) |
InternalItemNumber | string | Internal Item Number Type: varchar Available from: 25.06 (25.6.0.58802) |
HistTotalSupplPrice | number | Historical supplier price times quantity of moved item Type: money Available from: 25.06 (25.6.0.58802) |
DatabaseCurrencyCode | string | Database currency code Type: varchar Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiReport_StockMovementsForItemsWithBnBbdPost200TextXmlResponse>
<EANUPC>string</EANUPC>
<ItemName>string</ItemName>
<BinName>string</BinName>
<Stock>0</Stock>
<MovedQty>0</MovedQty>
<HistTotalSupplPrice>0</HistTotalSupplPrice>
<Date>string</Date>
<SMTType>string</SMTType>
<SMTName>string</SMTName>
<BatchNumber>string</BatchNumber>
<BestBeforeDate>string</BestBeforeDate>
<UserName>string</UserName>
<DatabaseCurrencyCode>string</DatabaseCurrencyCode>
<SupplNr>string</SupplNr>
<ItemKey>0</ItemKey>
<ItemNrInt>string</ItemNrInt>
<InternalItemNumber>string</InternalItemNumber>
</PixiReport_StockMovementsForItemsWithBnBbdPost200TextXmlResponse>
2. Error response
Name | Type | Description |
---|---|---|
Status | string | Status of the responce Type: varchar Available from: 25.06 (25.6.0.58802) |
Message | string | Description of the error response Type: varchar Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiReport_StockMovementsForItemsWithBnBbdPost400TextXmlResponse>
<Status>string</Status>
<Message>string</Message>
</PixiReport_StockMovementsForItemsWithBnBbdPost400TextXmlResponse>
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:pixiReport_StockMovementsForItemsWithBnBbd>
<LocID xsi:type="xsd:string">001</LocID>
<DateTo xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</DateTo>
<SMTKey xsi:type="xsd:integer">123</SMTKey>
<ItemTag xsi:type="xsd:integer">-6 (Batch Number) or -7 (Best Before Date)</ItemTag>
<SupplNr xsi:type="xsd:string">12ab</SupplNr>
<Category xsi:type="xsd:string">12ab</Category>
<DateFrom xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</DateFrom>
<UserName xsi:type="xsd:string">asdf</UserName>
</ns1:pixiReport_StockMovementsForItemsWithBnBbd>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiReport_StockMovementsForItemsWithBnBbd', [
'LocID' => '001', // string
'DateTo' => 'YYYY-MM-DD hh:mm:ss', // string
'SMTKey' => '123', // integer
'ItemTag' => '-6 (Batch Number) or -7 (Best Before Date)', // integer
'SupplNr' => '12ab', // string
'Category' => '12ab', // string
'DateFrom' => 'YYYY-MM-DD hh:mm:ss', // string
'UserName' => 'asdf', // 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);
}