Unofficial Pixi-API-Documentation

by koempf24.de

pixiCreateOrderComment

Pixi-Docs
Old Pixi-Docs

With this api call you can add a new order comment. The date and time of the comment is always the current timestamp of the server you are accessing.

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

Orderlines Orders

Request

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

Request body

Name Type Required Description
User string false

Type: varchar(50)

Default value:

Example:

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

Type: varchar(-1)

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
OrderNr integer false

Type: int

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="">
    <pixiCreateOrderComment>
      <OrderNr>0</OrderNr>
      <Comment>string</Comment>
      <User>string</User>
    </pixiCreateOrderComment>
  </Body>
</Envelope>

Response

Name Type Description

Response Example

<PixiCreateOrderCommentPost200TextXmlResponse />

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

PHP Example

<?php

getPixiSoapClientResponse('pixiCreateOrderComment', [
    'User' => '', // string
    'Comment' => '', // string
    'OrderNr' => '', // 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);
}