Unofficial Pixi-API-Documentation

by koempf24.de

pixiAddOrderComment

Pixi-Docs
Old Pixi-Docs

Update order shop note.

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

Orderlines Orders

Request

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

Request body

Name Type Required Description
Comment string true

Comment

Type: nvarchar

Default value:

Example: abc

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

Order Nr

Type: int

Default value:

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

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

Response

1. Result set

Name Type Description
ReturnMessage integer

1 = TRUE , 0 = FALSE

Type: int

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiAddOrderCommentPost200TextXmlResponse>
  <ReturnMessage>0</ReturnMessage>
</PixiAddOrderCommentPost200TextXmlResponse>

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:pixiAddOrderComment>
            <Comment xsi:type="xsd:string">abc</Comment> <!-- required -->
            <OrderNr xsi:type="xsd:integer">123</OrderNr> <!-- required -->
        </ns1:pixiAddOrderComment>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiAddOrderComment', [
    'Comment' => 'abc', // string (required)
    'OrderNr' => '123', // integer (required)
]);

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