Pixi-API-Dokumentation

Inoffiziell · von koempf24.de

Postman-Collection

Pixi-API-Dokumentation

Referenz für alle SOAP-Calls der Warenwirtschaft Pixi: was jeder Call macht, welche Parameter er erwartet und welche Result-Sets und Fehlermeldungen er liefert, mit fertigen Beispielen.

Postman-Collection

Endpoint

Alle Calls gehen als SOAP-1.1-Request per POST an denselben Endpoint:

Endpoint

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

Authentifizierung

Jeder Request nutzt HTTP Basic Auth mit dem API-Benutzer, den Descartes für die Pixi-Instanz einrichtet.

Request

Der SOAP-Body enthält ein Element mit dem Namen des Calls. Seine Kindelemente sind die Parameter. Weggelassene Parameter bekommen ihren Standardwert.

SOAP

<?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:pixiGetStockBins>
            <LocID>001</LocID>
            <RowCount>100</RowCount>
        </ns1:pixiGetStockBins>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Kategorien

Customers 39 Calls

  • pixiAddCustomerComment

    Setzt das Kommentarfeld `CHisNote` eines über die externe Kundennummer ermittelten Kunden und liefert 1 bei Erfolg bzw. 0, wenn kein Kunde gefunden wurde.

  • pixiAddressesDisplayDuplicates

    Liefert Paare möglicherweise doppelter Kundenadressen aus der Dublettenprüfung mit Adress-, Auftrags-, Rechnungs- und Kundendaten beider Seiten.

  • pixiAddressesDisplayDuplicatesMarkUsed

    Markiert ein gespeichertes Paar möglicher Kundendubletten als verwendet, indem `UsedFlag` = 1 in der Dublettenliste gesetzt wird.

  • pixiAddressesFindDuplicates

    Ermittelt wahrscheinliche Kundendubletten per unscharfem Adressabgleich in Blöcken von 2500 Adressen und speichert bewertete Kundenpaare in Addresses_Duplicates.

  • pixiCAGetCustomerEvents

    Liefert alle Kundenkonto-Ereignisse (Buchungen, inklusive gelöschter) eines Kunden zusammen mit den Kontostatistiken wie Saldo und vorgeschlagener Erstattung.

  • pixiCustomerInfoSet

    Aktualisiert Rechnungszahlungsziel und Mahneinstellungen eines Kunden, identifiziert über CustKey oder externe Kundennummer/E-Mail plus Shop.

Customs 3 Calls

  • pixiGetItemCustomsInfo

    Liefert die Zolldaten (Zolltarifnummer, Ursprungsland, Gewicht, Maße) eines Artikels, ermittelt über ItemKey, interne Artikelnummer oder EAN/UPC.

  • pixiReportItemsWithMissingCustomsInfo

    Liefert Artikel, die noch nicht mit dem System-Tag `AtlasData` markiert sind, inklusive Stammdaten und Zollfeldern, seitenweise nach `ItemKey`.

  • pixiSetItemCustomsInfo

    Aktualisiert die Zolldaten (Zolltarifnummer, Ursprungsland, Zolltariftext, Vorverfahren) sowie Gewicht und Abmessungen eines Artikels.

Direct-Fulfillment 10 Calls

  • pixiDFCreateInvoices

    Legt Direct-Fulfillment-Rechnungen (DF) für bereite Auftragspositionen an, optional eingeschränkt auf und ergänzt um Versanddienstleister und Tracking-Daten aus XML.

  • pixiDFGetChanges

    Liefert die neuesten, noch nicht gemeldeten Fulfillment-Statusänderungen von `FUT`-Auftragspositionen für einen Direct-Fulfillment-Lieferanten inklusive Adress-, Artikel- und Auftragsdaten.

  • pixiDFGetChangesConfirmation

    Bestätigt eine verarbeitete Auftragshistorien-Änderung für einen Direct-Fulfillment-Lieferanten, setzt das ClientNotified-Flag und optional das Tracking-Versanddatum einer Rechnung.

  • pixiDFGetOrderlines

    Liefert die offenen Direct-Fulfillment-Auftragspositionen (Status FUT) eines Auftrags für einen Direct-Fulfillment-Lieferanten, authentifiziert über Lieferantennummer und Secret.

  • pixiDFGetOrderlines_new

    Liefert die Direct-Fulfillment-Auftragspositionen (Status FUT) eines Auftrags für einen berechtigten Streckenlieferanten inklusive Artikel-, Historien- und Währungsdaten.

  • pixiDFGetOrders

    Liefert die Auftragsköpfe mit Lieferadressdaten der Aufträge, die offene Direct-Fulfillment-Auftragspositionen (Status FUT) für einen Lieferanten enthalten.

