Überblick
Mit der Händler-API steuerst du dein Shirtee-Konto aus deiner eigenen Software: Bestellungen anlegen und verfolgen, den Katalog lesen, Rechnungen abrufen, Reklamationen melden und Anlieferungen ins Lager planen. Die API ist eine REST-Schnittstelle mit JSON.
Basis-Adresse
Abschnitt betitelt „Basis-Adresse“https://gateway.shirtee.cloudAlle Pfade beginnen mit /api, zum Beispiel GET /api/orders. Die Verbindung läuft nur über HTTPS. Anfragen und Antworten sind JSON; Datei-Uploads (Lieferbeleg, Reklamationsfotos, Anlieferungsdokumente, Versandliste) sind multipart/form-data.
Was du damit machst
Abschnitt betitelt „Was du damit machst“| Bereich | Was möglich ist |
|---|---|
| Bestellungen | Bestellung per Vorschau prüfen und anlegen, Status und Verlauf lesen, stornieren, Adressen und Positionen ändern, nachbestellen, Lieferbeleg hochladen |
| Katalog | Produkte, Varianten, Farben und Größen lesen, Variante per SKU finden, Verfügbarkeit prüfen |
| Rechnungen | Rechnungen und Gutschriften auflisten, PDF abrufen |
| Reklamationen | Reklamation mit Fotos als Entwurf anlegen, einreichen, Rückfragen beantworten, zurückziehen |
| Lager | Anlieferungen planen und ändern, Versandliste einlesen, Dokumente hochladen, Lagerprodukte pflegen, Sicherheitsbestand lesen |
Die API-Referenz beschreibt jede Operation mit Parametern, Beispielen und allen Antwortcodes.
So fängst du an
Abschnitt betitelt „So fängst du an“Was es nicht gibt
Abschnitt betitelt „Was es nicht gibt“Voraussetzungen
Abschnitt betitelt „Voraussetzungen“Du brauchst ein Händlerkonto mit Portal-Login. Welche Funktionen deine Schlüssel nutzen dürfen, hängt von der Freischaltung deines Kontos ab, siehe Scopes und Freischaltung.
Postman
Abschnitt betitelt „Postman“Zum schnellen Ausprobieren gibt es eine Postman-Collection mit allen Anfragen. Setze die Variable apiKey auf deinen API-Schlüssel. Schreibende Anfragen wirken live, siehe oben.