Menu
Tracking Shipment Updates
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
RxWare offers integrated FedEx shipment tracking.
This Case Update allows partners to provide the FedEx tracking number within the payload so that patients and caregivers can quickly and easily receive updates about and track their treatment shipments:
Schema:
{
"status": {
"name": "shipment.status",
"text": "shipped",
"additionalData": [
{
"key": "trackerCode",
"value": "{{tracking-code}}"
}
]
},
"phoneNumber": "{{test-user-phone-number}}",
"externalId": "{{test-user-external-user-id}}",
"supportProgramId": "{{partners-support-program-id}}"
}
Standard Response Codes
| Status | Code | Message | Description |
|---|---|---|---|
200 | N/A | Patient updated successfully | Patient updated successfully |
401 | 0 | Unauthorized | Please verify with RxWare that you are authorized to use the RxWare API. |
400 | 1006 | Patient Not Found | Patient cannot be found in the system. |
400 | 2002 | Invalid Support Program ID | This means that the supportProgramId you provided is invalid.Please check your Support Program ID. |
400 | 1005 | User Previously Unsubscribed | |
403 | 403 | Invalid Token | This means that the bearer token you supplied is not valid for this Support Program. Please verify your credentials. |