Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetOrderComments

Pixi-Docs
Old Pixi-Docs

This API call returns all order comments, with their creation date and user, filtered by the order number or the order number shop. The order number shop is also known as order number external

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

Orderlines Orders

Request

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

Request body

Name Type Required Description
OrderNr integer false

Search for order comments of the provided order number

Type: int

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
OrderNrShop string false

Search for order comments of the provided order number external

Type: varchar(50)

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetOrderComments>
      <OrderNr>0</OrderNr>
      <OrderNrShop>string</OrderNrShop>
    </pixiGetOrderComments>
  </Body>
</Envelope>

Response

Name Type Description

Response Example

<PixiGetOrderCommentsPost200TextXmlResponse />

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:pixiGetOrderComments>
            <OrderNr xsi:type="xsd:integer"></OrderNr>
            <OrderNrShop xsi:type="xsd:string"></OrderNrShop>
        </ns1:pixiGetOrderComments>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetOrderComments', [
    'OrderNr' => '', // integer
    'OrderNrShop' => '', // 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);
}