pixiGetStockBins

Get bin information including the number of items in specific bin

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:

Items Stock

Request

POST https://apigateway.descartes.com/tms/pixi/pixiGetStockBins

Request body

Name	Type	Required	Description
LocID	string	false	Location Id Type: varchar(3) Default value: NULL Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927)
Start	integer	false	Starting row position Type: int Default value: 0 Example: 0 Available from: LOU Official - Update 46 (6.9.46.27927)
BinGroup	string	false	Search by Bin Group Type: varchar(20) Default value: NULL Example: abc123 Available from: 24.10 (24.10.0.52259)
RowCount	integer	false	Number of returned rows Type: int Default value: 0 Example: 100 Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetStockBins>
      <LocID>string</LocID>
      <RowCount>0</RowCount>
      <Start>0</Start>
      <BinGroup>string</BinGroup>
    </pixiGetStockBins>
  </Body>
</Envelope>

Response

1. Bin information

Name	Type	Description
RowNr	string	Row number Type: bigint Available from: 25.06 (25.6.0.58802)
BinKey	integer	Bin ID Type: int Available from: 25.06 (25.6.0.58802)
BinName	string	Bin name Type: varchar Available from: 25.06 (25.6.0.58802)
BinGroup	string	Bin group Type: varchar Available from: 25.06 (25.6.0.58802)
BinLocID	string	LocationID of bin Type: varchar Available from: 25.06 (25.6.0.58802)
BinSortNum	integer	Internal Sorting Number for this bin. This reflects how this bin is taken on Picklists Type: int Available from: 25.06 (25.6.0.58802)
NrOfItemOnBin	integer	Total items on bin Type: int Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetStockBinsPost200TextXmlResponse>
  <RowNr>string</RowNr>
  <BinKey>0</BinKey>
  <BinName>string</BinName>
  <BinLocID>string</BinLocID>
  <BinSortNum>0</BinSortNum>
  <BinGroup>string</BinGroup>
  <NrOfItemOnBin>0</NrOfItemOnBin>
</PixiGetStockBinsPost200TextXmlResponse>

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:pixiGetStockBins>
            <LocID xsi:type="xsd:string">abcdefg</LocID>
            <Start xsi:type="xsd:integer">0</Start>
            <BinGroup xsi:type="xsd:string">abc123</BinGroup>
            <RowCount xsi:type="xsd:integer">100</RowCount>
        </ns1:pixiGetStockBins>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetStockBins', [
    'LocID' => 'abcdefg', // string
    'Start' => '0', // integer
    'BinGroup' => 'abc123', // string
    'RowCount' => '100', // integer
]);

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);
}

Unofficial Pixi-API-Documentation

by koempf24.de