fetchOrderDocuments

Navigation:  WebService Calls > Options for Growth >

fetchOrderDocuments

 Previous pageReturn to chapter overviewNext page

Texte ein-/ausblenden

Beschreibung

Abrufen von Auftragsdokumenten. An Aufträge können verschiedene Dokumente angehängt sein. Wird typischerweise verwendet um Dokumente die vom Marktplatz bereitgestellt werden aus der Software abzurufen.

Beispiel Request

Code

<request method="fetchOrderDocuments" version="1.0.0">

   <filter>

   <mandator_id filter_method="=" filter_value="1"/>

   <order_ids filter_method="IN">

      <filter_values>

         <filter_value>1408848</filter_value>

      </filter_values>

   </order_ids>

   <order_number filter_method="=" filter_value="2017254"/>

   <order_number_prefix filter_method="=" filter_value="MV-"/>

   <document_type filter_method="=" filter_value="invoice"/>

   <base64 filter_method="=" filter_value="true"/>

   </filter>

</request>

Feldliste Request

Name

Beschreibung

Anz.

Typ

Sonstiges

request

Root-Element der Anfrage

1

Element

method

Attribut von request. Name der Webservice-Methode.

1

string

Fester Wert: „fetchOrderDocuments“

version

Attribut von request. Legt die Version der Anfrage fest.

1

integer

Fester Wert: „1.0.0“

filter

Legt Parameter fest nach denen die Ergebnismenge eingeschränkt wird. Mehrere Filter werden als ODER-Verknüpfung, Elemente innerhalb des Filters als UND-Verknüpfung behandelt.

1..N

Element

mandator_id

Schränkt die Ergebnismenge der Abfrage auf Auftragsdokumente eines bestimmten Mandanten ein.

1

Element

filter_method

Attribut von mandator_id. Legt das Verhalten des Mandanten-Filters fest.

1

string

Fester Wert: „=“

filter_value

Attribut von mandator_id. Legt den Filterwert des Mandanten-Filters fest.

1

integer

order_ids

Schränkt die Ergebnismenge der Abfrage auf Auftragsdokumente auf bestimmte Aufträge anhand von Auftrags-IDs ein.

0..1

Element

filter_method

Attribut von order_ids. Legt die Arbeitsweise des Filters fest.

1

string

Fester Wert: „IN“

filter_values

Element von order_ids, das alle Auftrags-IDs zusammenfasst.

1

Element

filter_value

Element von filter_values. Legt einen Filterwert für eine Auftrags-ID fest.

1..N

integer

order_number

Filtert die Ergebnismenge nach der Auftragsnummer.

0..1

Element

filter_method

Attribut von order_number. Legt die Arbeitsweise des Filters fest.

1

string

filter_value

Attribut von order_number. Legt einen Filterwert für eine Auftragsnummer fest.

1

integer

order_number_prefix

Filtert die Ergebnismenge nach dem Auftragsnummernpräfix.

0..1

Element

filter_method

Attribut von order_number_prefix. Legt die Arbeitsweise des Filters fest.

1

string

filter_value

Attribut von order_number_prefix. Legt einen Filterwert für einen Auftragsnummernpräfix fest.

1

string

document_type

Filtert die Ergebnismenge nach dem Dokumententyp.

0..1

Element

filter_method

Attribut von document_type. Legt die Arbeitsweise des Filters fest.

1

string

filter_value

Attribut von document_type. Legt einen Filterwert für einen Dokumententyp fest.

1

string

Mögliche Werte.

base64

Ermöglicht die Rückgabe des Dokuments als base64. Das Dokument muss dafür vorher nicht zwingend als Base64 übergeben worden sein.

0..1

Element

Hinweis

filter_method

Attribut von base64. Legt die Arbeitsweise des Filters fest.

1

string

Fester Wert: „=“

filter_value

Attribut von base64. Legt einen Filterwert für einen  fest.

1

boolean

Beispiel Response

Code

<response method="fetchOrderDocuments" version="1.0.0">

   <report return_code="0"/>

   <order>

   <mandator_id>1</mandator_id>

   <order_id>1408848</order_id>

   <order_number>2017254</order_number>

   <order_number_prefix>MV-</order_number_prefix>

   <external_order_number_1>69052a5f3f0acc5898ebe389ef47c1be</external_order_number_1>

   <external_order_number_2>98461a3g1a0acc1547aga389ef97c1du</external_order_number_2>

   <documents>

      <document>

         <base64_doc>JVBERi0xLjcNCiW1t...base64string...Pg0Kc3RhcnR4cmVmDQoyODA2Mg0KJSVFT0Y=</base64_doc>

         <external_document_number>Inv123</external_document_number>

         <local_doc_path>E:\speed4trade\connect\invoice\1\148614\Rechnung1.pdf</local_doc_path>

         <document_type>invoice</document_type>

         <document_name>Rechnung1.pdf</document_name>

         <uploaded>2020-02-28T17:06:13.818+01:00</uploaded>

         <packet_id>1721487</packet_id>

      </document>

   </documents>

   </order>

