Warenkorb
Übersetzung
Anmelden/Login
logo

API: order

>> zurück zur Liste aller Schnittstellen

Beschreibung Download aller Bestellungen eines bestimmten Tages bzw. Zeitintervalls
URL https://api.booklooker.de/2.0/order?token=REST_API_TOKEN
REST_API_TOKEN = Der von der Authentifizierung zurückgelieferte Token.
Methode GET
Version 2.0

Parameter

Name Beschreibung Optional? Default-Wert
orderId Interne booklooker orderId der Bestellung, wird von der Schnittstelle order zurückgeliefert. Nein –
date Datum, zu dem Bestellungen angefordert werden, im Format YYYY-MM-DD. Wenn übergeben, hat dieser Parameter Vorrang vor dateFrom und dateTo Nein –
dateFrom Startdatum, zu dem Bestellungen angefordert werden, im Format YYYY-MM-DD Nein –
dateTo Enddatum, zu dem Bestellungen angefordert werden, im Format YYYY-MM-DD Nein –
view Sicht auf die Bestellungen: seller (Standard) liefert die Bestellungen, die bei Ihnen eingegangen sind, buyer die Bestellungen, die Sie selbst aufgegeben haben. Nein seller

Rückgabe

Status Rückgabewert Beschreibung
OK

Alle Bestellungen des angeforderten Tages bzw. Zeitintervalls.

Mit view=buyer beschreibt die Antwort statt des Käufers den Verkäufer: Die Elemente buyerPositiveRatingPercentage, buyerTotalRatingNumber, buyerUsername, email, tel und ustIdNr entfallen, stattdessen sind sellerId, sellerEmail, sellerPositiveRatingPercentage, sellerTotalRatingNumber und sellerUsername immer vorhanden. Ebenfalls entfallen originalProvisionNet, currentProvisionNet und bei den Artikeln note. status ist der Status der Bestellung aus Käufersicht, invoiceAddress und deliveryAddress sind Ihre eigenen Adressen.

fett · Das Element ist immer vorhanden.
normal · Das Element ist nur dann vorhanden, wenn ein Wert existiert.

Element Bedeutung
orderId Interne Booklooker orderId der Bestellung
orderDate
orderTime 		Datum und Uhrzeit der Bestellung
accountHolder
accountIban
accountBic 		Falls der Besteller als Zahlungsart Lastschrift gewählt hat und eine Bankverbindung angegeben hat, stehen in diesen Feldern die Kontodaten: Kontoinhaber, IBAN und BIC.
buyerPositiveRatingPercentage Prozentzahl der positiven Bewertungen des Käufers (0.0 - falls der Käufer noch keine Bewertung erhalten hat)
buyerTotalRatingNumber Anzahl der erhaltenen Bewertungen des Käufers
buyerUsername Benutzername des Käufers, bei Händlern der Firmenname
calculatedShippingCost Dieses Element wird nur übergeben, wenn die Versandkosten berechnet werden konnten, bspw. bei vorhandener Gewichtsangabe und Nutzung der Gewichts-Staffel-Tabelle zur Portoberechnung, oder bei Nutzung von Pauschalpreisen
comments Freitextfeld, in das Kunden bei Bestellung spezielle Wünsche eintragen können
currentProvisionNet Aktuelle Provision ohne MwSt. unter Berücksichtigung von Stornierungen - siehe auch originalProvisionNet
email E-Mail-Adresse des Käufers
originalProvisionNet Ursprüngliche Provision ohne MwSt. ohne Berücksichtigung von Stornierungen - siehe auch currentProvisionNet.
paymentConfirmed
transactionId 		Aktuell nur für Zahlungsart PayPal bzw. PayPal REST API: Falls uns der Zeitpunkt der erfolgreichen Bezahlung vom Zahlungsdienstleister gemeldet wurde, steht hier der Zeitpunkt im Format YYYY-MM-DD HH:MM:SS. Weiterhin die von PayPal übermittelte txn_id bzw. Capture-ID der zugehörigen Bezahlung.
paymentId Die vom Besteller gewählte Zahlungsart. Folgende Werte sind möglich:
  • 1 · Banküberweisung (Vorkasse)
  • 2 · Offene Rechnung
  • 11 · Offene Rechnung (Vorkasse vorbehalten)
  • 3 · Lastschrift (Vorkasse)
  • 4 · Kreditkarte (Vorkasse)
  • 5 · Nachnahme
  • 6 · PayPal (Vorkasse)
  • 8 · Skrill (Vorkasse)
  • 9 · Selbstabholung und Barzahlung
  • 12 · PayPal REST API (Vorkasse)
