Report a failed delivery that came back

Reports that your courier brought an externally shipped order back to the pharmacy, e.g. because the patient was not at home. Only for providers that book the courier on the prescription_courier_requested webhook, and only after that webhook was sent for the current delivery. The pharmacy sees the return and the reason in the order. It can then call a courier again; the next prescription_courier_requested webhook carries the next attempt number. The goods stay in the pharmacy, so no stock changes. Idempotent: repeating a return that was already recorded returns 200 and changes nothing. Not yet available for pharmacies that work with an external ERP.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the prescription

Body Params
string
length between 1 and 500

Why the delivery failed, e.g. "Patient nicht angetroffen". Shown to the pharmacy in the order history.

Responses

Retry-After seconds.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json