Table of Contents

1. REST API Overview

Why a REST API?

  • Because an API is required to combine and suplement the tasks in XML, Export, Shop and SOAP interfaces.
  • Because they are platform-neutral.
  • Because they offer an easy expandability.
  • Because they are easy to understand and link to.

Who should use the REST API?

Anyone working with DreamRobot and would like to automate even more processes in their online order management account. From here on out, the DR customer will be referred to "User" and will be connected to third-party software (referred to as "Client"), with which our customers would like to use DR.

What can the REST API do?

The goal of the REST API is to add features to existing interfaces on a long-term basis. Currently, the REST API can perform the following tasks:
  • Stock / Lister Management: create Stock and Lister data, revise, delete and trigger your Cross-Channel Inventory Adjustments (CIA) online (incl. variants, sets and all shop/portal tables).
  • Order Management: create orders, update, delete, set various order status (i.e. Checkout complete? Paid? Packed? Etc.)

2. Setting up an API Client

The Client hast to execute HTTPS Requests in order to communicate with the API.

The PHP Client

To give you an example of how the queries look, you can click Download-Archiv and find a PHP example for every API-Call in the "Examples" folder. Access information and various IDs can be set up in "settings.inc.php".

The Client on a non-PHP Platform

For the API, the following parameters will help you set you HTTPS queries (also considered: "settings.inc.php"): :
  • The URL:
    • Token Query: "https://api.dreamrobot.de/rest/v1.1/token.php".
    • Resource Query: "https://api.dreamrobot.de/rest/v1.1/{endpoint thread}/".

  • The Request Method:
    The API supports: "GET", "POST", "DELETE" (and "OPTIONS").

  • The Header:
    • Token Header: "Authorization: Basic {User,Colon,Password -> as Base64}"
    • Resource Header: "Authorization: Bearer {AccessToken}"
    In addition, "Content-type", "Accept" and "Accept-Charset" are possible. Per default, JSON und UTF-8 will also be accepted and each XML and ISO-8859-15 are also possible.

  • The Data Query:
    Data relevant to the Headers comes as JSON or XML in the body of the query. (In GET Queries, a "?" will be attached to the URL.)

3. Using the REST API

The OAuth2-Authentication

The User Authentication (Only for DreamRobot Customers)

Important: The following authentication description only works for DreamRobot Customers/Users!!

Once you have requested your acces codes from the DreamRobot Support Team, send "POST https://api.dreamrobot.de/rest/v1.1/token.php" with the Data "grant_type=client_credentials" and the Token Header. You will receive an access token that is valid for one hour.
With this token, you have sufficient time to perform your resource queries.
If the token expires, simply generate a new one.

The Client Authentication (only for third-party software)

Important: The following authentication description only works for third-party software (i.e. when you would like to link your online shop to your warehouse management software).

Once you have received your Credentials, and created a testaccount, the authentication goes like this:
  1. Direct your users to https://api.dreamrobot.de/rest/v1.1/authorize.php?response_type=code&client_id={client_id}&state={ihre_user_id}&scope={scope}: That is where DR Users log in. Have them grant you access, and possible assign you a unique portal account, and confirm the selection.
  2. Change the "code" (Authentication Code) that you received via the redirect_url on file (i.e. in Example "02.0-Client-Authorization-authorization_code.php" for a Refresh Token). When the query successful is, you will see the Refresh Token (access) and the Scope in the reply.
  3. Like in Example "03.0-Client-Authorization-AccessToken.php", a new Access Token (and a new Refresh Token) can be requested via a Refresh Token: "POST https://api.dreamrobot.de/rest/v1.1/token.php" with the POST-Data "grant_type=refresh_token" and "refresh_token={RefreshToken}". A Refresh Token is valid for one month, or until a new Access/Refresh Token Combination has been requested.

The API Endpoints

You can use the Endpoints with the Access Token. A subset of the "CRUD" Functions are available for all endpoints. The four letters of the acronym will hereinafter illustrate the examples of the Order-Endpoints:
  1. Create: Create an Order. A POST Query without ID (i.e. "Post order/")
  2. Read: Request one or more orders. A GET Query with or without ID
    (i.e. "GET order/{order_id}/", for the order with an ID or "GET order/" to search for an order.
    Filter and Select parameters (Select also possible via GET with ID) can also be specified which records are searched (Filter) and which fields of the filtered data should be displayed (Select). We recommend to always use well-thought-out Select and Filter parameters.
  3. Update: Revise an Order. A POST Query with ID
    (i.e. "POST order/{order_id/"(update).
  4. Delete): Delete an Order A DELETE Query with ID (i.e. "DELETE order/{order_id}/")
  5. It is also possible to send an "OPTIONS" Query to all endpoints. This offers an overview of all possible endpoint methods (including objects and version changes).
Below is a complete list of the endpoints in the point Endpoints/Functions. You will find which parameters accept which functions and which values are returned. With only a few exceptions, all fields, except the ID, are optional.

4. HTTP Codes

Every query will be replied to by the API in a HTTP-Status Code. Errors will be accom-panied with an additional "error_description". The most common HTTP Codes are listed here

Code Status Description
200 Success The query has be processed successfully.
201 Created The record has been successfully created. Please find the ID of the new record in the reply.
202 Accepted The query has been accepted. It has been placed on a waiting list and has not been processed, yet.
207 Multi-Status The query is very complex and contains several individual queries that re-quire their own response. The query will be carried out. The status of the individual sub-requests is in response[] (e.g. Multistatus_type).
300 Multiple Choice The query does(n't) contain an ID, whereby several records can be found.
400 Bad Request The Standard Error Code: The query is not correct because of a variety of reasons and could not be processed. No data has been changed.
401 Unauthorized An error has occurred regarding the authentication process.
403 Forbidden Authentication worked. However, the necessary rights are not granted for this Access Token used to carry out the requested command. If you would like to proceed with this query, please contact the authorized user. As a User, you can activate your Client Access (Refresh Tokens) under "Admin->MyAccount->REST API"
404 Not Found Either the Object with the given ID or an included Object with that given ID cannot be found.
405 Method Not Allowed You have been authenticated, and have used a correct endpoint, but the HTTP Method isn't supported. Often, there is only POST or GET. You can take a look at Documentation or read about the HTTP Method "OPTIONS".
429 Too Many Requests Depending on your tariff, you have a limited number of calls. Please note that only one call can be processed at a time.
500 Internal Server Error A critical error has occurred. There can be a variety reasons:
  • The Skript was unexpectedly interupted.
  • An unexpected error occurred in the database query
  • etc.
IMPORTANT: It is possible that the query could only be partially processed, resulting in an inconsistency in the data.
501 Not Implemented This query method is currently in planning by our programmer, but hasn't been built into the system, yet.

5. Endpoint/Function

In the following table, you will field all of the functions that can be queried via the API. In addition to the listed fields in the column "Request" the field "portal_account_id" is always valid in order for the global fallback Portal Account ID to overwrite the default ID. You'll find detailed information about this field under Portal_account_id_type.

Module Rest-path Method Request Response Description
Field Name Data Type Field Name Data Type
Token token.php POST grant_type string access_token string(160) Request an Access Token.
code / refresh_token string expires int
scope string
refresh_token string(160)
System system/currency/ GET currency array_of_ System_currency_type Request all currency used in DR
system/currency/​{currency_id}/ GET currency System_currency_type Get DR currency
system/payment_method/ GET payment_method array_of_ Payment_method_type Alle Zahlungsarten abrufen.
system/stock/condition/ GET condition array_of_ Stock_condition_type Request all possible Stockconditions.
system/stock/description/icon/ GET icon_id array_of_ string Request valid values for the description->icon_id
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 Search for Order.
filter array_of_ Order_filter_type
pagination Pagination_type
POST order Order_type order_id string Create an Order
order/​{order_id}/ GET select Select_type order Order_type Request an Order.
POST order Order_type order_id string Edit an Order
DELETE Delete an Order.
order/​{order_id}/history/ GET history array_of_ string Request the Complete History.
POST text string Add an entry into the order history.
order/​{order_id}/send_mit/ POST send_mit Order_send_mit_type Mark order sent (in portal) and send Merchandise-in-Transit-Mail.
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 Search for several items in stock.
filter array_of_ Stock_filter_type
pagination Pagination_type
POST stock Stock_type stock_id integer Request a Stock Record.
lister_id array_of_ integer
stock/​{stock_id}/ GET select Select_type stock Stock_type Request Item in Stock
POST stock Stock_type stock_id integer Edit an Item in Stock
lister_id array_of_ integer
DELETE Delete an Item in Stock.
stock/​{stock_id}/cia/ POST stock_id integer Trigger CIA for an Item in Stock.
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 Request all descriptions for the stock item.
POST description Stock_description_type description_id integer Create a stock description for the requested item in stock.
stock/​{stock_id}/description/​{description_id}/ GET description Stock_description_type Request a Stock Description
POST description Stock_description_type description_id integer Edit a Stock Description
DELETE Delete a Stock Description.
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 Retrieve all Portal Accounts.
admin/portal_account/​{portal_account_id}/ GET portal_account Admin_portal_account_type Request a Portal Account. Mit "default" wird der Standardportalaccount abgerufen.
admin/shipping_group/ GET shipping_group array_of_ Admin_shipping_group_type Retrieve all Shipping Groups.
admin/shipping_group/​{shipping_group_id}/ GET shipping_group Admin_shipping_group_type Request a Shipping Group.
admin/user/ GET user Admin_user_type Request information about the REST API
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.

6. API Object

API Object Table of Contents


Error_type:

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

name Data Type Status Description
error string Lesen The errorstring ID.
description text Lesen Detailed errorstring with description.
code int(3) Lesen The HTTP Code that is generated due to the error.

Warning_type:

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

name Data Type Status Description
warning string Lesen The short currency string ID
description text Lesen A comprehensive warning notification with a detailed description.
code int(3) Lesen The HTTP Code through which the warnining is generated.

Operator_filter_type:

When a filter not onlies verify similarities, but also further operators, use the operator Operator_filter_type.
Ü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 Data Type Status Description
value[] array_of_mixed Schreiben The value that will be compared with the value in the databank via the Operator.
operator string(2) Schreiben The operator via which the value is compared. The standard operator is "=". Possible operators are: "<", "<=", ">", ">=", "=", "!=", "~" (like), "!~" (not like). The actual possible operators are dependent on the filter field. When using the "~"- or "!~" operator, you can use a star ("*") in value as a wild card. To search for the star character, escape with a "\". (i.e. Value "12*" finds all entries that begin with "12". "12\*" finds all entries that have exactly the value "12*")

System_currency_type:

A Currency (i.e. Euro or US Dollar)

name Data Type Status Description
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 The internal DR ID of the currency.

Payment_method_type:

Eine Zahlungsart.

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

Stock_condition_type:

The Condition (of an item in stock)

name Data Type Status Description
id integer Lesen, Primärschlüssel, automatisch generiert The ID of the item's condition. Key for stock->condition_id and stock->drwebshop[]->condition_id.
description string Lesen, automatisch generiert A very brief description to describe which item condition of the condition type stands for which ID.

Category_filter_type:

Der Category-Filter anhand dessen Lagerartikel gesucht werden können. ("ODER"-Conditions can be displayed via several filters)

name Data Type Status Description
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).

Pagination_type:

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

name Data Type Status Description
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 The number of entries per page (Standard is 20, Maximum is 200)

Category_type:

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

name Data Type Status Description
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).