General 31 Calls

  • pixiAdminGetCUL

    Liefert die an lizenzpflichtigen Pixi-Clients angemeldeten Benutzer zu einem Snapshot-Zeitpunkt oder zum letzten Snapshot, wenn kein Datum übergeben wird.

  • pixiCheckPixiUserLogin

    Prüft Benutzername und Passwort eines Pixi-Benutzers, optional einen Berechtigungscode, und liefert, ob die Anmeldung gültig ist, samt E-Mail und echtem Namen.

  • pixiGetClientVersion

    Liefert die aktuelle Version und die minimal erlaubte Version einer oder aller Pixi-Client-Anwendungen.

  • pixiGetCountries

    Liefert ein Land oder alle Länder aus den Länderstammdaten von Pixi, optional nur Länder, die in Adressen verwendet werden.

  • pixiGetCurrency

    Liefert die Hauptwährungen aus der Pixi-Währungstabelle, optional gefiltert nach ISO-Code oder Währungs-ID.

  • pixiGetCurrentPixiVersion

    Liefert die Version der aktuellen Pixi-Datenbank, den Revisionsnamen, den Konsistenzstatus zur Master-Datenbank sowie Endpunkt-Informationen.

Invoices 38 Calls

  • pixiCreateDirectInv

    Legt eine Direktrechnung für einen Auftrag an, entweder für alle offenen Auftragspositionen oder für eine kommagetrennte Liste von Positionsschlüsseln.

  • pixiCreateDirectInvoice

    Legt eine Direktrechnung für einen Auftrag an, für ausgewählte oder alle offenen Auftragspositionen, und liefert das Ergebnis als Statuszeile.

  • pixiCreateInvoice

    Legt eine Rechnung für eine gepackte Kiste (BoxNr an einem Lager) an und liefert die neue Rechnungs-ID und Rechnungsnummer mit einer Statuszeile.

  • pixiCreatePOSInvoice

    Legt aus einem XML-Dokument eine neue POS-Rechnung an oder ergänzt eine offene um Positionen und bucht die verkauften Artikel aus dem Bestand aus.

  • pixiDatevExportPosInvoices

    Liefert POS-Verkäufe und POS-Zahlungen eines Zeitraums als DATEV-Buchungszeilen (Erlöse je Steuersatz und Zahlungen) für den Export in die Buchhaltung.

  • pixiDeleteInvoicePackage

    Löscht ein Versandpaket samt Paketpositionen einer Rechnung und aktualisiert Tracking-IDs und Paketanzahl der Rechnung.

Items 35 Calls

  • pixiCanConvertBundle

    Prüft, ob ein Artikel in ein Bundle bzw. aus einem Bundle umgewandelt werden kann, und liefert seine Stammdaten mit dem Kennzeichen `CanConvert`.

  • pixiCreateItemSupplier

    Legt eine neue Lieferantenzuordnung (AddItems-Datensatz) für einen bestehenden Artikel an, optional mit eigener EAN und als bevorzugter Lieferant.

  • pixiDeleteItemSupplier

    Löscht die Lieferantenzuordnung (AddItems-Datensatz) eines Artikels für einen Lieferanten, sofern keine offenen Lieferantenbestellungen bestehen.

  • pixiDispoGetItems

    Liefert einen Block von Artikeln mit bevorzugtem Lieferanten, Preisen, Bestand und lagerortspezifischen Dispositionsdaten für den Export in die Logcontrol-Dispo-Software.

  • pixiEmillGetItemCategories

    Liefert alle Artikelkategorien mit Kennung und Bezeichnung, sortiert nach Bezeichnung.

  • pixiGetCategories

    Liefert die Artikelkategorien (Tabelle TontrArten), optional gefiltert nach Schlüssel, Kurzbezeichnung oder Text.

