pixiGetItemStockOnLocations

Pixi-Docs

Old Pixi-Docs

Deprecated

Returns item stock on location

Since pixi version: LOU Official (6.3.0.4452) Additional notes:

Items Stock

Request

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

Request body

Name	Type	Required	Description
EAN	string	false	Item EAN Type: varchar(13) Default value: NULL Example: abcdef Available from: LOU Official (6.3.0.4452)
ItemKey	integer	false	Item Id Type: int Default value: NULL Example: 123 Available from: LOU Official (6.3.0.4452)
Quantity	integer	false	Quantity - output Type: int Default value: NULL Example: 001 Available from: LOU Official (6.3.0.4452)
ItemNrInt	string	false	Item number (internal) Type: varchar(50) Default value: NULL Example: abcdef Available from: LOU Official (6.3.0.4452)
LocationId	string	false	Location Id Type: varchar(50) Default value: NULL Example: 001 Available from: LOU Official (6.3.0.4452)
ItemNrSuppl	string	false	Item number (supplier) Type: varchar(50) Default value: NULL Example: abcdef Available from: LOU Official (6.3.0.4452)

Request Example

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

Response

1. Result set

Name	Type	Description
AvailQTY	integer	AvailQTY Type: int Available from: 25.06 (25.6.0.58802)
Location	string	Location Type: varchar Available from: 25.06 (25.6.0.58802)
PhysicalQTY	integer	PhysicalQTY Type: int Available from: 25.06 (25.6.0.58802)
RealQtyAvail	integer	RealQtyAvail Type: int Available from: 25.06 (25.6.0.58802)
SpecialStock	integer	SpecialStock Type: int Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetItemStockOnLocationsPost200TextXmlResponse>
  <Location>string</Location>
  <PhysicalQTY>0</PhysicalQTY>
  <AvailQTY>0</AvailQTY>
  <RealQtyAvail>0</RealQtyAvail>
  <SpecialStock>0</SpecialStock>
</PixiGetItemStockOnLocationsPost200TextXmlResponse>

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:pixiGetItemStockOnLocations>
            <EAN xsi:type="xsd:string">abcdef</EAN>
            <ItemKey xsi:type="xsd:integer">123</ItemKey>
            <Quantity xsi:type="xsd:integer">001</Quantity>
            <ItemNrInt xsi:type="xsd:string">abcdef</ItemNrInt>
            <LocationId xsi:type="xsd:string">001</LocationId>
            <ItemNrSuppl xsi:type="xsd:string">abcdef</ItemNrSuppl>
        </ns1:pixiGetItemStockOnLocations>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetItemStockOnLocations', [
    'EAN' => 'abcdef', // string
    'ItemKey' => '123', // integer
    'Quantity' => '001', // integer
    'ItemNrInt' => 'abcdef', // string
    'LocationId' => '001', // string
    'ItemNrSuppl' => 'abcdef', // 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