Inhaltsverzeichnis

1. Überblick über die REST API

Warum eine REST API?

  • Weil eine API benötigt wird, die die Aufgaben der XML-Export-, Shop-, und SOAP- Schnittstellen vereint und übertrifft.
  • Weil sie plattformneutral sind.
  • Weil sie über eine leichte Erweiterbarkeit verfügen.
  • Weil sie leicht zu verstehen und anzubinden sind.

Für wen ist die REST API gemacht?

Für alle die mit DreamRobot arbeiten wollen und sich dabei nicht nur auf die manuelle Bedienung im Frontend beschränken (wollen). Das schließt sowohl DR Kunden(nachfolgend als "User" bezeichnet) als auch Partner/Drittsoftware, die im Auftrag unserer Kunden mit DR arbeiten wollen, mit ein (nachfolgend als "Client" bezeichnet).

Was kann die REST API?

Das Ziel der REST API ist es, langfristig sämtliche Aufgaben der anderen Schnittstellen abzulösen. Aktuell kann die REST API folgende Aufgaben durchführen:
  • Lager-/Lister-Verwaltung: Lager-/Lister-daten anlegen, aktualisieren, löschen, PüMa(Portalübergreifender Mengenabgleich) triggern (inkl. Varianten, Sets und alle Shop-/Portaltabellen).
  • Auftragsverwaltung: Auftrag anlegen, aktualisieren, löschen. versch. Status setzen: Kaufabwicklung abgeschlossen?, bezahlt?, gepackt?, etc.

2. Einrichtung eines API Clients

Der Client muss HTTPS-Requests absetzen um mit der API zu kommunizieren.

Der PHP Client

Zum Verständnis, wie die Anfragen aussehen, sind in dem Download-Archiv im Ordner "Examples" zu jedem API-Call ein PHP-Beispiel enthalten. Zugangsdaten und verschiedene IDs können in der "settings.inc.php" gesetzt werden.

Der Client auf einer PHP fremden Plattform

Für die API sind bei Ihren HTTPS-Anfragen folgende Parameter zu setzen (alles auch der "settings.inc.php" zu entnehmen):
  • Die URL:
    • Tokenanfrage: "https://api.dreamrobot.de/rest/v1.1/token.php".
    • Ressourcenanfrage: "https://api.dreamrobot.de/rest/v1.1/{Endpunktpfad}/".

  • Die Request-Method:
    Die API unterstützt: "GET", "POST", "DELETE" (und "OPTIONS").

  • Der Header:
    • Token-Header: "Authorization: Basic {Benutzer;Doppelpunkt;Passwort -> als Base64}"
    • Ressourcen-Header: "Authorization: Bearer {AccessToken}"
    Zusätzlich sind "Content-type", "Accept" und "Accept-Charset" möglich. Per default werden JSON und UTF-8 angenommen, es sind aber auch je XML und ISO-8859-15 möglich.

  • Die Anfragedaten:
    Die Daten kommen entsprechend den Headern als JSON oder XML in den Anfrage Body (Bei einer GET-Anfrage werden sie mit "?" an die URL angefügt).

3. Der Umgang mit der REST API

Die OAuth2-Authentifizierung

Die User-Authentifizierung(Nur für DR-Kunden)

Achtung, die nachfolgend beschriebene Authentifizierung funktioniert nur für DR-Kunden/User!

Nachdem Sie Ihre Zugangsdaten einmalig vom DreamRobot-Support angefordert haben, senden Sie "POST https://api.dreamrobot.de/rest/v1.1/token.php" mit den Daten "grant_type=client_credentials" und dem Tokenheader. Sie erhalten einen Access-Token der eine Stunde gültig ist.
Mit diesem Token können entsprechend lang Ressourcen-Anfragen durchgeführt werden.
Ist der Access-Token abgelaufen, generieren Sie sich einen Neuen.

Die Client-Authentifizierung(Nur für Drittsoftware)

Achtung, die nachfolgend beschriebene Authentifizierung funktioniert nur für Drittsoftware, z.B. wenn Sie Ihren Webshop oder Ihre WaWi anbinden möchten!

Nachdem Sie Ihre Zugangsdaten erhalten haben und sich ggf. einen Testaccount erstellt haben, läuft die Authentifizierung wiefolgt ab:
  1. Leiten Sie einen Nutzer auf https://api.dreamrobot.de/rest/v1.1/authorize.php?response_type=code&client_id={client_id}&state={ihre_user_id}&scope={scope}: Dort loggt der DR-Nutzer sich wie gewohnt ein, wählt die Zugriffsrechte die er Ihnen gewährt, ggf. die Zugehörigkeit zu einem Portalaccount, und bestätigt die Auswahl.
  2. Wandeln Sie den "code"(Autorisierungscode), den Sie an die hinterlegte redirect_uri gesendet bekommen, wie in Beispiel 2, in einen RefreshToken. Wenn die Anfrage Erfolgreich war, steht in der Antwort der RefreshToken(Der Zugang) und der Scope.
  3. Wie in Beispiel 3 kann durch einen RefreshToken ein neuer AccessToken (und ein neuer RefreshToken) angefordert werden: "POST https://api.dreamrobot.de/rest/v1.1/token.php" mit den POST-Daten "grant_type=refresh_token" und "refresh_token={RefreshToken}". Ein Refresh-Token ist 1 Monat lang gültig, aber maximal, bis eine neue Access-/Refreshtokenkombination angefordert wurde.

Die API-Endpunkte

Mit dem AccesToken können Sie die Endpunkte ansprechen. Für alle Endpunkte ist eine Teilmenge der "CRUD"-Funktionen verfügbar. Die vier Buchstaben das Akronyms werden nacholgend anhand des Order-Endpunkts erläutert:
  1. Create: Einen Auftrag anlegen. Ein POST-Request ohne ID.
    z.B.: "POST order/"
  2. Read: Einen oder mehrere Aufträge abrufen. Ein GET-Request mit oder ohne ID.
    z.B.: "GET order/{order_id}/", der Auftrag mit der ID.
    oder "GET order/", Aufträge suchen.
    Es kann mit Filter- und Select-(Select auch bei GET mit ID möglich)Parametern angegeben werden, welche Datensätze gesucht werden(Filter), und welche Felder der gefilterten Daten ausgegeben werden sollen(Select). Wir empfehlen, stets wohlüberlegte Select- und Filterparameter zu verwenden.
  3. Update: Einen Auftrag Aktualisieren. Ein POST-Request mit ID.
    z.B.: "POST order/{order_id}/"(aktualisieren).
  4. Delete): Einen Auftrag löschen. Ein DELETE-Request mit ID.
    z.B.: "DELETE order/{order_id}/".
  5. Zusätzlich ist es an allen Endpunkten möglich, einen "OPTIONS" Request zu senden. Dieser liefert eine Übersicht über alle möglichen Endpunktmethoden, -Objekte und Versionsänderungen.
Eine vollständige Auflistung der Endpunkte ist dem Punkt Endpunkte/Funktionen zu entnehmen. Es ist genau aufgelistet welche Parameter die Funktionen entgegennehmen und welche Werte zurückgegeben werden. Mit wenigen Ausnahmen gilt: Alle Felder außer der ID sind optional.

4. HTTP-Codes

Jede Anfrage wird von der API mit einem HTTP-Statuscode beantwortet. Fehlermeldungen werden zusätzlich von einer "error_description" begleitet. Die häufigsten HTTP-Codes sind nachfolgend einmal aufgeführt:

Code Status Beschreibung
200 Success Die Anfrage wurde erfolgreich verarbeitet.
201 Created Der Datensatz wurde erfolgreich erstellt. In der Rückgabe steht die ID des neuen Datensatzes.
202 Accepted Die Anfrage wurde entgegengenommen. Sie wurde erst in eine Warteliste eingetragen und noch nicht verarbeitet.
207 Multi-Status Die Anfrage ist eine komplexe Anfrage mit inhaltlich mehreren Einzelanfragen gewesen, die jeweils einen eigenen Rückgabewert haben. Die Anfrage wurde ausgeführt. Der Status der einzelnen Sub-Requests ist in multistatus->response[] zu finden(siehe Multistatus_type).
300 Multiple Choice Die Anfrage enthält (k-)eine ID, wodurch mehrere Datensätze gefunden würden.
400 Bad Request Der Standard-Fehlercode: Aus verschiedenen Gründen ist die Anfrage nicht korrekt aufgebaut und konnte nicht verarbeitet werden. Es wurden KEINE Daten verändert.
401 Unauthorized Im Rahmen des Autorisierungsprozesses ist ein Fehler aufgetreten.
403 Forbidden Die Autorisierung hat funktioniert, der verwendete AccessToken verfügt aber nicht über die notwendigen Rechte um den angefragten Befehl auszuführen. Falls Sie die Anfrage dennoch durchführen wollen, müssen Sie sich an den entsprechenden User wenden. Als User können Sie Ihre aktiven Client-Zugänge(RefreshTokens) unter "Admin->MyAccount->REST API" bearbeiten und ggf. erweitern oder einschränken.
404 Not Found Entweder das Objekt mit der übergebenen ID oder ein enthaltenes Objekt mit entsprechend übergebener ID wurde nicht gefunden.
405 Method Not Allowed Sie sind autorisiert, und haben einen korrekten Endpunkt angesprochen. Aber die HTTP-Methode wird (noch) nicht unterstützt. Oft gibt es nur POST oder GET. Näheres ist der Dokumentation oder über die HTTP-Methode "OPTIONS" zu entnehmen.
429 Too Many Requests Abhängig von Ihrem Tarif haben Sie eine beschränkte Anzahl Calls. Außerdem kann immer nur 1 Call gleichzeitig verarbeitet werden.
500 Internal Server Error Es ist ein kritischer Fehler aufgetreten. Dieser kann verschiedene Ursachen haben:
  • Das Skript ist unerwartet abgebrochen.
  • Es ist ein unerwarteter Fehler in einer Datenbankanfrage aufgetreten.
  • etc.
ACHTUNG: Es besteht die Möglichkeit, dass die Anfrage nur teilweise bearbeitet wurde und eine Dateninkonsistenz entstanden ist.
501 Not Implemented Der Programmierer hat bereits vorgesehen, dass die angefragte Methode theoretisch ausgeführt werden kann, diese wurde aber noch nicht eingebaut.

5. Endpunkte/Funktionen

In der nachfolgenden Tabelle sind alle Funktionen aufgeführt, die über die API aufgerufen werden können. Zusätzlich zu den in der Spalte "Anfrage" angegebenen Feldern ist stets das Feld "portal_account_id" gültig, um die globale fallback Portal-Account-ID für die aktuelle Anfrage zu überschreiben. Nähere Informationen zu diesem Feld sind unter Portal_account_id_type zu finden.

Modul Rest-Pfad Methode Anfrage Antwort Beschreibung
Feldname Datentyp Feldname Datentyp
Token token.php POST grant_type string access_token string(160) Einen Access-Token abrufen.
code / refresh_token string expires int
scope string
refresh_token string(160)
System system/currency/ GET currency array_of_ System_currency_type Alle DR Währungen abrufen.
system/currency/​{currency_id}/ GET currency System_currency_type Eine DR Währung abrufen.
system/payment_method/ GET payment_method array_of_ Payment_method_type Alle Zahlungsarten abrufen.
system/stock/condition/ GET condition array_of_ Stock_condition_type Mögliche Lagerzustände abrufen (einige Portale haben abweichende IDs).
system/stock/description/icon/ GET icon_id array_of_ string Alle gültigen Icon-IDs für die Lagerbeschreibungen(description->icon_id) abrufen.
system/stock/category/ GET filter Category_filter_type category array_of_ Category_type Globale Kategorien abrufen.
pagination Pagination_type
system/event/action/ GET event_action array_of_ System_event_action_type Alle möglichen Reaktionen auf ein Event abrufen.
system/event/condition/ GET event_condition array_of_ System_event_condition_type Alle möglichen Eventhandler Bedingungen abrufen.
system/event/type/ GET event_type array_of_ System_event_type_type Alle möglichen Eventauslöser abrufen.
system/scope/ GET scope array_of_ System_scope_type Liefert alle möglichen Berechtigungen.
Order order/ GET select Select_type order array_of_ Order_type Aufträge suchen.
filter array_of_ Order_filter_type
pagination Pagination_type
POST order Order_type order_id string Einen Auftrag anlegen.
order/​{order_id}/ GET select Select_type order Order_type Einen Auftrag abrufen.
POST order Order_type order_id string Einen Auftrag überarbeiten.
DELETE Einen Auftrag löschen.
order/​{order_id}/history/ GET history array_of_ string Die komplette Historie abrufen.
POST text string Einen Eintrag in die Auftragshistorie einfügen.
order/​{order_id}/send_mit/ POST send_mit Order_send_mit_type Ware-Unterwegs-Mail(WUM) senden. Einen Auftrag im (order->platform)-Portal als versendet markieren.
Bank bank/transfer/ GET filter array_of_ Bank_filter_type bank array_of_ Bank_type Banküberweisungen abrufen.
pagination Pagination_type
bank/paypal/ GET filter array_of_ Bank_filter_type bank array_of_ Bank_type Paypalzahlungen abrufen.
pagination Pagination_type
Stock stock/ GET select Select_type stock array_of_ Stock_type (Mehrere) Lagerartikel suchen.
filter array_of_ Stock_filter_type
pagination Pagination_type
POST stock Stock_type stock_id integer Einen Lagerdatensatz anlegen.
lister_id array_of_ integer
stock/​{stock_id}/ GET select Select_type stock Stock_type Einen Lagerartikel abrufen.
POST stock Stock_type stock_id integer Einen Lagerartikel überarbeiten.
lister_id array_of_ integer
DELETE Einen Lagerartikel löschen.
stock/​{stock_id}/cia/ POST stock_id integer Für den Lagerartikel einen PüMa triggern.
stock/​{stock_id}/portal_upload/ POST portal_upload Stock_portal_upload_type response array_of_ Multistatus_type Angebote im Portal einstellen/aktualisieren/beenden. Achtung: Multi-Status(siehe HTTP-Code 207).
stock/​{stock_id}/description/ GET description array_of_ Stock_description_type Alle Lager Beschreibungen für den aufgerufenen Lagerartikel abrufen.
POST description Stock_description_type description_id integer Eine Lager Beschreibung für den aufgerufenen Lagerartikel anlegen.
stock/​{stock_id}/description/​{description_id}/ GET description Stock_description_type Eine Lager Beschreibung abrufen.
POST description Stock_description_type description_id integer Eine Lager Beschreibung bearbeiten.
DELETE Eine Lager Beschreibung löschen.
stock/category/ DELETE filter Category_filter_type Eigene Kategorien löschen.
GET filter Category_filter_type category array_of_ category Eigene Kategorien abrufen.
pagination Pagination_type
POST category Category_type Eigene Kategorien anlegen.
stock/folder/ GET stock_id array_of_ folder Alle aktuellen Lagerordner abrufen.
Admin admin/portal_account/ GET portal_account array_of_ Admin_portal_account_type Alle Portalaccounts abrufen.
admin/portal_account/​{portal_account_id}/ GET portal_account Admin_portal_account_type Einen Portal Account abrufen.Mit "default" wird der Standardportalaccount abgerufen.
admin/person/ GET person array_of_ Admin_person_type Alle DR Benutzer abrufen.
admin/shipping_group/ GET shipping_group array_of_ Admin_shipping_group_type Alle Versandgruppen abrufen.
admin/shipping_group/​{shipping_group_id}/ GET shipping_group Admin_shipping_group_type Eine Versandgruppe abrufen.
admin/user/ GET user Admin_user_type Informationsdaten zum REST API-User abrufen.
admin/event/handler/ GET event_handler array_of_ Admin_event_handler_type API Event Handler abrufen.
POST event_handler Admin_event_handler_type event_handler_id integer Einen neuen API Event Handler anlegen.
admin/event/handler/​{event_handler_id}/ GET event_handler Admin_event_handler_type Einen API Event Handler abrufen.
DELETE Einen API Event Handler löschen.
admin/customer/ GET filter Customer_filter_type customer array_of_ Customer_type Kundendaten abrufen.
pagination Pagination_type
admin/customer/​{customer_id}/ GET customer Customer_type Einen Kunden mit ID abrufen.
Task task/ GET filter array_of_ Task_filter_type task array_of_ Task_type Aufgaben abrufen.
pagination Pagination_type
POST task Task_type task_id integer Eine Aufgabe erstellen.