System_event_action_type:

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

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

System_event_condition_type:

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

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

System_event_type_type:

Ein möglicher Eventauslöser.

name Data Type Status Description
section string Lesen Der betroffene Bereich in DR (~Modul)
type string Lesen, Primärschlüssel Die Eventauslöser ID.

System_scope_type:

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

name Data Type Status Description
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.

System_country_type:

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

name Data Type Status Description
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.

Country_filter_type:

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"-Conditions can be displayed via several filters)

name Data Type Status Description
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.

Select_type:

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

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


System_gender_type:

Ein Namensdatensatz (mit Geschlechtswahrscheinlichkeit in Abhängigkeit vom Land).

name Data Type Status Description
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.

Order_type:

A purchase/order/invoice

name Data Type Status Description
id string Lesen, Primärschlüssel, automatisch generiert The Order ID consists of the "Order Number," "Year" (4-digit) and "Month" (2-digit) and connected via an underscore.
portal_account_id Portal_account_id_type Lesen, Fremdschlüssel Every order is linked to a portal account. Orders can only be read or edited when the user authorization for the account--or the overall account--has been approved.
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 The invoice number for the IRS/Tax Authority (NOT the internal order number).
platform string Lesen, Schreiben, Fremdschlüssel The Platform/Portal ID will be generated on each order. Naturally, this cannot be changed afterwards.
history[] array_of_string Lesen, Schreiben, automatisch generiert The Order History (via "GET/POST order(order_id)/history", the entries can be read or edited.
infos text Lesen, Schreiben Notes from the seller
pack_infos text Lesen, Schreiben Ein Feld für externe Software, um Informationen zum Packzustand zu vermerken (z.B. Pick-/Packstation oder Dienstleister).
hidden_infos text Lesen, Schreiben A comment field for external software. The comment will not be used in DR nor displayed.
invoice_amount decimal Lesen, automatisch generiert The amount transfered (including shipping and VAT). The amount that has already been paid can be found in paid_amount.
paid_amount decimal Lesen, Schreiben The amount that has already been paid. If this value corresponds to the "invoice_amount," the order is considered as paid in full. If another value is entered, the order will be marked with a partial payment.
currency_id string(3) Lesen, Schreiben, Fremdschlüssel The ID of the currency that are in the values of the order. All currency can be queried via an order. : "GET /system/currency/".
customer array Lesen, Schreiben Here, you will find information regarding the buyer.
    ->id string Lesen, Schreiben, Fremdschlüssel The customer_id is chosen by the DR Customer. A "customer" will automatically be created in DR as soon as the first order in their date is imported. Therefore, the customer->id should always be used.
    ->username string Lesen, Schreiben The user name chosen by the purchaser in the portal. IMPORTANT: For some portals, the order number will be saved in this field.
    ->comment text Lesen, Schreiben Additional customer notes should be stored in this field.
    ->vat_id string Lesen, Schreiben The Buyer's VAT ID
    ->email string Lesen, Schreiben The buyer's Email address. This field is required and cannot be left blank.
    ->phone_1 string Lesen, Schreiben The buyer's main telephone number
    ->phone_2 string Lesen, Schreiben An additional telephone number for the buyer
    ->fax string Lesen, Schreiben The buyer's fax number
    ->address Order_address_type Lesen, Schreiben The Billing Address
shipping array Lesen, Schreiben Die Versandinformationen.
    ->fee decimal Lesen, Schreiben The Delivery Costs
    ->date date Lesen, Schreiben The Delivery Date
    ->deliverer string Lesen, Schreiben The Delivery Company / Dispatcher / Carrier. Additional values to select are possible, but here are the most common values: DHL, Post, Deutsche Post, UPS, Hermes, DPD, DPDP, TNT, GLS, GLSP
    ->code string Lesen, Schreiben, Fremdschlüssel The Tracking Number (Only useful in connection with the delivery company/dispatcher/carrier).
    ->method string Lesen, Schreiben The Type of Delivery
    ->address Order_address_type Lesen, Schreiben The Delivery Address
    ->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 This container contains the status information for the order.
    ->is_initial_contact bool Lesen, Schreiben Has someone contacted the buyer, yet?
    ->initial_contact_date date Lesen The date when the buyer was first contacted
    ->is_checkout bool Lesen, Schreiben Is the DreamRobot Checkout (i.e. only manual orders) completed?
    ->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 The date on which the order was paid.
    ->is_packed bool Lesen, Schreiben Packed?
    ->packed_date date Lesen The Packing Date
    ->is_shipped bool Lesen, Schreiben Sent?
    ->shipped_date date Lesen The Shipping Date
    ->is_arrived bool Lesen, Schreiben Arrived?
    ->arrived_date date Lesen Date of arrival
    ->is_cancelled bool Lesen, Schreiben Cancelled?
    ->cancelled_date date Lesen The Cancellation Date
    ->is_parked bool Lesen, Schreiben Parked?
line[] array_of_Order_line_type Lesen, Schreiben Here, you will find the individual order positions listed. Please note that these must be consistently transmitted in the correct order (and additionally contatin the corresponding positions - "id").
bill_url string Lesen As soon as the order has been archived, the invoice pdf URL can be retrieved using this field.
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.
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 You can retrieve or save the PayPal Transaction ID by using this field. This ID can not be changed afterwards.
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).

