Unofficial Pixi-API-Documentation

by koempf24.de

pixiSetSupplierStockMultiple

Pixi-Docs
Old Pixi-Docs

Deprecated

API call to set multi stock of item in bin.

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: If parameter "Username" is not provided at all, "pipiSetSupplierStockMultiple" is used by default.

    **Items** parameter sample XML:
    <ITEMS>
        <ITEM>
            <ItemNrSuppl>123456_XL</ItemNrSuppl>
            <Quantity>50</Quantity>
        </ITEM>
        <ITEM>
            <ItemNrSuppl>123456_L</ItemNrSuppl>
            <Quantity>30</Quantity>
        </ITEM>
    </ITEMS>
    
    API call return new current stock on bin.
Items Stock

Request

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

Request body

Name Type Required Description
Items string true

XML with multiple defined filters

Type: xml

Default value: NULL

Example: See additional information

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

Name of the bin

Type: varchar(50)

Default value: NULL

Example: A-1-0

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

Supplier number

Type: varchar(4)

Default value: MGS

Example: abcdefg

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

Bin location (in case of same binnames on locations)

Type: varchar(3)

Default value: 001

Example: 001

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

User name

Type: varchar(50)

Default value: pipiSetSupplierStockMultiple

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiSetSupplierStockMultiple>
      <Items>string</Items>
      <SupplNr>string</SupplNr>
      <Location>string</Location>
      <BinName>string</BinName>
      <Username>string</Username>
    </pixiSetSupplierStockMultiple>
  </Body>
</Envelope>

Response

1. Returning the item information.

Name Type Description
Quantity integer

Item stock quantity

Type: int

Available from: 25.06 (25.6.0.58802)
ItemNrSuppl string

Supplier item number

Type: varchar (50)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiSetSupplierStockMultiplePost200TextXmlResponse>
  <ItemNrSuppl>string</ItemNrSuppl>
  <Quantity>0</Quantity>
</PixiSetSupplierStockMultiplePost200TextXmlResponse>

2. Status output

Name Type Description
Code string

Execution status (OK/ERROR)

Type: varchar (20)

Available from: 25.06 (25.6.0.58802)
Message string

Description of the status

Type: varchar (200)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiSetSupplierStockMultiplePost200TextXmlResponse>
  <ItemNrSuppl>string</ItemNrSuppl>
  <Quantity>0</Quantity>
</PixiSetSupplierStockMultiplePost200TextXmlResponse>

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:pixiSetSupplierStockMultiple>
            <Items xsi:type="xsd:string">See additional information</Items> <!-- required -->
            <BinName xsi:type="xsd:string">A-1-0</BinName> <!-- required -->
            <SupplNr xsi:type="xsd:string">abcdefg</SupplNr>
            <Location xsi:type="xsd:string">001</Location>
            <Username xsi:type="xsd:string">abcdefg</Username>
        </ns1:pixiSetSupplierStockMultiple>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiSetSupplierStockMultiple', [
    'Items' => 'See additional information', // string (required)
    'BinName' => 'A-1-0', // string (required)
    'SupplNr' => 'abcdefg', // string
    'Location' => '001', // string
    'Username' => '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);
}