pixiReport_ItemsOnStockWithBatchManagement
API call that exposes pixi* report: "Items on stock with BN/BBD"
Since pixi version: AVA 17.07 (8.4.31.30601) Additional notes: This report shows all items with TAGs for batch number or best before date that are currently on stock. It is possible to filter according to a certain time frame for best before date so that you can check which items on which bin places will expire soon. If you want to check the items with a specific batch number use the filter parameter for batch number. Filters for location and bin group allow to get a list of items for specific areas in your warehouse, TAG, category and supplier for a specific set of items.
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
Ean | string | false | Search by barcode Type: varchar(13) Default value: Empty (all records shown) Example: 12345fd343 Available from: AVA 17.07 (8.4.31.30601) |
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) |
ItemTag | integer | false | Search by Tag Key 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) |
BinGroup | string | false | Search by BinGroup Type: varchar(20) Default value: Empty (all records shown) Example: sdfds223 Available from: AVA 17.07 (8.4.31.30601) |
Category | string | false | Search by Category Type: varchar(4) Default value: Empty (all records shown) Example: 123 Available from: AVA 17.07 (8.4.31.30601) |
ItemNrInt | string | false | Search by Shop item number Type: varchar(50) Default value: Empty (all records shown) Example: 123 Available from: AVA 17.12 (8.4.36.32642) |
SupplierNr | string | false | Search by Supplier Nr. Type: varchar(4) Default value: Empty (all records shown) Example: ABCD Available from: AVA 17.07 (8.4.31.30601) |
BatchNumber | string | false | Search by Batch number Type: varchar(50) Default value: Empty (all records shown) Example: asdf1234 Available from: AVA 17.07 (8.4.31.30601) |
BestBeforeDateTo | string | false | Search by Best Before Date - To Type: datetime Default value: End of current day Example: YYYY-MM-DD hh:mm:ss Available from: AVA 17.07 (8.4.31.30601) |
BestBeforeDateFrom | string | false | Search by Best Before Date - From Type: datetime Default value: Start of current day Example: YYYY-MM-DD hh:mm:ss Available from: AVA 17.07 (8.4.31.30601) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiReport_ItemsOnStockWithBatchManagement>
<BatchNumber>string</BatchNumber>
<BestBeforeDateFrom>string</BestBeforeDateFrom>
<BestBeforeDateTo>string</BestBeforeDateTo>
<LocId>string</LocId>
<Ean>string</Ean>
<ItemTag>0</ItemTag>
<SupplierNr>string</SupplierNr>
<BinGroup>string</BinGroup>
<Category>string</Category>
<ItemNrInt>string</ItemNrInt>
</pixiReport_ItemsOnStockWithBatchManagement>
</Body>
</Envelope>
Response
1. Report "Items on stock with BN/BBD" output columns
Name | Type | Description |
---|---|---|
EANUPC | string | Item barcode Type: varchar (13) Available from: 25.06 (25.6.0.58802) |
BinName | string | Bin name where the item is located Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
ItemKey | integer | pixi* item ID Type: int Available from: 25.06 (25.6.0.58802) |
BinGroup | string | Bin group Type: varchar (20) Available from: 25.06 (25.6.0.58802) |
ItemName | string | Item name Type: varchar (120) Available from: 25.06 (25.6.0.58802) |
QtyInBin | integer | Item quantity in specified bin place Type: int Available from: 25.06 (25.6.0.58802) |
ItemNrInt | string | Shop item number Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
BatchNumber | string | Item batch number Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
ItemNrSuppl | string | Item number supplier Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
BestBeforeDate | string | Item best before date Type: datetime Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiReport_ItemsOnStockWithBatchManagementPost200TextXmlResponse>
<ItemKey>0</ItemKey>
<ItemNrSuppl>string</ItemNrSuppl>
<ItemNrInt>string</ItemNrInt>
<EANUPC>string</EANUPC>
<ItemName>string</ItemName>
<BatchNumber>string</BatchNumber>
<BestBeforeDate>string</BestBeforeDate>
<BinName>string</BinName>
<BinGroup>string</BinGroup>
<QtyInBin>0</QtyInBin>
</PixiReport_ItemsOnStockWithBatchManagementPost200TextXmlResponse>
2. Error response
Name | Type | Description |
---|---|---|
Status | string | Status of the responce Type: varchar(50) Available from: 25.06 (25.6.0.58802) |
Message | string | Description of the error response Type: varchar(4000) Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiReport_ItemsOnStockWithBatchManagementPost400TextXmlResponse>
<Status>string</Status>
<Message>string</Message>
</PixiReport_ItemsOnStockWithBatchManagementPost400TextXmlResponse>
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_ItemsOnStockWithBatchManagement>
<Ean xsi:type="xsd:string">12345fd343</Ean>
<LocId xsi:type="xsd:string">001</LocId>
<ItemTag xsi:type="xsd:integer">-6 (Batch Number) or -7 (Best Before Date)</ItemTag>
<BinGroup xsi:type="xsd:string">sdfds223</BinGroup>
<Category xsi:type="xsd:string">123</Category>
<ItemNrInt xsi:type="xsd:string">123</ItemNrInt>
<SupplierNr xsi:type="xsd:string">ABCD</SupplierNr>
<BatchNumber xsi:type="xsd:string">asdf1234</BatchNumber>
<BestBeforeDateTo xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</BestBeforeDateTo>
<BestBeforeDateFrom xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</BestBeforeDateFrom>
</ns1:pixiReport_ItemsOnStockWithBatchManagement>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiReport_ItemsOnStockWithBatchManagement', [
'Ean' => '12345fd343', // string
'LocId' => '001', // string
'ItemTag' => '-6 (Batch Number) or -7 (Best Before Date)', // integer
'BinGroup' => 'sdfds223', // string
'Category' => '123', // string
'ItemNrInt' => '123', // string
'SupplierNr' => 'ABCD', // string
'BatchNumber' => 'asdf1234', // string
'BestBeforeDateTo' => 'YYYY-MM-DD hh:mm:ss', // string
'BestBeforeDateFrom' => '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);
}