Dokumentation zur Rakuten Shop-API


getShopCategories

Diese Methode gibt alle Shop-Kategorien 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
shop_category_id

ID der Shop-Kategorie

Datentyp: Integer
external_shop_category_id

ID der Shop-Kategorie aus einem externen System

Datentyp: String
Regeln: Maximal 20 Zeichen sind erlaubt.
parent_shop_category_id

ID der Eltern-Shop-Kategorie

Datentyp: Integer
external_parent_shop_category_id

ID der Eltern-Shop-Kategorie aus einem externen System

Datentyp: String
Regeln: Maximal 20 Zeichen sind erlaubt.
breadcrumb_path

Kategorie-Pfad bestehend aus den Kategorie-IDs

Datentyp: String
Regeln: Das Format des Pfades ist z.B. 3,4,5 (IDs mit Komma getrennt).
external_breadcrumb_path

Kategorie-Pfad bestehend aus den externen Kategorie-IDs

Datentyp: String
Regeln: Das Format des Pfades ist z.B. 3,80,500 (IDs mit Komma getrennt).
visible

Sichtbarkeit der Shop-Kategorie

Datentyp: Integer
Regeln:
0 = Im Kategoriebaum ausgeblendet
1 = Im Kategoriebaum angezeigt
-1 = Deaktiviert
layout

Produkt-Darstellung in der Shop-Kategorie

Datentyp: String
Regeln:
products = Produkte aus dieser Kategorie
child_products = Produkte aus dieser Kategorie und Unterkategorien
no_products = Keine Produkte, nur Beschreibung anzeigen
product_order

Sortierung der Produkte in der Kategorie

Datentyp: String
Regeln:
manual = Manuell
popularity = Beliebtheit
price_asc = Preis (aufsteigend)
price_desc = Preis (absteigend)
name_asc = Name (aufsteigend)
name_desc = Name (absteigend)
created_desc = Erstellungs-Datum
art_no_asc = Artikel-Nummer (aufsteigend)
art_no_desc = Artikel-Nummer (absteigend)
per_page

Anzahl der Kategorien pro Seite

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

Aktuelle Seite

Datentyp: Integer

Antwort

Beispiel im XML-Format.

<?xml version="1.0" encoding="utf-8"?>
<result>
   <success>1</success>
   <categories>
   	<paging>
   		<total>1</total>
   		<page>1</page>
   		<pages>1</pages>
   		<per_page>20</per_page>
   	</paging>
   	<category>
   		<parent_shop_category_id>3</parent_shop_category_id>
   		<external_parent_shop_category_id>EXT123PARENT</external_parent_shop_category_id>
   		<shop_category_id>2</shop_category_id>
   		<external_shop_category_id>EXT123</external_shop_category_id>
   		<name>Bücher</name>
   		<visible>1</visible>
   		<layout>child_products</layout>
   		<product_order>manual</product_order>
   		<url>http://www.rakuten.de/accessoires/uhren</url>
   		<breadcrumb_path>3,4,5</breadcrumb_path>
   		<external_breadcrumb_path>3,4,5</external_breadcrumb_path>
   		<seo>
   			<meta_title>Accessoires wie Uhren, Brillen und Halsketten</meta_title>
   			<meta_description>Sehr schöne Accessoires</meta_description>
   			<meta_keywords>Uhren, Brillen, Halsketten</meta_keywords>
   		</seo>
   	</category>
   </categories>
</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
categories Container Container mit Kategorien
paging Container Container mit Daten zum Paging
total Integer Anzahl aller Kategorien
page Integer Aktuelle Seite
pages Integer Anzahl aller Seiten
per_page Integer Anzahl der Kategorien pro Seite
category Container Container mit Kategorie-Daten
parent_shop_category_id Integer ID der Eltern-Shop-Kategorie
external_parent_shop_category_id String ID der Eltern-Shop-Kategorie aus externem System
shop_category_id Integer ID der Shop-Kategorie
external_shop_category_id String ID der Shop-Kategorie aus externem System
name String Bezeichnung der Kategorie
visible Integer Sichtbarkeit der Kategorie
0 = Im Kategoriebaum ausblendet
1 = Im Kategoriebaum anzeiget
-1 = Deaktiviert
layout String Produkt-Darstellung in der Shop-Kategorie
products = Produkte aus dieser Kategorie
child_products = Produkte aus dieser Kategorie und Unterkategorien
no_products = Keine Produkte, nur die Beschreibung wird anzeigt
product_order String Sortierung der Produkte in der Kategorie
manual = Manuelle Sortierung
popularity = Beliebtheit
price_asc = Preis (aufsteigend)
price_desc = Preis (absteigend)
name_asc = Name (aufsteigend)
name_desc = Name (absteigend)
created_desc = Erstellungs-Datum (absteigend)
art_no_asc = Artikel-Nummer (aufsteigend)
art_no_desc = Artikel-Nummer (absteigend)
url URL URL zur Shop-Kategorie
breadcrumb_path String Kategorie-Pfad aus den Shop-Kategorie-IDs
Das Format des Pfades ist z.B. 3,4,5
(IDs mit Komma getrennt).
external_breadcrumb_path String Kategorie-Pfad aus den externen Kategorie-IDs
Das Format des Pfades ist z.B. 3,80,500
(IDs mit Komma getrennt).
seo Container Daten zur Suchmaschinen-Optimierung
meta_title Container Seiten-Titel (SEO) der Shop-Kategorie
meta_description Container Seiten-Beschreibung (SEO) der Shop-Kategorie
meta_keywords Container Schlüsselwörter (SEO) der Kategorie-Seite


Fehlermeldungen



Code Bedeutung
4005 Die Shop-Kategorie konnte nicht gefunden werden