Integration guides

Method: CSV or EDI over SFTP, or email parsing. SA wholesalers publish no public APIs, so files are the norm.

1. Agree the manifest template (below) and cut-off times per lane.
2. Hazchem issues an SFTP folder per DC; drop one file per wave.
3. Each row becomes a job; validation errors come back in a .err file within 2 minutes.
4. A POD return file (CSV) lands in /outbound after each delivery, with seal and signature links.

Data exchanged: Order and tote IDs, consignee sites, temperature class. No patient data on wholesale lanes.

order_id,consignee_site,consignee_name,drop_window,totes,temperature_class,schedule_max,un_number,reference
SO-448120,ph-4,CarePoint Pharmacy Irene,10:00-12:00,3,ambient,S4,,PO 99812
SO-448121,ph-7,Highveld Pharmacy Kempton,10:00-12:00,1,2-8C,S4,,PO 99815

Method: Hazchem Partner portal by default; API (partner:orders) or CSV for chains; vendor link where the dispensing vendor supports it.

1. Mark an order ready from the dispensary: POST /v1/partner/orders/{id}/ready with the sealed bag number.
2. Quote availability and SEP + dispensing fee via POST /v1/partner/quotes (patient chooses the pharmacy).
3. Receive delivery.completed and delivery.failed webhooks to close or restock the order.
4. Stock feed (optional): POST /v1/partner/stock-feed as JSON or CSV.

Data exchanged: Order ID, patient name, address, phone and OTP only. Medicine details stay with the pharmacy; riders see sealed bags.

Method: REST API + webhooks; manifests via POST /v1/manifests; HL7 or CSV bridge where the LIS cannot call REST.

1. Create recurring routes for clinic pick-ups (POST /v1/routes).
2. Push the specimen manifest per route or STAT job (barcodes, UN3373 or UN1845).
3. Subscribe to custody.scanned and temperature.excursion to flag specimens before they arrive.
4. Pull Proof-of-Custody certificates for accreditation audits (GET /v1/certificates/{id}).

Data exchanged: Specimen IDs and barcodes; patient names only where they are on the outer label.

Method: CarTrack fleet API + signed webhook into POST /v1/telemetry/cartrack.

1. Positions every 30 s feed the live map and ETAs.
2. Geofence entry at pickup and drop-off triggers arrival events automatically.
3. Harsh driving events feed the DriveSmart score in the Driver app.
4. Webhook signatures are verified before ingestion.

Data exchanged: Vehicle positions, trips, geofence entry and exit, harsh events.

Method: WhatsApp Business API via 360dialog; SMS fallback for recipients without a smartphone.

1. Approved utility templates: booking confirmed, rider on the way, OTP, delivered, failed handover.
2. Health Cart ordering by WhatsApp: script photo upload, encrypted and visible only to the chosen pharmacy.
3. Inbound replies route to the support desk with job context.
4. Utility messages cost about R0.17 each; marketing about R0.68.

Data exchanged: Templates, replies, media (scripts). Consent captured per POPIA s69.

Method: Payment API + ITN webhooks; split payments release seller funds on ePOD.

1. Checkout charges goods (seller's invoice) and the flat delivery fee separately.
2. Funds for the goods are held and released to the pharmacy, lab or rental partner on signed ePOD.
3. Refunds and failed handovers reverse through the same provider.
4. No percentage commission is taken on medicine value.

Data exchanged: Payments, refunds, splits, payouts.

Method: Accounting API: invoices, credit notes, payments, account codes.

1. POD-verified jobs roll into invoices per client and cost centre.
2. Statements issue by the 3rd business day of the month.
3. Payments reconcile back to the invoice and update the client's billing standing.
4. Fuel-clause rate changes post as approved rate-card versions, never retroactively.

Data exchanged: Invoices, credit notes, payments. Client invoices are also available via GET /v1/invoices.