KPIs 2 Calls

  • pixiReportShippedOrders

    Liefert Dashboard-Zählwerte versendeter Rechnungen für den Stichtag, den Vortag, den laufenden Monat bis zum Enddatum und den Vormonat.

  • pixiReportShippingEfficiency

    Liefert die durchschnittliche Durchlaufzeit von Aufträgen in Tagen und den Anteil der innerhalb von 24 Stunden versendeten Aufträge der letzten N Tage.

Orderlines 21 Calls

  • pixiAddOrderLine

    Legt eine neue Auftragsposition für einen Artikel in einem bestehenden Auftrag an, berechnet Preise und Rabatte und liefert die neue Positions-ID oder Validierungsfehler.

  • pixiBreakOrderline

    Teilt eine Auftragsposition in zwei Positionen auf, indem eine angegebene Menge in eine neue Auftragsposition übertragen wird, optional mit neuem Status.

  • pixiCanAddOrderlines

    Prüft, ob einem Auftrag noch neue Auftragspositionen hinzugefügt werden dürfen, abhängig von Zahlungsart und Status der vorhandenen Positionen.

  • pixiCanCancelOrderline

    Prüft, ob eine Auftragsposition noch storniert werden kann, und liefert 1 (ja) oder 0 (nein).

  • pixiCanCancelOrderline2

    Liefert den Status einer Auftragsposition und ein Kennzeichen, ob die Auftragsposition noch storniert werden kann.

  • pixiCancelOrder

    Storniert alle offenen Auftragspositionen eines Auftrags, indem ihr Status auf `STO` (storniert) oder `NLB` (nicht lieferbar) gesetzt wird.

Orders 41 Calls

  • pixiAddOrderComment

    Setzt die Shop-Notiz (`Shop_Note`) eines Auftrags anhand der Auftragsnummer und liefert 1 bei Erfolg oder 0, wenn der Auftrag fehlt oder maskiert ist.

  • pixiCanChangeAddress

    Liefert 1, wenn die Adresse eines Auftrags noch geändert werden darf, weil zu seinen Auftragspositionen keine Rechnungspositionen existieren, sonst 0.

  • pixiCanMergeOrders

    Prüft, ob zwei Aufträge zusammengeführt werden können, und liefert ein Kennzeichen sowie einen Grundcode mit Text.

  • pixiChangeAddress

    Ändert die Rechnungs- oder Lieferadresse eines Auftrags, solange der Auftrag noch nicht berechnet wurde.

  • pixiCreateOrderComment

    Legt einen Freitext-Kommentar zu einem bestehenden Auftrag an und speichert Benutzer und Erstellungszeitpunkt.

  • pixiDeleteOrder

    Löscht einen kompletten Auftrag, sofern alle Auftragspositionen den Status ANG, HAL oder STO haben und keine auf einer aktiven Pickliste steht.

Payments 25 Calls

  • pixiAutoMatchPayments

    Ordnet die Bankzeilen eines Bank-Headers automatisch offenen Aufträgen oder Rechnungen zu, bestätigt die Zuordnung und gibt den Auftrag bei vollständiger Zahlung frei.

  • pixiBanklineExists

    Liefert die Anzahl der Bankzeilen, die zu den übergebenen Banktexten und optional zum Betrag passen.

  • pixiCACreateManualBooking

    Legt eine manuelle Buchung im Kundenkonto an und gleicht sie optional mit einem vorhandenen Kontoeintrag oder einer Rechnung ab.

  • pixiCADeleteEvent

    Löscht ein Kundenkonto-Ereignis (CustomerAccount-Eintrag) samt Rechnung, Bankzuordnungen und Kontozuordnungen, sofern das Löschen erlaubt ist.

  • pixiCADeleteEventMatches

    Löscht alle Kundenkonto-Zuordnungen (Matches) eines Kundenkonto-Eintrags (CAref) einschließlich der daraus abgeleiteten Bank-Zuordnungen.

  • pixiCAGetEvents

    Liefert Kundenkonto-Ereignisse (Buchungen), gefiltert nach Ereignistyp, Datum, Betrag, Rechnung, Zahlungsart oder Kunde, optional inklusive gelöschter Ereignisse.

