Returns Schreiben

pixiCreateReturnCase

Legt einen neuen Retourenfall mit Status NEW an und liefert dessen ID und Retourennummer.

Fügt einen neuen Datensatz in RET_CASES ein und liefert die Kennungen des neuen Retourenfalls.

Der neue Datensatz wird wie folgt befüllt:

CreateDate: aktuelles Datum und Uhrzeit des Servers.
CreateEmp: der Wert von Employee, gefolgt von (API). Ist Employee NULL, wird der Wert API verwendet.
RETURN_DATE: der Wert von ReturnDate. Ist dieser NULL, werden aktuelles Datum und Uhrzeit des Servers verwendet.
STATUS: immer NEW.
RECEIVERS_COMMENT: der Wert von ReceiversComment.

Nach dem Einfügen wird der neue Datensatz über seinen Identity-Wert (SCOPE_IDENTITY()) gelesen und eine Zeile mit RET_ID und RET_NUMBER zurückgegeben.

Hinweise

Alle drei Parameter haben keinen SQL-Standardwert und müssen im Request übergeben werden. NULL-Werte werden akzeptiert: Employee und ReturnDate werden wie beschrieben ersetzt; ReceiversComment wird als NULL gespeichert.
Der Aufruf legt nur den Kopf des Retourenfalls an. Es werden kein Auftrag, keine Artikel und keine Retourenpositionen verknüpft; dies muss über andere Aufrufe erfolgen.
RET_NUMBER wird von dieser Prozedur nicht gesetzt. Vermutlich wird der Wert von der Datenbank erzeugt (Standardwert, berechnete Spalte oder Trigger auf RET_CASES), was im Code nicht sichtbar ist.
Der Zusatz (API) verlängert Employee um 6 Zeichen; ob das Ergebnis in CreateEmp passt, hängt von der Spaltenlänge ab, die im Code nicht sichtbar ist.
Die Ergebniszeile wird mit NOLOCK gelesen. Einfügen und Lesen laufen nicht in einer expliziten Transaktion.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`ReturnDate` Pflicht	datetime dateTime	–	Datum der Retoure. Bei NULL werden aktuelles Datum und Uhrzeit des Servers verwendet. Beispiel: `2024-05-14T10:30:00`
`ReceiversComment` Pflicht	varchar(max) string	–	Kommentar des Empfängers, wird in `RECEIVERS_COMMENT` gespeichert. Darf NULL sein. Beispiel: `Package received damaged, customer requests refund.`
`Employee` Pflicht	varchar(50) string	–	Mitarbeiterkürzel. Wird mit dem Zusatz `(API)` als Ersteller gespeichert; bei NULL wird `API` gespeichert. Beispiel: `JD`

Antwort

Result-Set 1 · Immer, nach erfolgreichem Einfügen

Eine Zeile mit den Kennungen des neu angelegten Retourenfalls.

Spalte	Typ	Beschreibung
`RET_ID`	int	Interne ID (Identity) des neuen Retourenfalls.
`RET_NUMBER` Kann leer sein	string	Retourennummer des neuen Retourenfalls, wie von der Datenbank erzeugt.

Beispielantwort

<SqlRowSet1>
  <row>
    <RET_ID>1523</RET_ID>
    <RET_NUMBER>R001523</RET_NUMBER>
  </row>
</SqlRowSet1>

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:pixiCreateReturnCase>
      <ReturnDate>2024-05-14T10:30:00</ReturnDate>
      <ReceiversComment>Package received damaged, customer requests refund.</ReceiversComment>
      <Employee>JD</Employee>
    </ns1:pixiCreateReturnCase>
  </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:pixiCreateReturnCase>
      <ReturnDate>2024-05-14T10:30:00</ReturnDate>
      <ReceiversComment>Package received damaged, customer requests refund.</ReceiversComment>
      <Employee>JD</Employee>
    </ns1:pixiCreateReturnCase>
  </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 = [
    'ReturnDate' => '2024-05-14T10:30:00',
    'ReceiversComment' => 'Package received damaged, customer requests refund.',
    'Employee' => 'JD',
];

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

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

Verwendete Tabellen

RET_CASES · Schreiben

SQL-Objekt:: dbo.pipiCreateReturnCase