Replace external shipping details

Replaces the complete shipping configuration of an externally shipped order (i.e. orders created with shipping.isExternal: true), e.g. when the courier is booked after the order was created. Send the complete current configuration on every request: all omitted fields are cleared, including pickup and return codes, tracking, and pickup time. An empty object clears all shipping details. Unknown fields are rejected. The pharmacy sees the new details in the order. If pickupVerificationCode changes or is removed after the pharmacy printed the shipping label, the order history asks the pharmacy to print the label again. Without a pickup code the label QR contains the order ID. Send the pickup code with POST /prescriptions/paid when known, and include it in every replacement that should retain it. Emails already sent to the patient are not sent again. Allowed until the order is completed or canceled. Active labels are reconciled to the snapshot; repeating an already synchronized snapshot records no additional event.

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
uri

Patient/pharmacy tracking link. Will be included in the order details and emails sent to the patient if email notifications are enabled.

string
length ≥ 1

Carrier tracking identifier

date-time
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

ISO 8601 with timezone (e.g. UTC 'Z' or +/-HH:MM) - when driver arrives at pharmacy

string
length ≥ 1

Value encoded in the QR/barcode on the shipping label; scanned by the delivery driver at pickup to verify the correct package

string
length ≥ 1

Code used to verify a return to the pharmacy; displayed in the order details

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