Order_address_type:

An Order Address (Shipping Address or Billing Address)

name Data Type Status Description
name string Lesen, Schreiben The Main Field for the Name.
name_2 string Lesen, Schreiben An additonal field for the name.
street string Lesen, Schreiben The Main Field for the Address/Street.
street_2 string Lesen, Schreiben Ann additional field for the street.
zip string Lesen, Schreiben The Zip Code
city string Lesen, Schreiben The City
province string Lesen, Schreiben The State or Province
country string Lesen, Schreiben The Country (spelled out)
country_iso2 string(2) Lesen, Schreiben The Country (2-letter abbreviation)

Order_line_type:

An individual order line. Additional order positions form an array of all items in an order (order->line[]).

name Data Type Status Description
id integer Lesen, Schreiben, Primärschlüssel The ID must always be given in order to show the line/position in which this order can be found.
name string Lesen, Schreiben The Name of the Item
sku string Lesen, Schreiben The Item No. in the Portal
quantity string Lesen, Schreiben The Position Quantity
price string Lesen, Schreiben The Price for each Individual Element of that Position
tax string Lesen, Schreiben The VAT
transaction_id string Lesen, Schreiben, Fremdschlüssel The Order Position ID of the Portal (i.e. eBay). When there is only one ID for an entire order, you can find it either in "order->customer->username" (i.e. Kaufland.de) or only in the first position "order->line[0]->transaction_id (i.e. ePages Flex).
stock_align_id string Lesen, Schreiben, Fremdschlüssel The Stock Adjustment ID of the Item in Stock (i.e. 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.

Order_filter_type:

The filter object for "GET order/"-Such-Call. Several conditions can be etered, when using a filter, that can be linked with "UND" (and). ("ODER"-Conditions can be displayed via several filters)

By default - the API looks back 1 month by creation and outputs a maximum 20 Orders.

You can change this by working with the "pagination" value.

If you check out the examples in the download archive - I'm sure you can find some different ones and see how it could work.

depending on your workflow you should choose different parameters.

The Order search is a bit complicated:
It offers 3 completely different types of order-search

1.: range filter using filter->date->from and filter->date->to
-> maximum range is 3 months
-> using pagination->page and pagination->limit

2.: By ID: you insert a list of orders and get the result
-> modified_since works very much the same - you can pass "filter->modified_since" and insert a date being a maximum of a few months in the past. This looks into the database and filters internally for those specific IDs.
-> no creation range limit on this call.
-> using pagination->page and pagination->limit

3.: using min_id.
- if neither filter->date nor filter->modified_since is provided - pagination->page can be replaced by using pagination->min_id (pagination->limit still applies)
-> best performance - least easy to understand
-> maximum lookback is currently 6 years
-> check Pagination_type->min_id for more information
-> you can start with a pseudo min_id like "0_2020_01" for receiving all orders created since beginning of this year

name Data Type Status Description
id[] array_of_Operator_filter_type<string> Schreiben Contains a list of all order_IDs that should be selected (Only "="-Operator possible) Tip: This filter is a singleton filter and is only valid in the first filter, but it also valid for all following filters.
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); Tip: This filter is a singleton filter and is only valid in the first filter, but it also valid for all following filters.
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 with operator for the invoice number.
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".
hidden_infos[] array_of_Operator_filter_type<string> Schreiben When using the filter, only select one order of which hidden_info is identical to the value provided.
transaction_id[] array_of_Operator_filter_type<string> Schreiben Filter with optional "!=" Operator for platform-order-ID/transaction_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 This is an Order Status Filter.
    ->is_initial_contact bool Schreiben Initial Contact
    ->is_checkout bool Schreiben DR Checkout
    ->is_paid bool Schreiben Paid (or partly paid)
    ->is_fully_paid bool Schreiben vollständig bezahlt (der bezahlte Betrag ist gleich oder höher als Rechnungsbetrag inkl. Versandkosten).
    ->is_packed bool Schreiben Packed?
    ->is_shipped bool Schreiben Sent?
    ->is_arrived bool Schreiben Arrived
    ->is_cancelled bool Schreiben Cancelled?
    ->is_parked bool Schreiben Parked?
    ->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 Here, you can enter the period of time in which the searched order was created. The standard search period covers the last month. The period of time may only cover a maximum of three months. Tip: This filter is a singleton filter and is only valid in the first filter, but it also valid for all following filters.
    ->from datetime Schreiben The date after which will be searched. (The standard is the current date less one month.)
    ->to datetime Schreiben Up to which date you wish to search. (The standard is the current date.)
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. Only allowed to search up to 3 months in the past.
shipping array Schreiben Here, you can enter the period of time in which the searched order was created. The standard search period covers the last month. The period of time may only cover a maximum of three months.
    ->deliverer[] array_of_Operator_filter_type<string> Schreiben The date after which will be searched. (The standard is the current date less one month.)
    ->code[] array_of_Operator_filter_type<string> Schreiben Up to which date you wish to search. (The standard is the current date.)
    ->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 When using the filter, only select one order of which hidden_info is identical to the value provided.
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).

Order_address_filter_type:

Eine Auftragsadresse (Lieferadresse oder Rechnungsadresse).

name Data Type Status Description
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.

Portal_account_id_type:

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


Order_send_mit_type:

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

name Data Type Status Description
deliverer string Schreiben Synonym for order->shipping->deliverer.
code string Schreiben Synonym for 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.

Stock_type:

An item in stock (incl. all portal data)

