Name

Beschreibung

Anz.

Typ

sonstiges

request

Root-Element der Anfrage

1

Element

method

Attribut von request. Name der Webservice-Methode.

1

string

Fester Wert:

„fetchItems“

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

item_id

Filtert die Ergebnismenge nach der Artikel-ID.

0..1

Element

filter_method

Attribut von item_id. Legt die Arbeitsweise des Filters fest.

1

string

Fester Wert:

„=“

filter_value

Attribut von item_id. Legt den Filterwert der Artikel-ID fest.

1

integer

ean_code

Filtert die Ergebnismenge nach dem EAN-Code der Artikel

0..1

Element

filter_method

Attribut von ean_code. Legt die Arbeitsweise des Filters fest. Es sind die Suche nach einem exakten Wert, oder eine Wildcard-Suche möglich

1

string

Feste Werte:

„=“ | „like“

filter_value

Attribut von ean_code. Legt das Filterkriterium fest. Exakter Ausdruck oder Suchbegriff mit SQL-Wildcards.

1

string

internal_item_number

Filtert die Ergebnismenge nach der internen Artikelnummer.

0..1

Element

filter_method

Attribut von internal_item_number. Legt die Arbeitsweise des Filters fest. Es sind die Suche nach einem exakten Wert, oder eine Wildcard-Suche möglich

1

string

Feste Werte:

„=“ | „like“

filter_value

Attribut von internal_item_number. Legt das Filterkriterium fest. Exakter Ausdruck oder Suchbegriff mit SQL-Wildcards.

1

string

category_id

Filtert die Ergebnismenge nach der Warengruppen-ID.

0..1

Element

filter_method

Attribut von category_id. Legt das Verhalten des Filters fest.

1

string

Fester Wert:

„=“

filter_value

Attribut von internal_item_number. Legt das Filterkriterium fest.

1

integer

external_category_id

Filtert die Ergebnismenge nach der externen Warengruppen-ID.

0..1

Element

filter_method

Attribut von external_category_id. Legt die Arbeitsweise des Filters fest. Es ist die Suche nach einem exakten Wert oder eine Wildcard-Suche möglich

1

string

Feste Werte:

„=“ | „like“

filter_value

Attribut von external_category_id. Legt das Filterkriterium fest. Exakter Ausdruck oder Suchbegriff mit SQL-Wildcards.

1

string

last_changed

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

0..1

Element

from_date

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

0..1

dateTime

to_date

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

0..1

dateTime

created_at

Schränkt die Ergebnismenge der Abfrage nach dem Erstellungsdatum der Artikel-Datensätze ein.

0..1

Element

from_date

Attribut von created_at. Selektiert alle Artikel, die ab einschließlich des angegebenen Datums erstellt wurden.

0..1

dateTime

to_date

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

0..1

dateTime

is_adult_product

Schränkt die Ergebnismenge der Abfrage auf FSK-18-Artikel ein.

0..1

Element

filter_value

Attribut von is_adult_product. Legt das Filterkriterium fest.

1

boolean

allow_null

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

0..1

boolean

active

Schränkt die Ergebnismenge der Abfrage auf aktive Artikel ein.

0..1

Element

filter_value

Attribut von active. Legt das Filterkriterium fest.

1

boolean

allow_null

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

0..1

boolean

last_changed_by

Schränkt die Ergebnismenge der Abfrage auf den letzten Bearbeiter des Artikels ein.

0..1

Element

filter_method

Attribut von last_changed_by. Legt die Arbeitsweise des Filters fest. Es ist die Suche nach einem exakten Wert oder ungleich einem Wert möglich.

1

string

Feste Werte:

„=“ | „<>“ | "!="

filter_value

Attribut von last_changed_by. Legt das Filterkriterium fest.

1

string

items_per_page

Anzahl der Artikel, die pro Seite zurückgegeben werden sollen.

0..1

integer

Muss zusammen mit „page“ stehen

page

Die Seitennummer, von der die Artikel zurückgegeben werden sollen. Wird „items_per_page“ und „page“ weggelassen, so werden alle Aufträge zurückgegeben.

0..1

integer

Muss zusammen mit „items_per_

page“ stehen

images_as_base64

