pixiGetItemStockHistory

API call returns stock movement details

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

Items Stock

Request

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

Request body

Name	Type	Required	Description
EAN	string	false	Filter: Item barcode Type: varchar(13) Default value: NULL Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927)
ItemKey	integer	false	Filter: Item ID Type: int Default value: NULL Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927)
PageSize	integer	false	Pagination: Determine the page size (MAX:45000) Type: int Default value: 10000 Example: 100 Available from: AVA 17.10 (8.4.34.31829)
ItemNrInt	string	false	Filter: Shop item number Type: varchar(50) Default value: NULL Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927)
LanguageID	integer	false	Switch: Language selection (1-EN, 2-DE) Type: int Default value: 2 Example: 1 Available from: LOU Official - Update 46 (6.9.46.27927)
PageNumber	integer	false	Pagination: Select the page number to get returned Type: int Default value: 1 Example: 23 Available from: AVA 17.10 (8.4.34.31829)
ItemNrSuppl	string	false	Filter: Item number supplier Type: varchar(50) Default value: NULL Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetItemStockHistory>
      <ItemKey>0</ItemKey>
      <EAN>string</EAN>
      <ItemNrSuppl>string</ItemNrSuppl>
      <ItemNrInt>string</ItemNrInt>
      <LanguageID>0</LanguageID>
      <PageSize>0</PageSize>
      <PageNumber>0</PageNumber>
    </pixiGetItemStockHistory>
  </Body>
</Envelope>

Response

1. Stock movement details

Name	Type	Description
Qty	integer	Quantity Type: int Available from: 25.06 (25.6.0.58802)
LocID	string	Location code Type: varchar (3) Available from: 25.06 (25.6.0.58802)
Reason	string	Stock movement reason Type: varchar (50) Available from: 25.06 (25.6.0.58802)
BinName	string	Bin name Type: varchar (151) Available from: 25.06 (25.6.0.58802)
SMOName	string	Stock movement operation Type: varchar (512) Available from: 25.06 (25.6.0.58802)
SMTName	string	Stock movement type Type: varchar (517) Available from: 25.06 (25.6.0.58802)
UpdateEmp	string	User who last updated the record Type: varchar (100) Available from: 25.06 (25.6.0.58802)
TotalPages	integer	Count of total pages (Use in connection with @PageNumber parameter) Type: int Available from: 25.06 (25.6.0.58802)
UpdateDate	string	Last update date of the record Type: datetime Available from: 25.06 (25.6.0.58802)
ForOrderline	integer	Connected orderline ID Type: int Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetItemStockHistoryPost200TextXmlResponse>
  <Qty>0</Qty>
  <UpdateEmp>string</UpdateEmp>
  <UpdateDate>string</UpdateDate>
  <BinName>string</BinName>
  <LocID>string</LocID>
  <ForOrderline>0</ForOrderline>
  <Reason>string</Reason>
  <SMOName>string</SMOName>
  <SMTName>string</SMTName>
  <TotalPages>0</TotalPages>
</PixiGetItemStockHistoryPost200TextXmlResponse>

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:pixiGetItemStockHistory>
            <EAN xsi:type="xsd:string">abcdefg</EAN>
            <ItemKey xsi:type="xsd:integer">123</ItemKey>
            <PageSize xsi:type="xsd:integer">100</PageSize>
            <ItemNrInt xsi:type="xsd:string">abcdefg</ItemNrInt>
            <LanguageID xsi:type="xsd:integer">1</LanguageID>
            <PageNumber xsi:type="xsd:integer">23</PageNumber>
            <ItemNrSuppl xsi:type="xsd:string">abcdefg</ItemNrSuppl>
        </ns1:pixiGetItemStockHistory>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetItemStockHistory', [
    'EAN' => 'abcdefg', // string
    'ItemKey' => '123', // integer
    'PageSize' => '100', // integer
    'ItemNrInt' => 'abcdefg', // string
    'LanguageID' => '1', // integer
    'PageNumber' => '23', // integer
    'ItemNrSuppl' => 'abcdefg', // 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);
}

Unofficial Pixi-API-Documentation

by koempf24.de