Unofficial Pixi-API-Documentation

by koempf24.de

pixiSetBouncedReminderToPrint

Pixi-Docs
Old Pixi-Docs

Use this procedure to support mail bounce calls from eMill so whenever the mail would bounce back this procedure would be called to set reminder action to PRINT and also update invoices from latest reminder(s) one level back.

Since pixi version: LOU Official (6.3.0.4452) Additional notes:

Customers

Request

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

Request body

Name Type Required Description
eMail string true

[mandatory] The email to identify the customer

Type: varchar

Default value:

Example:

Available from: LOU Official (6.3.0.4452)
ResultCode string false

Status of the operation is returned in this parameter:

    200 DONE

    500 Unexpected error 

    are the possible values

Type: varchar

Default value:

Example:

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiSetBouncedReminderToPrint>
      <eMail>string</eMail>
      <ResultCode>string</ResultCode>
    </pixiSetBouncedReminderToPrint>
  </Body>
</Envelope>

Response

Name Type Description
ResultCode string

Status of the operation is returned in this parameter: 200 DONE 500 Unexpected error are the possible values

Type: 1

Available from: LOU Official (6.3.0.4452)

Response Example

<PixiSetBouncedReminderToPrintPost200TextXmlResponse>
  <ResultCode>string</ResultCode>
</PixiSetBouncedReminderToPrintPost200TextXmlResponse>

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:pixiSetBouncedReminderToPrint>
            <eMail xsi:type="xsd:string"></eMail> <!-- required -->
            <ResultCode xsi:type="xsd:string"></ResultCode>
        </ns1:pixiSetBouncedReminderToPrint>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiSetBouncedReminderToPrint', [
    'eMail' => '', // string (required)
    'ResultCode' => '', // 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);
}