</response>

Feldliste Response

Name

Beschreibung

Anz.

Typ

Sonstiges

response

Root-Element der Antwort

1

Element

method

Attribut von response. Name der Webservice-Methode.

1

string

Fester Wert: „fetchOrderDocuments“

version

Attribut von response. Legt die Version der Anfrage fest.

1

string

Fester Wert:  „1.0.0“

report

Information über die ausgeführte Operation.

1

Element

return_code

Attribut von report. Gibt an, ob in der durchgeführten Operation Fehler aufgetreten sind.

1

integer

0 = OK.

< 0 = Fehler

error_description

Falls bei der Durchführung der Operation Fehler aufgetreten sind, wird in error_description eine Fehlerbeschreibung zurück geliefert

1

string

order

Wrapper-Element, das die Daten eines Auftrags zusammenfasst.

0..N

Element

mandator_id

Mandanten ID

1

integer

order_id

Auftrags-ID

1

integer

order_number

Auftragsnummer

1

integer

order_number_prefix

Auftragsnummernpräfix

0..1

string

external_order_number_1

Externe Auftragsnummer 1

0..1

string

external_order_number_2

Externe Auftragsnummer 2

0..1

string

documents

Wrapper-Element, das die Dokumente eines Auftrags zusammenfasst.

1

Element

document

Wrapper-Element, das die Informationen für ein Dokument enthält.

1..N

Element

base64_doc

Das Dokument im Base64-Format. Wird nur ausgegeben, wenn bei der Abfrage der base64-Filter auf "true" gesetzt wird.

0..1

string

external_document_number

Externe Dokumentennummer (z. B. Rechnungsnummer).

1

string

local_doc_path

UNC-Pfad zum Dokument.

1

string

Hinweis

document_type

Dokumententyp

1

string

Mögliche Werte.

document_name

Dateiname des Dokuments inkl. Dateityp.

1

string

Hinweis

uploaded

Zu diesem Zeitpunkt wurde das Dokument an den zugehörigen Verkaufskanal übertragen.

0..1

dateTime

packet_id

ID des Paketes, dem das Dokument zugehörig ist.

0..1

integer

Hinweis

Wertetabelle(n)

Aufgeführte Werte gelten für das Feld document_type.

Wert

Belegtyp

offer

Angebot

order

Auftrag

invoice

Rechnung

delivery note

Lieferschein

return ticket

Rücksendeschein

cancellation invoice

Stornorechnung

shipping label

Versandlabel

parcel label 1

Paketschein 1

parcel label 2

Paketschein 2

sepa debit agreement

SEPA Lastschriftmandat

Hinweise

•Wird der Filter base64 nicht angegeben, dann greift der Standardwert "false" und das Dokument wird nicht zusätzlich als Base64 ausgegeben.

•Wird für einen Auftrag ein leeres base64-Tag im Response ausgegeben (<base64></base64>), dann konnte das Base64 nicht erzeugt werden. Dies kann zum Beispiel auftreten, wenn das Dokument in dem Moment nicht unter dem gespeicherten Pfad gefunden werden konnte.

•Der Dateiname in document_name und local_doc_path sind nur dann identisch wenn das Dokument von der Software erstellt wurde. Wird ein Dokument von extern (UI oder Webservice) beim Auftrag hinterlegt, dann unterscheiden sich die Werte. Document_name entspricht dann dem ursprünglichen Dokumentnamen. Beim local_doc_path ist der Dateiname angegeben, den die Software intern zur Dokumentenverwaltung verwendet.

•Die Zuordnung eines Dokuments zu eine Paket hat bisher keine funktionale Auswirkung. Das Mapping kann über updateOrderDocuments angelegt werden.

Änderungsübersicht

Version

Änderungsbeschreibung

4.10.7

Einführung des fetchOrderDocuments-Calls.

4.10.9

Response um Feld uploaded erweitert.

4.10.10

Anpassung an der softwareinternen Dokumentenverwaltung machte neuen Hinweis bzgl. Dateiname in den Feldern document_name und local_doc_path nötig.

4.11.6

Erweiterung der Dokumenttypen um "parcel label 1/2".

4.11.7

Erweiterung der Dokumenttypen um "sepa debit agreement".

4.11.26

Response um Feld packet_id erweitert.