updateCategories

Navigation:  WebService Calls > Options for Growth >

updateCategories

Previous pageReturn to chapter overviewNext page

Texte ein-/ausblenden

Beschreibung

Anlegen und aktualisieren von Warengruppen.

Beispiel Request

Code

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:

„updateCategories“

version

Attribut von request. Legt die Version der Anfrage fest.

1

integer

Fester Wert: „1.0.0“

category

Wrapper-Element, das die Daten der Warengruppe zusammenfasst

0..N

Element


significant_key

Gibt an welches Feld zur Identifikation der Warengruppe beim Update genutzt wird.

1

string

Feste Werte:

„category_id“ | „external_id“

category_id

ID der Warengruppe

0..1

integer


mandator_id

ID des Mandanten dem diese Waren-gruppe zugeordnet ist.

1

integer


identifier

Bezeichner der Warengruppe

1

string

Länge:

0 – 100 Zeichen

external_id

Externe ID

0..1

string

Länge:

0 – 50 Zeichen

parent_id

ID der übergeordneten Warengruppe.

0..1

integer

Null möglich

external_parent_id

Externe ID der übergeordneten Warengruppe.

0..1

string

Länge:

0 – 50 Zeichen

created_by

Benutzer der die 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.

0..N

Element


language_code_iso

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 Bildbausteine dieser Warengruppe zusammenfasst.

0..1

Element


image_module

Wrapper-Element, das die Daten eines Bildbausteins zusammenfasst.

0..N

Element


image_module_type_id

ID des Bildbausteintyps

1

integer


image_url

URL zu dem Bild

0..1

string

Länge:

0 – 200 Zeichen

local_image_path

UNC Pfad zu einer Bild-Datei.

0..1

string


base64_image_data

Base64-Codierte Daten des Bildes

0..1

string


image_type

Dateiendung des Bildes

0..1

string


is_local

Legt fest ob das lokale Bild oder eine URL genutzt wird.

1

boolean


cross_selling_items

Wrapper-Element, das die Zusatzartikel zusammenfasst.

0..1

Element


cross_selling_item

Wrapper-Element, einen Zusatzartikel beinhaltet.

1..N

Element


cross_selling_item_id

Aritkel ID des Zusatzaritkels

1

integer


position

Position (Reihenfolge) des Zusatzartikels

1

integer


cross_selling_type

Art des Zusatzartikels

1

string

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

Beispiel Response

Code

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:

„updateCategories“

version

Attribut von response. Legt die Version der Anfrage fest.

1

integer

Fester Wert:

„1.0.0“

report

Information über die ausgeführte Operation. Für jedes Category-Element aus dem Request wird ein Report zurückgegeben.

0..N

Element


action

Attribut von report. Gibt an welche Operation mit dem Datensatz durchgeführt wurde.

1

string

Feste Werte:

insert | update

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


category

Wrapper-Element, das die Daten der Warengruppe zusammenfasst

1

Element


category_id

ID der Warengruppe

1

integer


mandator_id

ID des Mandanten dem diese Warengruppe zugeordnet ist.

1

integer


external_id

Externe ID

1

string

Länge:

0 – 50 Zeichen

Hinweise

Bei jeder Operation wird zunächst geprüft ob bereits ein passender Datensatz mit dem durch significant_key angegebenen Schlüssel zum Aktualisieren vorhanden ist. Wenn dies nicht der Fall ist wird ein neuer Datensatz angelegt.

Die Elemente parent_id und external_parent_id dürfen nicht gemeinsam genutzt werden.

Wird ein Bild über die Elemente base64_image_data oder local_image_path übergeben, muss auch das Element image_type angegeben werden.

Aus Performance-Gründen sollten Bilder möglichst per UNC-Pfad oder URL angegeben werden. Falls dennoch eine Base64-codierte Übergabe notwendig ist, sollte die Datenmenge der übergebenen Bilder pro Request nicht mehr als 10 MB betragen.

Änderungsübersicht

Version

Änderungsbeschreibung

3.2.9.75

Redaktionelle Überarbeitung

3.5.47

Erweiterung des Request um Cross-Selling Daten.