6. API-Objekte

API-Objekte - Inhaltsverzeichnis


Error_type:

Enthält eine Fehlermeldung. Es kann in jeder Anfrage ein Fehler auftreten (HTTP 400+). In dem Fall wird auf Wurzelebene ein Feld "error" auftauchen welches eine Error_type-Liste enthält.

Name Datentyp Status Beschreibung
error string Lesen Die kurze Error-String-ID.
description text Lesen Die ausführliche Fehlermeldung mit detaillierter Beschreibung.
code int(3) Lesen Der HTTP-Code der durch den Error generiert wird.

Warning_type:

Es können während jeder Anfrage Warnings auftreten. Diese werden auf Wurzelebene in "warning" durch eine Warning_type-Liste zurückgegeben.

Name Datentyp Status Beschreibung
warning string Lesen Die kurze Warnungs-String-ID
description text Lesen Die ausführliche Warnmeldung mit detaillierter Beschreibung.
code int(3) Lesen Der HTTP-Code der durch den Warning generiert würde.

Operator_filter_type:

Wenn ein Filter nicht nur Gleichheit sondern auch mit weiteren Operatoren prüfen kann, wird ein Operator_filter_type verwendet.
Üblicherweise ist ein "array_of_Operator_filter_type" als Filtermöglichkeit gestattet und bezieht sich dabei auf ein einzelnes Feld des zu filternden Objekts.
Dabei werden die Inhalte wiefolgt interpretiert:
- Ein einzelner Wert oder eine Wert-Liste wird als Value eines einzelnen Operator_filter_Type interpretiert und mit dem "="-Operator verglichen.
- Ein Operator_Filter_type mit einfachem Wert wird entsprechend verglichen.
- Beinhaltet "value" mehrere Werte, werden die einzelnen Werte per "ODER"-Bedingung verknüpft.
- mehrere Operator_filter_type's werden per "UND"-Bedingung verknüpft.

Name Datentyp Status Beschreibung
value[] array_of_mixed Schreiben Der Wert der über den Operator mit dem Wert in der Datenbank verglichen wird.
operator string(2) Schreiben Der Operator über den der Wert verglichen wird.Der Standardoperator ist "=". Mögliche Operatoren sind: "<", "<=", ">", ">=", "=", "!=", "~" (ungefähr), "!~" (nicht ungefähr). Die tatsächlich möglichen Operatoren hängen vom Filter-Feld ab. Wenn Sie den "~"- oder "!~"-Operator verwenden, können Sie ein Sternchen ("*") in value als Wildcard verwenden. Um ungefähr nach dem Sternchen zu suchen, escapen Sie es mit einem "\". Zum Beispiel findet value "12*" alle Einträge die mit "12" beginnen. "12\*" findet alle Einträge die genau den Wert "12*" haben.

System_currency_type:

Eine Währung (z.B. Euro oder US-Dollar ).

Name Datentyp Status Beschreibung
internal_id integer Lesen, automatisch generiert Die DR-interne ID der Währung.
id string(3) Lesen, Primärschlüssel, automatisch generiert Der ISO3-Name der Währung in Großbuchstaben (z.B. "EUR" oder "USD"). Kenner für andere API-Objekte, z.B. order->currency_id.

Payment_method_type:

Eine Zahlungsart.

Name Datentyp Status Beschreibung
id string Lesen, automatisch generiert, Primärschlüssel Eine kurze String-ID die in verschiedenen Tabellen angibt, um welche Zahlungsart es sich handelt.
name string Lesen, automatisch generiert Der Anzeigename der Zahlungsart in der DR-Oberfläche.
is_prepaid bool Lesen, automatisch generiert Wenn diese Zahlart ausgewählt ist, ist der Auftrag automatisch bezahlt?
placeholder string Lesen, automatisch generiert Es gibt verschiedene Vorlagen in denen dieser Platzhalter eingetragen werden kann um die Zahlungsart einzufügen.

Stock_condition_type:

Ein Zustand (von einem Lagerartikel).

Name Datentyp Status Beschreibung
id integer Lesen, Primärschlüssel, automatisch generiert Die ID des Artikelzustands. Kenner für stock->condition_id und stock->drwebshop[]->condition_id.
description string Lesen, automatisch generiert Eine ganz kurze Beschreibung, für welchen Artikelzustand der Zustandstyp mit der entsprechenden ID steht.

Category_filter_type:

Der Category-Filter anhand dessen Lagerartikel gesucht werden können. ("ODER"-Bedingungen können durch mehrere Filter abgebildet werden.)

Name Datentyp Status Beschreibung
platform string Schreiben Pflichtfeld! Es können stets nur Kategorien von einem Portal abgerufen werden. Accountunabhängige unterstützte Portale sind: "amprice", "auvito", "dt24", "ebay", "hood", "real" und "yatego". Eigene Portale: "epages", "rakuten" und "shop"(ext. Lister Shop)
id[] array_of_Operator_filter_type<string> Schreiben Ein Kategorie-ID Filter anhand dessen die Rückgabe auf bestimmte Kategorien reduziert werden kann.
parent_id[] array_of_Operator_filter_type<string> Schreiben Ein Parent-ID Filter. Alle Kategorien mit Parent-ID "0" sind Wurzelkategorien.
name[] array_of_Operator_filter_type<string> Schreiben Eine Operator_filter_type Liste um auf Lagerartikelnamen zu filtern.
portal_account_id Portal_account_id_type Schreiben Der Portalaccount (Nur für die eigenen Kategorien).

Pagination_type:

Alle Such-Endpunkte (z.B. GET order/ oder GET stock/) haben einen Pagination_type um die seitenweise Ausgabe zu formatieren. Generell gilt, dass ein Maximum von 200 Elementen pro Seite gestattet ist.

Name Datentyp Status Beschreibung
page integer Schreiben Die Seite (abhängig von limit) die ausgegeben werden soll. Standard ist 1 (Hinweis: Der Wert "0" wird wie ein leerer Wert behandelt, also in diesem Fall als Seite 1.).
min_id string Schreiben Es wird eine Endpunkt-Objekt-ID übergeben (z.B. stock_id, order_id oder bank_id). Von dieser ID ausgehend werden dann "pagination->limit" Anzahl an gefilterten Einträgen geliefert. "pagination->min_id" ersetzt "pagination->page" und läuft anhand des Tabellen Index alle Einträge in der Datenbank in der üblichen Sortierung ab. Wenn min_id zur Seitensortierung verwendet wird, enthält die Rückgabe auf Wurzelebene das Feld "next_min_id". Der Wert in diesem Feld ist für die nächste Anfrage als neue "min_id" zu übergeben um die nächste "Seite" abzurufen.
limit integer Schreiben Die Anzahl der Einträge pro Seite. (Standard ist 20, maximum ist 200)

Category_type:

Der Category-Filter anhand dessen Lagerartikel gesucht werden können. ("ODER"-Bedingungen können durch mehrere Filter abgebildet werden.)

Name Datentyp Status Beschreibung
platform string Lesen, Schreiben, Primärschlüssel Pflichtfeld! Es können stets nur Kategorien von einem Portal abgerufen werden. Accountunabhängige unterstützte Portale sind: "amprice", "auvito", "dt24", "ebay", "hood", "real" und "yatego". Eigene Portale: "epages", "rakuten" und "shop"(ext. Lister Shop)
id string Lesen, Schreiben, Primärschlüssel Die Kategorie ID.
name string Lesen, Schreiben Der Name der Kategorie
parent_id string Lesen, Schreiben Die ID der übergeordneten Kategorie. Alle Kategorien mit Parent-ID "0" sind Wurzelkategorien.
portal_account_id Portal_account_id_type Lesen, Schreiben Der Portalaccount (Nur für die eigenen Kategorien).

System_event_action_type:

Eine mögliche Reaktion auf ein ausgelöstes Event (muss mit einem Event Handler verknüpft werden).

Name Datentyp Status Beschreibung
section string Lesen, Primärschlüssel Der betroffene Bereich in DR (~Modul)
type[] array_of_string Lesen, Fremdschlüssel Eine Liste aller Event-Typen für die diese "Reaktion" angewendet werden kann.
action string Lesen, Primärschlüssel Die Reaktions ID.
required mixed Lesen Eine Liste aller Pflichtparameter für die Reaktion. Beim Anlegen eines Eventhandlers muss jedes Feld in "required" angegeben werden. Felder ohne Inhalt sind Freitextfelder; Felder die eine Liste enthalten, müssen einen der Listenschlüssel als Wert übergeben; Felder die "function" enthalten, müssen nach speziellen Regeln befüllt werden, die noch nicht näher definiert wurden.

System_event_condition_type:

Eine mögliche Bedingung für ein ausgelöstes Event. Die Bedingung muss zutreffen, damit der Eventhandler verwendet wird.

Name Datentyp Status Beschreibung
section string Lesen, Primärschlüssel Der betroffene Bereich in DR (~Modul)
field string Lesen, Primärschlüssel Das section-Modul-Feld auf das sich die Bedingung bezieht. (z.B. wenn section "order" ist, und field ist "payment_method_id", dann bezieht sich die Bedingung auf die Zahlungsart des Auftrags.)
operator[] array_of_string Lesen Eine Liste aller möglichen Bedingungsoperatoren. Wenn das Event generiert wird, wird das Modul "field" gegen die übergebene Wert/Operator Kombination abgeglichen. Übliche Werte sind "=", "!=", "<" und ">".

System_event_type_type:

Ein möglicher Eventauslöser.

Name Datentyp Status Beschreibung
section string Lesen Der betroffene Bereich in DR (~Modul)
type string Lesen, Primärschlüssel Die Eventauslöser ID.

System_scope_type:

Eine mögliche Berechtigung die darüber entscheidet, ob bestimmte REST API Funktionen verwendet werden können, oder nicht.

Name Datentyp Status Beschreibung
id string Lesen, automatisch generiert, Primärschlüssel Die verlinkte ID des Scopes.
title string Lesen Gibt die Berechtigungsbezeichnung an.
description text Lesen Eine detaillierte Beschreibung die auch dem API Accountadmin angezeigt wird.

Order_type:

Eine Bestellung/Auftrag/Ware/Beleg.

Name Datentyp Status Beschreibung
id string Lesen, Primärschlüssel, automatisch generiert Die Auftrags ID besteht aus "Auftragsnummer", "Jahr"(4-stellig) und "Monat"(2-stellig), je verbunden durch einen Unterstrich.
portal_account_id Portal_account_id_type Lesen, Fremdschlüssel Jeder Auftrag ist mit einem Portalaccount verknüpft. Aufträge können nur gelesen oder geschrieben werden, wenn die User-Autorisierung den Account oder Accountübergreifende Anfragen genehmigt hat.
date datetime Lesen, automatisch generiert Der Zeitpunkt zu dem der Auftrag in DR angelegt wurde.
current_date datetime Lesen, Schreiben, automatisch generiert Das Auftragsdatum. Kann bearbeitet werden.
invoice_number integer Lesen, automatisch generiert, Fremdschlüssel Die Rechnungsnummer für das Finanzamt (NICHT die DR-interne-Auftragsnummer).
platform string Lesen, Schreiben, Fremdschlüssel Die ID der Plattform/Portal auf der der Auftrag erzeugt wurde. Darf nachträglich nicht mehr geändert werden.
history[] array_of_string Lesen, automatisch generiert Die Auftragshistorie. (über "GET/POST order/{order_id}/history/" können Einträge gelesen oder ergänzt werden.)
infos text Lesen, Schreiben Notizen vom Verkäufer.
pack_infos text Lesen, Schreiben Ein Feld für externe Software, um Informationen zum Packzustand zu vermerken (z.B. Pick-/Packstation oder Dienstleister).
payment_method_id string Lesen, Schreiben, Fremdschlüssel Die vom Kunden gewählte Zahlungsart. Ein gültiger Wert entspricht der ID aus einem Payment_type (siehe "GET system/payment_method/").
invoice_amount decimal Lesen, automatisch generiert Der Überweisungsbetrag (inkl. Versand und Mwst.). Der bereits bezahlte Betrag ist in paid_amount vermerkt.
paid_amount decimal Lesen, Schreiben Der bereits bezahlte Betrag. Entspricht dieser Wert dem "invoice_amount", gilt der Auftrag vollständig als bezahlt. Es genügt allerdings, dass hier irgendein Wert gesetzt wird um den Auftrag als teilweise bezahlt zu markieren.
currency_id integer Lesen, Schreiben, Fremdschlüssel Die ID der Währung in der die Werte des Auftrags angegeben sind. Alle Währungen können über eine Anfrage abgefragt werden: "GET /system/currency/".
customer array Lesen, Schreiben Dieser Container enthält verschiedene Informationen die den Käufer betreffen.
    ->id string Lesen, Schreiben, Fremdschlüssel Die vom DR-Kunden variierbare Kundennummer. Ein "Kunde" wird automatisch in DR angelegt, sobald der erste Auftrag mit seinen Daten eingelesen wird. Daher sollte die customer->id immer gesetzt sein.
    ->username string Lesen, Schreiben Der Benutzername der vom Käufer im Portal gewählt wurde. ACHTUNG: Bei einigen Portalen wird in diesem Feld alternativ die Auftragsnummer gespeichert.
    ->comment text Lesen, Schreiben Wenn der Käufer beim Einkauf zusätzliche Informationen hinterlegt hat, erscheinen diese in diesem gut sichtbar platzierten Feld.
    ->vat_id string Lesen, Schreiben Die Umsatzsteuer-ID des Käufers.
    ->email string Lesen, Schreiben Die Emailadresse des Käufers. Dieses Feld ist ein Pflichtfeld und darf nicht leer bleiben.
    ->phone_1 string Lesen, Schreiben Die erste Telefonnummer des Käufers.
    ->phone_2 string Lesen, Schreiben Die zweite Telefonnummer des Käufers.
    ->fax string Lesen, Schreiben Die Faxnummer des Käufers.
    ->address Order_address_type Lesen, Schreiben Die Rechnungsadresse.
shipping array Lesen, Schreiben Die Versandinformationen.
    ->fee decimal Lesen, Schreiben Die Versandkosten.
    ->date string Lesen, Schreiben Das Versendedatum.
    ->deliverer string Lesen, Schreiben Der Versanddienstleister. Weitere frei wählbare Werte sind möglich, dies sind aber die häufigsten Werte:DHL, Post, Deutsche Post, UPS, Hermes, DPD, DPDP, TNT, GLS, GLSP
    ->code string Lesen, Schreiben, Fremdschlüssel Die Sendungsverfolgungsnummer (macht nur zsm. mit dem Versanddienstleister(deliverer) Sinn).
    ->method string Lesen, Schreiben Die Versandmethode.
    ->address Order_address_type Lesen, Schreiben Die Lieferadresse.
