pixiImportGetChannelSettings · Pixi API documentation

Reads the channel identified by ChannelKey from the channel table and returns one row per setting of that channel.

The channel type name is joined via the channel's type reference (left join, so it is empty if the type is missing).
The settings are joined with a left join. A channel without any settings therefore still returns one row with empty SettingName and SettingValue.
If no channel with the given key exists, no rows are returned.

No sort order is defined.

Notes

All tables are read with NOLOCK, so uncommitted changes may be visible. The default ChannelKey of 0 usually matches no channel; always pass the key explicitly.

Tables used

C_Channels · Read C_ChannelTypes · Read C_ChannelSettings · Read

Parameter	Type	Default	Description
`ChannelKey`	int	0	Key of the channel whose settings are returned. Example: `3`

Result set 1 · Always; empty if no channel with the given key exists.

One row per setting of the channel, or one row with empty setting columns if the channel has no settings.

Column	Type	Description
`ChannelName` Nullable	string	Name of the channel.
`ChannelTypeName` Nullable	string	Name of the channel type; empty if the type is not found.
`SettingName` Nullable	string	Name of the setting; empty if the channel has no settings.
`SettingValue` Nullable	string	Value of the setting.

Response example

<SqlRowSet1>
  <row>
    <ChannelName>Shop DE</ChannelName>
    <ChannelTypeName>Shopware</ChannelTypeName>
    <SettingName>ApiUrl</SettingName>
    <SettingValue>https://shop.example.de/api</SettingValue>
  </row>
  <row>
    <ChannelName>Shop DE</ChannelName>
    <ChannelTypeName>Shopware</ChannelTypeName>
    <SettingName>ImportInterval</SettingName>
    <SettingValue>15</SettingValue>
  </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:pixiImportGetChannelSettings>
      <!-- <ChannelKey>3</ChannelKey> -->
    </ns1:pixiImportGetChannelSettings>
  </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:pixiImportGetChannelSettings>
      <!-- <ChannelKey>3</ChannelKey> -->
    </ns1:pixiImportGetChannelSettings>
  </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 = [
    // 'ChannelKey' => '3',
];

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

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