Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetStockMovementTypesForOperation

Pixi-Docs
Old Pixi-Docs

Enabled but undocumented

API call returns stock movement types with description

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

Items Stock

Request

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

Request body

Name Type Required Description
SMOKey integer false

Filter: Stock movement operation ID

Type: int

Default value: NULL

Example: 123

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

Filter: language

Type: int

Default value: 2

Example: 1 - English, 2 - German

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

Filter: Application

Type: varchar(100)

Default value: Picco

Example: API, BinClient_A, Mobile, Picco, PPOS2, Repairs, ShippingClient_A, SupplOrders_A

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetStockMovementTypesForOperation>
      <Application>string</Application>
      <SMOKey>0</SMOKey>
      <LanguageID>0</LanguageID>
    </pixiGetStockMovementTypesForOperation>
  </Body>
</Envelope>

Response

1. Stock movement types

Name Type Description
TYPE string

Stock movement type code

Type: varchar

Available from: 25.06 (25.6.0.58802)
SMOKey integer

Stock movement operation ID

Type: int

Available from: 25.06 (25.6.0.58802)
SMTKey integer

Stock movement type ID

Type: int

Available from: 25.06 (25.6.0.58802)
SMTName string

Stock movement type name

Type: varchar

Available from: 25.06 (25.6.0.58802)
AskInGUI boolean

Show popup dialog in UI

Type: bit

Available from: 25.06 (25.6.0.58802)
DefaultType boolean

Type is marked as default type

Type: bit

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetStockMovementTypesForOperationPost200TextXmlResponse>
  <SMTKey>0</SMTKey>
  <SMOKey>0</SMOKey>
  <AskInGUI>true</AskInGUI>
  <TYPE>string</TYPE>
  <SMTName>string</SMTName>
  <DefaultType>true</DefaultType>
</PixiGetStockMovementTypesForOperationPost200TextXmlResponse>

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:pixiGetStockMovementTypesForOperation>
            <SMOKey xsi:type="xsd:integer">123</SMOKey>
            <LanguageID xsi:type="xsd:integer">1 - English, 2 - German</LanguageID>
            <Application xsi:type="xsd:string">API, BinClient_A, Mobile, Picco, PPOS2, Repairs, ShippingClient_A, SupplOrders_A</Application>
        </ns1:pixiGetStockMovementTypesForOperation>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetStockMovementTypesForOperation', [
    'SMOKey' => '123', // integer
    'LanguageID' => '1 - English, 2 - German', // integer
    'Application' => 'API, BinClient_A, Mobile, Picco, PPOS2, Repairs, ShippingClient_A, SupplOrders_A', // 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);
}