pixiGetComments

Returns comments of the customer or the order, which have been given as input parameter.

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: Offset can be used for pagination

Customers

Request

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

Request body

Name	Type	Required	Description
Offset	integer	false	Offset Type: int Default value: 0 Example: Available from: LOU Official - Update 46 (6.9.46.27927)
OrderNr	string	false	OrderNr Type: varchar(50) Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927)
RowCount	integer	false	RowCount Type: int Default value: 300 Example: Available from: LOU Official - Update 46 (6.9.46.27927)
CustomerNrExternal	string	false	CustomerNrExternal Type: varchar(255) Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetComments>
      <CustomerNrExternal>string</CustomerNrExternal>
      <OrderNr>string</OrderNr>
      <Offset>0</Offset>
      <RowCount>0</RowCount>
    </pixiGetComments>
  </Body>
</Envelope>

Response

1. Result set

Name	Type	Description
Date	string	Creation/Change-Date of the Comment Type: datetime Available from: 25.06 (25.6.0.58802)
Offset	integer	Indexnumber of this row Type: int Available from: 25.06 (25.6.0.58802)
Comment	string	The Comment which can be found in the pixi* Customer Service Module Type: varchar Available from: 25.06 (25.6.0.58802)
Employee	string	Employee who wrote that Comment Type: varchar Available from: 25.06 (25.6.0.58802)
TypeOfComment	string	CustomerComment - Comments made for the Customer OrderComment - Comments to the given OrderNr Type: varchar Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetCommentsPost200TextXmlResponse>
  <Offset>0</Offset>
  <TypeOfComment>string</TypeOfComment>
  <Date>string</Date>
  <Employee>string</Employee>
  <Comment>string</Comment>
</PixiGetCommentsPost200TextXmlResponse>

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:pixiGetComments>
            <Offset xsi:type="xsd:integer"></Offset>
            <OrderNr xsi:type="xsd:string"></OrderNr>
            <RowCount xsi:type="xsd:integer"></RowCount>
            <CustomerNrExternal xsi:type="xsd:string"></CustomerNrExternal>
        </ns1:pixiGetComments>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetComments', [
    'Offset' => '', // integer
    'OrderNr' => '', // string
    'RowCount' => '', // integer
    'CustomerNrExternal' => '', // string
]);

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

Unofficial Pixi-API-Documentation

by koempf24.de