status array Lesen, Schreiben Dieser Container beinhaltet die Status Informationen zum Auftrag.
    ->is_initial_contact bool Lesen, Schreiben Hat der Erstkontakt mit dem Käufer bereits stattgefunden?
    ->initial_contact_date date Lesen Das Datum des Erstkontakts mit dem Käufer.
    ->is_checkout bool Lesen, Schreiben Wurde die DreamRobot Kaufabwicklung(eig. nur manuelle Aufträge) abgeschlossen?
    ->is_paid bool Lesen Bezahlt?
    ->paid_date date Lesen Das Datum an dem der Auftrag bezahlt wurde.
    ->is_packed bool Lesen, Schreiben Gepackt?
    ->packed_date date Lesen Das Gepacktdatum.
    ->is_shipped bool Lesen, Schreiben Versendet?
    ->shipped_date date Lesen Das Versendetdatum.
    ->is_arrived bool Lesen, Schreiben Angekommen?
    ->arrived_date date Lesen Das Ankunftsdatum.
    ->is_cancelled bool Lesen, Schreiben Storniert?
    ->cancelled_date date Lesen Das Storniertdatum
    ->is_parked bool Lesen, Schreiben Geparkt?
line[] array_of_Order_line_type Lesen, Schreiben Hier sind die einzelnen Auftragspositionen aufgeführt. Es ist darauf zu achten, dass diese stets in der korrekten Reihenfolge übertragen werden müssen (und zusätzlich die entsprechende positions-"id" beinhalten).
bill_url string Lesen Sobald ein Auftrag archiviert wurde, kann über dieses Feld die Rechnungs-PDF-URL abgerufen werden.
paypal_transaction_id string Lesen, Schreiben Über dieses Feld kann die PayPal Transaktions-ID abgerufen oder gespeichert werden. Sie kann nicht nachträglich verändert werden.
add_field[] array_of_array_of_string Lesen, Schreiben In diesem Feld stehen die Auftragszusatzfelder die per Custom Feature hinzugebucht werden können.

Order_address_type:

Eine Auftragsadresse (Lieferadresse oder Rechnungsadresse).

Name Datentyp Status Beschreibung
name string Lesen, Schreiben Das Hauptfeld für den Namen.
name_2 string Lesen, Schreiben Ein Zusatzfeld für den Namen.
street string Lesen, Schreiben Das Hauptfeld für die Adresse/Straße.
street_2 string Lesen, Schreiben Ein Zusatzfeld für die Adresse/Straße.
zip string Lesen, Schreiben Die Postleitzahl.
city string Lesen, Schreiben Die Stadt.
province string Lesen, Schreiben Das Bundesland.
country string Lesen, Schreiben Das Land (ausgeschrieben).
country_iso2 string(2) Lesen, Schreiben Das Land (zweistellig).

Order_line_type:

Eine einzelne Auftragsposition. Mehrere Auftragspositionen als array bilden alle Artikel eines Auftrags (order->line[]).

Name Datentyp Status Beschreibung
id integer Lesen, Schreiben, Primärschlüssel Die ID muss stets angegeben werden um anzuzeigen, an welcher Position im Auftrag die line/position steht.
name string Lesen, Schreiben Der Artikelname.
sku string Lesen, Schreiben Die Artikelnummer im Portal.
quantity string Lesen, Schreiben Die Positionsmenge.
price string Lesen, Schreiben Der Preis für ein einzelnes Element der Position.
tax string Lesen, Schreiben Die Mehrwertsteuer.
transaction_id string Lesen, Schreiben, Fremdschlüssel Die AuftragspositionsID vom Portal (z.B. eBay). Wenn es nur eine ID für den ganzen Auftrag gibt, steht diese entweder in "order->customer->username"(z.B. Hitmeister) oder nur in der ersten Position "order->line[0]->transaction_id (z.B. ePages).
stock_align_id string Lesen, Schreiben, Fremdschlüssel Die Lagerabgleichs ID des Lagerartikels (z.B. stock->id, stock->sku, stock->barcode).

Order_filter_type:

Das Filter Objekt für den "GET order/"-Such-Call. Über einen Filter können mehrere Bedingungen angegeben werden, die per "UND"-Bedingung miteinander verknüpft werden. ("ODER"-Bedingungen können durch mehrere Filter abgebildet werden.)

Name Datentyp Status Beschreibung
id[] array_of_Operator_filter_type<string> Schreiben Enthält eine Liste aller order_id's die selektiert werden sollen. (Nur "="-Operator möglich) Hinweis: Dieser Filter ist ein Singletonfilter der nur im ersten Filter gültig ist, aber auch für alle nachfolgenden Filter gilt.
invoice_number[] array_of_Operator_filter_type<integer> Schreiben Filter mit Operator für die Rechnungsnummer
transaction_id[] array_of_Operator_filter_type<string> Schreiben Filter mit optionalem "!=" Operator für die Portal-Auftragsnummer/Transaktions-ID
customer array Schreiben Hier können Filter zum Auftragskunden angegeben werden.
    ->id[] array_of_Operator_filter_type<string> Schreiben Kundennummer Filter. Achtung: Nur Un- und/oder Gleichheitsprüfung möglich. (!= / =)
    ->username[] array_of_Operator_filter_type<string> Schreiben Filter mit Operator für "username". Achtung: Dieses Feld kann portalabhängig auch die Portal-Auftragsnummer enthalten.
    ->email[] array_of_Operator_filter_type<string> Schreiben Filter mit Operator für "email".
    ->address Order_address_filter_type Schreiben Rechnungsadressfilter.
status array Schreiben In diesem Array können verschiedene Status angegeben werden um nur Aufträge zu selektieren die den Status wie angegeben gesetzt haben.
    ->is_initial_contact bool Schreiben Erstkontakt.
    ->is_checkout bool Schreiben DR-Kaufabwicklung.
    ->is_paid bool Schreiben Bezahlt (oder teilweise bezahlt).
    ->is_packed bool Schreiben Gepackt?
    ->is_shipped bool Schreiben Versendet?
    ->is_arrived bool Schreiben Angekommen?
    ->is_cancelled bool Schreiben Storniert?
    ->is_parked bool Schreiben Geparkt?
    ->paid_date Operator_filter_type<date> Schreiben Filter auf das Bezahltdatum (nur innerhalb des Suchzeitraums).
    ->packed_date Operator_filter_type<date> Schreiben Filter auf das Gepacktdatum (nur innerhalb des Suchzeitraums).
    ->shipped_date Operator_filter_type<date> Schreiben Filter auf das Versandtdatum (nur innerhalb des Suchzeitraums).
    ->arrived_date Operator_filter_type<date> Schreiben Filter auf das Angekommendatum (nur innerhalb des Suchzeitraums).
    ->storno Operator_filter_type<date> Schreiben Filter auf das Storniertdatum (nur innerhalb des Suchzeitraums).
date array Schreiben Hierüber kann ein Zeitraum angegeben werden, in dem die gesuchten Aufträge angelegt wurden. Der Standardsuchraum läuft über den letzten Monat. Der Zeitraum darf maximal 3 Monate umfassen. Hinweis: Dieser Filter ist ein Singletonfilter der nur im ersten Filter gültig ist, aber auch für alle nachfolgenden Filter gilt.
    ->from datetime Schreiben Das Datum ab dem gesucht wird (Standard ist das bis-Datum weniger einem Monat).
    ->to datetime Schreiben Das Datum bis zu dem gesucht wird. (Standard ist das aktuelle Datum)
pack_infos[] array_of_Operator_filter_type<string> Schreiben Filter mit Operator für "pack_infos".
history[] array_of_Operator_filter_type<string> Schreiben Filter mit Operator für "history".
modified_since date Schreiben Liefert alle Aufträge, die seit dem übergebenen Datum (Sekundengenau) geändert wurden. Darf maximal 3 Monate in die Vergangenheit schauen.
shipping array Schreiben Hierüber kann ein Zeitraum angegeben werden, in dem die gesuchten Aufträge angelegt wurden. Der Standardsuchraum läuft über den letzten Monat. Der Zeitraum darf maximal 3 Monate umfassen.
    ->deliverer[] array_of_Operator_filter_type<string> Schreiben Das Datum ab dem gesucht wird (Standard ist das bis-Datum weniger einem Monat).
    ->code[] array_of_Operator_filter_type<string> Schreiben Das Datum bis zu dem gesucht wird. (Standard ist das aktuelle Datum)
    ->address Order_address_filter_type Schreiben Lieferadressfilter.

Order_address_filter_type:

Eine Auftragsadresse (Lieferadresse oder Rechnungsadresse).

Name Datentyp Status Beschreibung
name[] array_of_Operator_filter_type<string> Schreiben Namensfilter.
name_2[] array_of_Operator_filter_type<string> Schreiben Zusatznamensfilter.
street[] array_of_Operator_filter_type<string> Schreiben Straßenfilter.
street_2[] array_of_Operator_filter_type<string> Schreiben Filter für zweite Straßenzeile.
zip[] array_of_Operator_filter_type<string> Schreiben Postleitzahlfilter.
city[] array_of_Operator_filter_type<string> Schreiben Stadtfilter.
province[] array_of_Operator_filter_type<string> Schreiben Bundeslandfilter.
country[] array_of_Operator_filter_type<string> Schreiben Landfilter.

Select_type:

Der Select type ist ganz primitiv aufgebaut und orientiert sich am zu selektierenden Modul-Typ(z.B. Stock_type für "GET stock/" oder Order_type für "GET order/"): Es können beliebige Felder des Modul-Typ übergegeben werden (die Werte in den Feldern sind meistens irrelevant), um in der Ausgabe genau diese Felder zurückzugeben (ein paar ID Felder werden immer zurückgegeben). Wenn Felder genauer spezifiziert sind (z.B. select->status->paid) werden auch nur die speziellen Felder selektiert (wird nur select->status angegeben, werden alle status selektiert). Die Select_type-Struktur ist daher dem entsprechenden Modul-Typ zu entnehmen.

Beispiel: Ein "GET order/12345_2016_10/?select[status][is_paid]=&select[paid_amount]=" liefert genau nur die Information über den Bezahltstatus des Auftrags mit der Auftragsnummer 12345 aus dem Oktober 2016."


Portal_account_id_type:

Für sämtliche Anfragen ist es möglich, die Portal Account ID auf Wurzelebene z.B. neben "filter", "select" oder bei den POST Anfragen, neben den Modul Objekten zu übergeben. Die Portal Account ID hat in der REST API Ihre ganz eigene Funktionsweise. Es gibt viele verschiedene Objekte in denen auf eine/n Portal Account / ID verwiesen wird. Dazu hat jeder REST API Zugang neben der Anmelde ID eine Standard-Portal Account ID hinterlegt (diese kann auch 0, also ungültig sein). Diese wird immer dann verwendet, wenn keine Portal Account ID im Datensatz gefunden wurde, wo eine erwartet wird. Es gibt für User(Resource-Owner) auch die Möglichkeit (z.B. für Verkaufsportale) Zugänge einzurichten die nur Zugang zu einem einzelnen Portal Account haben. Wenn der "cross_pid" Scope genehmigt wurde, ist es aber erlaubt entweder in den Objekten oder auf Wurzel Ebene eine Portal Account ID zu übergeben. Diese ID ersetzt dann für die aktuelle Anfrage die Standard Portal Account ID. Zur Bestimmung der zu verwendenden Portal Account ID gilt also folgende Reihenfolge: 1.:"Objekt" > 2.:"Wurzel" > 3.:"Zugangsstandardwert" > 4.: Fehlermeldung!. Die Übergabe von "portal_account_id" ist entsprechend stets optional.


Order_send_mit_type:

Das Objekt das Lieferanteninformationen für die Versandbestätigung enthalten kann. Wenn "deliverer" und "code" übergeben sind, werden diese vor Versandbestätigung im Auftrag eingetragen.

Name Datentyp Status Beschreibung
deliverer string Schreiben Synonym zu order->shipping->deliverer.
code string Schreiben Synonym zu order->shipping->code.

Stock_type:

Ein Lagerartikel(inkl. aller Portaldaten).

Name Datentyp Status Beschreibung
id string Lesen, Primärschlüssel, automatisch generiert Die Lagernummer. Zur Identifizierung eines Lagerartikels("stock_id" allgemein) kann generell alternativ auch Lager-ID, Barcode oder die Artikelnummer(druck_pseudonym) ensprechend mit "ID_", "EAN_" oder "SKU_" vorangestellt übergeben werden. Dies gilt für alle Stellen, an denen eine/mehrere "stock_id" übergeben werden soll/-en.
name text Lesen, Schreiben Der Artikelname.
sku text Lesen, Schreiben Die (individuelle) Artikelnummer.
barcode text Lesen, Schreiben Die EAN.
infos text Lesen, Schreiben Notizen von und für den Verkäufer zum Lagerartikel
price decimal(?,2) Lesen, Schreiben Der Verkaufspreis. Wenn in den Portaldaten kein Preis hinterlegt wurde, wird als Fallback-Option auf diesen Preis zurückgegriffen.
tax decimal(?,2) Lesen, Schreiben Die Mehrwertsteuer die im "price" bereits enthalten ist.
weight decimal Lesen, Schreiben Das Gewicht in Gramm(g).
size string Lesen, Schreiben Die Abmessungen. Enthält die Zentimeter(cm)-Angaben "Länge", "Breite" und "Höhe", verbunden durch ein kleines "x".
condition_id integer Lesen, Schreiben, Fremdschlüssel Die ID des Artikelzustands. Kenner für stock->condition_id und stock->drwebshop[]->condition_id.
manufacturer string Lesen, Schreiben Der Hersteller.
mpn string Lesen, Schreiben Die Herstellernummer.
folder string Lesen, Schreiben Der Ordner in dem der Lagerartikel in DR liegt/liegen soll (beginnt immer mit einem "/").
rrp decimal(10,2) Lesen, Schreiben Der Herstellerpreis (UVP)
quantity integer Lesen, Schreiben Die Lagermenge.
quantity_ebay integer Lesen, Schreiben Die Menge die derzeit über eBay eingestellt ist.
quantity_ordered integer Lesen, Schreiben Die Menge die (z.B. über die Einkaufsliste) bereits nachbestellt wurde.
quantity_ordered_date date Lesen, Schreiben Das Datum an dem die bestellte Menge "quantity_ordered" (z.B. über die Einkaufsliste) nachbestellt wurde.
quantity_alert integer Lesen, Schreiben Die Alarmmenge, wenn die Lagermenge diesen Wert unterschreitet, wird die Menge in der Lagerliste Orange hinterlegt.
quantity_min integer Lesen, Schreiben Die Mindestmenge, wenn die Lagermenge diesen Wert unterschreitet, wird die Menge in der Lagerliste Rot hinterlegt.
quantity_reserved integer Lesen, Schreiben Die Reserviertmenge. Reservierte Mengen gelten nicht mehr als "verfügbar".
quantity_reserved_2 integer Lesen, Schreiben Die Reserviertmenge 2. Diese wird teilweise für interne Prozesse(eBay) verwendet. Reservierte Mengen gelten nicht mehr als "verfügbar".
quantity_available integer Lesen Die verfügbare Menge (Wird als Grundlage für den PüMa und Neu-Listings verwendet). Diese Menge berechnet sich aus: (Lagermenge - Reservierte Mengen). In der klassischen DR-Logik wird noch die "quantity_ebay" abgezogen, dies kann aber über eine kurze Em@il an den Support abgeschaltet werden.
picture array Lesen, Schreiben Lager-Bild-URLs.
    ->small text Lesen, Schreiben Das kleine Lagerbild.
    ->large text Lesen, Schreiben Das große Lagerbild.
