pixiImportGetChannels · Pixi API documentation

Returns one row per channel stored in C_Channels. The call takes no parameters and applies no filter.

For each channel the call returns:

the channel key (ChannelKey)
the channel name (ChannelName)
the name of the channel type (ChannelType). This value is looked up in C_ChannelTypes through the channel's ChannelTypeRef.

The code sets no sort order, so the order of the rows is not guaranteed.

Notes

Both tables are read with NOLOCK, so uncommitted changes may appear in the result.
ChannelType is NULL if no channel type matches the channel's ChannelTypeRef.
The column data types are not visible in the code because the table definitions are not attached.

Tables used

C_Channels · Read C_ChannelTypes · Read

This call has no parameters.

Result set 1 · Always

One row per channel in C_Channels.

Column	Type	Description
`ChannelKey`	int	Key of the channel (`C_Channels.ChannelKey`).
`ChannelName` Nullable	string	Name of the channel (`C_Channels.ChannelName`).
`ChannelType` Nullable	string	Name of the channel type (`C_ChannelTypes.ChannelTypeName`), looked up through `ChannelTypeRef`. `NULL` if no channel type matches.

Response example

<SqlRowSet1>
  <row>
    <ChannelKey>1</ChannelKey>
    <ChannelName>Webshop DE</ChannelName>
    <ChannelType>Shop</ChannelType>
  </row>
  <row>
    <ChannelKey>2</ChannelKey>
    <ChannelName>Amazon DE</ChannelName>
    <ChannelType>Marketplace</ChannelType>
  </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:pixiImportGetChannels/>
  </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:pixiImportGetChannels/>
  </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 = [
];

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

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