Dokumentation zur Rakuten Shop-API


addShopCategory

Fügt eine neue Shop-Kategorie hinzu.

Mit dieser URL rufen Sie die API-Methode auf:

Authentifizierung

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

Parameter

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

key *

Authentifizierungs-Schlüssel

Datentyp: String
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.
name *

Bezeichnung der Shop-Kategorie

Datentyp: String
description

Beschreibung der Shop-Kategorie

Datentyp: String
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 Shop-Kategorie

Datentyp: String
Regeln:
manual = Manuelle Sortierung
popularity = Beliebtheit
price_asc = Preis (aufsteigend)
price_desc = Preis (absteigend)
name_asc = Name (aufsteigend)
name_desc = Name (absteigend)
created = Erstellungs-Datum (absteigend)
art_no_asc = Artikel-Nummer (aufsteigend)
art_no_desc = Artikel-Nummer (absteigend)
visible

Sichtbarkeit der Shop-Kategorie

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

Position der Kategorie in der Kategorie-Ebene

Datentyp: Integer
url

URL zur Kategorie im Shop

Datentyp: String
meta_title

Seiten-Titel (SEO) der Shop-Kategorie

Datentyp: String
meta_description

Seiten-Beschreibung (SEO) der Shop-Kategorie

Datentyp: String
meta_keywords

Schlüsselwörter (SEO) der Kategorie-Seite

Datentyp: String

Antwort

Beispiel im XML-Format.

<?xml version="1.0" encoding="utf-8"?>
<result>
   <success>1</success>
   <shop_category_id>1</shop_category_id>
</result>
Element Datentyp Bedeutung
result Container Container mit angeforderten Daten
success Boolean Kennzeichen für einen erfolgreichen Aufruf
1 = erfolgreich
-1 = fehlerhaft
shop_category_id Integer ID der Shop-Kategorie


Fehlermeldungen



Code Bedeutung
3905 Die Eltern-Shop-Kategorie konnte nicht gefunden werden
3910 Die externe Shop-Kategorie-ID ist bereits vergeben
3915 Der Parameter "url" besitzt einen ungültigen Wert
3920 Es können keine Kategorien mit gleichem Namen auf gleicher Ebene erstellt werden.