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:
|
| 501 | Not Implemented | Der Programmierer hat bereits vorgesehen, dass die angefragte Methode theoretisch ausgeführt werden kann, diese wurde aber noch nicht eingebaut. |
| 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. | |||
| system/country/ | GET | select | Select_type | country | array_of_ System_country_type | DR Länder abrufen. | |
| filter | Country_filter_type | ||||||
| pagination | Pagination_type | ||||||
| system/country/{country_id}/ | GET | select | Select_type | country | System_country_type | Eine DR Währung abrufen. | |
| system/gender/{gender_id}/ | GET | gender | System_gender_type | Das Geschlecht anhand eines Namen abrufen. | |||
| 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. | |||
| order/list/ | POST | order | array_of_ Order_type | response | array_of_ Multistatus_type | Es können bis zu 200 Aufträge übergeben werden, mit order->id für Update, oder ohne für das Anlegen. API Gewichtung: 1/10 (z.B. 200 Anfragen zählen nur als 20 Anfragen.) Achtung: Multi-Status(siehe HTTP-Code 207). | |
| Bank | bank/transfer/ | GET | filter | array_of_ Bank_filter_type | bank | array_of_ Bank_type | Banküberweisungen abrufen. |
| pagination | Pagination_type | ||||||
| POST | bank | Bank_type | bank_id | string | Banküberweisungen anlegen. is_order_paid "1", falls zugeordnet. Liefert HTTP 302 falls schon existiert. | ||
| is_order_paid | string | ||||||
| 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}/history/ | GET | filter | Stock_history_filter_type | stock_history | array_of_ Stock_history_type | Lagerbewegungen für den Lagerartikel abrufen. | |
| pagination | Pagination_type | ||||||
| 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_type | Eigene Kategorien abrufen. | ||
| pagination | Pagination_type | ||||||
| POST | category | Category_type | Eigene Kategorien anlegen. | ||||
| stock/folder/ | GET | folder | array_of_ string | Alle aktuellen Lagerordner abrufen. | |||
| stock/history/ | GET | filter | Stock_history_filter_type | stock_history | array_of_ Stock_history_type | Lager History abrufen. | |
| pagination | Pagination_type | ||||||
| stock/list/ | POST | stock | array_of_ Stock_type | response | array_of_ Multistatus_type | Es können bis zu 200 Lagerartikel übergeben werden, mit stock->id für Update, oder ohne für das Anlegen. API Gewichtung: 1/10 (z.B. 200 Anfragen zählen nur als 20 Anfragen.) Achtung: Multi-Status(siehe HTTP-Code 207). | |
| Admin | 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. | |||
| 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/person/ | GET | person | array_of_ Admin_person_type | Alle DR Benutzer abrufen. | |||
| 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/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. | |||
| POST | user | Admin_user_type | Account Einstellungen vornehmen. | ||||
| 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. | ||
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. |
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. |
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. |
Eine Währung (z.B. Euro oder US-Dollar ).
| Name | Datentyp | Status | Beschreibung |
|---|---|---|---|
| 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. |
| internal_id | integer | Lesen, automatisch generiert | Die DR-interne ID der Währung. |
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. |
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. |
Der Category-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<string> | Schreiben | Ein Kategorie-ID Filter anhand dessen die Rückgabe auf bestimmte Kategorien reduziert werden kann. |
| platform | string | Schreiben | Pflichtfeld! Es können stets nur Kategorien von einem Portal abgerufen werden. Accountunabhängige unterstützte Portale sind: "auvito", "dt24", "ebay", "hood", "kaufland" und "yatego". Eigene Portale: "epages" und "shop"(ext. Lister Shop) |
| 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). |
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) |
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", "kaufland" und "yatego". Eigene Portale: "epages" 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). |
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. |
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 ">". |
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. |
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. |
Eine Währung (z.B. Euro oder US-Dollar ).
| Name | Datentyp | Status | Beschreibung |
|---|---|---|---|
| id | string(2) | Lesen, Primärschlüssel | Die zweistellige Landabkürzung nach ISO 3166-1 alpha-2 |
| iso3 | string(3) | Lesen, Primärschlüssel | Die dreistellige Bezeichnung des Landes nach ISO 3166-1 alpha-3. |
| name | array | Lesen | Die Bezeichnungen des Landes in Deutsch, Englisch und anderen Sprachen. |
| ->de[] | array_of_string | Lesen | Eine Liste aus deutschen Bezeichnungen für das Land. |
| ->en[] | array_of_string | Lesen | Eine Liste aus englischen Bezeichnungen für das Land. |
| ->other[] | array_of_string | Lesen | Eine Liste weiterer Bezeichnungen für das Land. |
| is_europe | bool | Lesen | Gibt an, ob das Land in Europa liegt. |
| is_eu | bool | Lesen | Gibt an, ob das Land in der Europäischen Union liegt. |
Das Filter Objekt für den "GET country/"-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 |
|---|---|---|---|
| iso2[] | array_of_Operator_filter_type<string> | Schreiben | Hierüber kann nach der zweistelligegen Land-ID gefiltert werden. |
| iso3[] | array_of_Operator_filter_type<string> | Schreiben | Hierüber kann nach der dreistelligegen Land-ID gefiltert werden. |
| name[] | array_of_Operator_filter_type<string> | Schreiben | Hierüber kann nach der Bezeichnung gesucht werden (keine Einschränkung der Sprache möglich). |
| is_europe | bool | Schreiben | Hierüber kann nach europäischer Zugehörigkeit gefiltert werden. |
| is_eu | bool | Schreiben | Hierüber kann nach Zugehörigkeit zur Europäischen Union gefiltert werden. |
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."
Ein Namensdatensatz (mit Geschlechtswahrscheinlichkeit in Abhängigkeit vom Land).
| Name | Datentyp | Status | Beschreibung |
|---|---|---|---|
| id | string | Lesen, Primärschlüssel | Der Name ggfls. mit Landcodezusatz. z.B. "Peter_DE" oder nur "Peter" (dann weltweite Suche) |
| name | string | Lesen | Der Name. |
| country_iso2 | string(2) | Lesen | Das Land für das der Datensatz gilt. |
| gender | string | Lesen | Das wahrscheinlichste Geschlecht. |
| probability | integer | Lesen | Gibt an, zu wieviel Prozent "gender" dem Geschlecht bei Stichproben entsprach. |
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, Schreiben, 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). |
| 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 | string(3) | 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. |
| 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 | date | 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). |
| ->link[] | array_of_string | Lesen | Der Sendungsverfolgungslink der sich aus deliverer und code ergibt (die Sprache variiert mit language Headern). |
| ->method | string | Lesen, Schreiben | Die Versandmethode. |
| ->address | Order_address_type | Lesen, Schreiben | Die Lieferadresse. |
| ->platform_status | string | Lesen, Schreiben | Der Status der Versandstatusübermittlung ans Portal (z.B.: Konnte an eBay mitgeteilt werden, dass das Paket versendet wurde?). Mögliche Werte sind: "ok", "partially_ok", "error". |
| ->amazon_fba | array | Lesen | Informationen zum Amazon FBA-Center aus dem die Ware versendet wurde. |
| ->country_iso2 | string(2) | Lesen | Der zweistellige Ländercode des Landes aus dem die Ware durch Amazon versendet wurde. |
| ->center_id | string(4) | Lesen | Das Kürzel des Amazon-FBA-Centers aus dem die Ware durch Amazon versendet wurde. |
| 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, Schreiben | Bezahlt? Kann nur beim Neuanlegen übermittelt werden. Um einen Auftrag nachträglich als bezahlt zu markieren ist paid_amount zu setzen. |
| ->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. |
| bill_date | date | Lesen | Sobald ein Auftrag bezahlt, oder die Rechnung gedruckt wurde, erhält der Auftrag eine Rechnungsnummer. Dieses Feld gibt das Datum an, zu dem das passiert ist. |
| add_field[] | array_of_array_of_string | Lesen, Schreiben | In diesem Feld stehen die Auftragszusatzfelder die per Custom Feature hinzugebucht werden können. |
| web_link_id | string | Lesen | Diese ID kann verwendet werden um folgende HTML-Links zu generieren: - Rechnung (https://www.dreamrobot.de/ol_bill.php?urid={web_link_id} - Lieferschein (https://www.dreamrobot.de/ol_deln.php?urid={web_link_id} - Angebot (https://www.dreamrobot.de/ol_offer.php?urid={web_link_id} - Auftragsbestätigung (https://www.dreamrobot.de/ol_order.php?urid={web_link_id} - Mahnung (https://www.dreamrobot.de/ol_reminder.php?urid={web_link_id}) |
| external_order_id | string | Lesen, Schreiben | In diesem Feld steht für manche Portale, z.B. Amazon oder eBay (eBay erst, wenn die Kaufabwicklung abgeschlossen) die externe Referenz ID. |
| credit | array | Lesen, Schreiben | Dieser Container enthält die Gutschrift-Referenzen. |
| ->sub_id[] | array_of_string | Lesen, Fremdschlüssel | Die Liste aller order_id's von Gutschriften die aus diesem Auftrag heraus erzeugt wurden. Wenn aus diesem Auftrag keine Gutschriften erstellt wurden, bleibt die Liste leer. |
| ->main_id | string | Lesen, Schreiben, Fremdschlüssel | Die order_id des Auftrags aus dem diese Gutschrift erstellt wurde. Wenn dieser Auftrag keine Gutschrift ist, bleibt dieses Feld leer. |
| return | array | Lesen | Dieser Container enthält Informationen zur Retoure. |
| ->label_id | string | Lesen, Schreiben, Fremdschlüssel | Die ID des eventuell angeforderten Retourenlabels (zunächst nur für Otto). |
| ->carrier | string | Lesen, Schreiben | Die Bezeichnung des Lieferanten für die Retoure. |
| 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/"). |
| 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. |
| payment_instructions | string | Lesen, Schreiben | Hier können Zahlungshinweise ergänzt werden, welche über den Platzhalter "#pui_note#" in der Rechnungsvorlage eingefügt werden können. |
| payment_transaction_id | string | Lesen, Schreiben, Fremdschlüssel | Hier kann die ID zur Zahlart hinterlegt werden (z.B.: PayPal Transaktions-ID). |
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). |
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. Kaufland.de) oder nur in der ersten Position "order->line[0]->transaction_id (z.B. ePages Flex). |
| stock_align_id | string | Lesen, Schreiben, Fremdschlüssel | Die Lagerabgleichs ID des Lagerartikels (z.B. stock->id, stock->sku, stock->barcode). |
| external_id | string | Lesen, Schreiben, Fremdschlüssel | Die Positions-ID im externen Verkaufs-Portal |
| stock_sku | string | Lesen | Falls das Custom Feature "Lagerartikelnummer im Auftrag" aktiviert ist, wird in diesem Feld die Artikelnummer des verknüpften Lagerartikels (stock_align_id) notiert. Dies ist besonders hilfreich, falls die Artikelnummer für eBay- oder Kaufland.de benötigt wird, bei diesen Portalen ist die SKU ansonsten nicht im Auftragsdatensatz enthalten. |
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.)
Ohne explizite Angabe eines Auftragsfilters schaut die API 1 Monat zurück und liefert max. 20 Einträge auf der ersten Seite.
Sie können dieses Verhalten ändern, indem Sie "pagination" und "filter" nutzen.
Abhängig von Ihrer Anforderung können sie unterschiedlich mit dem Filter arbeiten.
Die Auftragssuche ist leider etwas kompliziert - es gibt 3 grundlegend verschiedene Techniken um Aufträge zu filtern:
1.: Standardsuche mit filter->date->from und filter->date->to
-> Der maximale Zeitraum beträgt 3 Monate
-> Es werden pagination->page und pagination->limit verwendet
-> Wenn keine anderen Angaben gemacht werden (siehe 2. oder 3.) dann wird automatischer dieser Modus mit filter->date->from ~ "heute vor 1 Monat" und filter->date->to ~ "Heute" verwendet.
2.: Direktzugriff per ID (oder mehreren IDs)
-> filter->modified_since und filter->id arbeiten nach diesem Konzept - Es wird gezielt auf die angegeben Datensätze zugegriffen.
-> Keine Einschränkung nach Erstellungszeitraum.
-> Es werden pagination->page und pagination->limit verwendet
3.: "min_id" als Alternative zur Seitenfunktion.
-> Wenn weder filter->date noch filter->modified_since angegeben wurden, kann pagination->page durch pagination->min_id ausgetauscht werden (über pagination->limit kann weiterhin die maximale Anzahl Datensätze definiert werden)
-> Beste Performance, aber am wenigsten intuitiv
-> Es kann (aktuell) maximal 6 Jahre in die Vergangenheit geschaut werden. (kein Limit auf 3 Monate)
-> Weitere Infos unter Pagination_type->min_id
-> Sie können mit einer pseudo min_id wie z.B. "0_2020_01" starten, um alle Aufträge seit Januar 2020 abzurufen.
| 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. |
| number[] | array_of_Operator_filter_type<integer> | Schreiben | Enthält eine Liste aller Auftragsnummern die selektiert werden sollen. Da Auftragsnummern mehrfach vergeben sein können, kann das Ergebnis entsprechend auch mehrere Aufträge pro Nummer enthalten. (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. |
| portal_account_id[] | array_of_Operator_filter_type<integer> | Schreiben | Filter mit Operator für den Portal-Account |
| invoice_number[] | array_of_Operator_filter_type<integer> | Schreiben | Filter mit Operator für die Rechnungsnummer |
| infos[] | array_of_Operator_filter_type<string> | Schreiben | Filter mit Operator für "infos". |
| pack_infos[] | array_of_Operator_filter_type<string> | Schreiben | Filter mit Operator für "pack_infos". |
| 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. |
| ->comment[] | array_of_Operator_filter_type<string> | Schreiben | Filter mit Operator für "comment". |
| ->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_fully_paid | bool | Schreiben | vollständig bezahlt (der bezahlte Betrag ist gleich oder höher als Rechnungsbetrag inkl. Versandkosten). |
| ->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) |
| history[] | array_of_Operator_filter_type<string> | Schreiben | Filter mit Operator für "history". |
| modified_since | datetime | Schreiben | Liefert alle Aufträge die seit der Sekunde geändert/erstellt 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. |
| platform[] | array_of_Operator_filter_type<string> | Schreiben | Filter mit Operator für "platform". |
| payment_method_id[] | array_of_Operator_filter_type<string> | Schreiben | Filter mit Operator für "payment_method_id". Achtung: Nur Un- und/oder Gleichheitsprüfung möglich. (!= / =) |
| external_order_id[] | array_of_Operator_filter_type<string> | Schreiben | Wenn der Filter angegeben wurde, werden nur Aufträge selektiert, deren hidden_infos identisch zu dem übergebenen Wert sind. |
| credit | array | Schreiben | Gutschriftenfilter |
| ->main_id[] | array_of_Operator_filter_type<string> | Schreiben | Filter für die Ursprungs-Order-ID. |
| ->sub_id[] | array_of_Operator_filter_type<string> | Schreiben | Filter für die enthaltenen Order-IDs (diese sind intern Komma-getrennt gespeichert, falls es mehrere sind und darauf wird der Filter angewandt). |
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. |
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.
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. |
| shipping_service | string | Schreiben | Nur wenn es sich um einen Amazon Auftrag handelt, wird dieses Feld als Versandoption an Amazon übergeben. Falls der Wert "amazon_prime" übergeben wird, findet für einen Amazonauftrag keine Versandstatusbestätigung statt, da Amazon bereits durch das Anfordern eines Prime-Etiketts erfährt, dass der Auftrag versendet wird. |
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, Artikelnummer(druck_pseudonym) oder auch Herstellernummer ensprechend mit "ID_", "EAN_" "SKU_" oder "MPN_" vorangestellt übergeben werden. Dies gilt für alle Stellen, an denen eine/mehrere "stock_id" übergeben werden soll/-en (Außer id Filter für GET stock/). |
| 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. In % |
| 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. |
| ->id[] | array_of_string | Lesen, Schreiben | Eine Liste aller hinterlegten Lagerbilder (einschließlich derer, die (noch) nicht ausgewählt sind. Beim create/update können Bilder angelegt werden |
| ->delete_id[] | array_of_string | Schreiben | Löscht die angegebenen URLs aus dem Lagerartikel wenn sie in keinem Portal mehr verknüpft sind. |
| ->is_upload_to_drive | bool | Schreiben | Gibt an ob die übertragenen stock->picture->id[] ans Drive weitergeleitet werden sollen. |
| location | array | Lesen, Schreiben | Verschiede Felder die sich auf den Lager-Ort beziehen. |
| ->area | text | Lesen, Schreiben | Der Lagerort. |
| ->field | text | Lesen, Schreiben | Das Lagerfach. |
| ->is_fullfilment | bool | Lesen, Schreiben | Ist "Fulfillment" aktiviert? Also, liegt die Ware nicht im eigenen Lager?. |
| economic_operator | array | Lesen | Verschiede Felder die sich auf den Wirtschaftsakteur beziehen. |
| ->name | string | Lesen | Die Händlernummer. |
| ->street | string | Lesen | Die Artikelnummer vom Händler. |
| ->postcode | string | Lesen | Der Einkaufspreis. |
| ->city | string | Lesen | Der Einkaufspreis. |
| ->country | string | Lesen | Der Einkaufspreis. |
| ->phone | string | Lesen | Der Einkaufspreis. |
| string | Lesen | Der Einkaufspreis. | |
| ->web_url | string | Lesen | Der Einkaufspreis. |
| 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. |
| ->yatego | Stock_cia_portal_type | Lesen, Schreiben | Der PüMa Status für Yatego. |
| ->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 Kaufland.de. |
| ->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 | Wenn type="sub", dann sind hier die einzelnen Sets aufgelistet und wie oft in denen dieser Set-Artikel Bestandteil ist. |
| hitmeister | Stock_kaufland_type | Lesen, Schreiben | Enthält die Kaufland.de 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. |
| 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 |
| class | string | Lesen, Schreiben | Enthält die Klassifizierung (DR Pack App). |
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. |
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, Schreiben | Der Zeitpunkt zu dem die Überweisung durchgeführt wurde. |
| sender | string | Lesen, Schreiben | Der Absender der Überweisung. |
| subject | string | Lesen, Schreiben | 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, Schreiben | Der Überweisungsbetrag. |
| status | string | Lesen | Bei Paypalzahlungen ein Hinweis zum aktuellen Status. |
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) |
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. |
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 nur für Amazon und für Eventhandler 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. |
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).) |
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. |
Die Lager Kaufland.de 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". Alternativ kann die Lieferzeit auch im Format "X-Y" angegeben werden wobei dann gilt "X bis Y Tage". |
| ean | string | Lesen, Schreiben | EAN oder ISBN. Im falle von ISBN muss "isbn:" vorangestellt werden. |
| category_id | string | Lesen, Schreiben | Die Kaufland.de-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 | Der Kaufland.de Versandgruppen Name (wird automatisch dem entsprechenden Portalaccount zugeordnet.). |
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?. |
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. |
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. |
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!). |
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. |
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. |
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. |
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), 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_featured_plus | bool | Lesen, Schreiben | Top-Angebot in Kategorie und Suche? |
| ->is_homepage_featured | bool | Lesen, Schreiben | Top-Angebot auf der Startseite? |
| ->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 | Gibt an, wann das Angebot gestartet werden soll. Intern wird nicht das Datum gespeichert, sondern die Differenz zum aktuellen Datum. Daher wäre als Übergabe z.B. "+5days 09:15pm" verständlicher. (Ein korrektes Datum funktioniert aber auch). |
| 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) |
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.). |
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. |
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_featured_plus | bool | Lesen, Schreiben | Top-Angebot in Kategorie und Suche? |
| ->is_homepage_featured | bool | Lesen, Schreiben | Top-Angebot auf der Startseite? |
| ->is_top_gallery | bool | Lesen, Schreiben | Top-Angebot in Gallerie? |
| ->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 | Gibt an, wann das Angebot gestartet werden soll. Intern wird nicht das Datum gespeichert, sondern die Differenz zum aktuellen Datum. Daher wäre als Übergabe z.B. "+5days 09:15pm" verständlicher. (Ein korrektes Datum funktioniert aber auch). |
| 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)? |
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? |
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? |
Ein lager_app Datensatz.
| Name | Datentyp | Status | Beschreibung |
|---|---|---|---|
| is_update | bool | Schreiben | Über dieses Feld kann angegeben werden, dass die übergebene "data"-Struktur in die bestehende Struktur integriert werden soll. Neue Werte überschreiben dabei alte Werte - Werte die nicht aufgeführt sind bleiben unangetastet. |
| data | mixed | Lesen, Schreiben | Beliebige Datenstruktur. Soll Apps dazu dienen, App-/ und Artikelspezifische Daten zu speichern. Der Speicher kann auf Anfrage für Ihre App freigeschaltet werden. Für Updates siehe Feld "is_update". |
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 Ordner zu filtern (stock->folder). |
| drwebshop | array | Schreiben | Enthält Felder um nach drwebshopfeldern zu suchen. Wenn (noch) kein Shopdatensatz angelegt wurde, wird eine Suche immer negativ sein (auch bei "gleich Leerstring" o.ä.) |
| ->shop_id[] | array_of_Operator_filter_type<integer> | Schreiben | Filter für die im Datensatz hinterlegte Shop-ID. |
| ->price[] | array_of_Stock_drwebshop_price_type | Schreiben | Operator_filter für die Webshop Preise - im Stock_drwebshop_price_type ist "net" Operator_filter_type |
| ->special | array | Schreiben | Sonderaktionsfilter |
| ->is_active | bool | Schreiben | Filter Sonderaktion aktiv? |
| amazon | array | Schreiben | Enthält Felder um nach Amazonfeldern zu suchen. |
| ->sku[] | array_of_Operator_filter_type<string> | Schreiben | Filter für Amazon-SKU (wie auch AMZSKU_XXXXXXXXX als stock_id). |
| ->id[] | array_of_Operator_filter_type<string> | Schreiben | Filter für die Amazon-ID (sollte sinnvollerweise zsm. mit filter->amazon->id_type verwendet werden). |
| ->id_type[] | array_of_Operator_filter_type<string> | Schreiben | Filter für den Amazon-ID-Typ |
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.) |
Der Stock_history-Filter anhand dessen Lagerbewegungen gesucht werden können. ("ODER"-Bedingungen können durch mehrere Filter abgebildet werden.)
| Name | Datentyp | Status | Beschreibung |
|---|---|---|---|
| stock_id[] | array_of_Operator_filter_type<string> | Schreiben | Eine Operator_filter_type Liste um Lagernummern oder Bereiche zu filtern - wenn der Endpunkt GET stock/{stock_id}/history/ statt GET stock/history/ verwendet wird, dann ist die entsprechende Lagernummer automatisch enthalten. Siehe Außerdem Beschreibung von Stock_type->id um evtl. alternative Schreibweisen für die Filterung zu nutzen. |
| order_id[] | array_of_string | Schreiben | Es können ein oder mehrere Aufträge referenziert werden um auf deren Bewegungen zu filtern. |
| date[] | array_of_Operator_filter_type<datetime> | Schreiben | Über diesen Filter kann der Zeitraum der Bewegungen eingeschränkt werden |
Eine (von mehreren) Lagerbewegungen.
| Name | Datentyp | Status | Beschreibung |
|---|---|---|---|
| internal_id | integer | Lesen, Primärschlüssel, automatisch generiert | Die interne ID der Lagerbewegung. |
| person_id | integer | Lesen, Fremdschlüssel | Wenn die Lagerbegung durch einen Benutzer ausgelöst wurde, wird die ID des DR Benutzers hier vermerkt. |
| movement_date | datetime | Lesen | Der Zeitpunkt zu dem sich die Lagermenge geändert hat.) |
| stock_id | integer | Lesen, Fremdschlüssel | Die Lagernummer des Artikels auf den sich die Lagerbewegung bezieht. |
| quantity | array | Lesen | Mengeninformationen zur Bewegung |
| ->old | integer | Lesen | Die alte Lagermenge. |
| ->difference | integer | Lesen | Der Unterschied der Lagermenge von vorher zu nacher. |
| ->new | integer | Lesen | Die neue Lagermenge. |
| order_id | string | Lesen, Fremdschlüssel | Falls die Lagerbewegung über einen Auftrag ausgelöst wurde (zum Beispiel weil der Artikel verkauft wurde) dann wird in diesem Feld die order_id zum Auftrag angegeben. |
| title | string | Lesen | Eine lesbare Bezeichnung des Bereichs in DR über den die Lagerbewegung ausgelöst wurde. |
| is_error | bool | Lesen | Gibt an ob die Lagerbewegung fehlerhaft ist (z.B. Die angegebenen Mengen sind ungültig oder das Ändern der Menge in der Datenbank ist fehlgeschlagen.). |
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. |
| kaufland[] | array_of_Stock_portal_upload_portal_type | Schreiben | Ein Kaufland.de-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. |
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. |
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.) |
| logo | string | Schreiben | Für "action" "list": In diesem Feld kann der Wert "responsive" angegeben werden, um beim Einstellen ein kleineres Logo ohne Text zu verwenden. Wird das Feld weggelassen, wird die Option "standard" verwendet. |
| 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 | Für "action" "revise": Ein Verweis auf die "Lister_eingestellt"-Tabelle. Entweder über deren ID oder, einfach über die eBay ItemId mit "EBAY_" vorangestellt. Z.B.: "EBAY_291813522065" |
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). |
Der Filter anhand dessen Shop-Parameter gesucht werden können. ("ODER"-Bedingungen können durch mehrere Filter abgebildet werden.)
| Name | Datentyp | Status | Beschreibung |
|---|---|---|---|
| id[] | array_of_Operator_filter_type<integer> | Schreiben | Ein Parameter-ID Filter. |
| type | string | Schreiben | Pflichtfeld! Es können stets nur Parameter von einem Typ gefiltert werden. Unterstützte Typen sind: "tax_class" und "manufacturer" |
| 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). |
Ein Shop-Parameter (z.B. Hersteller oder Mehrwertsteuer).
| Name | Datentyp | Status | Beschreibung |
|---|---|---|---|
| type | string | Lesen, Schreiben, Primärschlüssel | Pflichtfeld! Es können stets nur Parameter von einem Typ verarbeitet werden. Unterstützte Typen sind: "tax_class" und "manufacturer". |
| id | integer | Lesen, Schreiben, Primärschlüssel | Die Parameter ID. |
| portal_account_id | Portal_account_id_type | Lesen, Schreiben, Primärschlüssel | Der Portalaccount (Jeder Portalaccount hat seine eigenen Parameter). |
| name | string | Lesen, Schreiben | Der Name des Parameters. |
| additional | string | Lesen, Schreiben | Zusätzliche Informationen (nach einem festen Schema). |
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 |
|---|---|---|---|
| id[] | array_of_Operator_filter_type<string> | Schreiben | Enthält eine Liste der Kunden ID's auf die gefiltert werden sollen. |
| internal_id[] | array_of_Operator_filter_type<integer> | Schreiben | Enthält eine Liste der internen 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). |
Ein Eventhandler definiert Reaktionsregeln auf je einen Eventtypen.
| Name | Datentyp | Status | Beschreibung |
|---|---|---|---|
| id | integer | Lesen, automatisch generiert | Die veränderbare Kunden ID (customer_id). |
| internal_id | integer | Lesen, Primärschlüssel, automatisch generiert | Die DR interne Kunden-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. |
| string | Lesen | Die Emailadresse. | |
| sales | decimal | Lesen | Der mit dem Kunden erzielte Umsatz. |
| ->amount | decimal | Lesen | Der mit dem Kunden erzielte Umsatz Betrag. |
| ->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). |
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 Wert mit dem verglichen wird. |
| ->field | string | Lesen, Schreiben | Das Feld im Section-Modulobjekt Das verglichen wird. |
| is_active | bool | Lesen | Gibt an ob der Handler derzeit aktiv ist, oder nicht. |
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. |
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 | Gibt an, ob dieser Portalaccount der Standardportalaccount für den verwendeten Zugang ist (wird dann verwendet, falls nicht seperat definiert). |
| 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). |
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 Gruppierungs ID. |
| ships_to | array | Lesen | Die gültigen Versandländer. |
| ->worldwide | bool | Lesen | Weltweit (Alle Länder). |
| ->europe | bool | Lesen | Europa |
| ->eu | bool | Lesen | EU (Europäische Union) |
| ->germany | bool | Lesen | Deutschland |
| ->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). |
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. |
| created | date | Lesen | Das Registrierungsdatum des Accounts. |
| is_banking_active | bool | Lesen | If the requesting client has bank-scope, this field returns whether the account has activated the bankmodule or not. |
| settings | mixed | Lesen, Schreiben | In diesem Feld können Clients Einstellungen speichern (sodass sie von DR ausgewertet werden können). |
| string | Lesen | Emailadresse des Accounts (benötigt "email_r"-Scope). | |
| address | Order_address_type | Lesen | Die Handelsadresse des Accounts; "name" enthält die Firmenbezeichnung und "name_2" den Ansprechpartner (benötigt "account_address_r"-Scope). |
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 | Falls "section" den Wert "stock_lister" hat, wird über dieses Feld die zugehörige Lagernummer angegeben. |
| 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. |
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. |
| Version | Änderungen |
|---|---|
| v1.1.23 |
|
| v1.1.22 |
|
| v1.1.21 |
|
| v1.1.20 |
|
| v1.1.19 |
|
| v1.1.18 |
|
| v1.1.17 |
|
| v1.1.16 |
|
| v1.1.15 |
|
| v1.1.14 |
|
| v1.1.13 |
|
| v1.1.12 |
|
| v1.1.11 |
|
| v1.1.10 |
|
| v1.1.9 |
|
| v1.1.8 |
|
| v1.1.7 |
|
| v1.1.6 |
|
| v1.1.5 |
|
| v1.1.3 |
|
| v1.1.2 |
|
| v1.1.1 |
|
| v1.1 |
|
| v1.0.2 |
|
| v1.0 |
|
| v0.6 |
|
| v0.5 |
|