location array Lesen, Schreiben Verschiede Felder die sich auf den Lager-Ort beziehen.
    ->area text Lesen, Schreiben Der Lagerort.
    ->field text Lesen, Schreiben Der Lagerort.
    ->is_fullfilment bool Lesen, Schreiben Ist "Fulfillment" aktiviert? Also, liegt die Ware nicht im eigenen Lager?.
supplier array Lesen, Schreiben Verschiede Felder die sich auf den Händler(EK) beziehen.
    ->id string Lesen, Schreiben Die Händlernummer.
    ->sku string Lesen, Schreiben Die Artikelnummer vom Händler.
    ->price decimal Lesen, Schreiben Der Einkaufspreis.
shipping array Lesen, Schreiben Verschiedene Felder die sich auf den Versand beziehen.
    ->group_id[] array_of_integer Lesen, Schreiben, Fremdschlüssel Eine Liste aus bis zu 3 Versandgruppen IDs. (Versandgruppen können über "GET admin/shipping_group/" abgerufen werden).
    ->infos text Lesen, Schreiben Lieferinfos.
content array Lesen, Schreiben Verschiedene Felder die sich auf den/die Inhalt/Grundpreisangabe beziehen.
    ->quantity integer Lesen, Schreiben, Fremdschlüssel Die Menge von "type", die sich in dem Artikel befindet.
    ->type string(3) Lesen, Schreiben Die Einheit des Inhalts. Gültige Werte sind: "lt", "ml", "hl", "m", "m2", "mm3", "kg", "g", "ztr", "pal", "st", "kt".
    ->basic_price_type string(3) Lesen, Schreiben Die Einheit in der die Grundspreisangabe auf dem Portal angezeigt werden soll. Gültige Werte sind: "lt", "ml", "hl", "m", "m2", "mm3", "kg", "g", "ztr".
variation array Lesen, Schreiben Der Varianten Container. Dieser beinhaltet alle Informationen zu Lagervarianten.
    ->type string Lesen, Schreiben Gültige Werte sind "main", "sub" und "none". Wenn eine Variantenartikel erstellt/kombiniert werden soll, passiert dies ausschließlich über den Hauptartikel(type="main"). Soll ein/alle Lagerartikel wieder aufgetrennt werden, ist type="none" zu übergeben.
    ->sub[] array_of_Stock_variation_sub_type Lesen, Schreiben In diesem Array ist eine Liste aller Subs(Varianten) enthalten. (Diesen Container gibt es nur, wenn es sich um einen Variantenhauptartikel handelt.)
    ->specifics_set array Lesen, Schreiben Dieses Feld beinhaltet die Variantenmatrix. (Diesen Container gibt es nur, wenn es sich um einen Variantenhauptartikel handelt.)
        ->name_value[] array_of_Name_value_type Lesen, Schreiben Die Variantenmatrix besteht aus mehreren verschiedenen Ausprägungen. Dabei steht ein Name_value_type für z.B. "Farbe" und beinhaltet die gültigen Ausprägungen, z.B. "Rot", "Grün" und "Blau".
    ->specifics Name_value_type Lesen, automatisch generiert In diesem Container ist nur der Teil des specifics_set enthalten, der für diese Variante gilt. (Diesen Container gibt es nur, wenn es sich um eine Variante(sub) handelt.)
    ->parent integer Lesen, automatisch generiert In diesem Container steht die Lagernummer des Variantenhauptartikels. (Diesen Container gibt es nur, wenn es sich um eine Variante(sub) handelt.)
cross_selling array Lesen, Schreiben Verschiedene Felder die sich auf die Cross-Selling Funktion(nur DR-Webshop?) beziehen.
    ->is_active bool Lesen, Schreiben Ist die Cross-Selling Funktion aktiv?
    ->is_quantity_split bool Lesen, Schreiben Mengensplit?
    ->id[] array_of_string Lesen, Schreiben Eine Lagernummer-Liste auf die beim Crossselling verweisen wird.
    ->folder[] array_of_string Lesen, Schreiben Eine Ordner-Liste. Alle Artikel in den Ordnern werden beim Cross-selling beachtet.
    ->description_id array Lesen, Schreiben Beschreibungs IDs.
        ->national integer Lesen, Schreiben Die ID einer Beschreibung für die nationale Zielgruppe.
        ->international integer Lesen, Schreiben Die ID einer Beschreibung für die internationale Zielgruppe.
freetext[] array_of_Stock_freetext_type Lesen, Schreiben Hierüber können die 5 Freitextfelder(1, 2, 3, 4 und 5) angesprochen werden.
cia array Lesen, Schreiben In diesem Container sind die PüMa Informationen zu finden.
    ->ebay Stock_cia_portal_type Lesen, Schreiben Der PüMa Status für eBay.
    ->amazon Stock_cia_portal_type Lesen, Schreiben Der PüMa Status für Amazon.
    ->drwebshop Stock_cia_portal_type Lesen, Schreiben Der PüMa Status für den DR-Webshop 2.0.
    ->rakuten Stock_cia_portal_type Lesen, Schreiben Der PüMa Status für Rakuten.
    ->yatego Stock_cia_portal_type Lesen, Schreiben Der PüMa Status für Yatego.
    ->allyouneed Stock_cia_portal_type Lesen, Schreiben Der PüMa Status für Allyouneed.
    ->hood Stock_cia_portal_type Lesen, Schreiben Der PüMa Status für Hood.
    ->fnac Stock_cia_portal_type Lesen, Schreiben Der PüMa Status für Fnac.
    ->epages Stock_cia_portal_type Lesen, Schreiben Der PüMa Status für ePages.
    ->hitmeister Stock_cia_portal_type Lesen, Schreiben Der PüMa Status für real.
    ->cdiscount Stock_cia_portal_type Lesen, Schreiben Der PüMa Status für CDiscount.
    ->event Stock_cia_portal_type Lesen, Schreiben Der PüMa Status für Notifications.
set array Lesen, Schreiben Beinhaltet die Set-Informationen.
    ->type[] array_of_string Lesen, Schreiben Der Set-Typ. Es ist nur entweder "sub" oder "main" gleichzeitig gestattet (aber theoretisch dennoch möglich), da DR mit verschachtelten Sets nicht korrekt arbeitet. "none" ist ebenfalls ein gültiger Wert um ähnlich wie bei den Varianten alle Set-Verbindungen aufzulösen.
    ->sub[] array_of_Stock_set_connection_type Lesen, Schreiben Wenn type="main", dann sind hier die einzelnen Set-Artikel inkl. Mengen aufgelistet. Kann übergeben werden, um ein Set zu erstellen.
    ->main[] array_of_Stock_set_connection_type Lesen Der PüMa Status für den DR-Webshop 2.0.
hitmeister Stock_hitmeister_type Lesen, Schreiben Enthält die real Felder.
amazon Stock_amazon_type Lesen, Schreiben Enthält die Amazon Felder.
nextore Stock_nextore_type Lesen, Schreiben Enthält die Nextore Felder.
drwebshop[] array_of_Stock_drwebshop_type Lesen, Schreiben Enthält die DR-WebShop Felder.
allyouneed Stock_allyouneed_type Lesen, Schreiben Enthält die Allyouneed Felder.
rakuten Stock_rakuten_type Lesen, Schreiben Enthält die Rakuten Felder.
fnac Stock_fnac_type Lesen, Schreiben Enthält die Fnac Felder.
epages Stock_epages_type Lesen, Schreiben Enthält die ePages Felder.
ebay[] array_of_Stock_ebay_type Lesen, Schreiben Enthält die Lister-eBay Felder.
hood[] array_of_Stock_hood_type Lesen, Schreiben Enthält die Lister-Hood Felder.
yatego[] array_of_Stock_yatego_type Lesen, Schreiben Enthält die Lister-Yatego Felder.
shop[] array_of_Stock_shop_type Lesen, Schreiben Enthält die Lister-Shop Felder.
app[] array_of_Stock_app_type Lesen, Schreiben Enthält eine Liste der App Daten. Zugriff ist nur für aktive Apps gültig. Als Array(Objekt)-Key wird die jeweilige client_id verwendet.
customs array Lesen, Schreiben Enthält eine Liste der customs Daten. Zugriff ist nur für aktive customss gültig. Als Array(Objekt)-Key wird die jeweilige client_id verwendet.
    ->description text Lesen, Schreiben Beschreibung für den Zoll.
    ->hs_code string Lesen, Schreiben "Harmonized Commodity Description and Coding System" bzw. HS-Code um Angaben über Art des Paket-Inhalts zu machen.
    ->origin_country_iso2 string(2) Lesen, Schreiben ISO Ländercode für das Herkunftsland

Bank_type:

Ein Überweisungsobjekt. Dies kann entweder eine normale Banküberweisung oder eine Paypalzahlung sein.

Name Datentyp Status Beschreibung
id integer Lesen, Primärschlüssel, automatisch generiert Die Bank ID. Besteht aus einer fortlaufenden Zahl, Unterstrich, Jahr, Unterstrich, Monat. Ist also ähnlich aufgebaut, wie die order_id.
type string Lesen "bank" oder "paypal". Je nach dem was abgerufen wurde.
date datetime Lesen, automatisch generiert Das DR Einlesedatum der Überweisung.
transfer_date datetime Lesen Der Zeitpunkt zu dem die Überweisung durchgeführt wurde.
sender string Lesen Der Absender der Überweisung.
subject string Lesen Der Verwendungszweck.
order_id string Lesen, Fremdschlüssel Die ID des bereits erfolgreich verknüpften Auftrags. Es kann nur "order_id" oder "order_no" ausgegeben werden.
order_no string Lesen, Fremdschlüssel Falls noch keine Auftragsverknüpfung stattgefunden hat, können hier weiterführende Referenzinformationen enthalten sein. Es kann nur "order_id" oder "order_no" ausgegeben werden.
amount decimal Lesen Der Überweisungsbetrag.
status string Lesen Bei Paypalzahlungen ein Hinweis zum aktuellen Status.

Bank_filter_type:

Das Filter Objekt für den "GET bank/*/"-Such-Call. Über einen Filter können mehrere Bedingungen angegeben werden, die per "UND"-Bedingung miteinander verknüpft werden. ("ODER"-Bedingungen können durch mehrere Filter abgebildet werden.)

Name Datentyp Status Beschreibung
id[] array_of_Operator_filter_type Schreiben Enthält eine Liste aller bank_id's die selektiert werden sollen. (Nur "="-Operator möglich); Hinweis: Dieser Filter ist ein Singletonfilter der nur im ersten Filter gültig ist, aber auch für alle nachfolgenden Filter gilt.
date array Schreiben Hierüber kann ein Zeitraum angegeben werden, in dem die gesuchten Aufträge angelegt wurden. Der Standardsuchraum läuft über den letzten Monat. Der Zeitraum darf maximal 3 Monate umfassen. Hinweis: Dieser Filter ist ein Singletonfilter der nur im ersten Filter gültig ist, aber auch für alle nachfolgenden Filter gilt.
    ->from datetime Schreiben Das Datum ab dem gesucht wird (Standard ist das bis-Datum weniger einem Monat).
    ->to datetime Schreiben Das Datum bis zu dem gesucht wird. (Standard ist das aktuelle Datum)

Stock_freetext_type:

Ein Freitextfeld mit ID.

Name Datentyp Status Beschreibung
id string Lesen, Schreiben, Primärschlüssel Die ID des Freitextfeldes.
value text Lesen, Schreiben Das Freitextfeld.

Stock_cia_portal_type:

Enthält die PüMa Informationen über den Artikel für ein Portal. Achtung: PüMa Felder für Variantehauptartikel können gelesen und geschrieben werden, sind aber ausnahmslos ungültig. Es zählen stets die Werte in den Varianten.

Name Datentyp Status Beschreibung
is_active bool Lesen, Schreiben Ist der PüMa für dieses Portal aktiviert?.
max_quantity integer Lesen, Schreiben Die Maximalmenge (steht der Wert auf "-1" bedeutet das, dass das Angebot beendet werden soll).
portal_account_id[] array_of_Portal_account_id_type Lesen, Schreiben, Fremdschlüssel Hierüber kann ein/mehrere Portal_account angegeben werden, für den/die der Abgleich durchgeführt werden soll. Dieses Feld ist derzeit nur für Amazon und Allyouneed verfügbar.
target[] array_of_string Lesen, Schreiben, Fremdschlüssel Nur für stock->cia->event gültig. Gibt an, für welche Notification(s) (target_name) der PüMa aktiviert werden soll.

Stock_variation_sub_type:

Eine Lagervariante. Die Angaben in diesem Feld zeigen an, welcher Lagerartikel mit welchen Parametern(specifics) im übergeordneten Lagerartikel als Variante verknüpft ist(id)/werden soll(create_quantity).

Name Datentyp Status Beschreibung
id string Lesen, Schreiben, Fremdschlüssel Ein Verweis auf den Lagerartikel anhand von Lagernummer(stock_id).
create_quantity integer Schreiben Wenn beim POST(erstellen/update) keine "id" übergeben wird, darf alternativ dieses Feld übergeben werden, um einen neuen Lagerartikel, mit der entsprechenden Menge, zu generieren und direkt zu verknüpfen.
specifics Name_value_type Schreiben Beinhaltet genau einen "name" und einen "value" die diese Variante repräsentieren. (Diesen Container gibt es nur beim POST(erstellen/update).)

Stock_set_connection_type:

Zeigt eine "Set zu Set-Artikel" Verbindung an. Die "id" ist entweder die Set-ID(set-main) oder die Set-Artikel ID(set-sub). Das kommt auf den Kontext an.

Name Datentyp Status Beschreibung
id string Lesen, Schreiben, Fremdschlüssel Die Lagernummer (set-main oder set-sub).
quantity integer Lesen, Schreiben Die Anzahl, wie oft das set-sub in set-main enthalten ist.

Stock_hitmeister_type:

Die Lager real Felder.

Name Datentyp Status Beschreibung
quantity integer Lesen, Schreiben Die Menge.
comment text Lesen, Schreiben Ein Kommentar.
price decimal(?,2) Lesen, Schreiben Der Preis (Maximalpreis).
location string Lesen, Schreiben Der Artikelstandort.
price_min string Lesen, Schreiben Der Mindestpreis.
delivery_time string Lesen, Schreiben, Fremdschlüssel Die Lieferzeit ID. Gültige Werte sind "a", "b", "c", "d", "e", "f", "g", "h" und "i".
ean string Lesen, Schreiben EAN oder ISBN. Im falle von ISBN muss "isbn:" vorangestellt werden.
category_id string Lesen, Schreiben Die real-Kategorie ID.
description_id integer Lesen, Schreiben Die Beschreibungs ID.
picture[] array_of_string Lesen, Schreiben Eine Liste aus bis zu 12 Bild-URLs.
characteristics Stock_characteristics_type Lesen, Schreiben Die Artikelmerkmale.
name string Lesen, Schreiben Ein alternativer Produktname.
shipping_group_id string Lesen, Schreiben, Fremdschlüssel Ein alternativer Produktname.

