pixiSendEmailForInvoice

Legt für eine Rechnung eine Pixi-Automail vom Typ `API_Invoice_eMail` aus der passenden Mailvorlage an und stellt sie in den Postausgang oder die Entwürfe.

Erzeugt über das Pixi-Automail-Modul (AM) eine E-Mail zu einer Rechnung und stellt sie zum Versand bereit. Verwendet wird der Mailtyp API_Invoice_eMail.

Ablauf:

1. Ein leerer Wert für InvoiceNr gilt als nicht angegeben. Fehlende Werte für Subject und Message werden zu Leerstrings.
2. Subject, Message und InvoiceNr werden in einer temporären Tabelle abgelegt (Api_Subject, Api_Message, InvoiceNr). Die SQL-Abfrage des Mailtyps kann beim Aufbau der Mail darauf zugreifen.
3. Der Mailtyp API_Invoice_eMail wird in AM_Type gesucht und muss aktiviert sein.
4. Die Rechnung wird aus Invoices gelesen und mit ihrer Rechnungsadresse in Addresses verknüpft. Daraus ergeben sich Kunde, Shop-ID, Land, Versanddienstleister und Zahlungsart.
5. Über fPixi_AM_GetTemplate wird eine Mailvorlage dieses Typs gewählt. Gesucht wird eine aktive Vorlage, die zu Shop, Land, Zahlungsart und Versanddienstleister passt. Passt keine Vorlage zu allen vier Kriterien, wird schrittweise auf Vorlagen mit weniger Übereinstimmungen und zuletzt auf eine allgemeine Vorlage zurückgegriffen.
6. pixi_AM_CreateMailForCSD erzeugt die Mail: Empfänger, Betreff, Text und Textart.
7. Pixi_AM_SendManual speichert die Mail mit Status CREATED in AM_Mail. Gegebenenfalls wird das Rechnungsdokument als Anhang hinterlegt.
8. Der Schlüssel des neuen Mail-Datensatzes wird in der Spalte AM_TypeKey zurückgegeben.

Schlägt eine Prüfung fehl, liefert der Aufruf eine Zeile mit ReturnCode = ERROR und einer ErrorMsg und bricht ab.

Parameter

Antwort

Result-Set 1 · Bei Erfolg; mit Wert 0 auch dann, wenn Pixi_AM_SendManual einen Fehler ausgelöst hat

Schlüssel des neu angelegten Mail-Datensatzes.

Result-Set 2 · Wenn eine Prüfung fehlschlägt oder keine Mail erzeugt werden konnte

Statuszeile mit der Fehlerbeschreibung.

<SqlRowSet1>
  <row>
    <AM_TypeKey>158342</AM_TypeKey>
  </row>
</SqlRowSet1>

Fehlermeldungen

Beispiele

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
Authorization: Basic BASE64(USERNAME:PASSWORD)

<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiSendEmailForInvoice>
      <InvoiceNr>ZEB000003</InvoiceNr>
      <Subject>Your invoice ZEB000003</Subject>
      <Message>Thank you for your order. Please find your invoice attached.</Message>
      <UserName>master</UserName>
    </ns1:pixiSendEmailForInvoice>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

curl -X POST 'https://apigateway.descartes.com/tms/pixi/' \
  --user 'USERNAME:PASSWORD' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --data-binary @- <<'XML'
<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiSendEmailForInvoice>
      <InvoiceNr>ZEB000003</InvoiceNr>
      <Subject>Your invoice ZEB000003</Subject>
      <Message>Thank you for your order. Please find your invoice attached.</Message>
      <UserName>master</UserName>
    </ns1:pixiSendEmailForInvoice>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

<?php

$soapClient = new SoapClient(null, [
    'login' => 'USERNAME',
    'password' => 'PASSWORD',
    'location' => 'https://apigateway.descartes.com/tms/pixi/',
    'uri' => 'https://apigateway.descartes.com/tms/pixi/',
]);

$arguments = [
    'InvoiceNr' => 'ZEB000003',
    'Subject' => 'Your invoice ZEB000003',
    'Message' => 'Thank you for your order. Please find your invoice attached.',
    'UserName' => 'master',
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiSendEmailForInvoice', $soapArguments);

Verwendete Tabellen

SQL-Objekt:

dbo.pipiSendEmailForInvoice

Prozedur zuletzt geändert am 2026-10-05

Dokumentation von claude-opus-5-5 am 2026-10-30 geschrieben