pixiGetItemsOnStockBin
Procedure returns summarized stock on bins
Since pixi version: LOU Official (6.3.0.4452) Additional notes:
Request
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| LocID | string | false | [Optional] pixi* location id. (Default: empty) Type: varchar(3) Default value: NULL Example: 001 Available from: LOU Official (6.3.0.4452) |
| BinName | string | true | [Mandatory] Name of the bin. Type: varchar(50) Default value: Example: abc Available from: LOU Official (6.3.0.4452) |
| BinGroup | string | false | [Optional] Search by Bin Group Type: varchar(20) Default value: NULL Example: abc123 Available from: 24.10 (24.10.0.52259) |
| GroupItems | boolean | false | [Optional] When set to 1, procedure returns summarized "StockLevel" for items with multiple update dates. Type: bit Default value: 0 Example: 0 or 1 Available from: LOU Official (6.3.0.4452) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetItemsOnStockBin>
<BinName>string</BinName>
<LocID>string</LocID>
<GroupItems>true</GroupItems>
<BinGroup>string</BinGroup>
</pixiGetItemsOnStockBin>
</Body>
</Envelope>Response
1. Result set
| Name | Type | Description |
|---|---|---|
| EANUPC | string | EANUPC 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 | ItemKey Type: Int Available from: 25.06 (25.6.0.58802) |
| BinGroup | string | Group the bin belongs to. Type: varchar Available from: 25.06 (25.6.0.58802) |
| ItemName | string | Item Name Type: Varchar Available from: 25.06 (25.6.0.58802) |
| ItemNRInt | string | ItemNRInt Type: Varchar Available from: 25.06 (25.6.0.58802) |
| StockLevel | integer | StockLevel Type: Int Available from: 25.06 (25.6.0.58802) |
| UpdateDate | string | UpdateDate Type: DateTime 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) |
| ItemNrSuppl | string | ItemNrSuppl 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) |
Response Example
<PixiGetItemsOnStockBinPost200TextXmlResponse>
<ItemKey>0</ItemKey>
<EANUPC>string</EANUPC>
<ItemNRInt>string</ItemNRInt>
<ItemNrSuppl>string</ItemNrSuppl>
<StockLevel>0</StockLevel>
<UpdateDate>string</UpdateDate>
<ItemName>string</ItemName>
<InternalItemNumber>string</InternalItemNumber>
<BinGroup>string</BinGroup>
<BinName>string</BinName>
<BatchNumber>string</BatchNumber>
<BestBeforeDate>string</BestBeforeDate>
</PixiGetItemsOnStockBinPost200TextXmlResponse>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:pixiGetItemsOnStockBin>
<LocID xsi:type="xsd:string">001</LocID>
<BinName xsi:type="xsd:string">abc</BinName> <!-- required -->
<BinGroup xsi:type="xsd:string">abc123</BinGroup>
<GroupItems xsi:type="xsd:boolean">0 or 1</GroupItems>
</ns1:pixiGetItemsOnStockBin>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>PHP Example
<?php
getPixiSoapClientResponse('pixiGetItemsOnStockBin', [
'LocID' => '001', // string
'BinName' => 'abc', // string (required)
'BinGroup' => 'abc123', // string
'GroupItems' => '0 or 1', // boolean
]);
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);
}