Stock_amazon_type:

Die Lager Amazonfelder.

Name Datentyp Status Beschreibung
is_active bool Lesen, Schreiben Amazonartikel?
sku string Lesen, Schreiben Die Artikelnummer.
market string Lesen, Schreiben Handelt es sich um einen Marktplatzartikel (oder Seller Central)? Gültige Werte sind "Marketplace" und alle anderen Werte für "Seller Central".
delivery_time integer Lesen, Schreiben Die vom Amazonstandard abweichende Lieferzeit.
id_type string Lesen, Schreiben Die Art von ID die in "id" steht. Gültige Werte sind "ASIN", "ISBN", "UPC" und "EAN".
prime_template string Lesen, Schreiben Der MFN Prime Versandtemplate Name.
availibility_date date Lesen, Schreiben Das Verfügbarkeitsdatum.
category_id string Lesen, Schreiben Die Kategorie ID.
quantity string Lesen, Schreiben Die Menge.
price decimal(?,2) Lesen, Schreiben Der Preis.
id string Lesen, Schreiben Die Artikel-ASIN/ISBN/UPC/EAN.
comment text Lesen, Schreiben Ein Kommentar.
is_fba bool Lesen, Schreiben FBA(Versand durch Amazon) aktiv?.

Stock_nextore_type:

Die Lager Nextorefelder.

Name Datentyp Status Beschreibung
is_active bool Lesen, Schreiben Nextoreartikel?
ean string Lesen, Schreiben Der Barcode.
price decimal Lesen, Schreiben Der Preis.
quantity integer Lesen, Schreiben Die Menge.
delivery_time string Lesen, Schreiben Die Lieferzeit.
tax string Lesen, Schreiben Die Mehrwertsteuer.

Stock_drwebshop_type:

Die Lager DR-WebShop Felder.

Name Datentyp Status Beschreibung
shop_id string Lesen, Schreiben, Fremdschlüssel Die Shop-ID. Dieses Feld ist zwingend notwendig zur Zuordnung in den richtigen Shop (es können mehrere Shops gleichzeitig angebunden/überarbeitet sein/werden.)
is_lead bool Lesen, Schreiben Leadartikel?
name string Lesen, Schreiben Der Artikelname.
sku string Lesen, Schreiben Die Artikelnummer.
ean string Lesen, Schreiben Die EAN.
category[] array_of_string Lesen, Schreiben Die Shop-Kategorien.
mpn string Lesen, Schreiben Die Hersteller Artikelnummer.
description_id[] array_of_integer Lesen, Schreiben Beschreibungs IDs
template_id integer Lesen, Schreiben Die Vorlagen ID
picture[] array_of_string Lesen, Schreiben Eine Liste aus bis zu 12 Bild-URLs
price[] array_of_Stock_drwebshop_price_type Lesen, Schreiben Die Preise (verschiedene Preise für verschiedene Kundengruppen).
is_stock_price bool Lesen, Schreiben Lagerpreis(stock->price) verwenden?
is_deposit_net bool Lesen, Schreiben Zusätzliche Pfandgebühren (Netto)
tax_class_id string Lesen, Schreiben Die Mehrwertsteuer ID (können im Shop Backend ausgelesen werden).
weight decimal(?,2) Lesen, Schreiben Das Artikel Gewicht
delivery_time integer Lesen, Schreiben Die Lieferzeit in Tagen.
sold array Lesen, Schreiben Einstellungen zum Artikel, wenn dieser die Menge 0 erreicht hat.
    ->delivery_time integer Lesen, Schreiben Die Lieferzeit in Tagen (wenn der Artikel die Menge 0 erreicht hat).
    ->is_delivery_time bool Lesen, Schreiben Soll bei Menge 0 eine abweichende Lieferzeit angezeigt werden?
    ->is_active bool Lesen, Schreiben Soll der Artikel bei Menge 0 im Shop noch angezeigt werden?
restock_date date Lesen, Schreiben Das Datum zu dem planmäßig das Lager wieder aufgefüllt wird.
condition_id integer Lesen, Schreiben, Fremdschlüssel Der Zustand. Die IDs können über "GET system/stock/condition/" abgerufen werden.
is_adult integer(1) Lesen, Schreiben Ab 18 Artikel? Gültige Werte: 0 => Kein FSK18-Artikel; 1 => FSK18; 2 => FSK18 erw.;
availability_date date Lesen, Schreiben Falls der Artikel ausverkauft ist, wird dieses Datum angezeigt, ab wann der Artikel wieder verfügbar ist.
sortorder integer Lesen, Schreiben Die Sortierreihenfolge.
characteristics Stock_characteristics_type Lesen, Schreiben Die Shop Merkmale.
is_digital bool Lesen, Schreiben Digitaler Artikel?
is_massarticle bool Lesen, Schreiben Maßartikel?
special array Lesen, Schreiben Sonderaktion
    ->is_active bool Lesen, Schreiben Sonderaktion aktiv?
    ->price[] array_of_Stock_drwebshop_price_type Lesen, Schreiben Die Sonderaktionspreise.
    ->date array Lesen, Schreiben Der Aktionszeitraum
        ->from date Lesen, Schreiben Start
        ->to date Lesen, Schreiben Ende
    ->quantity integer Lesen, Schreiben Die maximale Aktionsmenge.
is_active bool Lesen, Schreiben Shopartikel?
modified_time date Lesen Das Datum an dem der Shopdatensatz das letzte mal aktualisiert wurde.

Stock_drwebshop_price_type:

Einer von 4 DR-Webshop Preisen.

Name Datentyp Status Beschreibung
id integer Lesen, Schreiben Die Preis ID. Gültige Werte sind "0", "1", "2" oder "3"
net decimal(10,4) Lesen, Schreiben Der Preis(Im Gegensatz zu fast allen anderen Preisen in DR ist diese Angabe Netto!).

Stock_allyouneed_type:

Die Lager Allyouneedfelder.

Name Datentyp Status Beschreibung
ean string Lesen, Schreiben Die EAN. (Sollte für Allyouneed stets gefüllt werden, auch wenn der Wert nicht vom Lagerbarcode abweicht, da es der "is_active" Indikator für das Einstellen ist)
price decimal(?,2) Lesen, Schreiben Der Preis.
quantity integer Lesen, Schreiben Die Menge.
delivery_time integer Lesen, Schreiben Die Lieferzeit in Tagen (1 - 30).
tax decimal(4,2) Lesen, Schreiben Die Mehrwertsteuer.
name string Lesen, Schreiben Ein abweichender Artikelname.
description_id integer Lesen, Schreiben, Fremdschlüssel Die Beschreibungs ID.
picture[] array_of_string Lesen, Schreiben Eine Liste aus genau 3 Bild-URLs.
category_id string Lesen, Schreiben Eine ID aus dem allgemeinen Allyouneed Kategorienbaum.

Stock_rakuten_type:

Die Lager Rakutenfelder.

Name Datentyp Status Beschreibung
name string Lesen, Schreiben Ein, von stock->name abweichender, Artikelname.
price decimal(?,2) Lesen, Schreiben Der Preis.
description_id integer Lesen, Schreiben, Fremdschlüssel Die Beschreibungs ID.
manufacturer string Lesen, Schreiben, Fremdschlüssel Ein, von stock->manufacturer abweichender, Hersteller.
tax_id integer Lesen, Schreiben Die Mehrwertsteuer. Gültige Werte sind: "3"(0%), "2"(7%), "10"(10%), "4"(10,7%), "11"(12%), "1"(19%), "12"(20%)
ean string Lesen, Schreiben Die, von stock->barcode abweichende, EAN.
mpn string Lesen, Schreiben Die, von stock->mpn abweichende, Herstellernummer.
reduced_price decimal(?,2) Lesen, Schreiben Ein reduzierter Preis (dann ist "price" der Streichpreis).
quantity integer Lesen, Schreiben Die Menge.
delivery_time integer Lesen, Schreiben Die Lieferzeit ID. Gültige Werte sind "0"(1 - 4 Werktage), "3"(4 - 6 Tage), "5"(6 - 8), "7"(8-10), "10"(10-15), "15"(15-20), "20"(20-30), "30"(30-40), "40"(40-50), "50"(50-60), "60"(3 Monate+).
category_id string Lesen, Schreiben Eine ID aus dem privaten Rakuten Shop-Kategorienbaum. Der Baum kann von DR unter "Admin -> Einstellungen -> DR-Lister" eingelesen werden.
picture[] array_of_string Lesen, Schreiben Eine Liste aus genau 3 Bild-URLs.
characteristics Stock_characteristics_type Lesen, Schreiben Die Rakuten Attribute. (Ein Attribut enthält genau die beiden Felder "type" und "value")

Stock_fnac_type:

Die Lager Fnacfelder.

Name Datentyp Status Beschreibung
is_active bool Lesen, Schreiben Fnacartikel?
ean string Lesen, Schreiben Die EAN.
price decimal(?,2) Lesen, Schreiben Der Preis.
quantity integer Lesen, Schreiben Die Menge (1 - 9999).
description_id integer Lesen, Schreiben, Fremdschlüssel Die Beschreibungs ID.

Stock_epages_type:

Die Lager ePagesfelder.

Name Datentyp Status Beschreibung
append_path string Lesen, Schreiben Der Objekt-Pfad zum gelisteten Artikel.
class array Lesen, Schreiben Der verknüpfte Produkttyp.
    ->id string Lesen, Schreiben Die Produkttypen-ID.
    ->portal_account_id Portal_account_id_type Lesen, Schreiben, Fremdschlüssel Der Account in dem die Produkttypen hinterlegt sind.
tax_class string Lesen, Schreiben Die Steuerklassen-ID.
is_new bool Lesen, Schreiben Artikel als "Neu"(eingestellt, NICHT der Artikelzustand) markieren.
is_daily_price bool Lesen, Schreiben Unterliegt der Preis tagesabhängigen Schwankungen?
newness_date date Lesen, Schreiben Bis wann soll der Artikel als "Neu" markiert werden?
price_quantity integer Lesen, Schreiben Für wieviele Artikel(quantity) gilt der Preis? Normalerweise immer 1.
min_order_quantity decimal(10,2) Lesen, Schreiben Die Mindestbestellmenge.
order_quantity_interval decimal(10,2) Lesen, Schreiben Das Bestellmengenintervall (z.B. 6, wenn die Wasserflaschen in Sixpacks gelagert und versendet werden).
quantity integer Lesen, Schreiben Die Menge.
quantity_alert integer Lesen, Schreiben Die Alarmmenge. (Da auch 0 ein sinnvoller Wert ist, ist dieses Feld standard mit "-1" für einen leeren Wert gefüllt.)
delivery_time integer Lesen, Schreiben Die Lieferzeit in Tagen. (Da auch 0 ein sinnvoller Wert ist, ist dieses Feld standard mit "-1" für einen leeren Wert gefüllt.)
is_available bool Lesen, Schreiben Käuflich?
availability_date date Lesen, Schreiben Das Verfügbarkeitsdatum (ab dem der Artikel käuflich wird).
expiry_date date Lesen, Schreiben Das Ablaufdatum (ab dem der Artikel nicht mehr käuflich ist).
is_download_product bool Lesen, Schreiben Downloadartikel?
is_default bool Lesen, Schreiben Standardvariante? (nur für Varianten)
price decimal(10,2) Lesen, Schreiben Der, vom Lager abweichende, Preis
rrp decimal(10,2) Lesen, Schreiben Der Herstellerpreis (UVP)
deposit_price decimal(10,2) Lesen, Schreiben Die Pfandgebühren
eco_participation_price decimal(10,2) Lesen, Schreiben Die (französischen) Umwelt Recyclinggebühren
eco_participation_category_id integer(2) Lesen, Schreiben Die Umwelt Recyclinggebühren Kategorie ID
ean string Lesen, Schreiben EAN oder UPC
description_id[] array_of_integer Lesen, Schreiben Die Beschreibungs IDs (Eine Beschreibung für jede Sprache).
category[] array_of_array Lesen, Schreiben Je Account beliebig viele Kategorien IDs.
    ->id string Lesen, Schreiben, Fremdschlüssel Die Kategorien ID.
    ->portal_account_id Portal_account_id_type Lesen, Schreiben, Fremdschlüssel Der Account in dem die Kategorien hinterlegt sind.
picture[] array_of_string Lesen, Schreiben Eine Liste aus bis zu 12 Bild-URLs.
currency_id integer Lesen, Schreiben Die Währungs ID ("GET system/currency/").
characteristics Stock_characteristics_type Lesen, Schreiben Die Attribute im DR Attribut-Format.

Stock_characteristics_type:

Ein komplettes DR-Portal-Attribute-Objekt. Dieses kann die unterschiedlichsten Informationen beinhalten. Ursprünglich wurde dieses Objekt entwickelt um die eBay-Artikelmerkmale zu speichern. Die Struktur wurde dann für weitere Portalattribute übernommen. Intern sind die "characteristics" stets als XML gespeichert (daher können die characteristics immer nur als Ganzes gelesen oder geschrieben werden). Mit der REST API werden Sie aber wie gewohnt als Array gelesen/geschrieben.

Name Datentyp Status Beschreibung
data[] array_of_array Lesen, Schreiben Ein "data" beschreibt einen "characteristics"-Eintrag. Die einzelnen Felder im "data" sind die Spalten des Datensatzes. Der genau Aufbau variiert je nach Anwendungsfall. In der Urform für die eBay-Artikelmerkmale(ItemSpecifics) beinhaltet "data" die beiden Felder "type" und "value" wobei es wiederum mehrere Values geben kann(array_of_string). Der einfachste Weg um die genau Struktur herauszufinden wird sein, einen Testdatensatz mit Testdaten anzulegen und einen GET stock/{stock_id}/ mit Filter auf das gesuchte characteristic-Feld durchzuführen.

Stock_ebay_type:

Die Lister eBayfelder (in der REST API ausschließlich über den Lagerartikel zu erreichen).

Name Datentyp Status Beschreibung
lister_id string Lesen, Schreiben, Primärschlüssel Die Listerverknüpfung. Im Optimalfall wird dieses Feld einfach weggelassen (Wenn es keinen oder nur einen verknüpften Lister gibt). Gültige Werte sind die Stamm-ID(Im Backend nicht einsehbar), oder die Listernummer mit "NO_" vorangestellt. Außerdem kann "0" übergeben werden um einen neuen Lister anzulegen.
modified_time date Lesen Das Datum zu dem der DR-eBay-Datensatz das letzte mal aktualisiert wurde.
duration string(3) Lesen, Schreiben Die Angebotsdauer. Gültige Werte sind: 1, 3, 5, 7, 10, 30 und "GTC"(bis auf Widerruf).
type_id string(2) Lesen, Schreiben Das Verkaufsformat. Gültige Werte sind: 1(Auktion), 9(Festpreis-Angebot), 7(Shop-Angebot), 22(Varianten-Angebot).
name string(80) Lesen, Schreiben Der Angebotsname
subtitle string(80) Lesen, Schreiben Der Untertitel
quantity integer Lesen, Schreiben Die initiale Einstellmenge
start_price decimal(10,2) Lesen, Schreiben Der Auktionspreis
price decimal(10,2) Lesen, Schreiben Der Festpreis(Sofort-Kaufen Preis)
vat decimal(4,2) Lesen, Schreiben Die Mwst
min_price decimal(10,2) Lesen, Schreiben Der Mindestpreis
description text(ca.500000) Lesen, Schreiben Die Beschreibung
payment array Lesen, Schreiben Zahlungsinformationen
    ->id[] array_of_string Lesen, Schreiben akzeptierte Zahlungsmethoden: "nachnahme", "ueberweisung", "ueberweisungPlus", "kreditkarte", "barzahlung", "treuhand"(Treuhandservice), "beschreibung"(Die Zahlunginformationen sind in der Artikelbeschreibung hinterlegt), "paypal", "autopay"(Paypal: sofortige Bezahlung; ist nur zwingend mit "paypal" kombinierbar.)
    ->email_paypal string(255) Lesen, Schreiben wenn "paypal" als Zahlungsart gewählt ist, wird die in diesem Feld angegebene Emailadresse als Zahlungsempfänger verwendet.
    ->advice string(255) Lesen, Schreiben Zahlungshinweise. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
