Postman-Collection
Direct-Fulfillment Lesen

pixiDFGetOrders

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

Teil der Direct-Fulfillment-API (DF): Ein Lieferant ruft die Aufträge ab, die er direkt an den Kunden versenden soll.

Authentifizierung

  • Die Einstellung DFAPIAllowFullAccessWithoutSecret wird gelesen. Ist sie nicht 1, wird der Lieferant über SupplNr zusammen mit Secret identifiziert; Secret muss der CustNr des Lieferanten (Kundennummer beim Lieferanten) entsprechen.
  • Der Lieferant muss existieren, darf nicht deaktiviert sein und muss CanDoDirectFulfillment = 1 haben.
  • Kann der Lieferant nicht identifiziert werden und ist die Einstellung nicht 1, wird eine einzelne Fehlerzeile mit Error = 403 zurückgegeben.
  • Ist die Einstellung 1, wird das Secret nicht geprüft. Eine angegebene SupplNr muss trotzdem einem aktiven DF-Lieferanten entsprechen, sonst wird eine Fehlerzeile geliefert. Wird SupplNr weggelassen (oder 0), werden die Aufträge aller Lieferanten geliefert.

Auftragsauswahl

Ein Auftrag wird geliefert, wenn er mindestens eine Auftragsposition hat, die

  • den Status FUT hat,
  • dem Lieferanten zugeordnet ist (SupplInfo), außer wenn kein Lieferant gesetzt ist (Vollzugriff), und
  • ClientNotified = 'N' hat (noch nicht übertragen), außer bei AllOrders = 1.

Aufträge mit gesperrter Lieferadresse oder gesperrtem Kunden werden ausgeschlossen. Nur Aufträge mit vorhandenem Kunden, Rechnungsadresse, Lieferadresse, Land und Währung werden geliefert (Inner Joins).

Das Ergebnis enthält eine Zeile pro Auftrag, sortiert nach OrderNr. AddrShopID und APayment stammen aus der Rechnungsadresse, alle anderen Adressfelder aus der Lieferadresse.

Hinweise

  • Alle Lesezugriffe verwenden NOLOCK, daher können nicht festgeschriebene Daten geliefert werden.
  • Der Aufruf markiert die Aufträge nicht als übertragen; ClientNotified wird hier nicht geändert. Ohne AllOrders = 1 werden dieselben Aufträge erneut geliefert, bis ein anderer Prozess die Auftragspositionen aktualisiert.
  • Bei einem Authentifizierungsfehler wird nur die Fehlerzeile geliefert (Rückgabewert 1), keine Auftragsdaten.
  • Ist DFAPIAllowFullAccessWithoutSecret = 1 und wird keine SupplNr angegeben, werden die Aufträge aller Lieferanten offengelegt; diese Einstellung sollte mit Bedacht eingesetzt werden.
  • Die Auftragshistorie wird in der Positionsprüfung verknüpft, der Historienfilter ist jedoch auskommentiert und hat keinen Einfluss auf das Ergebnis.
  • Eine temporäre Tabelle wird über util.TempTableDrop angelegt bzw. gelöscht (Definition nicht beigefügt).

Parameter

Parameter Typ Standardwert Beschreibung
SupplNr
varchar(4)
string
NULL

Lieferantennummer des Direct-Fulfillment-Lieferanten. Erforderlich, außer die Einstellung DFAPIAllowFullAccessWithoutSecret ist 1; dann liefert das Weglassen die Aufträge aller Lieferanten.

Beispiel: L001

Secret
varchar(20)
string
NULL

Secret des Lieferanten; muss der CustNr des Lieferanten entsprechen. Wird ignoriert, wenn DFAPIAllowFullAccessWithoutSecret 1 ist.

Beispiel: K123456

AllOrders
bit
boolean
0

Steuert, ob bereits übermittelte Auftragspositionen berücksichtigt werden. NULL wird als 0 behandelt.

Erlaubte Werte

  • 0 – Nur Aufträge mit noch nicht übermittelten FUT-Positionen (`ClientNotified = 'N'`).
  • 1 – Alle Aufträge mit FUT-Positionen, unabhängig von `ClientNotified`.

Beispiel: 0

Antwort

Result-Set 1 · Wenn der Lieferant nicht authentifiziert werden kann oder SupplNr ungültig ist

Einzelne Fehlerzeile; es folgt keine weitere Ergebnismenge.

