Dokumentation zur Rakuten Shop-API


getOrders

Diese Methode gibt Bestellungen des Händlers aus.

Mit dieser URL rufen Sie die API-Methode auf:

Authentifizierung

Für diese Methode ist eine Authentifizierung mit Leserechten erforderlich.
Empfohlen wird der Aufruf über HTTP-GET.

Parameter

Die mit * gekennzeichneten Parameter müssen übergeben werden.

key *

Authentifizierungs-Schlüssel

Datentyp: String
search

Filter: Such-Text

Datentyp: String
Regeln: Zu einem Such-Text muss ein entsprechendes Such-Feld angegeben sein.
Maximal 100 Zeichen sind erlaubt.

Der Inhalt des Suchfeldes wird für die Suche nicht beachtet, wenn einer der folgenden Parameter übergeben wurde:
order_no, invoice_no, first_name, last_name, email, company, city
search_field

Filter: Such-Feld

Datentyp: String
Regeln:
order_no = Bestell-Nr.
invoice_no = Rechnungs-Nr.
first_name = Vorname
last_name = Nachname
company = Firma
city = Stadt
email = E-Mail

Zu einem Such-Feld muss ein entsprechender Such-Text angegeben sein.

Der Inhalt des Suchfeldes wird für die Suche nicht beachtet, wenn einer der folgenden Parameter übergeben wurde:
order_no, invoice_no, first_name, last_name, email, company, city
status

Filter: Status

Datentyp: String
Regeln:
pending = Bestellung ist neu eingegangen
editable = Bestellung ist zur Bearbeitung freigegeben
shipped = Bestellung ist versendet
payout = Bestellung ist ausbezahlt
cancelled = Bestellung ist storniert
from

Filter: Von

Datentyp: Date
to

Filter: Bis

Datentyp: Date
order

Sortierung

Datentyp: String
Standard:
created_asc = Bestell-Datum aufsteigend
created_desc = Bestell-Datum absteigend
per_page

Anzahl der Bestellungen pro Seite

Datentyp: Integer
Standard: 20
Regeln: Maximal 100 Bestellungen pro Seite sind erlaubt.
Wird ein Wert über 100 angegeben, so wird der Standard-Wert verwendet.
page

Aktuelle Seite

Datentyp: Integer
Standard: 1
created_from

Einschränkung nach Datum des Bestelleingangs, frühester Zeitpunkt.

Datentyp: Date
Regeln: Wenn nur das "created_from" angegeben worden ist und das "created_to" nicht, dann wird das "created_to" auf das heutige Datum gesetzt.
created_to

Einschränkung nach Datum des Bestelleingangs, spätester Zeitpunkt.

Datentyp: Date
Regeln: Wenn "created_to" nicht angegeben ist, dann wird das heutige Datum gesetzt.
approved_from

Einschränkung nach Datum der Bestellfreigabe, frühester Zeitpunkt.

Datentyp: Date
Regeln: Wenn "approved_from" angegeben worden ist und das "approved_to" nicht, dann wird das "approved_to" auf das heutige Datum gesetzt.
approved_to

Einschränkung nach Datum der Bestellfreigabe, spätester Zeitpunkt.

Datentyp: Date
Regeln: Wenn "approved_to" nicht angegeben ist, dann wird das heutige Datum gesetzt.
shipping_from

Einschränkung nach Datum des Versandes, frühester Zeitpunkt.

Datentyp: Date
Regeln: Wenn "shipping_from" angegeben worden ist und das "shipping_to" nicht, dann wird das "shipping_to" auf das heutige Datum gesetzt.
shipping_to

Einschränkung nach Datum des Versandes, spätester Zeitpunkt.

Datentyp: Date
Regeln: Wenn "shipping_to" nicht angegeben ist, dann wird das heutige Datum gesetzt.
paidout_from

Einschränkung nach Datum der Auszahlung, frühester Zeitpunkt.

Datentyp: Date
Regeln: Wenn "paidout_from" angegeben worden ist und das "paidout_to" nicht, dann wird das "paidout_to" auf das heutige Datum gesetzt.
paidout_to