refund array Lesen, Schreiben Rückgabehinweise
    ->policy_id integer Lesen, Schreiben Die ID zur passenden Standard Rückgaben-Police. Gültige Werte sind "0"(Keine Rückgaben), "11"(14 Tage Widerrufsrecht: Verkäufer trägt die Rücksendekosten), "21"(1 Monat Widerrufsrecht: Verkäufer trägt die Rücksendekosten), "12"(14 Tage Widerrufsrecht: Käufer trägt die Rücksendekosten unter 40 Euro), "22"(1 Monat Widerrufsrecht: Käufer trägt die Rücksendekosten unter 40 Euro), "13"(14 Tage Rückgaberecht: Verkäufer trägt die Rücksendekosten), "23"(1 Monat Rückgaberecht: Verkäufer trägt die Rücksendekosten), "14"(14 Tage Käufer trägt die unmittelbaren Kosten der Rücksendung der Waren), "24"(1 Monat Käufer trägt die unmittelbaren Kosten der Rücksendung der Waren), "15"(14 Tage Verkäufer trägt die Kosten der Rücksendung der Waren), "25"(1 Monat Verkäufer trägt die Kosten der Rücksendung der Waren). Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
    ->advice text Lesen, Schreiben Zahlungshinweise. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
additional array Lesen, Schreiben Zusatzoptionen
    ->is_private bool Lesen, Schreiben Privatauktion?
    ->is_bold bool Lesen, Schreiben Fettschrift?
    ->is_highlighted bool Lesen, Schreiben Highlight?
    ->is_border bool Lesen, Schreiben Rahmen?
shipping array Lesen, Schreiben Versandinformationen
    ->ships_to_id[] array_of_string Lesen, Schreiben Lieferländer. Gültige Werte sind: "nichtLiefern"(nur Abholung), oder "weltweit", oder "portal"(Portalland) plus: "deutschland", "oesterreich", "schweiz", "europa", "usa", "amerika", "asien", "japan", "australien", "kanada", "EU"
    ->national Stock_lister_shipping_table_type Lesen, Schreiben Die nationale Versandkostentabelle. Hier können die Versandkosten für verschiedene Lieferanten und Lieferorte angegeben werden.
    ->international Stock_lister_shipping_table_type Lesen, Schreiben Die internationale Versandkostentabelle. Hier können die Versandkosten für verschiedene Lieferanten und Lieferorte angegeben werden.
    ->preparation_time integer Lesen, Schreiben Die Bearbeitungsdauer.
    ->is_express bool Lesen, Schreiben Expressversand?
    ->discount_profile_id bool Lesen, Schreiben Versandprofile
        ->national integer Lesen, Schreiben Versandrabattoptionen für Angebote mit dem selben Profil.
        ->international integer Lesen, Schreiben Versandrabattoptionen für Angebote mit dem selben Profil.
    ->is_national_active bool Lesen, Schreiben stock->ebay[]->shipping->national verwenden?
    ->is_international_active bool Lesen, Schreiben stock->ebay[]->shipping->international verwenden?
    ->is_promotional_discount bool Lesen, Schreiben Versand zum Sonderpreis?
location array Lesen, Schreiben Der Artikelstandort. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
    ->city string Lesen, Schreiben Stadt. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
    ->zip string Lesen, Schreiben Postleitzahl. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
    ->country_id integer Lesen, Schreiben Land. Orientiert sich an den eBay-Site-IDs. (77=DE;0=USA). Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
freetext[] array_of_Stock_freetext_type Lesen, Schreiben Die Bausteine 1 - 3. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
start date Lesen, Schreiben Der Angebotsstart.
counter_id integer Lesen, Schreiben Die ID des Besucherzählers der im Angebot angezeigt werden soll.
picture array Lesen, Schreiben Bilderinformationen.
    ->type_id integer Lesen, Schreiben Bilder-Service ID (0 = Portal, 1 = DR-Bilderservice, 2 = eigener Server, 3 = Portal über URL). Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
    ->url[] array_of_string Lesen, Schreiben Die Listerbilder (max. 12 Stk.). Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
    ->is_in_description bool Lesen, Schreiben Bild in Beschreibung?
    ->gallery array Lesen, Schreiben Gallerie-Bild
        ->url string Lesen, Schreiben Die Extra-Bild-URL für die Gallerie
        ->url_id integer Lesen, Schreiben Statt der Gallerie-URL die ID von stock->ebay[]->picture->url. (1-12)
        ->type_id integer Lesen, Schreiben Gibt an, wie das Bild in der Galerie dargestellt wird. Gültige Werte sind: 0 = Kein Galeriebild; 1 = Galerie; 2 = Premium-Angebot in Kategorie und Suche; 3 = Galerie Plus
    ->layout_id integer Lesen, Schreiben Bildlayout-ID. Gültige Werte sind: 0 = Standard; 2 = XXL-Foto; 3 = Bilderpaket; 4 = Dia-Show; 6 = XXL-Dia-Show.
    ->variation_name string Lesen, Schreiben Für Varianten können aus dem Lagerartikel Bilder ergänzt werden. Dazu muss der Name der Variation(z.B. Farbe, oder Größe) in diesem Feld angegeben werden. Ansonsten "0" für keine Bilder übergeben.
template_id integer Lesen, Schreiben Die Vorlagen ID für die Artikelbeschreibung.
category_1_id string Lesen, Schreiben Die Hauptkategorie.
category_2_id string Lesen, Schreiben Kategorie 2.
shop_category_1_id string Lesen, Schreiben Die Shopkategorie.
shop_category_2_id string Lesen, Schreiben Die zweite Shopkategorie.
is_max_quantity_available bool Lesen, Schreiben Maximal die verfügbare Menge "stock->quantity_available" einstellen (nur für Varianten).
is_stock_price bool Lesen, Schreiben Den Lagerpreis verwenden (nur für Varianten).
post array Lesen, Schreiben Posten.
    ->is_active bool Lesen, Schreiben Postenfunktion aktiv?
    ->quantity integer Lesen, Schreiben Anzahl Posten
    ->quantity_per_post integer Lesen, Schreiben Anzahl pro Posten
characteristics Stock_characteristics_type Lesen, Schreiben Die eBay Artikelmerkmale im DR Attribut-Format.
best_offer array Lesen, Schreiben Preisvorschlag.
    ->is_active bool Lesen, Schreiben aktiv?
    ->auto_accept_price decimal(10,2) Lesen, Schreiben Preisgrenze ab der ein Preisvorschlag automatisch angenommen wird.
    ->min_price decimal(10,2) Lesen, Schreiben Mindestpreis für einen Preisvorschlag
site_id integer Lesen, Schreiben Die eBay-Listing-Land ID (77 für Deutschland).
catalog array Lesen, Schreiben Produktkataloginformationen. (Sollte nicht mehr verwendet werden. Stattdessen bitte z.B. stock->barcode verwenden.)
    ->value string Lesen, Schreiben Produktkatalog Wert (z.B. die EAN). (Sollte nicht mehr verwendet werden. Stattdessen bitte z.B. stock->barcode verwenden.)
    ->type_id integer(1) Lesen, Schreiben Der Typ des Produktkatalogwerts. Gültige Werte sind: 0 = Keine Auswahl; 1 = EAN; 2 = ISBN; 3 = Hersteller; 4 = EPID; 5 = UPC; (Sollte nicht mehr verwendet werden. Stattdessen bitte z.B. stock->barcode verwenden.)
gallery_duration string Lesen, Schreiben Die Dauer, wie lange das Angebot in der Gallerie angezeigt wird. Gültige Werte sind: "0" bis "50" (je in Tagen) und "Lifetime".
sku string Lesen, Schreiben Die Artikelnummer.
is_mobile bool Lesen, Schreiben Auf mobile.de anzeigen?
condition array Lesen, Schreiben Artikelzustand
    ->id string Lesen, Schreiben Die Zustands ID (Bei eBay ist diese von der Kategorie abhängig. Die möglichen gültigen Werte können daher stark variieren.)
    ->description text Lesen, Schreiben Artikelzustandsbeschreibung.
compatibilities Stock_characteristics_type Lesen, Schreiben Die Fahrzeugverwendungsliste im DR Attribut-Format.
seller_profile array Lesen, Schreiben Rahmenbedingungen
    ->payment[] array_of_Stock_ebay_seller_profile_type Lesen, Schreiben Zahlungsprofil
    ->refund[] array_of_Stock_ebay_seller_profile_type Lesen, Schreiben Rücknahmebedingsprofil
    ->shipping[] array_of_Stock_ebay_seller_profile_type Lesen, Schreiben Versandbedingungsprofil
rrp decimal(10,2) Lesen, Schreiben UVP / Unverbindliche Preisempfehlung / Streichpreis.
ebay_plus integer Lesen, Schreiben eBay-Plus Artikel?. (-1 = Nein, 0 = Standard, 1 = Ja)

Stock_lister_shipping_table_type:

Beinhaltet Versandinformationen zu Dienstleistern, Kosten und Lieferländern..

Name Datentyp Status Beschreibung
id integer Lesen, Schreiben, Primärschlüssel 1, 2 oder 3
type_id string Lesen, Schreiben, Fremdschlüssel Die Versandart/Versender.
first decimal(10,2) Lesen, Schreiben Die Versandkosten für den ersten Artikel.
more decimal(10,2) Lesen, Schreiben Die Versandkosten für weitere gleiche Artikel (nur für eBay verfügbar).
ships_to_id[] array_of_string Lesen, Schreiben Lieferländer für die die Versandkosten gültig sind. (Nur für die internationalen Angaben ein gültiges Feld, da sich das Feld national erübrigt.).

Stock_ebay_seller_profile_type:

Eine eBay-Rahmenbedingung abhängig vom eBay-Account(dort müssen Sie auch die Rahmenbedingungen anlegen. Anschließend können Sie die Rahmenbedingungen unter Admin->Einstellungen einlesen.).

Name Datentyp Status Beschreibung
id integer Lesen, Schreiben, Fremdschlüssel Die Rahmenbedingungs ID.
portal_account_id Portal_account_id_type Lesen, Schreiben, Fremdschlüssel Wenn das Feld keinen Wert enthält, wird die Standardportal-Account-ID verwendet.

Stock_hood_type:

Die Lister-Hood Felder (in der REST API ausschließlich über den Lagerartikel zu erreichen).

Name Datentyp Status Beschreibung
lister_id string Lesen, Schreiben, Primärschlüssel Die Listerverknüpfung. Im Optimalfall wird dieses Feld einfach weggelassen (Wenn es keinen oder nur einen verknüpften Lister gibt). Gültige Werte sind die Stamm-ID(Im Backend nicht einsehbar), oder die Listernummer mit "NO_" vorangestellt. Außerdem kann "0" übergeben werden um einen neuen Lister anzulegen.
modified_time date Lesen Das Datum zu dem der DR-Hood-Datensatz das letzte mal aktualisiert wurde.
duration string(3) Lesen, Schreiben Die Angebotsdauer. Gültige Werte sind: 1, 3, 5, 7, 10, 30 und "GTC"(bis auf Widerruf).
type_id string(2) Lesen, Schreiben Das Verkaufsformat. Gültige Werte sind: 1(Auktion), 9(Festpreis-Angebot), 7(Shop-Angebot), 22(Varianten-Angebot).
name string(80) Lesen, Schreiben Der Angebotsname
subtitle string(80) Lesen, Schreiben Der Untertitel
quantity integer Lesen, Schreiben Die initiale Einstellmenge
start_price decimal(10,2) Lesen, Schreiben Der Auktionspreis
price decimal(10,2) Lesen, Schreiben Der Festpreis(Sofort-Kaufen Preis)
vat decimal(4,2) Lesen, Schreiben Die Mwst
min_price decimal(10,2) Lesen, Schreiben Der Mindestpreis
description text(ca.65000) Lesen, Schreiben Die Beschreibung
payment array Lesen, Schreiben Zahlungsinformationen
    ->id[] array_of_string Lesen, Schreiben akzeptierte Zahlungsmethoden: "nachnahme", "ueberweisung", "barzahlung", "rechnung", "moneybookers", "moneybookers_escrow"(Moneybookers Treuhandservice), "treuhand", "sofortueberweisung", "paypal", "billsafe", "beschreibung"(Die Zahlunginformationen sind in der Artikelbeschreibung hinterlegt)
    ->advice string(255) Lesen, Schreiben Zahlungshinweise. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
refund array Lesen, Schreiben Rückgabehinweise
    ->policy_id integer Lesen, Schreiben Die ID zur passenden Standard Rückgaben-Police. Gültige Werte sind "0"(Keine Rückgaben), "11"(14 Tage Widerrufsrecht: Verkäufer trägt die Rücksendekosten), "21"(1 Monat Widerrufsrecht: Verkäufer trägt die Rücksendekosten), "12"(14 Tage Widerrufsrecht: Käufer trägt die Rücksendekosten unter 40 Euro), "22"(1 Monat Widerrufsrecht: Käufer trägt die Rücksendekosten unter 40 Euro), "13"(14 Tage Rückgaberecht: Verkäufer trägt die Rücksendekosten), "23"(1 Monat Rückgaberecht: Verkäufer trägt die Rücksendekosten), "14"(14 Tage Käufer trägt die unmittelbaren Kosten der Rücksendung der Waren), "24"(1 Monat Käufer trägt die unmittelbaren Kosten der Rücksendung der Waren), "15"(14 Tage Verkäufer trägt die Kosten der Rücksendung der Waren), "25"(1 Monat Verkäufer trägt die Kosten der Rücksendung der Waren). Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
    ->advice text Lesen, Schreiben Zahlungshinweise. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
additional array Lesen, Schreiben Zusatzoptionen
    ->is_private bool Lesen, Schreiben Privatauktion?
    ->is_bold bool Lesen, Schreiben Fettschrift?
    ->is_highlighted bool Lesen, Schreiben Highlight?
    ->is_top_start_pic bool Lesen, Schreiben Top-Angebot auf der Startseite mit Bild?
    ->is_no_ads bool Lesen, Schreiben Keine Werbung?