Spalte Typ Beschreibung
Error varchar(3)
string

Immer 403.

ErrorMsg varchar(34)
string

Fehlertext.

Result-Set 2 · Bei erfolgreicher Authentifizierung

Eine Zeile pro Auftrag mit offenen DF-Auftragspositionen, sortiert nach OrderNR.

Spalte Typ Beschreibung
OrderNR string

Auftragsnummer (OrderHeader.OrderNr).

Anrede
Kann leer sein
string

Anrede der Lieferadresse.

CareOf
Kann leer sein
string

c/o-Zeile der Lieferadresse.

FirstName
Kann leer sein
string

Vorname der Lieferadresse.

LastName
Kann leer sein
string

Nachname der Lieferadresse.

Street
Kann leer sein
string

Straße der Lieferadresse.

ZIP
Kann leer sein
string

Postleitzahl der Lieferadresse.

HouseNr
Kann leer sein
string

Hausnummer der Lieferadresse.

City
Kann leer sein
string

Ort der Lieferadresse.

Country string

Pixi-Ländercode der Lieferadresse.

Email
Kann leer sein
string

E-Mail der Lieferadresse.

Phone
Kann leer sein
string

Telefonnummer der Lieferadresse.

Address_remarks
Kann leer sein
string

Adressbemerkungen des Auftrags.

ShipInstruct
Kann leer sein
string

Versandanweisungen des Auftrags.

Shipdate
Kann leer sein
dateTime

Geplantes Versanddatum des Auftrags.

ShipVendorCode
Kann leer sein
string

Versanddienstleister-Code des Auftrags.

AddrShopID
Kann leer sein
string

Shop-ID der Rechnungsadresse.

APayment
Kann leer sein
string

Zahlungsart der Rechnungsadresse.

AddrNoChargeVAT
Kann leer sein
string

Kennzeichen MwSt.-Befreiung der Lieferadresse.

discount
Kann leer sein
decimal

Rabatt des Auftrags.

CntCodeISO2
Kann leer sein
string

ISO-3166-Alpha-2-Code des Lieferlandes.

CntCodeISO3
Kann leer sein
string

ISO-3166-Alpha-3-Code des Lieferlandes.

ShipCost
Kann leer sein
decimal

Versandkosten des Auftrags.

PartialDeliveryActive boolean

Teillieferung erlaubt (ForceToPicklistIfNotFULL), 0 wenn nicht gesetzt.

PartialDeliveryForceCancelAfterShipout boolean

Restpositionen nach erzwungenem Versand stornieren (OHCancelAfterForcedShipOut), 0 wenn nicht gesetzt.

PartialDeliveryMultiple boolean

Mehrfache Teillieferungen erlaubt (OHMultiForceToPicklist), 0 wenn nicht gesetzt.

OrderCurrencyCode string

Währungscode des Auftrags (pixi.Currency.CodeA).

Fax
Kann leer sein
string

Faxnummer der Lieferadresse.

Referrer
Kann leer sein
string

Referrer des Auftrags.

SubShopName
Kann leer sein
string

Subshop-Name des Auftrags.

Fehlermeldungen

Status Meldung Ursache
403 Not Authorized. Secret or SupplNr is incorrect. Die Secret-Prüfung ist aktiv und kein aktiver DF-Lieferant passt zu `SupplNr` und `Secret` (falsche Werte, Lieferant deaktiviert oder `CanDoDirectFulfillment` nicht gesetzt).
403 SupplNr is incorrect. `DFAPIAllowFullAccessWithoutSecret` ist 1, die angegebene `SupplNr` gehört jedoch zu keinem aktiven Lieferanten mit aktiviertem Direct Fulfillment.

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:pixiDFGetOrders>
      <!-- <SupplNr>L001</SupplNr> -->
      <!-- <Secret>K123456</Secret> -->
      <!-- <AllOrders>0</AllOrders> -->
    </ns1:pixiDFGetOrders>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Verwendete Tabellen

Settings · Lesen Suppliers · Lesen OrderHeader · Lesen Customers · Lesen Addresses · Lesen Countries · Lesen Currency · Lesen Orderlines · Lesen OrderHistory · Lesen
SQL-Objekt:
dbo.pipiDFGetOrders
Prozedur zuletzt geändert am 2026-10-05
Dokumentation von claude-opus-5-5 am 2026-10-30 geschrieben