Einschränkung nach Datum der Auszahlung, spätester Zeitpunkt.

Datentyp: Date
Regeln: Wenn "paidout_to" nicht angegeben ist, dann wird das heutige Datum gesetzt.
cancelled_from

Einschränkung nach Datum der Stornierung, frühester Zeitpunkt.

Datentyp: Date
Regeln: Wenn "cancelled_from" angegeben worden ist und das "cancelled_to" nicht, dann wird das "cancelled_to" auf das heutige Datum gesetzt.
cancelled_to

Einschränkung nach Datum der Stornierung, spätester Zeitpunkt.

Datentyp: Date
Regeln: Wenn "cancelled_to" nicht angegeben ist, dann wird das heutige Datum gesetzt.
order_no

Die Bestell-Nummer der gesuchten Bestellung

Datentyp: String
Regeln: Muss eine gültige Bestell-Nr. sein. Das Format der Bestell-Nr. ist XXX-XXX-XXX.
invoice_no

Die Rechnungsnummer der gesuchten Bestellung

Datentyp: String
Regeln: Muss eine gültige Rechnungsnummer sein.
first_name

Der Vorname des Kunden

Datentyp: String
Regeln: Maximal 50 Zeichen sind erlaubt.
last_name

Der Nachname des Kunden

Datentyp: String
Regeln: Maximal 50 Zeichen sind erlaubt.
email

Die Email-Adresse des Kunden

Datentyp: String
Regeln: Maximal 100 Zeichen sind erlaubt.
company

Die Firma des Kunden

Datentyp: String
Regeln: Maximal 50 Zeichen sind erlaubt.
city

Die Stadt des Kunden

Datentyp: String
Regeln: Maximal 50 Zeichen sind erlaubt.

Antwort

Beispiel im XML-Format.

<?xml version="1.0" encoding="utf-8"?>
<result>
   <success>1</success>
   <orders>
   	<paging>
   		<total>1</total>
   		<page>1</page>
   		<pages>1</pages>
   		<per_page>20</per_page>
   	</paging>
   	<order>
   		<order_no>123-456-789</order_no>
   		<total>12.12</total>
   		<shipping>3.50</shipping>
   		<max_shipping_date>2010-01-01 20:15:00</max_shipping_date>
   		<payment>CC</payment>
   		<status>pending</status>
   		<invoice_no>123456</invoice_no>
   		<comment_client>Ich freu mich so sehr!</comment_client>
   		<comment_merchant>Beim Lieferanten bestellt</comment_merchant>
   		<created>2010-01-01 20:15:00</created>
   		<InLogistics>1</InLogistics>
   		<client>
   			<client_id>1</client_id>
   			<gender>Herr</gender>
   			<first_name>Max</first_name>
   			<last_name>Mustermann</last_name>
   			<company>Muster GmbH</company>
   			<street>Musterstraße</street>
   			<street_no>1</street_no>
   			<address_add>Seiteneingang</address_add>
   			<zip_code>11111</zip_code>
   			<city>Musterstadt</city>
   			<country>DE</country>
   			<email>max@mustermann.de</email>
   			<phone>123456-4555</phone>
   		</client>
   		<delivery_address>
   			<gender>Herr</gender>
   			<first_name>Max</first_name>
   			<last_name>Mustermann</last_name>
   			<company>Muster GmbH</company>
   			<street>Musterstraße</street>
   			<street_no>1</street_no>
   			<address_add>Seiteneingang</address_add>
   			<zip_code>11111</zip_code>
   			<city>Musterstadt</city>
   			<country>DE</country>
   		</delivery_address>
   		<items>
   			<item>
               <item_id>7</item_id>
   				<product_id>1</product_id>
   				<variant_id>5</variant_id>
   				<product_art_no>ART-99</product_art_no>
   				<name>Musterprodukt</name>
   				<name_add>Grün</name_add>
   				<qty>2</qty>
   				<price>10.00</price>
   				<price_sum>20.00</price_sum>
   				<tax>19.0</tax>
   			</item>
   		</items>
   		<coupon>
   			<coupon_id>1</coupon_id>
   			<total>10.00</total>
   			<code>ABCDEFG</code>
   			<comment>Neukunde</comment>
   		</coupon>
   	</order>
   </orders>