shipping array Lesen, Schreiben Versandinformationen
    ->ships_to_id[] array_of_string Lesen, Schreiben Lieferländer. Gültige Werte sind: "nichtLiefern"(nur Abholung), oder "weltweit", oder "portal"(Portalland) plus: "deutschland", "oesterreich", "schweiz", "europa", "usa", "amerika", "asien", "japan", "australien", "kanada", "EU"
    ->national Stock_lister_shipping_table_type Lesen, Schreiben Die nationale Versandkostentabelle. Hier können die Versandkosten für verschiedene Lieferanten und Lieferorte angegeben werden.
    ->international Stock_lister_shipping_table_type Lesen, Schreiben Die internationale Versandkostentabelle. Hier können die Versandkosten für verschiedene Lieferanten und Lieferorte angegeben werden.
    ->discount decimal(10,2) Lesen, Schreiben Der Versandrabatt.
    ->from bool Lesen, Schreiben Lieferzeit - Von (in Tagen)
    ->to bool Lesen, Schreiben Lieferzeit - Bis (in Tagen)
location array Lesen, Schreiben Der Artikelstandort. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
    ->city string Lesen, Schreiben Stadt. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
    ->zip string Lesen, Schreiben Postleitzahl. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
    ->country_id integer Lesen, Schreiben Land. Orientiert sich an den eBay-Site-IDs. (77=DE;0=USA). Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
freetext[] array_of_Stock_freetext_type Lesen, Schreiben Die Bausteine 1 - 3. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
start date Lesen, Schreiben Der Angebotsstart.
picture array Lesen, Schreiben Bilderinformationen.
    ->type_id integer Lesen, Schreiben Bilder-Service ID (0 = Portal, 1 = DR-Bilderservice, 2 = eigener Server, 3 = Portal über URL). Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
    ->url[] array_of_string Lesen, Schreiben Die Listerbilder (max. 12 Stk.). Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
    ->is_in_description bool Lesen, Schreiben Bild in Beschreibung?
    ->quantity integer Lesen, Schreiben Die Anzahl der Bilder aus "url" die für Hood verwendet werden sollen.
template_id integer Lesen, Schreiben Die Vorlagen ID für die Artikelbeschreibung.
category_1_id string Lesen, Schreiben Die Hauptkategorie.
category_2_id string Lesen, Schreiben Die zweite Kategorie.
shop_category_1_id string Lesen, Schreiben Die Shopkategorie.
shop_category_2_id string Lesen, Schreiben Die zweite Shopkategorie.
shop_category_3_id string Lesen, Schreiben Die dritte Shopkategorie.
is_max_quantity_available bool Lesen, Schreiben Maximal die verfügbare Menge "stock->quantity_available" einstellen (nur für Varianten).
is_stock_price bool Lesen, Schreiben Den Lagerpreis verwenden (nur für Varianten).
is_auto_renew bool Lesen, Schreiben Wiedereinstellen?
condition_id string(2) Lesen, Schreiben Die Artikelzustands-ID. Gültige Werte: "0" => Neu; "1" => Gebraucht; "2" => Gebraucht(Wie Neu); "3" => Gebraucht(Sehr Gut); "4" => Gebraucht(Gut); "5" => Gebraucht(Akzeptabel); "6" => Erneuert; "7" => Defekt oder mit Fehlern;
shop array Lesen, Schreiben Bilderinformationen.
    ->short_description text Lesen, Schreiben Die Kurzbeschreibung.
    ->sold_out string Lesen, Schreiben Anzeigeoption, falls ausverkauft: "hide"(default), "display", "endless"
    ->homepage_id bool Lesen, Schreiben Anzeigeoptionen für die Shopstartseite: 0 => Nicht anzeigen; 1 => Mit Bild anzeigen; 2 => anzeigen;
    ->is_auction_subtitle bool Lesen, Schreiben Untertitel in Auktion anzeigen?
    ->is_active bool Lesen, Schreiben Shopartikel?
    ->is_auction bool Lesen, Schreiben Zusätzlich als Auktion veröffentlichen?
fsk integer Lesen, Schreiben FSK-Angabe. 0, 6, 12, 16 oder 18.
usk integer Lesen, Schreiben USK-Angabe. 0, 6, 12, 16 oder 18.
rrp integer Lesen, Schreiben UVP / Unverbindliche Preisempfehlung / Listenpreis.
mpn string Lesen, Schreiben Herstellernummer.
manufacturer string Lesen, Schreiben Hersteller.
is_no_id bool Lesen, Schreiben Sonderanfertigung (ohne EAN)?

Stock_yatego_type:

Die Lister-Yatego Felder (in der REST API ausschließlich über den Lagerartikel zu erreichen).

Name Datentyp Status Beschreibung
lister_id string Lesen, Schreiben, Primärschlüssel Die Listerverknüpfung. Im Optimalfall wird dieses Feld einfach weggelassen (Wenn es keinen oder nur einen verknüpften Lister gibt). Gültige Werte sind die Stamm-ID(Im Backend nicht einsehbar), oder die Listernummer mit "NO_" vorangestellt. Außerdem kann "0" übergeben werden um einen neuen Lister anzulegen.
modified_time date Lesen Das Datum zu dem der DR-Yatego-Datensatz das letzte mal aktualisiert wurde.
name string(80) Lesen, Schreiben Der Angebotsname
quantity integer Lesen, Schreiben Die initiale Einstellmenge
price decimal(10,2) Lesen, Schreiben Der Festpreis(Sofort-Kaufen Preis)
vat decimal(4,2) Lesen, Schreiben Die Mwst
description text(ca.65000) Lesen, Schreiben Die Beschreibung
payment array Lesen, Schreiben Zahlungsinformationen
    ->advice string(255) Lesen, Schreiben Zahlungshinweise. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
refund array Lesen, Schreiben Rückgabehinweise
    ->policy_id integer Lesen, Schreiben Die ID zur passenden Standard Rückgaben-Police. Gültige Werte sind "0"(Keine Rückgaben), "11"(14 Tage Widerrufsrecht: Verkäufer trägt die Rücksendekosten), "21"(1 Monat Widerrufsrecht: Verkäufer trägt die Rücksendekosten), "12"(14 Tage Widerrufsrecht: Käufer trägt die Rücksendekosten unter 40 Euro), "22"(1 Monat Widerrufsrecht: Käufer trägt die Rücksendekosten unter 40 Euro), "13"(14 Tage Rückgaberecht: Verkäufer trägt die Rücksendekosten), "23"(1 Monat Rückgaberecht: Verkäufer trägt die Rücksendekosten), "14"(14 Tage Käufer trägt die unmittelbaren Kosten der Rücksendung der Waren), "24"(1 Monat Käufer trägt die unmittelbaren Kosten der Rücksendung der Waren), "15"(14 Tage Verkäufer trägt die Kosten der Rücksendung der Waren), "25"(1 Monat Verkäufer trägt die Kosten der Rücksendung der Waren). Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
    ->advice text Lesen, Schreiben Zahlungshinweise. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
location array Lesen, Schreiben Der Artikelstandort. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
    ->city string Lesen, Schreiben Stadt. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
    ->zip string Lesen, Schreiben Postleitzahl. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
    ->country_id integer Lesen, Schreiben Land. Orientiert sich an den eBay-Site-IDs. (77=DE;0=USA). Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
freetext[] array_of_Stock_freetext_type Lesen, Schreiben Die Bausteine 1 - 3. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
picture array Lesen, Schreiben Bilderinformationen.
    ->type_id integer Lesen, Schreiben Bilder-Service ID (0 = Portal, 1 = DR-Bilderservice, 2 = eigener Server, 3 = Portal über URL). Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
    ->url[] array_of_string Lesen, Schreiben Die Listerbilder (max. 12 Stk.). Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
template_id integer Lesen, Schreiben Die Vorlagen ID für die Artikelbeschreibung.
category_1_id string Lesen, Schreiben Die Hauptkategorie.
category_2_id string Lesen, Schreiben Die zweite Kategorie.
category_3_id string Lesen, Schreiben Die dritte Kategorie.
sku string Lesen, Schreiben Die Artikelnummer
short_description text Lesen, Schreiben Die Kurzbeschreibung
cross_selling text Lesen, Schreiben Cross Selling
discount_id text Lesen, Schreiben Die Rabattsatz-IDs
variation_id text Lesen, Schreiben Die Variantensatz-IDs
is_line_feed bool Lesen, Schreiben Auto-Linefeed (Beschreibung)?
is_basic_price bool Lesen, Schreiben Soll die Grundpreisangabe angezeigt werden??
is_active bool Lesen, Schreiben Yatego-Artikel?
is_delete bool Lesen, Schreiben Soll gelöscht werden?
rrp decimal(10,2) Lesen, Schreiben UVP / Unverbindliche Preisempfehlung / Streichpreis
shipping_surcharge decimal(10,2) Lesen, Schreiben Der Versandkostenaufschlag
is_shipping_surcharge_once bool Lesen, Schreiben Den Versandkostenaufschlag nur ein Mal hinzufügen?

Stock_shop_type:

Die Lister-Shop Felder (in der REST API ausschließlich über den Lagerartikel zu erreichen).

Name Datentyp Status Beschreibung
lister_id string Lesen, Schreiben, Primärschlüssel Die Listerverknüpfung. Im Optimalfall wird dieses Feld einfach weggelassen (Wenn es keinen oder nur einen verknüpften Lister gibt). Gültige Werte sind die Stamm-ID(Im Backend nicht einsehbar), oder die Listernummer mit "NO_" vorangestellt. Außerdem kann "0" übergeben werden um einen neuen Lister anzulegen.
modified_time date Lesen Das Datum zu dem der DR-Shop-Datensatz das letzte mal aktualisiert wurde.
name string(80) Lesen, Schreiben Der Angebotsname
quantity integer Lesen, Schreiben Die initiale Einstellmenge
price decimal(10,2) Lesen, Schreiben Der Festpreis(Sofort-Kaufen Preis)
vat decimal(4,2) Lesen, Schreiben Die Mwst
description text(ca.65000) Lesen, Schreiben Die Beschreibung
payment array Lesen, Schreiben Zahlungsinformationen
    ->advice string(255) Lesen, Schreiben Zahlungshinweise. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
refund array Lesen, Schreiben Rückgabehinweise
    ->policy_id integer Lesen, Schreiben Die ID zur passenden Standard Rückgaben-Police. Gültige Werte sind "0"(Keine Rückgaben), "11"(14 Tage Widerrufsrecht: Verkäufer trägt die Rücksendekosten), "21"(1 Monat Widerrufsrecht: Verkäufer trägt die Rücksendekosten), "12"(14 Tage Widerrufsrecht: Käufer trägt die Rücksendekosten unter 40 Euro), "22"(1 Monat Widerrufsrecht: Käufer trägt die Rücksendekosten unter 40 Euro), "13"(14 Tage Rückgaberecht: Verkäufer trägt die Rücksendekosten), "23"(1 Monat Rückgaberecht: Verkäufer trägt die Rücksendekosten), "14"(14 Tage Käufer trägt die unmittelbaren Kosten der Rücksendung der Waren), "24"(1 Monat Käufer trägt die unmittelbaren Kosten der Rücksendung der Waren), "15"(14 Tage Verkäufer trägt die Kosten der Rücksendung der Waren), "25"(1 Monat Verkäufer trägt die Kosten der Rücksendung der Waren). Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
    ->advice text Lesen, Schreiben Zahlungshinweise. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
location array Lesen, Schreiben Der Artikelstandort. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
    ->city string Lesen, Schreiben Stadt. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
    ->zip string Lesen, Schreiben Postleitzahl. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
    ->country_id integer Lesen, Schreiben Land. Orientiert sich an den eBay-Site-IDs. (77=DE;0=USA). Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
freetext[] array_of_Stock_freetext_type Lesen, Schreiben Die Bausteine 1 - 3. Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
start date Lesen, Schreiben Der Angebotsstart (Nur Datum ohne Uhrzeit).
picture array Lesen, Schreiben Bilderinformationen.
    ->type_id integer Lesen, Schreiben Bilder-Service ID (0 = Portal, 1 = DR-Bilderservice, 2 = eigener Server, 3 = Portal über URL). Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
    ->url[] array_of_string Lesen, Schreiben Die Listerbilder (max. 12 Stk.). Dieses Feld ist für alle Lister(eBay, Hood, Yatego, Shop) mit der selben lister_id identisch.
template_id integer Lesen, Schreiben Die Vorlagen ID für die Artikelbeschreibung.
category_1_id string Lesen, Schreiben Die Kategorie.
manufacturer_url string Lesen, Schreiben Der Herstellerlink
short_description text Lesen, Schreiben Die Kurzbeschreibung
is_adult text Lesen, Schreiben Ab 18 Artikel?
weight decimal(10,2) Lesen, Schreiben Das Artikelgewicht in Gramm
delivery_time_id string Lesen, Schreiben Die ID der Lieferzeit (abhängig vom ausgewählten Shop, kann eingelesen werden.)
barcode string Lesen, Schreiben Barcode / EAN
manufacturer string Lesen, Schreiben Der Hersteller
is_delete bool Lesen, Schreiben Soll gelöscht werden?

Stock_filter_type:

Der Lager-Filter anhand dessen Lagerartikel gesucht werden können. ("ODER"-Bedingungen können durch mehrere Filter abgebildet werden.)

Name Datentyp Status Beschreibung
id[] array_of_Operator_filter_type<mixed> Schreiben Eine Liste aus Lagernummern von "stock"s, die zurückgegeben werden sollen.
sku[] array_of_Operator_filter_type<string> Schreiben Eine Artikelnummer/Druck_pseudonym-Liste, die zurückgegeben werden soll.
barcode[] array_of_Operator_filter_type<string> Schreiben Eine Barcode/EAN-Liste, die zurückgegeben werden soll.
name[] array_of_Operator_filter_type<string> Schreiben Eine Operator_filter_type liste um auf Lagerartikelnamen zu filtern.
infos[] array_of_Operator_filter_type<string> Schreiben Eine Operator_filter_type liste um auf Lagerartikel infos zu filtern (stock->infos).
folder[] array_of_Operator_filter_type<string> Schreiben Eine Operator_filter_type liste um auf Lagerartikel infos zu filtern (stock->infos).

Name_value_type:

Beinhaltet eine Liste aus Werten ("value[]") die sich auf einen Namen("name") beziehen. Es wird z.B. für die Variantenmatrix der Lagervarianten verwendet.

Name Datentyp Status Beschreibung
name string Lesen, Schreiben Der Name
value[] array_of_string Lesen, Schreiben Die Liste aus Werten die sich auf den Namen beziehen.(Normalerweise ist nur ein Wert enthalten. Mehrere Werte sind nur vereinzelt in den eBay-Artikelmerkmalen vorgesehen.)

Stock_portal_upload_type:

Einen Lagerartikel in einem oder mehreren Portal(-en) über das Protokoll einstellen, bzw. Updates durchführen.

Name Datentyp Status Beschreibung
ebay[] array_of_Stock_portal_upload_ebay_type Schreiben Ein eBay-Angebot einstellen oder aktualisieren.
amazon[] array_of_Stock_portal_upload_portal_type Schreiben Ein Amazon-Angebot einstellen oder den Preis aktualisieren.
allyouneed[] array_of_Stock_portal_upload_portal_type Schreiben Ein Allyouneed-Angebot einstellen.
rakuten[] array_of_Stock_portal_upload_portal_type Schreiben Ein Rakuten-Angebot einstellen oder aktualisieren.
hitmeister[] array_of_Stock_portal_upload_portal_type Schreiben Ein real-Angebot einstellen/aktualisieren oder beenden.
fnac[] array_of_Stock_portal_upload_portal_type Schreiben Ein Fnac-Angebot einstellen.
epages[] array_of_Stock_portal_upload_portal_type Schreiben Ein ePages-Angebot einstellen.