status Mögliche Rückgabewerte siehe order_status
tel Telefonnummer des Käufers
ustIdNr Umsatzsteuer-Identifikationsnummer des Käufers
invoiceAddress
deliveryAddress 		Rechnungs- und ggf. Lieferanschrift
titleAnrede
nameNachname
firstNameVorname
companyFirma
addressSupplementZusatz
streetStraße und Hausnummer
zipPLZ
cityOrt
countryLand
orderItems
amount Bestellmenge
author Geistiger Schöpfer des Artikels, abhängig vom mediaType (s.u.):
  • Buch · Autor/in
  • Hörbuch · Autor/in
  • Film · Regisseur/in
  • Tonträger · Interpret/in
  • Spiel · Autor/in
infotext Beschreibungstext des Artikels (diese Option muss von unserem Kundendienst aktiviert werden, bitte schreiben Sie bei Bedarf eine E-Mail an support@booklooker.de
mediaType
  • 0 · Buch
  • 3 · Hörbuch
  • 1 · Film
  • 2 · Tonträger
  • 4 · Spiel
note Persönliche Notiz/Lagerort (nur wenn vorhanden)
orderItemId Interne booklooker orderItemId des Artikels, wichtig bei Nutzung der Schnittstelle order_item_cancel
orderNo Ihre Bestellnummer
orderTitle Titel des Artikels
singlePrice Preis des einzelnen Bestellpostens (unabhängig von Amount)
status
  • Ordered
  • Canceled
totalPriceRebated Gesamtpreis des Bestellpostens abzgl. evtl. Rabatte
NOK INVALID_ORDERID Der Parameter orderId hat ein falsches Format.
NOK INVALID_VIEW Der Parameter view ist weder seller noch buyer.
NOK INVALID_DATE Der Parameter date hat ein falsches Datumsformat.
NOK INVALID_DATE_FROM Der Parameter dateFrom hat ein falsches Datumsformat.
NOK INVALID_DATE_TO Der Parameter dateTo hat ein falsches Datumsformat.
NOK INVALID_DATE_INTERVAL Das maximal erlaubte Intervall beträgt 1 Monat.
NOK ENCODING_ERROR Die Rückgabe enthält ungültige Zeichen.
NOK INVALID_INTERFACE Es wurde eine ungültige Schnittstelle verwendet.
NOK INVALID_REQUEST_METHOD Die Schnittstelle wurde mit einer ungültigen HTTP-Methode aufgerufen.
NOK QUOTA_EXCEEDED Die maximale Anzahl Abfragen/Minute wurde überschritten.
NOK SERVER_DOWN Aufgrund von Wartungsarbeiten ist die REST API momentan nicht verfügbar.
NOK TEMPORARILY_BLOCKED Der Zugang wurde vorübergehend gesperrt, bitte wenden Sie sich an unseren Kundensupport.
NOK TOKEN_EXPIRED Der Token ist nicht mehr gültig, eine erneute Authentifizierung ist notwendig.
NOK TOKEN_MISSING Der Token ist leer oder nicht vorhanden.
NOK TOKEN_UNKNOWN Der Token wurde nicht gefunden.