pixiGetStockMovementOperations · Pixi API documentation

Reads the stock movement operations (table StockMovementOperations) that belong to the application given in Application. Typical use is filling a selection list of movement reasons in a client such as Picco.

Only operations whose stored Application value equals @Application exactly are returned. The filter uses the raw, untranslated value.
The application name and the operation name are translated through the Translation table, using the language from @LanguageID:
- The application name uses the DBObjectName ApplicationNames.
- The operation name uses StockMovementOperations, matched on SMOKey.
If no translation exists, the untranslated value from StockMovementOperations is returned.
App_SMOName combines both texts in the form Application - Name.
The original, untranslated operation name is always available in NameId.

The rows are sorted by application, then by the translated operation name.

Notes

The meaning of the language IDs (e.g. which language 2 stands for) is defined by the Pixi language master data, not by this procedure.
@Application must match the untranslated application key stored in StockMovementOperations, not a translated display name.
If no operation exists for the application, an empty result set is returned. No error is raised.
The data types of SMOKey, NameId, AskInGUI and Editable come from the table definition, which is not attached.

Tables used

StockMovementOperations · Read Translation · Read

Parameter	Type	Default	Description
`LanguageID`	int	2	Language used to translate the application and operation names via the `Translation` table. Example: `2`
`Application`	varchar(100) string	Picco	Application whose stock movement operations are returned. The value is compared exactly with the untranslated `Application` value in `StockMovementOperations`. Example: `Picco`

Result set 1 · Always (may be empty)

One row per stock movement operation of the requested application, sorted by application and translated name.

Column	Type	Description
`SMOKey`	string	Key of the stock movement operation.
`Application` Nullable	varchar(100) string	Translated application name, or the untranslated value if no translation exists.
`NAME` Nullable	varchar(512) string	Translated operation name, or the untranslated name if no translation exists.
`NameId` Nullable	string	Untranslated operation name as stored in `StockMovementOperations`.
`App_SMOName` Nullable	varchar(615) string	Combined display text in the form `Application - Name`, built from the translated values.
`AskInGUI` Nullable	boolean	Flag from `StockMovementOperations`. By its name, it indicates whether the operation is offered or queried in the user interface.
`Editable` Nullable	boolean	Flag from `StockMovementOperations`. By its name, it indicates whether the operation is editable.

Response example

<SqlRowSet1>
  <row>
    <SMOKey>12</SMOKey>
    <Application>Picco</Application>
    <NAME>Inventurkorrektur</NAME>
    <NameId>Inventory correction</NameId>
    <App_SMOName>Picco - Inventurkorrektur</App_SMOName>
    <AskInGUI>1</AskInGUI>
    <Editable>0</Editable>
  </row>
  <row>
    <SMOKey>15</SMOKey>
    <Application>Picco</Application>
    <NAME>Umlagerung</NAME>
    <NameId>Relocation</NameId>
    <App_SMOName>Picco - Umlagerung</App_SMOName>
    <AskInGUI>1</AskInGUI>
    <Editable>1</Editable>
  </row>
</SqlRowSet1>

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
Authorization: Basic BASE64(USERNAME:PASSWORD)

<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiGetStockMovementOperations>
      <!-- <LanguageID>2</LanguageID> -->
      <!-- <Application>Picco</Application> -->
    </ns1:pixiGetStockMovementOperations>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

curl -X POST 'https://apigateway.descartes.com/tms/pixi/' \
  --user 'USERNAME:PASSWORD' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --data-binary @- <<'XML'
<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiGetStockMovementOperations>
      <!-- <LanguageID>2</LanguageID> -->
      <!-- <Application>Picco</Application> -->
    </ns1:pixiGetStockMovementOperations>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

<?php

$soapClient = new SoapClient(null, [
    'login' => 'USERNAME',
    'password' => 'PASSWORD',
    'location' => 'https://apigateway.descartes.com/tms/pixi/',
    'uri' => 'https://apigateway.descartes.com/tms/pixi/',
]);

$arguments = [
    // 'LanguageID' => '2',
    // 'Application' => 'Picco',
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiGetStockMovementOperations', $soapArguments);