name Data Type Status Description
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 The Item Name
sku text Lesen, Schreiben The (individual) Item Number
barcode text Lesen, Schreiben The EAN
infos text Lesen, Schreiben Comments from and for the selling regarding this item in stock
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 The VAT that is already included in the "price". In %
weight decimal Lesen, Schreiben Weight in Grams (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 The ID of the item's condition. Key for stock->condition_id and stock->drwebshop[]->condition_id.
manufacturer string Lesen, Schreiben The Manufacturer
mpn string Lesen, Schreiben Manufacturer's Number
folder string Lesen, Schreiben The folder in which you should store your items in stock (always begins with a "/").
rrp decimal(10,2) Lesen, Schreiben The manufacturer's recommended price
quantity integer Lesen, Schreiben The Quantity in Stock
quantity_ebay integer Lesen, Schreiben The quantity that is currently listed on eBay.
quantity_ordered integer Lesen, Schreiben The quantity (i.e. via Purchasing) that has already been reordered.
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 The Reserved Quantity. Reserved quantities do not mean "available".
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 Stock Image URLs
    ->small text Lesen, Schreiben The Small Stock Image
    ->large text Lesen, Schreiben The Large Stock Image
    ->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 Different fields that refer to the warehouse location
    ->area text Lesen, Schreiben Stock Location
    ->field text Lesen, Schreiben Das Lagerfach.
    ->is_fullfilment bool Lesen, Schreiben Is "fulfillment" activated? Or, are you not storing your items in your own warehouse?
economic_operator array Lesen Verschiede Felder die sich auf den Wirtschaftsakteur beziehen.
    ->name string Lesen The Supplier's ID
    ->street string Lesen The Supplier's Item Number (SKU)
    ->postcode string Lesen The Purchasing Price
    ->city string Lesen The Purchasing Price
    ->country string Lesen The Purchasing Price
    ->phone string Lesen The Purchasing Price
    ->email string Lesen The Purchasing Price
    ->web_url string Lesen The Purchasing Price
supplier array Lesen, Schreiben Various fields that pertain to the distributor (Purchase Price)
    ->id string Lesen, Schreiben The Supplier's ID
    ->sku string Lesen, Schreiben The Supplier's Item Number (SKU)
    ->price decimal Lesen, Schreiben The Purchasing Price
shipping array Lesen, Schreiben Various fields regarding shipping
    ->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 Delivery Information
content array Lesen, Schreiben Various fields that refer to the contents/base price.
    ->quantity integer Lesen, Schreiben, Fremdschlüssel The quantity of "type" that is found in the item.
    ->type string(3) Lesen, Schreiben The unit of the contents. The following values are valid: "lt", "ml", "hl", "m", "m2", "mm3", "kg", "g", "ztr", "pal", "st", "kt".
    ->basic_price_type string(3) Lesen, Schreiben The unit of the basis price entered should be shown on the portal. Valid values are: "lt", "ml", "hl", "m", "m2", "mm3", "kg", "g", "ztr".
variation array Lesen, Schreiben The variant container. This contains all of the information regarding the variants in stock.
    ->type string Lesen, Schreiben Valid values are "main", "sub" and "none". When a variant item should be created or combined, this can only take place via the main item (Type = "main"). If you would like to separate one / all of your items in stock (again), please enter "none" as the Type.
    ->sub[] array_of_Stock_variation_sub_type Lesen, Schreiben A list of all sub-variants is contained in this array. (This box only appears when a variant main item is involved.)
    ->specifics_set array Lesen, Schreiben This field contains a Variant Matrix. (This box only appears when dealing with a Variant Main Item.)
        ->name_value[] array_of_Name_value_type Lesen, Schreiben The variant matrix is made up of several different characteristics. Here, you will find a Name_value_type for ie.e "color" and contains the vailid characteristics, i.e. "red", "green", and "blau".
    ->specifics Name_value_type Lesen, automatisch generiert Only a part of the specifics_set is in this container that applies to this variant. (This container is only available when there is a (sub) variant involved.)
    ->parent integer Lesen, automatisch generiert You will find the stock number of the variant main items in this container. (This container is only available when a variant is involved)
cross_selling array Lesen, Schreiben Various fields that refer to the Cross-Selling function (only DR-WebShop).
    ->is_active bool Lesen, Schreiben Is the cross-selling function active?
    ->is_quantity_split bool Lesen, Schreiben Split the Quantity?
    ->id[] array_of_string Lesen, Schreiben A Stock Number List that will be referenced when Cross-Selling.
    ->folder[] array_of_string Lesen, Schreiben A File List. All items in the file will be noted.
    ->description_id array Lesen, Schreiben Description IDs
        ->national integer Lesen, Schreiben The Description ID for the domestic target group.
        ->international integer Lesen, Schreiben The Description ID for the international target group.
freetext[] array_of_Stock_freetext_type Lesen, Schreiben Here, the 5 text fields (1, 2, 3, 4, and 5) respond.
cia array Lesen, Schreiben You will find all the Cross-Channel Inventory Adjustment (CIA) information in this container.
    ->ebay Stock_cia_portal_type Lesen, Schreiben The CIA Status for eBay
    ->amazon Stock_cia_portal_type Lesen, Schreiben The CIA Status for Amazon
    ->drwebshop Stock_cia_portal_type Lesen, Schreiben The CIA Status for DR-WebShop 2.0
    ->yatego Stock_cia_portal_type Lesen, Schreiben The CIA Status for Yatego
    ->hood Stock_cia_portal_type Lesen, Schreiben The CIA Status for Hood
    ->fnac Stock_cia_portal_type Lesen, Schreiben The CIA Status for Fnac
    ->epages Stock_cia_portal_type Lesen, Schreiben The CIA Status for ePages
    ->hitmeister Stock_cia_portal_type Lesen, Schreiben cia activated for Kaufland.de?
    ->event Stock_cia_portal_type Lesen, Schreiben Der PüMa Status für Notifications.
set array Lesen, Schreiben Contains the Set-Information
    ->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 Contains the Kaufland.de fields.
amazon Stock_amazon_type Lesen, Schreiben Contains Amazon fields.
nextore Stock_nextore_type Lesen, Schreiben Contains Nextore fields.
drwebshop[] array_of_Stock_drwebshop_type Lesen, Schreiben Contains DR-WebShop fields.
fnac Stock_fnac_type Lesen, Schreiben Contains Fnac fields.
epages Stock_epages_type Lesen, Schreiben Contains ePages fields.
ebay[] array_of_Stock_ebay_type Lesen, Schreiben Contains Lister eBay fields.
hood[] array_of_Stock_hood_type Lesen, Schreiben Contains Lister-Hood fields.
yatego[] array_of_Stock_yatego_type Lesen, Schreiben Contains Lister Yatego fields.
shop[] array_of_Stock_shop_type Lesen, Schreiben Contains Lister Shop fields.
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).

Multistatus_type:

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

name Data Type Status Description
path string Lesen, automatisch generiert The reference to the input, so it is clear which part of the query the answer should address.
code integer(3) Lesen, automatisch generiert The HTTP code for the partial answer.
... mixed Lesen Regardless of partial queries, further answer fields are possible.

Bank_type:

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

name Data Type Status Description
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.

Bank_filter_type:

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

name Data Type Status Description
id[] array_of_Operator_filter_type Schreiben Enthält eine Liste aller bank_id's die selektiert werden sollen. (Nur "="-Operator möglich); Tip: This filter is a singleton filter and is only valid in the first filter, but it also valid for all following filters.
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. Tip: This filter is a singleton filter and is only valid in the first filter, but it also valid for all following filters.
    ->from datetime Schreiben Das Datum ab dem gesucht wird (Standard ist das bis-Datum weniger einem Monat).
    ->to datetime Schreiben Das Datum bis zu dem gesucht wird. (Standard ist das aktuelle Datum)

Stock_freetext_type:

A free-text field with ID

name Data Type Status Description
id string Lesen, Schreiben, Primärschlüssel The ID for the Free-Text Field
value text Lesen, Schreiben The Free-Text Field

Stock_cia_portal_type:

Contains the Quantity Adjustment information regarding the item for a Portal. IMPORTANT: Quantity Adjustment fields for variant main item can be read and written, but are invalid without exception. The values in the variants only count.

name Data Type Status Description
is_active bool Lesen, Schreiben Is the CIA (Cross-Channel Inventory Adjustment) activated for this portal?
max_quantity integer Lesen, Schreiben The maximum quantity. When the value is set to "-1", this means that the offer should be completed.
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.

