Diese Methode gibt Bestellungen des Händlers aus.
Mit dieser URL rufen Sie die API-Methode auf:
http://webservice.rakuten.de/merchants/orders/getOrders
Für diese Methode ist eine Authentifizierung mit Leserechten erforderlich.
Empfohlen wird der Aufruf über HTTP-GET.
Die mit * gekennzeichneten Parameter müssen übergeben werden.
Authentifizierungs-Schlüssel
| Datentyp: | String |
Filter: Such-Text
| Datentyp: | String |
| Regeln: | Zu einem Such-Text muss ein entsprechendes Such-Feld angegeben sein. Maximal 100 Zeichen sind erlaubt. |
Filter: Such-Feld
| Datentyp: | String | |||||||||||||||||||||
| Regeln: |
Zu einem Such-Feld muss ein entsprechender Such-Text angegeben sein. |
Filter: Status
| Datentyp: | String | |||||||||||||||
| Regeln: |
|
Filter: Von
| Datentyp: | Date |
Filter: Bis
| Datentyp: | Date |
Sortierung
| Datentyp: | String | ||||||
| Standard: |
|
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. |
Akutelle Seite
| Datentyp: | Integer |
| Standard: | 1 |
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>
<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>
<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
|
|||||||||||||||||||||||||||
| 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 | Versankosten | |||||||||||||||||||||||||||
| max_shipping_date | Date | Spätestes Versand-Datum der Bestellung | |||||||||||||||||||||||||||
| payment | String |
|
|||||||||||||||||||||||||||
| status | String |
|
|||||||||||||||||||||||||||
| invoice_no | String | Rechnungs-Nr. | |||||||||||||||||||||||||||
| comment_client | String | Kommentar des Kunden | |||||||||||||||||||||||||||
| comment_merchant | String | Kommentar des Händlers | |||||||||||||||||||||||||||
| created | Date | Bestelleingangs-Datum | |||||||||||||||||||||||||||
| 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 | |||||||||||||||||||||||||||
| 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ß | |||||||||||||||||||||||||||
| 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 | |||||||||||||||||||||||||||
| 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
|
|||||||||||||||||||||||||||
| coupon | Container | Container mit Daten zum Gutschein | |||||||||||||||||||||||||||
| coupon_id | Integer | ID | |||||||||||||||||||||||||||
| total | Float | Wert | |||||||||||||||||||||||||||
| code | String | Code | |||||||||||||||||||||||||||
| comment | String | Kommentar |
| Code | Bedeutung |
|---|---|
| 3205 | Das angegebene Such-Feld ist nicht bekannt |
| 3206 | Die angegebene Sortierung ist nicht bekannt |
| 3210 | Das Such-Feld zur Suche wurde nicht übergeben |
| 3211 | Die Suche zum Such-Feld wurde nicht übergeben |