</result>
Element Datentyp Bedeutung
result Container Container mit angeforderten Daten
success Boolean Kennzeichen für einen erfolgreichen Aufruf
1 = erfolgreich
0 = erfolgreich (keine Datensätze gefunden)
-1 = fehlerhaft
orders Container Container mit Bestellungen
Beinhaltet keine Daten, wenn keine Bestellungen gefunden wurden!
paging Container Container mit Daten zum Paging
total Integer Anzahl aller Bestellungen
page Integer Aktuelle Seite
pages Integer Anzahl aller Seiten
per_page Integer Anzahl der Bestellungen pro Seite
order Container Container mit Daten zu einer Bestellung
order_no String Bestell-Nr.
total Float Gesamt-Preis der Bestellung
shipping Float Versandkosten
max_shipping_date Date Spätestes Versand-Datum der Bestellung
payment String
PP = Vorauskasse
CC = Kreditkarte
ELV = Lastschrift
ELV-AT = Lastschrift Österreich
SUE = Sofortüberweisung
CB = ClickAndBuy
INV = Rechnung
INV-AT = Rechnung Österreich
PAL = Paypal
PDK = paydirekt
GP = giropay
KLA = Klarna
MPA = mpass
BAR = Barzahlen
YAP = YAPITAL
status String
pending = Bestellung ist neu eingegangen
editable = Bestellung ist zur Bearbeitung freigegeben
shipped = Bestellung ist versendet
payout = Bestellung ist ausbezahlt
cancelled = Bestellung ist storniert
invoice_no String Rechnungs-Nr.
comment_client String Kommentar des Kunden
comment_merchant String Kommentar des Händlers
created Date Bestelleingangs-Datum
InLogistics Boolean Bestellung befindet sich in Versandvorbereitung.
0 = Bestellung noch nicht in Versandvorbereitung
1 = Bestellung ist in Versandvorbereitung
client Container Container mit Daten zum Kunden
client_id Integer ID
gender String Anrede
first_name String Vorname
last_name String Nachname
company String Firma
street String Straße
street_no String Haus-Nr.
address_add String Adresszusatz
zip_code Integer Postleitzahl
city String Stadt
country String Land im ISO2-Format
email String E-Mail-Adresse
phone String Telefon-Nr.
delivery_address Container Container mit Daten zur Lieferadresse
gender String Anrede
first_name String Vorname
last_name String Nachname
company String Firma
street String Straße
street_no String Haus-Nr.
address_add String Adresszusatz
zip_code Integer Postleitzahl
city String Stadt
country String Land im ISO2-Format
items Container Container mit Bestell-Positionen
item Container Container mit Daten zu einer Bestell-Position
item_id Integer ID der Bestell-Position
product_id Integer ID des Produkts
variant_id Integer ID der Variante
product_art_no String Artikel-Nummer
name String Bezeichnung des Produkts
name_add String Zusatz zur Bezeichnung
qty Integer Stückzahl
price Container Einzel-Preis
price_sum Float Gesamt-Preis
tax Integer Mehrwertsteuer-Klasse
1 = 19 %
2 = 7 %
3 = 0 %
4 = 10,7 %
10 = 10 %
11 = 12 %
12 = 20 %
13 = 13 %
coupon Container Container mit Daten zum Gutschein
coupon_id Integer ID
total Float Wert
code String Code
comment String Kommentar


Fehlermeldungen



Code Bedeutung
3205 Das angegebene Such-Feld ist nicht bekannt
3206 Die angegebene Sortierung ist nicht bekannt
3207 Zu einem Suchparameter wurde ein ungültiger Wert übergeben.
3210 Das Such-Feld zur Suche wurde nicht übergeben
3211 Die Suche zum Such-Feld wurde nicht übergeben