Stock_variation_sub_type:

An Item in Stock. The entries in this field show which item in stock with which parameters (specifics) in the primary items in stock are/should be linked as a variant (create_quantity).

name Data Type Status Description
id string Lesen, Schreiben, Fremdschlüssel A reference to the item in stock via the Stock Number (stock_id).
create_quantity integer Schreiben When using POST (creating/updating) without giving an "id", this field can be used as an alternative in order to generate and directly link new items in stock to their respective quantities.
specifics Name_value_type Schreiben Contains exactly one "name" and a "value" that these variants represent. (This contains is only available with POST (create/update).

Stock_set_connection_type:

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

name Data Type Status Description
id string Lesen, Schreiben, Fremdschlüssel The Stock Number (set-main or set-sub)
quantity integer Lesen, Schreiben How many times the sub-set is included in the set-main.

Stock_kaufland_type:

Kaufland.de stock fields

name Data Type Status Description
quantity integer Lesen, Schreiben The Quantity
comment text Lesen, Schreiben A Comment
price decimal(?,2) Lesen, Schreiben The (Maximum) Price
location string Lesen, Schreiben The Item's Location
price_min string Lesen, Schreiben The Minimum Price
delivery_time string Lesen, Schreiben, Fremdschlüssel The delivery time ID. Valid values are: "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 or ISBN. When using an ISBN, you must be put in front.
category_id string Lesen, Schreiben The Kaufland.de category ID
description_id integer Lesen, Schreiben The description ID
picture[] array_of_string Lesen, Schreiben A list from up to 12 image URLs.
characteristics Stock_characteristics_type Lesen, Schreiben The item characteristics
name string Lesen, Schreiben An Alternate Item Name.
shipping_group_id string Lesen, Schreiben, Fremdschlüssel Der Kaufland.de Versandgruppen Name (wird automatisch dem entsprechenden Portalaccount zugeordnet.).

Stock_amazon_type:

Amazon Stock Fields

name Data Type Status Description
is_active bool Lesen, Schreiben Amazon Item?
sku string Lesen, Schreiben The Item Number
market string Lesen, Schreiben Does this involve a Marketplace Item (or Seller Central)? Valid values are "Marketplace" and all other values for "Seller Central."
delivery_time integer Lesen, Schreiben The delivery date different from the Amazon standard.
id_type string Lesen, Schreiben The type of ID in the "ID" itself. Valid values are "ASIN", "ISBN", "UPC" und "EAN".
prime_template string Lesen, Schreiben The MFN Prime Shipping Template Name
availibility_date date Lesen, Schreiben The Availability Date
category_id string Lesen, Schreiben The Category ID
quantity string Lesen, Schreiben The Quantity
price decimal(?,2) Lesen, Schreiben The Price
id string Lesen, Schreiben The Item-ASIN/ISBN/UPC/EAN
comment text Lesen, Schreiben Ein Kommentar.
is_fba bool Lesen, Schreiben FBA (shipping via Amazon) active?

Stock_nextore_type:

Nextore Store Fields

name Data Type Status Description
is_active bool Lesen, Schreiben Nextore Item?
ean string Lesen, Schreiben The Barcode
price decimal Lesen, Schreiben The Price
quantity integer Lesen, Schreiben The Quantitiy
delivery_time string Lesen, Schreiben The Delivery Time
tax string Lesen, Schreiben The VAT

Stock_drwebshop_type:

The DR-WebShop 2.0 Stock Fields

name Data Type Status Description
shop_id string Lesen, Schreiben, Fremdschlüssel The Shop ID. This field is mandatory to assign to the correct shop. (There could be several shops linked/edited at the same time.)
is_lead bool Lesen, Schreiben Lead Item?
name string Lesen, Schreiben The Item Name
sku string Lesen, Schreiben The Item Number
ean string Lesen, Schreiben The EAN
category[] array_of_string Lesen, Schreiben The Shop Category
mpn string Lesen, Schreiben The Manufacturer's Item Number
description_id[] array_of_integer Lesen, Schreiben Description IDs
template_id integer Lesen, Schreiben The Template ID
picture[] array_of_string Lesen, Schreiben A list from up to 12 image URLs
price[] array_of_Stock_drwebshop_price_type Lesen, Schreiben The Prices (Different prices for different customer groups)
is_stock_price bool Lesen, Schreiben Use the Stock Price (Stock->Price)?
is_deposit_net bool Lesen, Schreiben Additional Deposit (net)
tax_class_id string Lesen, Schreiben The VAT ID
weight decimal(?,2) Lesen, Schreiben The item's weight
delivery_time integer Lesen, Schreiben Delivery Time in Days
sold array Lesen, Schreiben Settings for the item when it has reached 0 (quantity).
    ->delivery_time integer Lesen, Schreiben The delivery time in days (when the item quantity has reached 0)
    ->is_delivery_time bool Lesen, Schreiben Should a optional/different delivery time be shown with a quantity of 0?
    ->is_active bool Lesen, Schreiben When you have 0 items in stock, do you still want the item to be shown?
restock_date date Lesen, Schreiben The date that has been planned to re-stock.
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 Is this item for users over 18? Valid values: 0 => Not Over 18 Item; 1 => Over 18: 2 => Adult
availability_date date Lesen, Schreiben In the event an item is sold out, this date will be shown and say when the item will be available again.
sortorder integer Lesen, Schreiben Sorting order
characteristics Stock_characteristics_type Lesen, Schreiben The Shop Characteristics
is_digital bool Lesen, Schreiben Digital Item?
is_massarticle bool Lesen, Schreiben Made-to-Measure Item?
special array Lesen, Schreiben Special Action
    ->is_active bool Lesen, Schreiben Is Special Action active?
    ->price[] array_of_Stock_drwebshop_price_type Lesen, Schreiben The special price
    ->date array Lesen, Schreiben The action's timeframe
        ->from date Lesen, Schreiben Start
        ->to date Lesen, Schreiben End
    ->quantity integer Lesen, Schreiben The maximum quantity
is_active bool Lesen, Schreiben Shop Item?
modified_time date Lesen The date when the shop records were revised last.

Stock_drwebshop_price_type:

One of 4 DR-WebShop Prices

name Data Type Status Description
id integer Lesen, Schreiben The Price ID. Valid Values are "0", "1", "2" or "3".
net decimal(10,4) Lesen, Schreiben The Price (Unlike almost all other prices in DR, this one is Net.)

Stock_fnac_type:

Fnac Stock Fields

name Data Type Status Description
is_active bool Lesen, Schreiben Fnac Item?
ean string Lesen, Schreiben The EAN
price decimal(?,2) Lesen, Schreiben The Price
quantity integer Lesen, Schreiben The Quantity (1 - 9999)
description_id integer Lesen, Schreiben, Fremdschlüssel The Description ID

Stock_epages_type:

ePages Stock Fields

name Data Type Status Description
append_path string Lesen, Schreiben The Object Thread to the Listed Item
class array Lesen, Schreiben The linked product type
    ->id string Lesen, Schreiben The product type ID
    ->portal_account_id Portal_account_id_type Lesen, Schreiben, Fremdschlüssel The account in which the product type has been assigned.
tax_class string Lesen, Schreiben The Tax Class ID
is_new bool Lesen, Schreiben Set Item as "New" (listed, NOT the item's condition)
is_daily_price bool Lesen, Schreiben Is the price subject to fluctuations based on the day?
newness_date date Lesen, Schreiben Until when should this item be marked as "new"?
price_quantity integer Lesen, Schreiben For how many items (quantity) is this price valid? Normally always 1.
min_order_quantity decimal(10,2) Lesen, Schreiben The Minumum Order Quantity
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 The Quantity
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 Available?
availability_date date Lesen, Schreiben The Date of Availability
expiry_date date Lesen, Schreiben Expiration Date (when the item is no longer available)
is_download_product bool Lesen, Schreiben Download Item?
is_default bool Lesen, Schreiben Standard Variant? (only for variants)
price decimal(10,2) Lesen, Schreiben The price that varies from the price in stock
rrp decimal(10,2) Lesen, Schreiben The Manufacturer's Suggested Price
deposit_price decimal(10,2) Lesen, Schreiben The Deposit
eco_participation_price decimal(10,2) Lesen, Schreiben The (french) Environmental Recycling Fees
eco_participation_category_id integer(2) Lesen, Schreiben The Environmental Recycling Fee Category ID
ean string Lesen, Schreiben EAN or UPC
description_id[] array_of_integer Lesen, Schreiben The description IDs (a description for every language)
category[] array_of_array Lesen, Schreiben Each account with several random category IDs.
    ->id string Lesen, Schreiben, Fremdschlüssel The Category ID
    ->portal_account_id Portal_account_id_type Lesen, Schreiben, Fremdschlüssel The account in which the category has been assigned.
picture[] array_of_string Lesen, Schreiben A list from up to 12 image URLs
currency_id integer Lesen, Schreiben The Currency ID ("GET system/currency/").
characteristics Stock_characteristics_type Lesen, Schreiben The attribute in the DR attribute format

Stock_characteristics_type:

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

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

Stock_ebay_type:

The Lister eBay fields (in the REST API) that are only available via the item in stock.

name Data Type Status Description
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 The date that the DR-eBay data record was last revised.
duration string(3) Lesen, Schreiben The duration of the offer. Valid values are: 1, 3, 5, 7, 10, 30 and "GTC"(until withdrawn).
type_id string(2) Lesen, Schreiben The purchasing format. Valid values are: 1 (Auction), 9 (Fixed Price Offer), 22 (Variant Offer)
name string(80) Lesen, Schreiben Listing Name
subtitle string(80) Lesen, Schreiben The Subtitle
quantity integer Lesen, Schreiben The initial listing quantity
start_price decimal(10,2) Lesen, Schreiben The Start Price
price decimal(10,2) Lesen, Schreiben Buy Now Price
vat decimal(4,2) Lesen, Schreiben Die Mwst
min_price decimal(10,2) Lesen, Schreiben The Minimum Price
description text(ca.500000) Lesen, Schreiben The Description
payment array Lesen, Schreiben Payment Information
    ->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 When PayPal is selected as the payment method, this field will show the entered email address as the receiver of the payment.
    ->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 Refund Information
    ->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 Additional Options
    ->is_private bool Lesen, Schreiben Private Auction?
    ->is_bold bool Lesen, Schreiben Bold?
    ->is_highlighted bool Lesen, Schreiben Highlight?
    ->is_border bool Lesen, Schreiben Frame?
shipping array Lesen, Schreiben Shipping Information
    ->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 The domestic shipping cost table. Hier, you can enter different suppliers and delivery points.
    ->international Stock_lister_shipping_table_type Lesen, Schreiben The international shipping cost table. Here, you can enter the shipping costs for different suppliers and point of delivery.
    ->preparation_time integer Lesen, Schreiben The preparation time.
    ->is_express bool Lesen, Schreiben Express Shipping?
    ->discount_profile_id bool Lesen, Schreiben Shipping Discount Profile
        ->national integer Lesen, Schreiben Shipping Discount Options for Listings with the same Profile
        ->international integer Lesen, Schreiben Shipping Discount Options for Listings with the same Profile
    ->is_national_active bool Lesen, Schreiben Use stock->ebay[]->shipping->national?
    ->is_international_active bool Lesen, Schreiben Use stock->ebay[]->shipping->international ?
    ->is_promotional_discount bool Lesen, Schreiben Is shipping a promotional discount?
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 City. This field is for every lister (eBay, Hood, Yatego, Shop) with the identical lister_id.
    ->zip string Lesen, Schreiben Zip / Zip Code / Postal Code. This field is for every lister (eBay, Hood, Yatego, Shop) with the identical lister_id.
    ->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 The ID of the visitor counters in the listing should be shown.
picture array Lesen, Schreiben Image Information
    ->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 Picture in the description?
    ->gallery array Lesen, Schreiben Gallery Image
        ->url string Lesen, Schreiben The extra image URL for the gallery
        ->url_id integer Lesen, Schreiben Use the ID from stock->ebay[]->picture->url. (1-12) instead of the Gallery URL.
        ->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 Images from the items in stock can be used for variants. For this purpose, the name of the variation (i.e. color or size) must be entered in this field. Otherwise, enter "0" to specify that no images will be transfered.
template_id integer Lesen, Schreiben The Template ID for the Item Description
category_1_id string Lesen, Schreiben The Main Category
category_2_id string Lesen, Schreiben Category 2
shop_category_1_id string Lesen, Schreiben The Shop Category
shop_category_2_id string Lesen, Schreiben The Second Shop Category
is_max_quantity_available bool Lesen, Schreiben Set the maximum available quantity "stock->quantity_available" (only for variants).
is_stock_price bool Lesen, Schreiben Use the Stock Price (only for variants)
post array Lesen, Schreiben Post
    ->is_active bool Lesen, Schreiben Is the Post function active?
    ->quantity integer Lesen, Schreiben Quantity of Posts
    ->quantity_per_post integer Lesen, Schreiben Quantity per Post
characteristics Stock_characteristics_type Lesen, Schreiben The eBay Item features in the DR attribute format
best_offer array Lesen, Schreiben Suggested Price
    ->is_active bool Lesen, Schreiben active?
    ->auto_accept_price decimal(10,2) Lesen, Schreiben Price limit once a price suggestion is automatically accepted.
    ->min_price decimal(10,2) Lesen, Schreiben Minimum Price to Suggest
site_id integer Lesen, Schreiben The eBay Listing Country ID (77 for Germany)
catalog array Lesen, Schreiben Product catalogue information. (Should not be used anymore. Instead, please use--for example-- stock->barcode)
    ->value string Lesen, Schreiben Product Catalogue Value (i.e. the EAN). Should not be used anymore. Instead, please use i.e. stock->barcode.
    ->type_id integer(1) Lesen, Schreiben The Type of the Product Catalogue Value. Valid values are: 0 = No selection; 1 0 EAN, 2 = ISBN; 3 = Manufacturer, 4 = EPID; 5 = UPC (Should not be used anymore. Instead, please use--for example-- stock->barcode)
gallery_duration string Lesen, Schreiben The duration of how long the offer is shown in the gallery. Valid values are "0" to "50" (in days) and "Lifetime".
sku string Lesen, Schreiben The Item Number
is_mobile bool Lesen, Schreiben Show on mobile.de?
condition array Lesen, Schreiben Condition of the Item
    ->id string Lesen, Schreiben The Condition ID (For eBay, this is dependent on the category. The possible valid values can vary emensely).
    ->description text Lesen, Schreiben Item Condition Description
compatibilities Stock_characteristics_type Lesen, Schreiben The vehicle use list in the DR attribute format.
seller_profile array Lesen, Schreiben Contract Conditions
    ->payment[] array_of_Stock_ebay_seller_profile_type Lesen, Schreiben Payment Profile
    ->refund[] array_of_Stock_ebay_seller_profile_type Lesen, Schreiben Return Conditions Profile
    ->shipping[] array_of_Stock_ebay_seller_profile_type Lesen, Schreiben Versandbedingungsprofil
rrp decimal(10,2) Lesen, Schreiben Suggested Retail Price
ebay_plus integer Lesen, Schreiben eBay Plus item? (-1 = No, 0 = Standard, 1 = Yes)

Stock_lister_shipping_table_type:

Contains shipping information regarding the services, costs and delivery countries.

name Data Type Status Description
id integer Lesen, Schreiben, Primärschlüssel 1, 2 or 3
type_id string Lesen, Schreiben, Fremdschlüssel Type of Shipping/Carrier
first decimal(10,2) Lesen, Schreiben The shipping costs for the first item
more decimal(10,2) Lesen, Schreiben The shipping costs for similar items (only available through eBay)
ships_to_id[] array_of_string Lesen, Schreiben Lieferländer für die die Versandkosten gültig sind. (Nur für die internationalen Angaben ein gültiges Feld, da sich das Feld national erübrigt.).

Stock_ebay_seller_profile_type:

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

name Data Type Status Description
id integer Lesen, Schreiben, Fremdschlüssel Contract Conditions ID
portal_account_id Portal_account_id_type Lesen, Schreiben, Fremdschlüssel When the field does not contain a value, the standard portal account ID will be used.

Stock_hood_type:

The Hood Lister fields (in the REST API reachable solely via the item in stock)

name Data Type Status Description
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 The date the DR-Hood data record was last revised.
duration string(3) Lesen, Schreiben The duration of the offer. Valid values are: 1, 3, 5, 7, 10, 30 and "GTC" (until revoked).
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 The Listing Name
subtitle string(80) Lesen, Schreiben Subtitle
quantity integer Lesen, Schreiben The initial starting quantity
start_price decimal(10,2) Lesen, Schreiben The Auction Price
price decimal(10,2) Lesen, Schreiben The Buy Now Price
vat decimal(4,2) Lesen, Schreiben Die Mwst
min_price decimal(10,2) Lesen, Schreiben The Minimum Price
description text(ca.65000) Lesen, Schreiben The Description
payment array Lesen, Schreiben Payment Information
    ->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 Refund Information
    ->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 Additional Options
    ->is_private bool Lesen, Schreiben Private Auction?
    ->is_bold bool Lesen, Schreiben Bold?
    ->is_highlighted bool Lesen, Schreiben Highlight?
    ->is_top_start_pic bool Lesen, Schreiben Would you like your top offer on the start page with an image?
    ->is_no_ads bool Lesen, Schreiben No ads?
shipping array Lesen, Schreiben Shipping Information
    ->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 The Shipping Discount
    ->from bool Lesen, Schreiben Delivery Time from (in days)
    ->to bool Lesen, Schreiben Delivery Time until (in days)
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 City. This field is for every lister (eBay, Hood, Yatego, Shop) with the identical lister_id.
    ->zip string Lesen, Schreiben Zip / Zip Code / Postal Code. This field is for every lister (eBay, Hood, Yatego, Shop) with the identical lister_id.
    ->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 Image Information
    ->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 Image in the description?
    ->quantity integer Lesen, Schreiben The number of images from the "URL" that should be used for Hood.
template_id integer Lesen, Schreiben The Template ID for the Item Description
category_1_id string Lesen, Schreiben The Main Category
category_2_id string Lesen, Schreiben The Second Category
shop_category_1_id string Lesen, Schreiben The Shop Category
shop_category_2_id string Lesen, Schreiben The Second Shop Category
shop_category_3_id string Lesen, Schreiben The Third Shop Category
is_max_quantity_available bool Lesen, Schreiben Set the maximal available quantity "stock->quantity_available" (only for variants).
is_stock_price bool Lesen, Schreiben Use the Stock Price (only for variants).
is_auto_renew bool Lesen, Schreiben Auto Renew?
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 Image Information
    ->short_description text Lesen, Schreiben Quick Description
    ->sold_out string Lesen, Schreiben Display option in the event this item is sold out: "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 Show subtitle in the auction?
    ->is_active bool Lesen, Schreiben Shop Item?
    ->is_auction bool Lesen, Schreiben List as an auction, as well?
fsk integer Lesen, Schreiben Rating (G, PG, PG-13, R or X)
usk integer Lesen, Schreiben Rating: G, PG, PG13, R or X
rrp integer Lesen, Schreiben Suggested Manufacturer's Price / Listed Price
mpn string Lesen, Schreiben Manufacturer's Number
manufacturer string Lesen, Schreiben Hersteller.
is_no_id bool Lesen, Schreiben Custom-Made (without EAN)?

Stock_yatego_type:

The Lister Yatego fields (in the REST API solely reachable via the item in stock).

name Data Type Status Description
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 The date which the DR-Yatego data record was last revised.
name string(80) Lesen, Schreiben The Listing Name
quantity integer Lesen, Schreiben The Initial Listing Quantity
price decimal(10,2) Lesen, Schreiben The Buy Now Price
vat decimal(4,2) Lesen, Schreiben Die Mwst
description text(ca.65000) Lesen, Schreiben The Description
payment array Lesen, Schreiben Payment Information
    ->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 Refund Information
    ->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 City. This field is for every lister (eBay, Hood, Yatego, Shop) with the identical lister_id.
    ->zip string Lesen, Schreiben Zip / Zip Code / Postal Code. This field is for every lister (eBay, Hood, Yatego, Shop) with the identical lister_id.
    ->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 Image Information
    ->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 The Template ID for the Item Description
category_1_id string Lesen, Schreiben The Main Category
category_2_id string Lesen, Schreiben The Second Category
category_3_id string Lesen, Schreiben The Third Category
sku string Lesen, Schreiben The Item Number
short_description text Lesen, Schreiben A Quick Description
cross_selling text Lesen, Schreiben Cross-Selling
discount_id text Lesen, Schreiben The Discount Rate ID
variation_id text Lesen, Schreiben The Variant ID
is_line_feed bool Lesen, Schreiben Auto Linefeed (Description)?
is_basic_price bool Lesen, Schreiben Should the basic price be shown?
is_active bool Lesen, Schreiben Yatego Item?
is_delete bool Lesen, Schreiben Are you sure you want to delete this?
rrp decimal(10,2) Lesen, Schreiben Manufacturer's Suggested Retail Price
shipping_surcharge decimal(10,2) Lesen, Schreiben The Delivary Surcharge
is_shipping_surcharge_once bool Lesen, Schreiben Den Versandkostenaufschlag nur ein Mal hinzufügen?

Stock_shop_type:

The Lister Shop fields (in the REST API solely reachable via the item in stock).

name Data Type Status Description
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 The Auction Name
quantity integer Lesen, Schreiben Initial listing quantity
price decimal(10,2) Lesen, Schreiben Buy Now
vat decimal(4,2) Lesen, Schreiben Die Mwst
description text(ca.65000) Lesen, Schreiben The Description
payment array Lesen, Schreiben Payment Information
    ->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 Refund Information
    ->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 City. This field is for every lister (eBay, Hood, Yatego, Shop) with the identical lister_id.
    ->zip string Lesen, Schreiben Zip / Zip Code / Postal Code. This field is for every lister (eBay, Hood, Yatego, Shop) with the identical lister_id.
    ->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 The Listing Start (only the date without the time).
picture array Lesen, Schreiben Image Information
    ->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 The Template ID for the Item Description
category_1_id string Lesen, Schreiben The Category
manufacturer_url string Lesen, Schreiben The Link to the Manufacturer
short_description text Lesen, Schreiben Short Description
is_adult text Lesen, Schreiben From 18 items?
weight decimal(10,2) Lesen, Schreiben The Weight of the Item in grams
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 The Manufacturer
is_delete bool Lesen, Schreiben Are you sure you want to delete this?

Stock_app_type:

Ein lager_app Datensatz.

name Data Type Status Description
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".

Stock_filter_type:

The Stock Filter to use when searching for an item in stock. ("ODER"-Conditions can be displayed via several filters)

name Data Type Status Description
id[] array_of_Operator_filter_type<mixed> Schreiben A list of Stock Numbers from "stock"s that should be returned.
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 A Barcode/EAN-List that should be returned
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 statt decimal.
    ->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

Name_value_type:

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

name Data Type Status Description
name string Lesen, Schreiben The Name
value[] array_of_string Lesen, Schreiben The list

Stock_history_filter_type:

Der Stock_history-Filter anhand dessen Lagerbewegungen gesucht werden können. ("ODER"-Conditions can be displayed via several filters)

name Data Type Status Description
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

Stock_history_type:

Eine (von mehreren) Lagerbewegungen.

name Data Type Status Description
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.).

Stock_portal_upload_type:

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

name Data Type Status Description
ebay[] array_of_Stock_portal_upload_ebay_type Schreiben List an item on eBay or revise it
amazon[] array_of_Stock_portal_upload_portal_type Schreiben List an item on Amazon or revise the price
kaufland[] array_of_Stock_portal_upload_portal_type Schreiben List, revise or end a listing on Kaufland.de.
fnac[] array_of_Stock_portal_upload_portal_type Schreiben List an Item on Fnac
epages[] array_of_Stock_portal_upload_portal_type Schreiben List an Item on ePages

Stock_portal_upload_portal_type:

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

name Data Type Status Description
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 Indicates from which account the portal access data should be used.

Stock_portal_upload_ebay_type:

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

name Data Type Status Description
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 Indicates from which account the portal access data should be used.
lister_id string Schreiben, Fremdschlüssel Gibt an, welcher verknüpfte Lister verwendet werden soll. (Wenn es nur einen gibt, kann das Feld freigelassen werden.)
start date Schreiben For "action" "list": Here, you can indicated when the offer should be listed.
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"

Stock_description_type:

A Stock Desctiption (from several)

name Data Type Status Description
id integer Lesen, Primärschlüssel, automatisch generiert The Description ID
name string(255) Lesen, Schreiben The name of the description (only for the backend description).
icon_id string(255) Lesen, Schreiben, Fremdschlüssel The value determines which symbol will be shown next to the description. (For Amazon, it is actually an indicator that the description should be used.)
language_iso2 string(2) Lesen, Schreiben, Fremdschlüssel The description language in the double-digit format
long text Lesen, Schreiben The Main Description
short text Lesen, Schreiben The short description. Is not supported by all platforms.
alternative_title string(255) Lesen, Schreiben An Alternate Item Name (i.e. for the DR-Webshop 2.0)
meta_keywords string(255) Lesen, Schreiben Some platforms support meta keywords (i.e. DR-WebShop)
meta_description string(255) Lesen, Schreiben Some platforms support a meta description with general information (i.e. the DR DR-WebShop)

Shop_parameter_filter_type:

Der Filter anhand dessen Shop-Parameter gesucht werden können. ("ODER"-Conditions can be displayed via several filters)

name Data Type Status Description
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).