Gibt an, ob die Bilder im Base64-Format übertragen werden.

0..1

boolean

Name

Beschreibung

Anz.

Typ

Sonstiges

response

Root-Element der Antwort

1

Element

method

Attribut von response. Name der Webservice-Methode.

1

string

Fester Wert:

„fetchItems“

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

total_number_of_pages

Gibt an, wie viele Seiten es insgesamt gibt.

0..1

integer

total_number_of_entries

Gibt an, wie viele Artikel es insgesamt zurückgegeben werden.

0..1

integer

item

Wrapper-Element für die Artikeldetails

0..N

Element

item_id

Artikel-ID

1

integer

mandator_id

Mandanten-ID

1

integer

identifier

Artikelbezeichnung

0..1

string

Länge:

0-255 Zeichen

internal_item_number

interne Artikelnummer

0..1

string

Länge:

0-50 Zeichen

vendor_item_number

Artikelnummer des Herstellers

0..1

string

Länge:

0-100 Zeichen

match_code

Matchcode

0..1

string

Länge:

0-100 Zeichen

ean_code

EAN-Code des Artikels

0..1

string

Länge:

0-30 Zeichen

variable_field

Freifeld

0..1

string

Länge:

0-100 Zeichen

stock_count

Gibt die Summe aller Lagerbestände an.

0..1

integer

stocks

Wrapper-Element, das die Lagerbestände zusammenfasst.

Element

stock

Wrapper-Element, das den Lagerbestand zusammenfasst.

Element

warehouse

Wrapper-Element, das das Lager zusammenfasst.

Element

warehouse_id

Lager-ID

integer

identifier

Lagerbezeichung

string

code

Lagercode

string

active

Gibt an ob das Lager aktiv ist.

boolean

external

Gibt an ob das Lager ein externes ist.

boolean

default_

warehouse

Gibt an ob das Lager das Standardlager ist.

boolean

stock_count

Lagerbestand

integer

reservedStock

reservierter Lagerbestand

integer

safety_stock_count

Sicherheitsbestand

0..1

integer

minimal_stock_count

Mindestbestand

0..1

integer

reserved_count

Gibt an welche Menge dieses Artikels reserviert ist.

0..1

integer

purchase_price

Einkaufspreis

0..1

decimal

list_price

Listenpreis

0..1

decimal

tax_type

Wrapper-Element für den Mehrwertsteuer-Typ

1

Element

tax_type_id

Element von tax_type. ID des Mehrwertsteuertyps.

1

integer

Feste Werte:

1 = Frei

2 = Reduziert

3 = Normal

tax_type_identifier

Element von tax_type. Bezeichner des Mehrwertsteuertyps.

1

string

Feste Werte:

"free" |

"reduced" |

"regular"

length

Länge des Artikels.

0..1

decimal

width

Breite des Artikels

0..1

decimal

height

Höhe des Artikels

0..1

decimal

distance_unit_id

Legt die Maßeinheit für Strecken fest. Default: Millimeter

0..1

integer

Feste Werte

weight

Gewicht des Artikels.

0..1

decimal

weight_unit_id

Legt die Maßeinheit für das Gewicht des Artikels fest. Default: Gramm

0..1

integer

Feste Werte

area

Fläche des Artikels.

0..1

decimal

area_unit_id

Legt die Maßeinheit für Flächen fest.

0..1

integer

Feste Werte

volume

Volumen des Artikels.

0..1

decimal

volume_unit_id

Legt die Maßeinheit für das Volumen fest.

0..1

integer

Feste Werte

piece

Anzahl des Artikels.

0..1

decimal

piece_unit_id

Legt die Maßeinheit für Stück fest

0..1

integer

Feste Werte

base_price_type_id

Grundpreistyp des Artikels.

0..1

integer

Feste Werte

package_length

Länge der Verpackung

0..1

decimal

package_width

Breite der Verpackung

0..1

decimal

package_height

Höhe der Verpackung

0..1

decimal

package_distance_measure

Legt die Maßeinheit für Strecken fest. Default: Millimeter

Veraltetes Feld - neues Feld package_distance_unit_id

0..1

integer

Feste Werte

package_distance_unit_id

Legt die Maßeinheit für Strecken fest. Default: Millimeter