Replacements 2 Calls

  • pixiCreateReplacement

    Legt einen Ersatzauftrag mit negativen Mengen für ausgewählte Auftragspositionen an, basierend auf Kunde und Adressen eines bestehenden Auftrags.

  • pixiCreateReplacementOrder

    Legt einen Ersatzauftrag für eine oder mehrere Retourenfall-Positionen an, protokolliert die Anforderung in der Retourenhistorie und liefert die neue Auftragsnummer.

Reports 28 Calls

  • pixiGetPOSSalesReport

    Liefert die POS-Verkaufspositionen (Kassenverkäufe) eines Zeitraums, optional für einen Standort, mit Artikel-, Lieferanten- und Preisdaten.

  • pixiGetProductSalesReport

    Liefert die verkaufte Menge eines Artikels pro Rechnungsmonat und -jahr, optional eingeschränkt auf einen Shop.

  • pixiReport1SS

    Liefert monatliche Paketstatistiken aus den Rechnungen für die Abrechnung: Pakete gesamt, Ein-Artikel-Pakete und als 1SS markierte Pakete mit Größenklassen.

  • pixiReportActiveLogins

    Liefert die aktuell in Pixi angemeldeten Benutzer, die Lizenzen belegen, optional einschließlich mobiler Sitzungen.

  • pixiReportCustomerSales

    Liefert Rechnungspositionen mit Kunde, Land, Netto-Positionssumme, Währung und letztem Verkaufsdatum, gefiltert nach Artikel, Shop, Zahlungsart, Kunde und Rechnungsdatum.

  • pixiReportGetShippableOrders

    Liefert die aus dem aktuellen Bestand versandfähigen Auftragspositionen als Details oder als Summen (Aufträge, Wert, Versandkosten, Picks), optional je Lager.

Returns 9 Calls

  • pixiAddReturnCaseLine

    Fügt einem bestehenden Retourenfall eine Zeile für eine Rechnungsposition hinzu oder legt einen neuen leeren Retourenfall an, wenn keine Retourenfall-ID übergeben wird.

  • pixiCreateReturn

    Legt eine Retouren-Gutschrift für ausgewählte Positionen einer Rechnung an, setzt die Auftragspositionen auf retourniert und bucht die Gutschrift auf das Kundenkonto.

  • pixiCreateReturnCase

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

  • pixiGetItemsTopReturnReason

    Liefert Artikel, deren häufigster Retourengrund öfter als ein angegebener Schwellwert vorkommt, zusammen mit diesem Grund und seiner Anzahl.

  • pixiGetReturnItems

    Liefert die Positionen eines Retourenfalls mit Artikel, Rechnungsposition, Lagerplatz sowie übersetztem Retourengrund und Qualitätsklassifizierung.

  • pixiGetReturns

    Liefert eine seitenweise Liste von Retouren, die in einem Zeitraum geändert wurden, optional gefiltert nach Status und Rechnungsnummer, inklusive zugehöriger Gutschrift.

Shipping 14 Calls

  • pixiCheckPickListNr

    Prüft, ob eine Picklistennummer existiert und nicht abgelaufen ist, und liefert Kistenbereich, 1SS-Kennzeichen, Scanstatus und Anzahl offener Aufträge.

  • pixiCreateInvoicePackage

    Legt ein Paket (pixi.InvoicePackage) zu einer Rechnung an, optional mit Paketpositionen, Tracking-IDs und Label-URLs, und liefert die neue PackageId.

  • pixiCreatePicklist

    Erstellt eine Pickliste auf Basis eines Picklistenprofils, entweder sofort oder über einen Eintrag in der Ausführungs-Warteschlange.

  • pixiGetBoxItems

    Liefert die in eine Box gepackten Artikel, ermittelt über Boxnummer und Lager, mit Auftrags-, Auftragspositions-, Artikel- und Scandaten.

  • pixiGetInvoicePackage

    Liefert die Versandpakete einer Rechnung (Labels, Tracking-IDs, Gewicht, Paketmaße), ausgewählt über Rechnungsnummer, Rechnungs-ID oder Paket-ID.

  • pixiGetShippedOrdersPerLocation

    Liefert versendete Aufträge (auf Basis von Rechnungen) eines Zeitraums je Lager, entweder als Detailzeilen oder als Anzahl und Summe je Lager und Währung.

