Unofficial Pixi-API-Documentation

by koempf24.de

pixiUpdateMailStatus

Pixi-Docs
Old Pixi-Docs

This API is used to update mail status in pixi*.

Since pixi version: 18.04 (8.4.40.34047) Additional notes: General info

    The API Call can be used by external mail sending service which will send mails to customer email address.
    
    **Important**
    
    Sending of emails via external service has to be enabled "PixiMail_SendingEnabled_External".
    
    If the setting is not enabled then you get following error message:
    - Sending of mails via External Service is disabled.
    
    **Using the XML parameter:**
    When using **XML** parameter you can specify Status for several Mails
     Sample XML structure:
    
    <MAILS>
        <MAIL>
            <ID>20</ID>
            <STATUS>QUEUED</STATUS>
        </MAIL>
        <MAIL>
            <ID>1</ID>
            <STATUS>FAILED</STATUS>
        </MAIL>
    </MAILS>
Orderlines Orders

Request

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

Request body

Name Type Required Description
XML string false

List of Mail Ids for which you want to update status. See additional information for XML structure.

Type: varchar(-1)

Default value: NULL

Example:

Available from: 18.04 (8.4.40.34047)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiUpdateMailStatus>
      <XML>string</XML>
    </pixiUpdateMailStatus>
  </Body>
</Envelope>

Response

1. Status of records from XML.

Name Type Description
Id integer

Mail id

Type: int

Available from: 18.04 (8.4.40.34047)
Status integer

Returns 0/1 if update was successful or not.

Type: int

Available from: 18.04 (8.4.40.34047)
Description string

Descriptive message if update was successful and reason why it failed.

Type: varchar(255)

Available from: 18.04 (8.4.40.34047)

Response Example

<PixiUpdateMailStatusPost200TextXmlResponse>
  <Id>0</Id>
  <Status>0</Status>
  <Description>string</Description>
</PixiUpdateMailStatusPost200TextXmlResponse>

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:pixiUpdateMailStatus>
            <XML xsi:type="xsd:string"></XML>
        </ns1:pixiUpdateMailStatus>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiUpdateMailStatus', [
    'XML' => '', // 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);
}