Skip to main content

Listing-Anfragen

Apotheken können einen Shop bitten, ein Produkt aufzunehmen, das sie bereits führen. Die Management API stellt den organisationsweiten Posteingang für diese Anfragen bereit: auflisten, eingereichte Felder einsehen und eine Annahme oder Ablehnung festhalten. Annahme und Ablehnung halten nur die Entscheidung fest. Sie legen keine Katalogzeilen an (Product, SKU, ShopProduct) und stoßen nichts an Shopify oder WooCommerce an. Alle Endpoints sind auf die Organisation beschränkt, der der API-Schlüssel gehört. UIDs einer anderen Organisation werden als nicht gefunden behandelt. Welche Felder eine Apotheke liefern muss, konfigurieren Sie in der Admin-Oberfläche, nicht über diese API.

Berechtigungen

Listing-Anfrage-Endpoints werden durch zwei Berechtigungen gesteuert:
  • listing_request:read — erforderlich für alle Lese-Endpoints (GET).
  • listing_request:write — erforderlich zum Annehmen oder Ablehnen.
Ein Schlüssel mit listing_request:write erhält nicht automatisch listing_request:read; fügen Sie beide hinzu, wenn Sie lesen und schreiben müssen. Kontaktieren Sie Ihren RxScale-Kundenbetreuer, um Berechtigungen anzupassen. Alle Anfragen authentifizieren sich mit dem Header X-API-Key. Siehe Authentifizierung für Details.

Form der Anfrage

Es gibt kein Top-Level-Feld pzn. PZN ist ein gewöhnlicher Extras-Schlüssel: ein Shop muss eine pzn-Extras-Anforderung konfigurieren, bevor eine Apotheke eine PZN senden kann. Der Wert erscheint dann unter extras.pzn in der Antwort. price_indication ist eine Ganzzahl in Kleinsteinheiten (Cent), analog zu Apotheken-SKU-Preisen.
Attributfilter (attr.*) und PZN-Filter sind in v1 auf der Management API nicht verfügbar. Sie sind nur in der Admin-Oberfläche vorhanden. Filtern Sie hier nur mit shop_uid, pharmacy_uid und status.

Listing-Anfragen auflisten

Gibt eine paginierte Liste der Listing-Anfragen der Organisation zurück. Erforderliche Berechtigung: listing_request:read
integer
Standard:"0"
Seitennummer (0-basiert)
integer
Standard:"50"
Anzahl der Listing-Anfragen pro Seite
string
Nach Shop-UID filtern. Unbekannte Shops dieser Organisation liefern 404.
string
Nach Apotheken-UID filtern
string
Nach Status filtern. Einer von PENDING, ACCEPTED, DECLINED oder WITHDRAWN.

Beispielanfrage

Antwort

Listing-Anfrage abrufen

Erforderliche Berechtigung: listing_request:read
string
erforderlich
UID der Listing-Anfrage

Beispielanfrage

Eine fehlende UID oder eine UID einer anderen Organisation liefert 404.

Listing-Anfrage annehmen

Hält eine Annahme fest. Legt keine Katalogprodukte an und stößt nichts an einen Storefront an. Erforderliche Berechtigung: listing_request:write
string
erforderlich
UID der Listing-Anfrage
string
Optionale Notiz zur Entscheidung

Beispielanfrage

Nur Anfragen mit Status PENDING können angenommen werden. Eine bereits entschiedene Anfrage liefert 400.

Listing-Anfrage ablehnen

Hält eine Ablehnung fest. Erforderliche Berechtigung: listing_request:write
string
erforderlich
UID der Listing-Anfrage
string
Optionale Notiz zur Entscheidung

Beispielanfrage

Nur Anfragen mit Status PENDING können abgelehnt werden. Eine bereits entschiedene Anfrage liefert 400.