Orders Schreiben

pixiOrderSetGdprPollingExportFlag

Setzt oder entfernt das DSGVO-Polling-Exportkennzeichen (`ExportGdprDataForPolling`) eines Auftrags, der über Auftragsnummer oder externe Auftragsnummer ermittelt wird.

Aktualisiert die Spalte ExportGdprDataForPolling eines Auftrags in OrderHeader.

OrderNr = 0 und ein leerer OrderNrExternal gelten als nicht übergeben.
Der Auftrag wird zuerst über OrderNr gesucht. Wird dabei kein Auftrag gefunden, erfolgt die Suche über OrderNrExternal. Sind beide angegeben und passt OrderNr, wird OrderNrExternal ignoriert.
Prüfungen in dieser Reihenfolge:
- weder OrderNr noch OrderNrExternal übergeben → Fehler,
- kein Auftrag gefunden → Fehler,
- ExportGdprDataForPolling ist NULL → Fehler.
Hat der Auftrag bereits den gewünschten Wert, wird nichts geändert und eine Zeile mit Warning geliefert.
Andernfalls wird das Kennzeichen aktualisiert, UpdateEmp auf User gesetzt (Standard API user) und eine Zeile mit Success geliefert.

Der Aufruf liefert immer genau eine Zeile mit Status und Message.

Hinweise

Läuft in einer eigenen Transaktion bzw. in einem Savepoint, falls bereits eine Transaktion offen ist. Mit XACT_ABORT ON werden unerwartete Fehler zurückgerollt und über log.InsertError (nicht beigefügt) protokolliert; der Fehlertext wird in Message auf 80 Zeichen gekürzt.
Suche und Existenzprüfung lesen OrderHeader mit NOLOCK; das Update verwendet ROWLOCK.
Teilen sich mehrere Aufträge dieselbe OrderNrExternal, wird nur einer davon (die zuerst gelesene Zeile) aktualisiert.
ExportGdprDataForPolling hat keinen Standardwert; fehlt der Parameter, lehnt SQL Server den Aufruf ab, bevor die Prozedur läuft. Nur ein explizites NULL führt zur Statuszeile "Mandatory parameter ExportGdprDataForPolling is missing".
Prüfungsfehler werden als normale Zeile mit Status = Error geliefert, nicht als SQL-Fehler.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`OrderNr`	int	NULL	Pixi-Auftragsnummer. `0` wird als NULL behandelt. Wird vor `OrderNrExternal` geprüft. Beispiel: `123456`
`OrderNrExternal`	varchar(50) string	NULL	Externe Auftragsnummer (z. B. Shop-Bestellnummer). Leerer String wird als NULL behandelt. Wird verwendet, wenn über `OrderNr` kein Auftrag gefunden wird. Beispiel: `SHOP-100045`
`ExportGdprDataForPolling` Pflicht	bit boolean	–	Neuer Wert des DSGVO-Polling-Exportkennzeichens. Erlaubte Werte `1` – DSGVO-Datenexport für Polling aktivieren `0` – DSGVO-Datenexport für Polling deaktivieren Beispiel: `1`
`User`	varchar(50) string	NULL	Benutzername, der in `UpdateEmp` geschrieben wird. NULL oder leer wird zu `API user`. Beispiel: `ShopSync`

Antwort

Result-Set 1 · Immer

Eine Statuszeile mit dem Ergebnis.

Spalte	Typ	Beschreibung
`Status`	varchar(10) string	`Success`, `Warning` (Kennzeichen hatte bereits den gewünschten Wert) oder `Error`.
`Message`	varchar(100) string	Ergebnis- oder Fehlermeldung.

Beispielantwort

<SqlRowSet1>
  <row>
    <Status>Success</Status>
    <Message>GDPR Polling Export Flag successfully updated</Message>
  </row>
</SqlRowSet1>

Fehlermeldungen

Status	Meldung	Ursache
Error	Mandatory parameter OrderNr/OrderNrExternal is missing	Weder `OrderNr` (ungleich 0) noch ein nicht leerer `OrderNrExternal` wurde übergeben.
Error	Order can not be found	Kein Auftrag passt zur angegebenen `OrderNr` oder `OrderNrExternal`.
Error	Mandatory parameter ExportGdprDataForPolling is missing	`ExportGdprDataForPolling` wurde als NULL übergeben.
Warning	GDPR Polling Export Flag is already set to {TRUE\|FALSE}	Der Auftrag hat bereits den gewünschten Wert; es wurde nichts geändert.
Error	Unexpected error: "{error message}"	Ein unerwarteter SQL-Fehler ist aufgetreten; die Transaktion wird zurückgerollt und der Fehler protokolliert. Der Text wird auf 80 Zeichen gekürzt.

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:pixiOrderSetGdprPollingExportFlag>
      <!-- <OrderNr>123456</OrderNr> -->
      <!-- <OrderNrExternal>SHOP-100045</OrderNrExternal> -->
      <ExportGdprDataForPolling>1</ExportGdprDataForPolling>
      <!-- <User>ShopSync</User> -->
    </ns1:pixiOrderSetGdprPollingExportFlag>
  </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:pixiOrderSetGdprPollingExportFlag>
      <!-- <OrderNr>123456</OrderNr> -->
      <!-- <OrderNrExternal>SHOP-100045</OrderNrExternal> -->
      <ExportGdprDataForPolling>1</ExportGdprDataForPolling>
      <!-- <User>ShopSync</User> -->
    </ns1:pixiOrderSetGdprPollingExportFlag>
  </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 = [
    // 'OrderNr' => '123456',
    // 'OrderNrExternal' => 'SHOP-100045',
    'ExportGdprDataForPolling' => '1',
    // 'User' => 'ShopSync',
];

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

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

Verwendete Tabellen

OrderHeader · Schreiben

SQL-Objekt:: dbo.pipiOrderSetGdprPollingExportFlag