Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetStockBinsEmpty

Pixi-Docs
Old Pixi-Docs

Get empty bins

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

Items Stock

Request

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

Request body

Name Type Required Description
Rows integer false

Number of rows returned

Type: int

Default value: 10

Example: 10

Available from: LOU Official - Update 46 (6.9.46.27927)
LocID string false

Location Id

Type: varchar(3)

Default value: NULL

Example: 001

Available from: LOU Official - Update 46 (6.9.46.27927)
BinName string false

Bin Name

Type: varchar(50)

Default value: NULL

Example: abcdef

Available from: LOU Official - Update 46 (6.9.46.27927)
NearBinKey integer false

Search arround this Bin

Type: int

Default value: NULL

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetStockBinsEmpty>
      <LocID>string</LocID>
      <Rows>0</Rows>
      <NearBinKey>0</NearBinKey>
      <BinName>string</BinName>
    </pixiGetStockBinsEmpty>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
BinKey integer

Bin Reference Key

Type: int

Available from: 25.06 (25.6.0.58802)
BinName string

Bin Name

Type: varchar

Available from: 25.06 (25.6.0.58802)
BinLocID string

LocationID of this bin

Type: varchar

Available from: 25.06 (25.6.0.58802)
BinSortNum integer

Sort Number of this bin

Type: int

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetStockBinsEmptyPost200TextXmlResponse>
  <BinSortNum>0</BinSortNum>
  <BinLocID>string</BinLocID>
  <BinName>string</BinName>
  <BinKey>0</BinKey>
</PixiGetStockBinsEmptyPost200TextXmlResponse>

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:pixiGetStockBinsEmpty>
            <Rows xsi:type="xsd:integer">10</Rows>
            <LocID xsi:type="xsd:string">001</LocID>
            <BinName xsi:type="xsd:string">abcdef</BinName>
            <NearBinKey xsi:type="xsd:integer">123</NearBinKey>
        </ns1:pixiGetStockBinsEmpty>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetStockBinsEmpty', [
    'Rows' => '10', // integer
    'LocID' => '001', // string
    'BinName' => 'abcdef', // string
    'NearBinKey' => '123', // integer
]);

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);
}