Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetPhysicalItemStock

Pixi-Docs
Old Pixi-Docs

Deprecated

This function returns the physical stock (i.e., how many items is physically in stock) for the given item and given location.

Use pixiGetItemStock instead!

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

Use either of the parameters to identify the required Item. If the item cannot be found, the function returns NULL. If several different parameters are used to identify the item and they indicate different valid items, result of the function is undefined (but corresponds to the stock of one of these items).

Items Stock

Request

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

Request body

Name Type Required Description
EAN string false

[optional] Filter by EAN. The default value is NULL.

Type: varchar (13)

Default value:

Example:

Available from: LOU Official (6.3.0.4452)
ItemKey integer false

[optional] Filter by item key. The default value is NULL.

Type: int

Default value:

Example:

Available from: LOU Official (6.3.0.4452)
ItemNrInt string false

[optional] Filter by ItemNrInt. The default value is NULL.

Type: varchar (50)

Default value:

Example:

Available from: LOU Official (6.3.0.4452)
LocationId string false

[optional] Location ID for the location you inquire the stock for. If the value does not indicate a valid location, the function returns NULL. The default value is NULL.

Type: char

Default value:

Example:

Available from: LOU Official (6.3.0.4452)
ItemNrSuppl string false

[optional] Filter by ItemNrSuppl. The default value is NULL.

Type: varchar (50)

Default value:

Example:

Available from: LOU Official (6.3.0.4452)

Request Example

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

Response

Name Type Description
return integer

Function returns an integer value of the physical stock for the given item and location, or NULL, if the item or location are not specified correctly

Type: int

Available from: LOU Official (6.3.0.4452)

Response Example

<PixiGetPhysicalItemStockPost200TextXmlResponse>
  <return>0</return>
</PixiGetPhysicalItemStockPost200TextXmlResponse>

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

PHP Example

<?php

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