prescription.courier_requested

Payload

Courier requested event, enabled per telemedicine provider. Sent for externally shipped orders (shipping.isExternal: true) when the pharmacy calls the courier after packaging. Book the courier for requestedPickupAt; that is when the pharmacy expects the driver. Sent once per delivery attempt. If a delivery fails and you report the return with POST /prescriptions/{id}/external-shipping/return, the pharmacy can call the courier again, and you receive this event again with the next attempt number.

string
enum
required
Allowed:
number
required

Unix timestamp

prescription
object
required
date-time
required

When the courier should pick up the package at the pharmacy (ISO 8601, UTC)

integer
required
≥ 1

Delivery attempt of the order: 1 for the first courier, 2 after the first return, and so on

Response
200

Event processed successfully

LoadingLoading…