Stock_portal_upload_portal_type:

Einen Lagerartikel in einem oder mehreren Portal(-en) über das Protokoll einstellen, bzw. Updates durchführen.

Name Datentyp Status Beschreibung
action string Schreiben Die Aktion die durchgeführt werden soll: Mögliche Werte sind: "list"(Einstellen/Aktualisieren) und "delete".
portal_account_id Portal_account_id_type Schreiben, Fremdschlüssel Gibt an, aus welchem Account die Portal-Zugangsdaten verwendet werden sollen.
is_pictures bool Schreiben Nur für Rakuten: Im Falle eines Updates werden auch die Bilder aktualisiert?
is_variations bool Schreiben Nur für Rakuten: Im Falle eines Updates werden auch die Varianten aktualisiert?

Stock_portal_upload_ebay_type:

Einen Lagerartikel in einem oder mehreren Portal(-en) über das Protokoll einstellen, bzw. Updates durchführen.

Name Datentyp Status Beschreibung
action string Schreiben "list" oder "revise" um einen Lister neu einzustellen, oder ein bestehendes Angebot zu aktualisieren.
portal_account_id Portal_account_id_type Schreiben, Fremdschlüssel Gibt an, aus welchem Account die Portal-Zugangsdaten verwendet werden sollen.
lister_id string Schreiben, Fremdschlüssel Gibt an, welcher verknüpfte Lister verwendet werden soll. (Wenn es nur einen gibt, kann das Feld freigelassen werden.)
start date Schreiben Für "action" "list": Hier kann angegeben werden, wann das Angebot eingestellt werden soll.
revise_values[] array_of_string Schreiben Für "action" "revise": Gültige Werte sind: "price": Preise und Zahlungsbedingungen aktualisieren; "title": Titel aktualisieren; "desc": Artikelbeschreibung aktualisieren; "sku": Das SKU-Feld Aktualisieren(nicht die Varianten SKU); "specs": Varianten, Artikelmerkmale und Fahrzeugverwendungsliste aktualisieren; "widerruf": Informationen zum Rückgaberecht aktualisieren; "subtitle": Untertitel aktualisieren; "pic": Die Bilder neu zu eBay laden; "shipping": Die Versandoptionen aktualisieren; "quantity": Varianten und Menge aktualisieren; "cat": Kategorien(und Zusatzoptionen) aktualisieren.
ebay_live_id string Schreiben, Fremdschlüssel Gibt an, welcher verknüpfte Lister verwendet werden soll. (Wenn es nur einen gibt, kann das Feld freigelassen werden.)

Multistatus_type:

Beinhaltet eine Liste aus "response"-Feldern die sich auf verschiedene Bereiche der Anfrage beziehen und jeweils eine eigene HTTP-Antwort repräsentieren.

Name Datentyp Status Beschreibung
path string Lesen, automatisch generiert Die Referenz auf den Input, damit klar ist, auf welchen Teil der Anfrage sich die Antwort bezieht.
code integer(3) Lesen, automatisch generiert Der HTTP-Code für die Teilantwort.
... mixed Lesen Abhängig von der Teilanfrage sind weitere Antwortfelder möglich.

Stock_description_type:

Eine (von mehreren) Lagerbeschreibung.

Name Datentyp Status Beschreibung
id integer Lesen, Primärschlüssel, automatisch generiert Die ID der Beschreibung.
name string(255) Lesen, Schreiben Der Name der Beschreibung (Nur für die Backend Bezeichnung).
icon_id string(255) Lesen, Schreiben, Fremdschlüssel Der Wert bestimmt, welches Symbol neben der Beschreibung angezeigt wird. (Für Amazon ist es sogar indikator, dass die Beschreibung verwendet werden soll.)
language_iso2 string(2) Lesen, Schreiben, Fremdschlüssel Die Beschreibungssprache im zweistelligen Format.
long text Lesen, Schreiben Die Hauptbeschreibung.
short text Lesen, Schreiben Die Kurzbeschreibung. Wird nicht von allen Plattformen untestützt.
alternative_title string(255) Lesen, Schreiben Ein Alternativer Produkttitel (z.B. für den DR-Webshop 2.0).
meta_keywords string(255) Lesen, Schreiben Manche Plattformen unterstützen Meta Keywords (z.B. der DR-Webshop 2.0).
meta_description string(255) Lesen, Schreiben Manche Plattformen unterstützen eine Meta Beschreibung mit allgemeinen Informationen (z.B. der DR-Webshop 2.0).

Admin_portal_account_type:

Ein Paar aus ID und Name die zusammen den Portalaccount darstellen. Oft wird auf die ID referenziert wenn es um Informationen geht die sich unter den Portalaccounts unterscheiden können, bzw. nur für einen Portalaccount gültig sind.

Name Datentyp Status Beschreibung
id integer Lesen, Primärschlüssel, automatisch generiert Die Portalaccount ID.
is_default bool Lesen, automatisch generiert Die Portalaccount ID.
name string(255) Lesen, Fremdschlüssel Der Anzeigename des Portalaccounts in der Oberfläche (Für eBay Portal_accounts ist es auch der eBay Benutzername).

Admin_person_type:

Ein Paar aus ID und Name die zusammen den Benutzer darstellen. Oft wird auf die ID referenziert wenn es um Informationen geht die sich unter den Benutzern unterscheiden können, bzw. nur für einen Benutzer gültig sind. (z.B. werden Aufgaben einem bestimmten Benutzer zugestellt)

Name Datentyp Status Beschreibung
id integer Lesen, Primärschlüssel, automatisch generiert Die Benutzer ID.
name string Lesen, Fremdschlüssel Der Anzeigename des Benutzers.

Admin_shipping_group_type:

Versandgruppen beinhalten die Information in welche Länder zu welchen Versandkosten die verknüpften Lagerartikel versendet werden.

Name Datentyp Status Beschreibung
id integer Lesen, Primärschlüssel, automatisch generiert Die Versandgruppen ID.
name string(255) Lesen Die Bezeichnung.
portal_account_id Portal_account_id_type Lesen, Fremdschlüssel Die Portal-Account ID für die die Versandgruppe gültig ist. Wenn der Wert '0' ist, dann ist sie für alle Accounts gültig.
type_id integer Lesen Die Versandgruppen ID.
ships_to array Lesen Die gültigen Versandländer.
    ->worldwide bool Lesen Weltweit (Alle Länder).
    ->europe bool Lesen Europa
    ->eu bool Lesen Europa
    ->germany bool Lesen Europa
    ->eu_more text Lesen Weitere Länder in der EU. Angabe im ISO2-Stil, Semikolon seperiert.
    ->switzerland bool Lesen Schweiz
    ->europe_more text Lesen Weitere Länder in Europa. Angabe im ISO2-Stil, Semikolon seperiert.
    ->usa bool Lesen USA
    ->canada bool Lesen Kanada
    ->japan bool Lesen Japan
    ->australia bool Lesen Australien
    ->worldwide_more text Lesen Weitere Länder in der Welt. Angabe im ISO2-Stil, Semikolon seperiert.
price array Lesen Die verschiedenen Versandkosten.
    ->first decimal(8,2) Lesen Die Versandkosten für den ersten Artikel.
    ->more decimal(8,2) Lesen Die Versandkosten für weitere Artikel.
cash_surcharge decimal(8,2) Lesen Der Versandkostenzuschlag wenn Nachnahme gewählt wurde.
currency string(3) Lesen, Fremdschlüssel Die Währung im 3-stelligen Format (z.B. EUR oder USD).

Admin_user_type:

Allgemeine Statusinformationen zum REST API-Account

Name Datentyp Status Beschreibung
id integer Lesen, Primärschlüssel, automatisch generiert Die REST API-Account-ID.
scope[] array_of_string Lesen Die Berechtigungen für den verwendeten Accesstoken.

Admin_event_handler_type:

Ein Eventhandler definiert Reaktionsregeln auf je einen Eventtypen.

Name Datentyp Status Beschreibung
id integer Lesen, Primärschlüssel, automatisch generiert Die Eventhandler ID.
modified datetime Lesen, automatisch generiert Das Aktualisierungsdatum.
type array Lesen, Schreiben Der Eventtyp auf den reagiert wird. Siehe "GET system/event/type/"
    ->id string Lesen, Schreiben, Fremdschlüssel Der Eventtyp auf den reagiert wird.
action array Lesen, Schreiben Die Aktion die durchgeführt wird, wenn das Event ausgelöst wurde. Siehe "GET system/event/action/" (vor allem für die "required"-Felder)
    ->id string Lesen, Schreiben, Fremdschlüssel Die Aktion die durchgeführt wird, wenn das Event ausgelöst wurde.
    ->required array Lesen, Schreiben Eine Name-Wert Liste aller Aktionsabhängigen Pflichtparameter.
        ->... mixed Lesen, Schreiben flexible Pflichtfelder abhängig von der Aktion.
section string Lesen, Schreiben Der Bereich in den der Handler einzuordnen ist.
condition[] array_of_array Lesen, Schreiben Die Bedingung(en) für den Handler. Achtung: Derzeit ist immer nur 1 Bedingung gleichzeitig möglich. Weitere sind geplant. Siehe "GET system/event/condition/".
    ->operator string Lesen, Schreiben Der Bedingungsoperator.
    ->value string Lesen, Schreiben Der Bedingungsoperator.
    ->field string Lesen, Schreiben Das Feld im Section-Modulobjekt Das verglichen wird.

Customer_filter_type:

Das Filter Objekt für den "GET customer/"-Such-Call. Über einen Filter können mehrere Bedingungen angegeben werden, die per "UND"-Bedingung miteinander verknüpft werden. ("ODER"-Bedingungen können durch mehrere Filter abgebildet werden.)

Name Datentyp Status Beschreibung
internal_id[] array_of_Operator_filter_type<integer> Schreiben Enthält eine Liste der internen Kunden ID's auf die gefiltert werden sollen.
id[] array_of_Operator_filter_type<string> Schreiben Enthält eine Liste der Kunden ID's auf die gefiltert werden sollen.
name[] array_of_Operator_filter_type<string> Schreiben Über diesen Filter kann der customer->address->name gefiltert werden.
email[] array_of_Operator_filter_type<string> Schreiben Email Filter.
date[] array_of_Operator_filter_type<datetime> Schreiben Ein Filter für das Datum (ohne Zeitraumbeschränkung).
group_id[] array_of_Operator_filter_type<integer> Schreiben Die Kundengruppen ID (siehe Customer_type->group_id für die Zuordnungen).

Customer_type:

Ein Eventhandler definiert Reaktionsregeln auf je einen Eventtypen.

Name Datentyp Status Beschreibung
internal_id integer Lesen, Primärschlüssel, automatisch generiert Die DR interne Kunden-ID.
id integer Lesen, automatisch generiert Die veränderbare Kunden ID (customer_id).
phone_1 string Lesen Die erste Telefonnummer.
phone_2 string Lesen Die zweite Telefonnummer.
fax string Lesen Die Faxnummer des Kunden.
date datetime Lesen Der Zeitpunkt zu dem der Kunde zuletzt angelegt/bearbeitet wurde.
shop_username[] array_of_string Lesen Eine Liste aus Portal Benutzernamen.
username string Lesen Benutzernamen vom Portal.
comment string Lesen Kommentare über den Kunden.
email string Lesen Die Emailadresse.
sales decimal Lesen Der mit dem Kunden erzielte Umsatz.
    ->amount decimal Lesen Der mit dem Kunden erzielte Umsatz.
    ->currency_id string(3) Lesen, Fremdschlüssel Die Währungs ID im ISO3 Format.
group_id integer(1) Lesen Die Versandgruppen-ID (0 = Keine, 1 = Grün, 2 = Gelb, 3 = Orange, 4 = Rot, 5 = Lila, 6 = Blau, 9 = Schwarz).

Customer_address_type:

Eine Kundenadresse (Rechnungs- oder Lieferadresse).

Name Datentyp Status Beschreibung
name string Lesen Das Hauptfeld für den Namen.
name_2 string Lesen Ein Zusatzfeld für den Namen.
street string Lesen Das Hauptfeld für die Adresse/Straße.
street_2 string Lesen Ein Zusatzfeld für die Adresse/Straße.
zip string Lesen Die Postleitzahl.
city string Lesen Die Stadt.
country string Lesen Das Land.

Task_type:

Ein Überweisungsobjekt. Dies kann entweder eine normale Aufgabenüberweisung oder eine Paypalzahlung sein.

Name Datentyp Status Beschreibung
id integer Lesen, Primärschlüssel, automatisch generiert Die Aufgaben ID.
reference array Lesen, Schreiben Ein spezieller Bereich auf den sich die Aufgabe bezieht.
    ->section string Lesen, Schreiben Der Bereich auf den sich die Aufgabe bezieht.
    ->id mixed Lesen, Schreiben Die ID eines Objekts aus der "section".
    ->platform string Lesen, Schreiben Falls "section" den Wert "stock_lister" hat, wird über dieses Feld spezifiziert, um welches Portal im Lister es sich handelt.
    ->stock_id string Lesen, Schreiben Die ID eines Objekts aus der "section".
person_id string Lesen, Schreiben, Fremdschlüssel Die Benutzer-ID. Wer soll die Aufgabe bearbeiten?
title string Lesen, Schreiben Die Aufgabenüberschrift.
text text Lesen, Schreiben Der Aufgabentext mit den Hinweisen, was zu tun ist.
appointment_date datetime Lesen, Schreiben Der Zeitpunkt zu dem die Aufgabe angezeigt/bearbeitet werden soll.
modified_date datetime Lesen, automatisch generiert Der Zeitpunkt zu dem die Aufgabe zuletzt verändert wurde.
priority string Lesen, Schreiben Wie weit oben soll die Aufgabe angezeigt werden? Wie hoch ist die Priorität? Mögliche Werte sind: "low", "normal", "high".
is_completed bool Lesen, Schreiben Die ID des bereits erfolgreich verknüpften Auftrags. Es kann nur "order_id" oder "order_no" ausgegeben werden.

Task_filter_type:

Das Filter Objekt für den "GET task/*/"-Such-Call. Über einen Filter können mehrere Bedingungen angegeben werden, die per "UND"-Bedingung miteinander verknüpft werden. ("ODER"-Bedingungen können durch mehrere Filter abgebildet werden.)

Name Datentyp Status Beschreibung
id[] array_of_Operator_filter_type<integer> Schreiben Enthält eine Liste aller aufgaben_id's die selektiert werden sollen.
is_completed bool Schreiben Wenn auf FALSE gesetzt, kann gefiltert werden, um nur offene Aufträge zu erhalten.

7. Änderungshistorie

Version Änderungen
v1.1.1
v1.1
v1.0.2
  • stock/{stock_id}/portal_upload/: POST Durch die Multistatus_Type-Änderung ändert sich die Rückgabe.

  • Stock_ebay_type->name: Wenn in einem Lister der Angebotsname gesetzt wird, wird dieser auch in die Stammdaten übernommen.

  • Stock_hood_type->name: Wenn in einem Lister der Angebotsname gesetzt wird, wird dieser auch in die Stammdaten übernommen.

  • Stock_yatego_type->name: Wenn in einem Lister der Angebotsname gesetzt wird, wird dieser auch in die Stammdaten übernommen.

  • Stock_shop_type->name: Wenn in einem Lister der Angebotsname gesetzt wird, wird dieser auch in die Stammdaten übernommen.

v1.0
v0.6
v0.5