0..1

integer

Feste Werte

package_weight

Gewicht des Artikels inkl. Verpackung

0..1

decimal

package_weight_measure

Legt die Maßeinheit für Gewicht fest. Default: Gramm

Veraltetes Feld - neues Feld package_weight_unit_id

0..1

integer

Feste Werte

package_weight_unit_id

Legt die Maßeinheit für Gewicht fest. Default: Gramm

0.1

integer

Feste Werte

packaging_unit

Verpackungseinheit in Stück

0..1

integer

package_count

Anzahl Packstücke

0..1

integer

category_id

Warengruppen-ID

0..1

integer

active

Aktiv/Inaktiv

0..1

boolean

delivery_charge_category_id

Versandkostenkategorie-ID

0..1

integer

delivery_time

Gibt die voraussichtliche Lieferzeit des Artikels an.

0..1

Element

delivery_time_id

Bestandteil von delivery_time. Gibt die ID der gewählten Lieferzeit an.

1

integer

identifier

Bestandteil von delivery_time. Gibt den Bezeichner der gewählten Lieferzeit an.

1

string

Länge:

0-255 Zeichen

vendor_id

Hersteller-ID

0..1

integer

is_coupon

Gibt an ob es sich bei diesem Artikel um einen Gutschein handelt.

1

boolean

is_adult_product

Gibt an ob es sich um einen Artikel handelt der ausschließlich für Erwachsene bestimmt ist.

1

boolean

isbn

ISBN-Nummer des Artikels

0..1

string

Länge:

0 - 13 Zeichen

upc_code

UPC-Code des Artikels

0..1

string

Länge:

0-12 Zeichen

variant

Wrapper-Element, das die Variantenoptionen dieses Artikels zusammenfasst.

0..1

Element

variant_parent_id

Übergeordnete Artikelvariante

1

integer

variant_standard

Gibt an ob dieser Artikel die Standardausführung der Artikelvarianten ist.

0..1

boolean

attributes

Wrapper-Element, das die Attibute der Variante zusammenfasst.

1

Element

attribute

Wrapper-Element, das ein Attribut der Variante zusammenfasst.

1..N

Element

sort

Gibt an in welcher Reihenfolge die Varianten-Attribute sind.

1

integer

property

Wrapper-Element, das die Attribute-Eigenschaften der Variante zusammenfasst.

1

Element

identifier

Gibt an, um welche Eigenschaft es sich handelt

1

string

translation

Wrapper-Element, das eine Übersetzung der Attribut-Eigenschaft enthält.

1..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

value

Wrapper-Element, das die Attribute-Werte der Variante zusammenfasst.

1

Element

identifier

Gibt an, um welche Eigenschaft es sich handelt

1

string

translation

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

1..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

text_modules

Wrapper-Element, das die Textbausteine dieses Artikels zusammenfasst.

1

Element

text_module

Wrapper-Element, das die Daten des Textbausteins zusammenfasst

0..N

Element

text_module_type

ID des Textbausteintyps

1

integer

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 dieses Artikels zusammenfasst.

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

original_image_path

Der ursprüngliche Pfad zur Bilddatei.

0..1

string

image_type

Dateityp des Bildes

0..1

string

is_local

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

1

boolean

image_as_base64

Bild als Base64-String. Wird nur ausgegeben, wenn „images_as_base64“ beim request angegeben werden.

0..1

string

cross_selling_items

Wrapper-Element, das die Zusatzartikel dieses Artikels zusammenfasst.

0..1

Element

cross_selling_item

Wrapper-Element, das die Daten des Zusatzartikels zusammenfasst

0..N

Element

cross_selling_item_id

ID des Zusatzartikels

1

integer

position

Position innerhalb der Menge der Zusatzartikel zum Hauptartikel. Wird zum Sortieren verwendet.

0..1

integer

cross_selling_type

Typ des Zusatzartikels

0..1

string

Feste Werte:

CROSS_

SELLING |

UP_SELLING

item_set

Wrapper-Element, das die Artikelsets dieses Artikels zusammenfasst.

0..1

Element

set_item

Wrapper-Element, das die Daten des Artikelsets zusammenfasst.

0..N

Element

set_item_id

ID des Setartikels

1

