Bestellungen
Rufen Sie Bestellinformationen ab, einschließlich Positionen, Fulfillment-Aufträgen und Shop-Daten.Diese Seite behandelt das Lesen von Bestelldaten. Wenn Ihre Organisation über einen anderen
Kanal als Shopify verkauft und Bestellungen in RxScale einspielen muss, siehe
Bestellerfassung.
Bestellungen auflisten
Nach dem Identifier des Shops filtern (der String, den Sie bei der
Shop-Einrichtung konfiguriert haben). Es werden nur Bestellungen
zurückgegeben, deren verknüpfter Shop zu Ihrer Organisation gehört und
diesen Identifier hat.
Nach der externen Bestell-ID filtern, die vom Shop bzw. der
E-Commerce-Plattform vergeben wurde (z. B. die Shopify-Bestellnummer).
Kombinieren Sie diesen Parameter mit
shop_identifier, um eine
bestimmte Shop-Bestellung nachzuschlagen.Volltextsuche über den Shop-Bestellnamen (einen Shopify-Namen wie
#1001
oder eine Storefront-Bestellnummer wie RXS-1001), den Apotheken-Bestellnamen
(z. B. PO-XXXX-XXXX-XXXX) und den vollständigen Namen des Patienten.
Derselbe Wert wird zusätzlich als exakte UID gegen die Bestellung, ihre
Verschreibungen und ihre Apothekenbestellungen abgeglichen, sodass Sie
eine ID direkt einfügen können. Ein führendes # wird vor der
UID-Suche entfernt, damit aus der Admin-Oberfläche kopierte Werte
(z. B. #ord_…) wie erwartet aufgelöst werden.order:read
Beispielanfrage
Eine bestimmte Shop-Bestellung nachschlagen
Kombinieren Sieshop_identifier und shop_order_external_id, um genau
die Bestellung zu finden, die beide Werte erfüllt. Die Antwortstruktur
bleibt unverändert (paginierte Liste), das Ergebnis enthält jedoch
höchstens eine Bestellung.
Antwort
Antwortfelder
Bestelldetails abrufen
order:read
Gibt die gleiche Struktur wie ein einzelner Eintrag in der Listenantwort zurück.
Beispielanfrage
Rezeptdaten
Rezeptdaten werden nur einbezogen, wenn Ihr API-Schlüssel auch die Berechtigungprescription:read besitzt. Ohne diese Berechtigung:
- Das
prescriptions-Array wird als[]zurückgegeben - Das Feld
prescription_uidwird aus den Bestellpositionen entfernt
Wenn Sie Rezeptdetails benötigen, stellen Sie sicher, dass Ihr API-Schlüssel sowohl die Berechtigung
order:read als auch prescription:read besitzt. Kontaktieren Sie Ihren RxScale-Kundenbetreuer, um Berechtigungen anzupassen.Split-Payment-Routing
Stellen Sie on-demand Split-Payment-Routing für eine abgeschlossene oder stornierte Bestellung bzw. für eine einzelne abgeschlossene Apothekenbestellung in die Warteschlange. Diese Endpunkte nehmen die Anfrage nur an und veröffentlichen ein Event; die Geldbewegung läuft asynchron im Split-Payment-Handler. Das Routing kann etwa eine Minute dauern. Derselbe POST erneut auszuführen, stellt eine weitere Routing-Ausführung in die Warteschlange (der Handler bleibt additiv und idempotent). Erforderliche Berechtigung:split_payment:route (wird nicht durch order:write abgedeckt)
Split Payment für Bestellung routen
completed oder cancelled haben. Jeder andere Status führt zu 400 Bad Request ohne Event-Veröffentlichung.
Beispielanfrage
Beispielantwort (202 Accepted)
Split Payment für Apothekenbestellung routen
completed sein, und die übergeordnete Bestellung darf nicht cancelled sein. Andernfalls antwortet die API mit 400 Bad Request ohne Event-Veröffentlichung.
Beispielanfrage
Beispielantwort (202 Accepted)
Fehler
Apothekenbestellungen
Zu jeder Bestellung können eine oder mehrere Apothekenbestellungen gehören — also der Teil der Bestellung, den eine bestimmte Apotheke beliefert. Sie erscheinen in den obigen Antworten unterpharmacy_orders.
Eine Apothekenbestellung führt zwei unterschiedliche Statusfelder:
Status erneut bei der Apotheke abfragen
pharmacy_order:write
Fordert RxScale auf, den Status dieser Apothekenbestellung sofort bei der
Apotheke abzufragen, statt die nächste planmäßige Prüfung abzuwarten.
Die Prüfung läuft asynchron. Dieser Endpunkt stellt sie in die Warteschlange
und antwortet sofort mit 202 Accepted sowie der Apothekenbestellung in dem
Zustand vor der Prüfung — der external_status in der Antwort ist also noch
der alte Wert, nicht der neu abgefragte. Sobald die Apotheke antwortet, wird
external_status aktualisiert. Meldet die Apotheke die Bestellung als
versandt, abgeschlossen oder storniert, wechselt die Apothekenbestellung
zusätzlich ihren Status und die üblichen Webhooks werden ausgelöst.
Um das Ergebnis zu sehen, rufen Sie entweder
GET /v1/management/orders/{order_uid} erneut ab oder abonnieren Sie die
Webhooks für Apothekenbestellungen.
Beispielanfrage
Beispielantwort
Fehler
Externen Status setzen
Der rohe Statustext der Apotheke, höchstens 255 Zeichen. Senden Sie einen
leeren String (oder
null), um ihn zu löschen.pharmacy_order:write
Hinterlegt den apothekenseitigen Status selbst — nützlich, wenn RxScale keine
direkte Verbindung zum System der Apotheke hat.
Bei Apotheken, die RxScale direkt abfragt, kann eine spätere automatische
Statusprüfung einen hier gesetzten Wert überschreiben.
external_status wird als null zurückgegeben.