Menu
EVENT: shipment.status
ENDPOINT: POST /v1/patients/{patientId}/event
Endpoint Example
For the User Updates API endpoint, you will need to replace the
Example: POST /v1/patients/ha98402932/subscribe-campaign
{patientId} variable with your patient's HA ID.Example: POST /v1/patients/ha98402932/subscribe-campaign
The shipment.status event updates the patient’s record with their order’s shipment status.
Possible values in the text field:
| Text Field Value | Description |
|---|---|
consultationReq | Consultation With Patient Required |
shipped | Order Has Shipped |
hold | Order Is On Hold |
Example code to notate that a patient’s order has shipped using the shipped value in the text field:
{
"status": {
"name": "shipment.status",
"text": "shipped"
},
"phoneNumber": "{{test-user-phone-number}}",
"externalId": "{{test-user-external-user-id}}",
"supportProgramId": "{{partners-support-program-id}}"
}