integer

internal_item_number

Interne Artikel-Nummer des Setartikels

0..1

string

position

Position des Setartikels. Wird zum sortieren verwendet.

0..1

integer

amount

Menge des Setartikels im Set

0..1

integer

specific_item_data

Wrapper-Element, das Verkaufskanalspezifische Daten zum Artikel zusammenfasst.

1

Element

[entries]

Platzhalter für Verkaufskanalspezifische Daten. Die möglichen Daten sind in den platformspezifischen Daten zum call fetchItems beschrieben.

0..N

Element

item_suppliers

Wrapper-Element, das die Daten der zugeordneten Lieferantenbeziehungen enthält

0..1

Element

item_supplier

Wrapper-Element, das die Daten einer zugeordneten Lieferantenbeziehung enthält

0..N

Element

supplier_id

ID des Lieferanten der entsprechenden Artikel-Lieferanten-Beziehung

1

integer

purchase_price

Gibt den Preis des Artikels bei diesem Lieferanten an.

0..1

decimal

additional_charge_percentage

Gibt den prozentualen Aufschlag für diesen Lieferanten an.

0..1

decimal

priority

Gibt die Priorität des Lieferanten an.

0..1

integer

default_shipping_carrier

Wrapper-Element, das die Daten des Versanddienstleisters zusammenfasst für diesen Artikel festgelegt wurde.

0..1

Element

shipping_carrier_id

ID des Versanddienstleisters

1

integer

identifier

Bezeichner des Versanddienstleisters

1

string

Länge:

0-100 Zeichen

external_id

externe ID des Versanddienstleitsters

1

string

item_attributes

Wrapper-Element, das alle Attribute des Artikels zusammenfasst.

0..1

Element

item_attribute

Wrapper-Element, das ein Attribut des Artikels beinhaltet.

1..N

Element

attribute_id

ID des Attributes.

1

integer

attribute_identifier

Bezeichnung des Attributes.

1

string

Max.: 100 Zeichen

translations

Wrapper-Element, das die Übersetzungen zur Attributbezeichnung zusammenfasst.

0..1

Element

translation

Wrapper-Element, das eine Übersetzung zur Attributbezeichnung beinhaltet.

1..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

item_attribute_values

Wrapper-Element, das alles Attribut-Werte eines Attributes zusammenfasst.

0..1

Element

item_attribute_value

Wrapper-Element, das einen Attribut-Wert eines Attributes beinhaltet.

1..N

Element

attribute_value_id

ID des Attribut-Wertes.

0..1

integer

attribute_value_identifier

Bezeichnung des Attribut-Wertes

1

string

Max.: 100 Zeichen

translations

Wrapper-Element, das die Übersetzungen zum Attribut-Wert zusammenfasst.

0..1

Element

translation

Wrapper-Element, das eine Übersetzung zum Attribut-Wert beinhaltet.

1..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

last_changed_by

Benutzername des Benutzers, der zuletzt den Artikel geändert hat.

0..1

string

1

per 1 m

2

per 1 m²

3

per 100 cm³

4

per 1 dm³

5

per 100 g

6

per 1 kg

7

per 100 ml

8

per 1 l

9

per 1 piece | Stück

10

per 1 m³

105

mm

110

cm

115

dm

120

m

125

in.

130

ft.

135

yd

400

g

405

kg

407

t

409

oz.tr.

410

oz.

415

pd.

200

mm²

205

cm²

210

dm²

215

m²

220

sq. in.

225

sq. ft.

230

sq. yd.

235

sq.

300

mm³

305

cm³

310

dm³

315

m³

320

cu. in.

325

cu. ft.

330

cu. yd.

355

ml

357

cl

360

l

365

fl. oz.

370

pt.

375

qt.

380

gal.

500

piece | Stück

Version

Änderungsbeschreibung

3.2.9.75

Redaktionelle Überarbeitung

3.5.37

Hinzufügen der externen ID und der Artikelattribute (ItemAttributes).

3.5.47

Hinzufügen der Anzahl und der zugehörigen Maßeinheit.

4.7.5

Hinzufügen der Verpackungseinheit

4.7.22

Hinzufügen des letzten Bearbeiters und einen neuen Filter für diesen Wert.