fetchSuppliers

Navigation:  WebService Calls > Options for Growth >

fetchSuppliers

 Previous pageReturn to chapter overviewNext page

Texte ein-/ausblenden

Beschreibung

Abfrage von Lieferantendaten.

Beispiel Request

Code

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

  <filter>

    <supplier_id filter_method="=" filter_value="3069"/>

    <supplier_number filter_method="=" filter_value="100001"/>

    <supplier_name filter_method="=" filter_value="Hauptlieferant"/>

    <postal_code filter_method="=" filter_value="92655"/>

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

  </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:

„fetchSuppliers“

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

supplier_id

Schränkt die Ergebnismenge der Abfrage auf einen bestimmten Lieferanten ein.

1

Element

filter_method

Attribut von supplier_id. Legt das Verhalten des Lieferanten-Filters fest.

1

string

Fester Wert:

„=“

filter_value

Attribut von supplier_id. Legt den Filterwert des Lieferanten-Filters fest.

1

integer

supplier_number

Schränkt die Ergebnismenge der Abfrage auf die angegebene Lieferantennummer ein.

1

Element

filter_method

Attribut von supplier_number. Legt das Verhalten des Lieferanten-Filters fest.

1

string

Fester Wert:

„=“

filter_value

Attribut von supplier_number. Legt den Filterwert des Lieferanten-Filters fest.

1

integer

supplier_name

Schränkt die Ergebnismenge der Abfrage auf den angegebenen Lieferantennamen ein.

 

0..1

string

Länge:

0 - 200 Zeichen

filter_method

Attribut von supplier_name. Legt das Verhalten des Lieferanten-Filters fest.

1

string

Feste Werte:

„=“, „like“, „IS“, „IS NOT“

filter_value

Attribut von supplier_name. Legt den Filterwert des Lieferanten-Filters fest.

1

integer

Falls filter_

method = „IS“  oder „IS NOT“:

„NULL“

allow_null

Attribut von supplier_name. Legt fest ob auch Null-Werte in der Ergebnismenge berücksichtigt werden.

0..1

postal_code

Schränkt die Ergebnismenge der Abfrage auf die angegebene PLZ ein.

0..1

string

Länge:

0 - 50 Zeichen

filter_method

Attribut von supplier_name. Legt das Verhalten des Lieferanten-Filters fest.

1

string

Feste Werte:

„=“, „like“, „IS“, „IS NOT“

filter_value

Attribut von supplier_name. Legt den Filterwert des Lieferanten-Filters fest.

1

integer

Falls filter_

method = „IS“  oder „IS NOT“:

„NULL“

allow_null

Attribut von supplier_name. Legt fest ob auch Null-Werte in der Ergebnismenge berücksichtigt werden.

0..1

mandator_id

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

1

Element

filter_method

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

1

string

Fester Wert:

„=“

filter_value

Attribut von mandator _id. Legt den Filterwert des Lieferanten-Filters fest.

1

integer

last_changed_at

Schränkt die Ergebnismenge der Abfrage nach dem letzten Änderungsdatum der Auftragsdatensätze ein.

0..1

Element

from_date

Attribut von last_changed. Selektiert alle Aufträge die ab einschließlich des angegebenen Datums geändert wurden.

0..1

dateTime

to_date

Attribut von last_changed. Selektiert alle Aufträge die bis einschließlich des angegebenen Datums geändert wurden.

0..1

dateTime

allow_null

Attribut von last_changed_at. Legt fest ob auch Null-Werte in der Ergebnismenge berücksichtigt werden.

0..1

boolean

created_at

Schränkt die Ergebnismenge der Abfrage nach dem Erstellungsdatum der Auftragsdatensätze ein.

0..1

Element

from_date

Attribut von created_at. Selektiert alle Aufträge die ab einschließlich des angegebenen Datums erstellt wurden.

0..1

dateTime

to_date

Attribut von created_at. Selektiert alle Aufträge die bis einschließlich des angegebenen Datums erstellt wurden.

0..1

dateTime

allow_null

Attribut von created_at. Legt fest ob auch Null-Werte in der Ergebnismenge berücksichtigt werden.

0..1

boolean

Beispiel Response

