Unofficial Pixi-API-Documentation

by koempf24.de

pixiAddCustomerComment

Pixi-Docs
Old Pixi-Docs

Adds a comment for a pixi* customer

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

Customers

Request

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

Request body

Name Type Required Description
ShopID string false

pixi* Shop ID

Type: varchar(3)

Default value: NULL

Example:

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

Comment to be added for customer

Type: ntext

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
CustomerNrExternal string true

Customer Nr from Shop

Type: varchar(250)

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="">
    <pixiAddCustomerComment>
      <CustomerNrExternal>string</CustomerNrExternal>
      <Comment>string</Comment>
      <ShopID>string</ShopID>
    </pixiAddCustomerComment>
  </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

<PixiAddCustomerCommentPost200TextXmlResponse>
  <ReturnMessage>0</ReturnMessage>
</PixiAddCustomerCommentPost200TextXmlResponse>

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:pixiAddCustomerComment>
            <ShopID xsi:type="xsd:string"></ShopID>
            <Comment xsi:type="xsd:string"></Comment> <!-- required -->
            <CustomerNrExternal xsi:type="xsd:string"></CustomerNrExternal> <!-- required -->
        </ns1:pixiAddCustomerComment>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiAddCustomerComment', [
    'ShopID' => '', // string
    'Comment' => '', // string (required)
    'CustomerNrExternal' => '', // string (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);
}