API-Dokumentation
Allgemeines
Für die einfache Integration von Shopgate in Ihren Shop bieten wir Ihnen eine vorgefertigte PHP-Klasse an. Um die Klasse nutzen zu können müssen PHP5 und CURL auf dem Server installiert sein.
Download
Die Methoden
Hier erhalten Sie einen Überblick über die vorhandenen API-Methoden. Klicken Sie auf einen Methodennamen, erhalten Sie weitere Informationen.
orders
- orders_get_list
- orders_get_not_completed_list
- orders_get_not_approved_list
- orders_get_details
- orders_add_delivery_note
- orders_set_shipping_status_completed
- orders_add_invoice
- orders_send_message
- orders_batch_set_shipping_status_completed
categories
- categories_get_tree
- categories_delete
- categories_add
- categories_update
- categories_remove_item
- categories_add_item
items
Überblick
Die Shopgate-API besteht aus mehreren Methoden. Über diese Methoden lassen sich dem Server Befehle übermitteln. Um eine Anfrage durchzuführen, müssen Sie eine Methode aufrufen und verschiedene Argumente übergeben. Daraufhin erhalten Sie eine Antwort im JSON-Format.
Neben methodenspezifischen Parametern gibt es einige globale Parameter, die Sie für jeden Methodenaufruf benötigen:
- apikey
- Mit dem Apikey identifizieren Sie sich gegenüber Shopgate
- customer_number
- Ihre Kundennummer bei Shopgate
- shop_number
- Mit der shop_number wählen Sie den Shop aus, für den Sie Aktionen durchführen wollen.
Die Parameter und Fehlercodes für jede Methode, finden Sie auf der jeweiligen Spezifaktionsseite aufgelistet. Die Methoden werden auf der Übersichtsseite aufgeführt.
Bestellungen übermitteln
Diese Grafik zeigt Ihnen den Ablauf, wie neue Bestellungen automatisiert von Shopgate zu Ihrem System übertragen werden. Nachdem ein Kunde Ihre Produkte bestellt hat erfolgt die Zahlung auf ein Treuhandkonto der Shopgate GmbH. Anschließend werden Sie per HTTP-Script-Aufruf über den Eingang der neuen Bestellung informiert. Hierbei wird die Bestellnummer übertragen. Nun kann das Shopsystem von Ihnen eine Anfrage an unsere API mit der Bestellnummer stellen und so sicher und zuverlässig die Bestelldaten abrufen und im internen System speichern.
Versand bestätigen
Nachdem der Händler die Waren an den Kunden verschickt hat, muss er den Versand an Shopgate bestätigen und die Tracking-Nummer (sofern vorhanden) übermitteln. Shopgate bestätigt anschließend dem Kunden den Versand und gibt die Zahlung für den Händler nach erfolgter Lieferung frei.