Code

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

   <report return_code="0" />

   <supplier>

      <supplier_id>3069</supplier_id>

      <mandator_id>1</mandator_id>

      <supplier_number>100001</supplier_number>

      <supplier_name>Lieferantenname</supplier_name>

      <street>Lieferantenstraße</street>

      <house_number>1</house_number>

      <additional_street_data>Straßenzusatz</additional_street_data>

      <postal_code>92655</postal_code>

      <city>Grafenwöhr</city>

      <country_code_iso>DE</country_code_iso>

      <free_field>Freifeld</free_field>

      <phone_number>+49 (0) 9641.45.49.0</phone_number>

      <mobile_phone_number>0177-1234567</mobile_phone_number>

      <fax_number>+49 (0) 9641.45.49.10</fax_number>

      <email_address>contact@speed4trade.com</email_address>

      <salutation>

         <salutation_id>1</salutation_id>

         <salutation_identifier>mr</salutation_identifier>

      </salutation>

      <contact_title>Dr.</contact_title>

      <contact_first_name>Vorname</contact_first_name>

      <contact_last_name>Nachname</contact_last_name>

      <contact_email_address>contact@speed4trade</contact_email_address>

      <contact_phone_number>+49 (0) 9641.45.49.0</contact_phone_number>

      <contact_mobile_phone_number>0177-1234567</contact_mobile_phone_number>

      <contact_fax_number>+49 (0) 9641.45.49.10</contact_fax_number>

      <additional_charge_percentage>1.00</additional_charge_percentage>

      <comment>Bemerkung</comment>

      <drop_shipping>false</drop_shipping>

      <ware_house>

         <ware_house_id>3072</ware_house_id>

         <ware_house_identifier>Lager Grafenwöhr</ware_house_identifier>

      </ware_house>

      <email_template>

         <email_template_id>3071</email_template_id>

         <email_template_identifier>Lieferanten-Email-Vorlage</email_template_identifier>

      </email_template>

      <created_at>2011-01-01T01:00:00.000+01:00</created_at>

      <last_changed>2011-01-01T01:00:00.000+01:00</last_changed>

   </supplier>

</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:

„fetchSuppliers“

version

Attribut von response. Legt die Version der Anfrage fest.

1

integer

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

0..1

string

supplier

Wrapper-Element für die Lieferantendaten

0..N

Element

supplier_id

ID des Lieferanten

1

integer

mandator_id

ID des Mandanten

1

integer

supplier_number

Lieferantennummer

1

integer

supplier_name

Bezeichnung des Lieferanten

1

string

Länge:

0-200 Zeichen

street

Straße

1

string

Länge:

0-200 Zeichen

house_number

Hausnummer

1

string

Länge:

0-50 Zeichen

additional_street_data

Straßenzusatz

0..1

string

Länge:

0-200 Zeichen

postal_code

Postleitzahl

1

string

Länge:

0-50 Zeichen

city

Stadt

1

string

Länge:

0-200 Zeichen

country_code_iso

Land

1

string

Ländercode ISO 3166-1 ALPHA-2 (z.B. „DE“)

free_field

Freifeld

0..1

string

Länge:

0-200 Zeichen

phone_number

Telefonnummer

0..1

string

Länge:

0-50 Zeichen

mobile_phone_number

Mobiltelefonnummer

0..1

string

Länge:

0-50 Zeichen

fax_number

Faxnummer

0..1

string

Länge:

0-50 Zeichen

email_address

Email-Adresse

1

string

Länge:

0-100 Zeichen

salutation

Wrapper-Element, das die Anrede enthält.

1

Element

salutation_id

Element von salutation. ID der Anrede.

1

integer

Zulässige Werte:

1 (= Herr)

2 (= Frau)

3 (= Firma)

salutation_identifier

Element von salutation. Bezeichner der Anrede.

1

string

Zulässige Werte:

„mr“ | „ms“| „business“

contact_title

Titel des Ansprechpartners

0..1

string

Länge:

0-50 Zeichen

contact_first_name

Vorname des Ansprechpartners

0..1

string

Länge:

0-100 Zeichen

contact_last_name

Nachname des Ansprechpartners

0..1

string

Länge:

0-200 Zeichen

contact_email_address

Email-Adresse des Ansprechpartners

0..1

string

Länge:

0-100 Zeichen

contact_phone_number

Telefonnummer des Ansprechpartners

0..1

string

Länge:

0-50 Zeichen

contact_mobile_phone_number

Mobiltelefonnummer des Ansprechpartners

0..1

string

Länge:

0-50 Zeichen

contact_fax_number

Faxnummer des Ansprechpartners

0..1

string

Länge:

0-50 Zeichen

additional_charge_percentage

Prozentualer Aufschlag des Lieferanten

0..1

decimal

comment

Kommentar

0..1

string

drop_shipping

Gibt an ob der Lieferant die Ware direkt verschickt (true) oder an ein Lager liefert (false)

1

boolean

ware_house

Wrapper-Element, das Daten über ein Lager zusammenfasst.

0..1

Element

ware_house_id

ID des Lagers

1

integer

ware_house_identifier

Bezeichner des Lagers

1

string

Länge:

0-100 Zeichen

email_template

Wrapper-Element, das die Daten einer E-Mail-Vorlage zusammenfasst.

0..1

Element

email_template_id

ID der E-Mail-Vorlage

1

integer

email_template_identifier

Bezeichner der E-Mail-Vorlage

1

string

Länge:

0-100 Zeichen

created_at

Erstellungsdatum des Lieferanten

0..1

dateTime

last_changed

Datum der letzten Änderung des Lieferanten

0..1

dateTime

 

Änderungsübersicht

Version

Änderungsbeschreibung

3.2.9.75

Redaktionelle Überarbeitung