Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetItemStockBins

Pixi-Docs
Old Pixi-Docs

API call returns the current stock of item in bin places.

Since pixi version: LOU Official (6.3.0.4452) Additional notes: Select multiple items with one call:

     When using **ItemXML** parameter one can get the item info for **multiple items** with one call.
     Sample XML structure:
    
         <ITEMS>
        	<ITEM><ITEMKEY>365</ITEMKEY></ITEM>
        	<ITEM><EAN>2000000000091</EAN></ITEM>
        	<ITEM><ITEMNRINT>54e46dd1dc2c30a39.01766786</ITEMNRINT></ITEM>
        	<ITEM><ITEMNRSUPPL>mg316</ITEMNRSUPPL></ITEM>        
        </ITEMS>
    
    ----------
Items Stock

Request

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

Request body

Name Type Required Description
EAN string false

Filter: Item barcode.

Type: varchar(13)

Default value: NULL

Example:

Available from: LOU Official (6.3.0.4452)
ItemKey integer false

Filter: Item ID.

Type: int

Default value: NULL

Example:

Available from: LOU Official (6.3.0.4452)
ItemXML string false

Filter: See additional information for XML structure

Type: varchar(-1)

Default value: NULL

Example:

Available from: 18.04 (8.4.40.34047)
ItemNrInt string false

Filter: Item shop number.

Type: varchar(50)

Default value: NULL

Example:

Available from: LOU Official (6.3.0.4452)
ItemNrSuppl string false

Filter: Item supplier number.

Type: varchar(50)

Default value: NULL

Example:

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetItemStockBins>
      <ItemKey>0</ItemKey>
      <EAN>string</EAN>
      <ItemNrSuppl>string</ItemNrSuppl>
      <ItemNrInt>string</ItemNrInt>
      <ItemXML>string</ItemXML>
    </pixiGetItemStockBins>
  </Body>
</Envelope>

Response

1. Bins with current item stock.

Name Type Description
EAN string

Item barcode.

Type: varchar

Available from: 25.06 (25.6.0.58802)
LocID string

Location of the bin.

Type: varchar

Available from: 25.06 (25.6.0.58802)
BinName string

Bin name.

Type: varchar

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)
Quantity integer

Current item stock in bin.

Type: int

Available from: 25.06 (25.6.0.58802)
ItemNRInt string

Item shop number.

Type: varchar

Available from: 25.06 (25.6.0.58802)
BinSortNum integer

Bin sorting number.

Type: int

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)
TransportBin boolean

Boolean indicating if bin is a transport bin.

Type: bit

Available from: 25.06 (25.6.0.58802)
BestBeforeDate string

Best before date of the item.

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetItemStockBinsPost200TextXmlResponse>
  <BinName>string</BinName>
  <Quantity>0</Quantity>
  <BinSortNum>0</BinSortNum>
  <EAN>string</EAN>
  <ItemNRInt>string</ItemNRInt>
  <LocID>string</LocID>
  <BatchNumber>string</BatchNumber>
  <BestBeforeDate>string</BestBeforeDate>
  <BinGroup>string</BinGroup>
  <TransportBin>true</TransportBin>
</PixiGetItemStockBinsPost200TextXmlResponse>

2. Status output

Name Type Description
Status string

Execution status (INFO/ERROR)

Type: varchar

Available from: 25.06 (25.6.0.58802)
Message string

Description of the status

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetItemStockBinsPost200TextXmlResponse>
  <BinName>string</BinName>
  <Quantity>0</Quantity>
  <BinSortNum>0</BinSortNum>
  <EAN>string</EAN>
  <ItemNRInt>string</ItemNRInt>
  <LocID>string</LocID>
  <BatchNumber>string</BatchNumber>
  <BestBeforeDate>string</BestBeforeDate>
  <BinGroup>string</BinGroup>
  <TransportBin>true</TransportBin>
</PixiGetItemStockBinsPost200TextXmlResponse>

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:pixiGetItemStockBins>
            <EAN xsi:type="xsd:string"></EAN>
            <ItemKey xsi:type="xsd:integer"></ItemKey>
            <ItemXML xsi:type="xsd:string"></ItemXML>
            <ItemNrInt xsi:type="xsd:string"></ItemNrInt>
            <ItemNrSuppl xsi:type="xsd:string"></ItemNrSuppl>
        </ns1:pixiGetItemStockBins>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetItemStockBins', [
    'EAN' => '', // string
    'ItemKey' => '', // integer
    'ItemXML' => '', // string
    'ItemNrInt' => '', // string
    'ItemNrSuppl' => '', // 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);
}