Zum Hauptinhalt springen

Produkte

Rufen Sie eine paginierte Liste der in einem bestimmten Shop verfügbaren Produkte ab, gefiltert nach Markt.

Produkte auflisten

string
erforderlich
Eindeutiger Bezeichner für den Shop
string
erforderlich
Marktbezeichner (z. B. DE für Deutschland)
Produkte und SKUs nach Name filtern
integer
Standard:"0"
Seitennummer (0-basiert)
integer
Standard:"50"
Produkte pro Seite (max. 150). Produkte sind nach Anzeigenamen sortiert, und jedes Produkt erscheint auf genau einer Seite, zusammen mit allen passenden SKUs.
Erforderliche Berechtigung: telemed_product:read
Produkte mit Shopify-Status DRAFT oder ARCHIVED werden ausgeschlossen. Produkte mit Status ACTIVE oder UNLISTED bleiben verfügbar. Der Status wird zum Zeitpunkt der Anfrage direkt bei Shopify geprüft — ein archiviertes Produkt verschwindet also sofort.

Beispielanfrage

Antwort

Antwortfelder

Fehlerantworten

Live Stock prüfen

Prüfen Sie vor dem Checkout, ob eine oder mehrere SKUs aktuell in der angefragten Menge verfügbar sind.
string
erforderlich
Eindeutiger Bezeichner für den Shop
Erforderliche Berechtigung: telemed_product:read
Live Stock wird gegen den aktuell verfügbaren Shopify-Bestand der zugeordneten Produktvarianten geprüft. Darin enthalten sind Bestände, die bereits durch Shopify-Bestellungen und Draft-Order-Reservierungen gehalten werden.

Anfragekörper

Jede aufgelöste sku_uid darf pro Live-Stock-Anfrage nur einmal vorkommen.
Wenn Sie external_id senden, muss der API-Key mit einem Telemedizin-Anbieter verknüpft sein. Eine Position, deren external_id oder sku_uid in diesem Shop nicht verkauft wird, liefert 404 mit code unknown_sku und benennt die Position — siehe Reason-Codes der Public API.

Beispielanfrage

Antwort bei Verfügbarkeit

Wenn alle angefragten Mengen verfügbar sind, gibt der Endpoint 200 OK zurück.

Antwort bei fehlender Verfügbarkeit

Wenn mindestens eine angefragte Menge nicht verfügbar ist, gibt der Endpoint 409 Conflict zurück.

Antwortfelder

Fehlerantworten

Produkte reservieren

Erstellen Sie einen Shopify-Bestellentwurf mit einer Bestandsreservierung für 24 Stunden, bevor Rezepte vorliegen. Verwenden Sie die zurückgegebene Draft-Order-ID später als reserved_draft_order_id, wenn Sie signierte Rezepte hochladen.
string
erforderlich
Eindeutiger Bezeichner für den Shop
Erforderliche Berechtigung: create_prescription_checkout
Die Reservierungsanfrage enthält keine Rezepte und keine Patientendaten. RxScale ergänzt Telemedizin-Anbieter-Attribute automatisch anhand des API-Keys.
Der API-Key muss mit einem Telemedizin-Anbieter verknüpft sein. Anfragen mit einem nicht-telemedizinischen API-Key werden mit 400 Bad Request abgelehnt, bevor Bestand reserviert wird, da der resultierende Bestellentwurf beim späteren Rezept-Upload nicht zugeordnet werden könnte.

Anfragekörper

Jede aufgelöste sku_uid darf pro Reservierungsanfrage nur einmal vorkommen. Doppelte SKU-Zeilen werden abgelehnt, weil der spätere Rezept-Upload jede reservierte Draft-Order-Zeile eindeutig zuordnen muss.

Beispielanfrage

Antwort

draft_order.id ist die Shopify Legacy-DraftOrder-ID, nicht die Shopify-GID. Übergeben Sie diesen Wert nach der Signatur der Rezepte als reserved_draft_order_id an POST /v2/public-api/prescriptions/{shop_identifier}.

Eine Reservierung wiederholen

Eine Reservierung ist über die external_reservation_id idempotent. Wenn die Antwort nicht bei Ihnen ankommt — ein Timeout, eine abgebrochene Verbindung —, senden Sie dieselbe Anfrage mit derselben ID erneut:
  • Gleiche ID, gleiche Positionen: 200 mit dem bereits bestehenden Bestellentwurf. draft_order.id, invoiceUrl und reserve_inventory_until sind die der ersten Anfrage; es wird nichts Neues reserviert und die Frist nicht verlängert. Die Positionen gelten als gleich, wenn sie dieselben SKUs in denselben Mengen reservieren — unabhängig von der Reihenfolge und davon, ob Sie sie per sku_uid oder per external_id angeben.
  • Gleiche ID, andere Positionen: 409 mit code duplicate_reservation. Eine ID steht für genau eine Reservierung; verwenden Sie für eine neue Reservierung eine neue ID.
Die ID ist je Shop und Telemedizin-Anbieter eindeutig. Eine abgelehnte Anfrage (4xx, 502) reserviert nichts und gibt die ID wieder frei; Sie können sie erneut senden, sobald die Ursache behoben ist. Lassen Sie external_reservation_id weg, und jede Anfrage erzeugt einen neuen Bestellentwurf. "" ist ein validation_error und nicht dasselbe wie das Weglassen des Feldes.

Fehlerantworten

Wird die Anfrage mit einem 4xx-Status abgelehnt, wird keine Draft Order angelegt und kein Bestand reserviert.