Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetMailsWaitingToBeSent

Pixi-Docs
Old Pixi-Docs

Deprecated

This API call returns all mails which are waiting to be sent from 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 has to be enabled in pixi with setting "PixiMail_SendingEnabled". 
    and also setting to send emails via external service has to be enabled "PixiMail_SendingEnabled_External".
    
    If the settings are not enabled then you get one of the following error messages:
    - Sending of mails is disabled.
    - Sending of mails via External Service is disabled.
Orderlines Orders

Request

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

Request body

Name Type Required Description

Request Example

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

Response

1. Return list of mails that are waiting to be sent.

Name Type Description
Id integer

Mail id

Type: int

Available from: 18.04 (8.4.40.34047)
Body string

Email body

Type: varchar (MAX)

Available from: 18.04 (8.4.40.34047)
Subject string

Email subject

Type: varchar (500)

Available from: 18.04 (8.4.40.34047)
BodyType string

Email body type (HTML / TEXT)

Type: varchar (4)

Available from: 18.04 (8.4.40.34047)
ToAddress string

Email recipient

Type: varchar (100)

Available from: 18.04 (8.4.40.34047)
BccAddress string

Semicolon separated list of bcc recepients

Type: varchar (256)

Available from: 18.04 (8.4.40.34047)
AttachmentPaths string

Semicolon separated list of files from document storage (network path) which has to be sent as attachments.

Type: varchar (MAX)

Available from: 18.04 (8.4.40.34047)

Response Example

<PixiGetMailsWaitingToBeSentPost200TextXmlResponse>
  <Id>0</Id>
  <ToAddress>string</ToAddress>
  <BccAddress>string</BccAddress>
  <Subject>string</Subject>
  <Body>string</Body>
  <BodyType>string</BodyType>
  <AttachmentPaths>string</AttachmentPaths>
</PixiGetMailsWaitingToBeSentPost200TextXmlResponse>

2. Error response

Name Type Description
Status string

Status of the responce

Type: varchar(50)

Available from: 18.04 (8.4.40.34047)
Message string

Description of the error response

Type: varchar(4000)

Available from: 18.04 (8.4.40.34047)

Response Example

<PixiGetMailsWaitingToBeSentPost400TextXmlResponse>
  <Status>string</Status>
  <Message>string</Message>
</PixiGetMailsWaitingToBeSentPost400TextXmlResponse>

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:pixiGetMailsWaitingToBeSent/>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetMailsWaitingToBeSent');

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