Postman-Collection
General Lesen

pixiGetSettings

Liefert den Wert einer einzelnen Pixi-Einstellung oder ohne Namensangabe eine Übersicht ausgewählter Einstellungen, Lizenzzähler und Stammdatenanzahlen.

Liest Systemeinstellungen aus der Tabelle Settings. Leere Zeichenketten in den Parametern werden als NULL behandelt.

Der Aufruf kennt drei Modi:

  • SettingName = LocID: liefert eine Zeile mit SettingName = LocID und einem SettingValue, der alle Lager-IDs aus Location jeweils gefolgt von ; auflistet (z. B. 001; 002; ).
  • Beliebiger anderer SettingName: liefert eine Zeile mit dem angefragten Namen und dessen Wert aus Settings (erster Treffer). Existiert die Einstellung nicht oder ist ihr Wert NULL, ist SettingValue gleich '0'.
  • Kein SettingName (weggelassen oder leer): liefert eine Übersicht mit mehreren Zeilen:
    • die Einstellungen EnablePrintingRules, BookExportDatevActive, FulfillmentBuyingOption, pixiLicences, ReservePrepaymentOrders, ScanInWithPiccoLink, EnablePersonalizedItems, SerialNumberValidityCheckEnabled, PixiMail_CreationEnabled, PixiMail_SendingEnabled, C_ItemImportEnabled, C_OrderImportEnabled, ReturnsEnabled, EnableDbCCP, Add_0_to_12_char_BarCode, default_quantity, APIUpdateItemBinCodes, NumberOfPiccoTerminals (nur sofern in Settings vorhanden),
    • Mobile_Licenses: Anzahl aktiver Benutzersitzungen mit Sitzungstyp 4 oder 5,
    • Suppliers, Shops, Locations: Anzahl der Datensätze in den jeweiligen Tabellen,
    • ShipVendors: alle Versanddienstleister-Namen, jeweils gefolgt von , ,
    • LocID: alle Lager-IDs, jeweils gefolgt von ; ,
    • PIM: '1', wenn eine Einstellung ShopUrl auf pim.pixi.eu oder pim-beta.pixi.eu verweist, sonst '0'. Ist die Einstellung C_OrderImportEnabled gleich 1, werden zusätzlich die Kanaleinstellungen (C_ChannelSettings) geprüft.

Die Übersichtszeilen werden per UNION zusammengeführt; doppelte Zeilen entfallen, eine Sortierreihenfolge ist nicht garantiert.

Hinweise

  • ShopID und LocID werden an die interne Funktion zum Lesen der Einstellung übergeben, dort aber ignoriert. Shop- oder lagerspezifische Werte werden daher nicht geliefert; das Ergebnis ist immer der globale Wert aus Settings.
  • Eine fehlende Einstellung ist nicht von einer Einstellung mit dem Wert '0' zu unterscheiden.
  • Alle Lesezugriffe erfolgen mit NOLOCK; Werte können nicht festgeschriebene Änderungen enthalten.
  • Die Listen für LocID und ShipVendors werden mit FOR XML PATH erzeugt: Sie enden mit einem Trennzeichen, Sonderzeichen wie & können XML-maskiert erscheinen, und bei leerer Tabelle ist der Wert NULL.
  • Im Übersichtsmodus wird C_OrderImportEnabled mit der Zahl 1 verglichen; ein nicht numerischer Wert dieser Einstellung würde einen Konvertierungsfehler verursachen.

Parameter

Parameter Typ Standardwert Beschreibung
SettingName
varchar(50)
string
–

Name der zu lesenden Einstellung. LocID liefert die Liste aller Lager-IDs. Leer oder weggelassen liefert die Übersicht ausgewählter Einstellungen und Zähler.

Beispiel: ReturnsEnabled

ShopID
varchar(3)
string
–

Shop-ID. Wird an die Einstellungsabfrage übergeben, hat derzeit aber keine Wirkung.

Beispiel: SHP

LocID
varchar(3)
string
–

Lager-ID. Wird an die Einstellungsabfrage übergeben, hat derzeit aber keine Wirkung.

Beispiel: 001

Antwort

Result-Set 1 · Wenn SettingName = LocID

Eine Zeile mit der Liste aller Lager-IDs.

Spalte Typ Beschreibung
SettingName varchar(5)
string

Immer LocID.

SettingValue
Kann leer sein
nvarchar(max)
string

Alle Lager-IDs, jeweils gefolgt von ; . NULL, wenn keine Lager existieren.

Result-Set 2 · Wenn SettingName angegeben und nicht LocID ist

Eine Zeile mit der angefragten Einstellung und ihrem Wert.

Spalte Typ Beschreibung
SettingName varchar(50)
string

Der angefragte Einstellungsname wie übergeben.

SettingValue varchar(8000)
string

Wert der Einstellung; '0', wenn die Einstellung nicht existiert oder keinen Wert hat.

Result-Set 3 · Wenn SettingName leer ist oder weggelassen wird

Übersicht ausgewählter Einstellungen, Lizenzzähler, Stammdatenanzahlen, Versanddienstleister, Lager-IDs und PIM-Kennzeichen; unsortiert.

Spalte Typ Beschreibung
SettingName string

Einstellungsname oder Name des berechneten Werts (Mobile_Licenses, Suppliers, Shops, Locations, ShipVendors, LocID, PIM).

SettingValue
Kann leer sein
nvarchar(max)
string

Einstellungswert, Anzahl als Text, getrennte Liste oder '1'/'0' für PIM.

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:pixiGetSettings>
      <!-- <SettingName>ReturnsEnabled</SettingName> -->
      <!-- <ShopID>SHP</ShopID> -->
      <!-- <LocID>001</LocID> -->
    </ns1:pixiGetSettings>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Verwendete Tabellen

Settings · Lesen Location · Lesen UserActiveSession · Lesen Suppliers · Lesen Shops · Lesen ShipVendor · Lesen C_ChannelSettings · Lesen
SQL-Objekt:
dbo.pipiGetSettings
Prozedur zuletzt geändert am 2026-10-05
Dokumentation von claude-opus-5-5 am 2026-10-30 geschrieben