Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetCategories

Pixi-Docs
Old Pixi-Docs

pipiGetCategories

Since pixi version: LOU Official (6.3.0.4452) Additional notes:

Items Stock

Request

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

Request body

Name Type Required Description
TontrText string false

TontrText

Type: varchar(50)

Default value: NULL

Example:

Available from: LOU Official (6.3.0.4452)
TontrShort string false

TontrShort

Type: varchar(50)

Default value: NULL

Example:

Available from: LOU Official (6.3.0.4452)
TontrArtKey integer false

TontrArtKey

Type: int

Default value: NULL

Example:

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetCategories>
      <TontrArtKey>0</TontrArtKey>
      <TontrShort>string</TontrShort>
      <TontrText>string</TontrText>
    </pixiGetCategories>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
TontrText string

Name of the category

Type: varchar

Available from: 25.06 (25.6.0.58802)
TontrShort string

Shortname of the category

Type: varchar

Available from: 25.06 (25.6.0.58802)
TontrArtKey integer

Pixi* internal category-key

Type: int

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetCategoriesPost200TextXmlResponse>
  <TontrArtKey>0</TontrArtKey>
  <TontrShort>string</TontrShort>
  <TontrText>string</TontrText>
</PixiGetCategoriesPost200TextXmlResponse>

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:pixiGetCategories>
            <TontrText xsi:type="xsd:string"></TontrText>
            <TontrShort xsi:type="xsd:string"></TontrShort>
            <TontrArtKey xsi:type="xsd:integer"></TontrArtKey>
        </ns1:pixiGetCategories>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetCategories', [
    'TontrText' => '', // string
    'TontrShort' => '', // string
    'TontrArtKey' => '', // 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);
}