Unofficial Pixi-API-Documentation

by koempf24.de

pixiImportGetChannelSettings

Pixi-Docs
Old Pixi-Docs

API call returns settings for channel connected to external platforms

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

General

Request

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

Request body

Name Type Required Description
ChannelKey integer false

ID of the channel

Type: int

Default value: 0

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiImportGetChannelSettings>
      <ChannelKey>0</ChannelKey>
    </pixiImportGetChannelSettings>
  </Body>
</Envelope>

Response

1. List of settings

Name Type Description
ChannelName string

Channel name

Type: varchar (32)

Available from: / (25.7.0.59144)
SettingName string

Setting Name

Type: varchar (64)

Available from: / (25.7.0.59144)
SettingValue string

Setting Value

Type: varchar (8000)

Available from: / (25.7.0.59144)
ChannelTypeName string

Type of this Channel (e.g. URL / Plenty)

Type: varchar (32)

Available from: / (25.7.0.59144)

Response Example

<PixiImportGetChannelSettingsPost200TextXmlResponse>
  <ChannelName>string</ChannelName>
  <ChannelTypeName>string</ChannelTypeName>
  <SettingName>string</SettingName>
  <SettingValue>string</SettingValue>
</PixiImportGetChannelSettingsPost200TextXmlResponse>

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:pixiImportGetChannelSettings>
            <ChannelKey xsi:type="xsd:integer">123</ChannelKey>
        </ns1:pixiImportGetChannelSettings>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiImportGetChannelSettings', [
    'ChannelKey' => '123', // integer
]);

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);
}