Shop_parameter_type:

Ein Shop-Parameter (z.B. Hersteller oder Mehrwertsteuer).

name Data Type Status Description
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).

Customer_filter_type:

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

name Data Type Status Description
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).

Customer_type:

Ein Eventhandler definiert Reaktionsregeln auf je einen Eventtypen.

name Data Type Status Description
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.
email 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).

Admin_event_handler_type:

Ein Eventhandler definiert Reaktionsregeln auf je einen Eventtypen.

name Data Type Status Description
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.

Admin_person_type:

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

name Data Type Status Description
id integer Lesen, Primärschlüssel, automatisch generiert Die Benutzer ID.
name string Lesen, Fremdschlüssel Der Anzeigename des Benutzers.

Admin_portal_account_type:

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

name Data Type Status Description
id integer Lesen, Primärschlüssel, automatisch generiert The Portal Account 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 The name shown for the Portal Account on your screen (For eBay Portal_accounts, is is also your eBay user name).

Admin_shipping_group_type:

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

name Data Type Status Description
id integer Lesen, Primärschlüssel, automatisch generiert The Shipping Group ID
name string(255) Lesen The Description
portal_account_id Portal_account_id_type Lesen, Fremdschlüssel The Portal Account ID that is valid for the shipping group. When the value is '0', then it is valid for all accounts.
type_id integer Lesen Die Gruppierungs ID.
ships_to array Lesen The valid shipping countries
    ->worldwide bool Lesen Worldwide (all countries)
    ->europe bool Lesen Europe
    ->eu bool Lesen EU (Europäische Union)
    ->germany bool Lesen Deutschland
    ->eu_more text Lesen Additional countries in the EU--entered in ISO2 format and separated by semi-colons.
    ->switzerland bool Lesen Switerland
    ->europe_more text Lesen Additional countries in Europe--entered in ISO2 format and separated by semi-colons.
    ->usa bool Lesen USA
    ->canada bool Lesen Canada
    ->japan bool Lesen Japan
    ->australia bool Lesen Australia
    ->worldwide_more text Lesen Additional world-wide countries--entered in ISO2 format and separated by semi-colons.
