Unofficial Pixi-API-Documentation

by koempf24.de

pixiShopLinkGetItemsStock

Pixi-Docs
Old Pixi-Docs

[Deprecated] Returns stock of all items.

Since pixi version: LOU Official (6.3.0.4452) Additional notes: DEPRECATED: This call should not be used anymore! Please check pixiGetItemStock instead.

Items Stock

Request

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

Request body

Name Type Required Description
ExcludeZeros boolean false

Enabled parameter (1) will exclude all items with quantity 0

Type: bit

Default value: 0

Example: 0 or 1

Available from: LOU Official (6.3.0.4452)
ExcludeBinGroups string false

Provide bin group names to exclude, separated by comma

Type: varchar(-1)

Default value: NULL

Example: abcdefg

Available from: AVA Official - Update 23 (8.4.23.27873)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiShopLinkGetItemsStock>
      <ExcludeZeros>true</ExcludeZeros>
      <ExcludeBinGroups>string</ExcludeBinGroups>
    </pixiShopLinkGetItemsStock>
  </Body>
</Envelope>

Response

1. Item stock

Name Type Description
ItemNrInt string

Shop item number

Type: varchar (50)

Available from: 25.06 (25.6.0.58802)
AvailableQty integer

Items available quantity

Type: int

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiShopLinkGetItemsStockPost200TextXmlResponse>
  <ItemNrInt>string</ItemNrInt>
  <AvailableQty>0</AvailableQty>
</PixiShopLinkGetItemsStockPost200TextXmlResponse>

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:pixiShopLinkGetItemsStock>
            <ExcludeZeros xsi:type="xsd:boolean">0 or 1</ExcludeZeros>
            <ExcludeBinGroups xsi:type="xsd:string">abcdefg</ExcludeBinGroups>
        </ns1:pixiShopLinkGetItemsStock>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiShopLinkGetItemsStock', [
    'ExcludeZeros' => '0 or 1', // boolean
    'ExcludeBinGroups' => '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);
}