Supplier Portal APIs

Supplier & Customer API Dokumentation

REST APIs fuer Supplier-, Customer-, Preis-, Katalog-, OCI- und Bestell-Funktionen. Fachliche Endpunkte verwenden JSON oder den ausgewiesenen CSV-Download.

Getting started

Die API ist unter derselben Host-Basis wie das Supplier Portal erreichbar. Beispiele verwenden https://supplier-portal.example.com als Platzhalter. 

curl -H "Authorization: Bearer <api_key>" \
     -H "Accept: application/json" \
     https://supplier-portal.example.com/api/v1/products?limit=10

Content-type

Requests mit Body senden Content-Type: application/json. Responses werden als JSON ausgeliefert.

Accept language

Die aktuelle API lokalisiert Response-Inhalte nicht. Clients koennen Accept-Language senden; die fachlichen Daten bleiben unveraendert.

Query parameters

Listen-Endpunkte akzeptieren je nach Ressource Filter. limit ist auf 1 bis 200 begrenzt und faellt ohne Angabe auf 50 zurueck.

Authentication

Alle Endpunkte ausser GET /health erwarten einen gehasht gespeicherten, aktiven Bearer-API-Key. Nur die nach einem erfolgreichen OCI-Login ausgewiesenen OCI-Sitzungsrouten verwenden stattdessen X-OCI-Session: <session_token>. Supplier- und Customer-Keys besitzen getrennte Identitaeten und Scopes.

Scope Berechtigung
products:readProdukte, Varianten, Kategorien und Attribute lesen
prices:readUsergroups, Preislisten und Preise lesen
prices:writePreislisten und Preispositionen schreiben
orders:readBestellungen und Bestellpositionen lesen
orders:writeAbschaltbare Customer-Checkout-/Bestellanforderungen ausloesen
catalog:readFreigegebene Supplier und tagesaktuellen Customer-CSV-Katalog lesen
oci:login / oci:catalog / oci:return / oci:orderOCI-Sitzung, Katalog, Rueckgabe oder abschaltbare Checkout-Bestellung verwenden
billing:readBilling, Invoices und Sales lesen
billing:writeBilling-Positionen ergaenzen und eigene Menge/Preis korrigieren

Documentation maintenance

Sobald sich die API aendert, muss diese Dokumentation im selben Change automatisch mit angepasst werden. Der Check python3 scripts/check-api-docs.py vergleicht die FastAPI-Routen mit den hier dokumentierten Endpunkten und sollte vor jedem Merge laufen.

Resources