request

Root-Element der Anfrage

1

Element

method

Attribut von request. Name der Webservice-Methode.

1

string

Fester Wert:

„fetchCategories“

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 einen 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

last_changed_at

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

0..1

Element

from_date

Attribut von last_changed. Selektiert alle Daten die ab einschließlich dem angegebenem Datum geändert wurden.

0..1

dateTime

to_date

Attribut von last_changed. Selektiert alle Daten die bis einschließlich dem angegebenen Datum geändert wurden.

0..1

dateTime

created_at

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

0..1

Element

from_date

Attribut von created_at. Selektiert alle Daten die ab einschließlich dem angegebenem Datum erstellt wurden.

0..1

dateTime

to_date

Attribut von created_at. Selektiert alle Daten die bis einschließlich dem angegebenen Datum erstellt wurden.

0..1

dateTime

response

Root-Element der Antwort

1

Element

method

Attribut von response. Name der Webservice-Methode.

1

string

Fester Wert:

„fetchCategories“

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

Fehlerbeschreibung falls bei der Durchführung der Operation Fehler aufgetreten sind.

0..1

string

category

Wrapper-Element, das die Daten einer Warengruppe zusammenfasst

0..N

Element

category_id

ID der Warengruppe

1

integer

mandator_id

ID des Mandanten dem diese Warengruppe zugeordnet ist.

1

integer

identifier

Bezeichner der Warengruppe

1

string

Länge:

0 – 100 Zeichen

external_id

Externe ID

1

string

Länge:

0 – 50 Zeichen

parent_id

ID der Warengruppe der diese Warengruppe untergeordnet ist.

0..1

integer

created_by

Benutzer der Kategorie angelegt hat

0..1

string

text_modules

Wrapper-Element, das die Textbausteine dieser Warengruppe zusammenfasst.

0..1

Element

text_module

Wrapper-Element, das die Daten des Textbausteins zusammenfasst

0..N

Element

text_module_type

ID des Textbausteintyps

1

integer

translation

Wrapper-Element, das eine Übersetzung des Textbausteins enthält.

1..N

Element

language

Sprache dieser Übersetzung

1

string

Sprachcode ISO 639-1

ALPHA-2 (z.B. „de“)

text

Text in der Sprache die im Element language_code_iso angegeben wurde

1

string

image_modules

Wrapper-Element, das die Bildbau-steine dieser Warengruppe zusammenfasst.

0..1

Element

image_module

Wrapper-Element, das die Daten des Bildbausteines zusammenfasst

0..N

Element

image_module_type_id

ID des Bildbausteintypen

1

integer

image_url

URL eines im Web verfügbaren Bildes

0..1

string

image_file

lokaler Pfad auf dem Server zur abgelegten Bilddatei.

0..1

string

is_local

Legt fest ob die lokale Datei oder die URL genutzt wird.

1

boolean

image_as_base64

Base64-Codierte Daten des Bildes.

0..1

string

image_type

Dateiendung der Bilddatei.

0..1

string

specific_category_data

Wrapper-Element, das Verkaufskanal spezifische Daten zur Warengruppe zusammenfasst.

0..1

Element

cross_selling_items

Wrapper-Element, das Zusatzartikel zusammenfasst

0..1

Element

cross_selling_item

Wrapper-Element, das einen Zusatzartikel beinhaltet.

1..N

Element

cross_selling_item_id

ID des Zusatzartikels.

1

integer

position

Position (Reihenfolge) des Zusatzartikels

1

integer

cross_selling_type

Art des Zusatzartikels

1

string

Feste Werte: "CROSS_SELLING" | "UP_SELLING" | "ALTERNATIVE"

3.2.9.75

Redaktionelle Überarbeitung

3.5.47

Erweiterung der Response um Cross-Selling Daten.