price array Lesen Various Shipping Costs
    ->first decimal(8,2) Lesen The Shipping Cost for the First Item
    ->more decimal(8,2) Lesen The delivery costs for additional items
cash_surcharge decimal(8,2) Lesen The shipping surcharges when COD has been selected
currency string(3) Lesen, Fremdschlüssel The Currency 3-letter Format (i.e. EUR or USD)

Admin_user_type:

General status information to the REST API account

name Data Type Status Description
id integer Lesen, Primärschlüssel, automatisch generiert The 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).
email 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).

Task_type:

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

name Data Type Status Description
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.

Task_filter_type:

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

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

7. Revision History

Version Changes
v1.1.23
v1.1.22
v1.1.21
v1.1.20
v1.1.19
v1.1.18

  • Order_type->shipping->link: Link war falsch wenn mehrere Sendungsverfolgungsnummern angegeben waren -> In Liste mit mehreren Links geändert.
v1.1.17
v1.1.16
v1.1.15
v1.1.14
v1.1.13

  • Wenn das API Limit nur selten überschritten wird (max. 3 Mal in 30 Tagen) dann wirdmit erreichen des Limits das Limit für den aktuellen Tag verdoppelt.

  • order/: GET Die Auftragssuche liefert nur noch Aufträge die mindestens 10 Sekunden alt sind, damit sie von externen Systemen erst verarbeitet werden, sobald alle internen Prozesse zum Anlegen eines Auftrags vollständig verarbeitet wurden.

  • order/{order_id}/send_mit/: POST Die eBay Bewertungsautomatik funktioniert nun auch dann, wenn die Ware über diese Funktion abgeschlossen wird.

  • Order_type->history: Beim Anlegen eines Auftrags können nun Einträge übergeben werden, die sofort in die Historie geschrieben werden. Ein nachträgliches Hinzufügen ist weiterhin nur über den Endpunkt POST order/{order_id}/history/ möglich.

  • Order_filter_type->number: added

  • Stock_type->id: Zugriff per "AMZSKU_[...]" hinzugefügt

  • Stock_type->set->type: Die Werte werden künftig, wie sie dokumentiert sind, kleingeschrieben (Main => main / Sub => sub) ausgegeben.

  • Stock_filter_type->amazon: added
v1.1.12
v1.1.11
v1.1.10

  • token.php: POST Ein Refreshtoken ist nun bis zu 2 Jahre lang gültig und wird erst ab 1 Monat vor Ablauf durch einen neuen RefreshToken ausgetauscht.

  • Order_type->bill_date: added
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