Statistics 4 Calls

  • pixiAdminGetCULStatistics

    Liefert die maximale Anzahl gleichzeitig lizenzierter Benutzer (CULs) pro Stunde oder pro Tag seit einem Startdatum, aufgeteilt nach Pixi-Client-Anwendung.

  • pixiFederalStatisticReport

    Liefert einen monatlichen Bericht für die Bundesstatistik (Intrastat) über gelieferte Lieferantenartikel, gruppiert nach Lieferantenland, Zolltarifnummer und Ursprungsland.

  • pixiGetApplicationUsageStatistic

    Liefert pro Tag die pixi*-Anwendungen, die zum Zeitpunkt der meisten verbundenen Benutzer geöffnet waren, oder nur die Liste der genutzten Anwendungen.

  • pixiGetItemSalesStats

    Liefert Verkaufsstatistiken für einen Artikel: verkaufte Mengen der letzten 30/120/365 Tage, offene und gehaltene Mengen, offene Einzelstück-Aufträge und ABC-Klasse.

Stock 44 Calls

  • pixiAssignBoxesForPicklist

    Ordnet einer Pickliste eine Menge von Boxen zu und ersetzt die bisherige Zuordnung, nachdem Existenz und ausreichende Anzahl der Boxen geprüft wurden.

  • pixiBinCreate

    Legt einen oder mehrere Lagerplätze aus einer XML-Liste an, prüft jeden Eintrag und liefert pro Lagerplatz eine Statuszeile.

  • pixiBinUpdate

    Aktualisiert einen oder mehrere bestehende Lagerplätze aus einer XML-Liste und liefert je Lagerplatz eine Statuszeile.

  • pixiDispoGetItemBinLog

    Liefert verdichtete Lagerbewegungen aus dem Lagerplatz-Artikel-Log für eine externe Dispositionssoftware (LogControl), optional pro Artikel summiert im Inventurmodus.

  • pixiExportItemStock

    Liefert alle Artikel mit positivem exportierbarem Bestand für einen Lagerort oder alle Lagerorte, mit Artikelnummern, EAN, Name, Hersteller, Preisen und Kategorie.

  • pixiGetChangedItems

    Liefert alle seit einem Zeitpunkt geänderten Artikel mit verfügbarem Bestand und frühestem erwarteten Liefertermin aus offenen Lieferantenbestellungen.

Suppliers 41 Calls

  • pixiCreateDelivery

    Legt eine Lieferantenlieferung (Wareneingang) mit Status NEW an, entweder aus einer bestätigten Lieferantenbestellung oder aus per XML übergebenen Artikelzeilen.

  • pixiCreateDeliveryItem

    Legt eine neue Artikelposition in einer offenen Lieferantenlieferung an, die über Lieferungs-Key oder -Nummer bestimmt wird, und liefert die angelegte Position zurück.

  • pixi_CreateSDeliveryByTemplate

    Legt aus einer oder mehreren bestätigten Lieferantenbestellungen eine neue Lieferantenlieferung (Status NEW) an und führt anschließend eine Abfrage der Lieferungsköpfe aus.

  • pixiCreateSDeliveryByTemplate

    Legt aus einer oder mehreren bestätigten Lieferantenbestellungen eine neue Lieferantenlieferung (Status NEW) an einem Lager an und liefert deren Kopfdaten.

  • pixiCreateSupplier

    Legt einen neuen Lieferanten samt Hauptkontakt an und liefert eine Statuszeile mit ReturnCode und Message.

  • pixiCreateSupplierOrderFromProfile

    Legt Lieferantenbestellungen anhand eines gespeicherten Bestellvorschlagsprofils an und liefert die Nummern der erzeugten Bestellungen.

Woher diese Dokumentation kommt

Hinter jedem SOAP-Call von Pixi steht eine Stored Procedure in der Pixi-Datenbank. Die Texte auf dieser Seite hat Claude (Anthropic) aus dem SQL-Code dieser Prozeduren geschrieben, sie werden bei jeder Änderung einer Prozedur neu erzeugt. Descartes hat sie nicht geprüft; wichtige Details deshalb in einem Testsystem nachvollziehen.