Download OpenAPI specification:
Partner REST API for health checkups, lab tests, doctor consultations, ePharmacy, benefit wallets and member pre-registration.
The hlthstack API lets partners book and manage health benefits for their members:
health checkups and lab tests, in-clinic and online specialist consultations, ePharmacy
orders, and benefit wallet balances. Status changes are pushed to you through webhooks
(see the webhooks section).
Authentication. Call getAccessToken with HTTP Basic credentials issued by hlthstack.
It returns a bearer token valid for 1 hour. Send it as Authorization: Bearer <token> on
every other call. Multi-entity partners also send API-ENTITY-ID and API-SECRET-KEY.
Pre-registration (tag Pre-registration) uses its own credentials and token: call
getPreRegistrationAccessToken with HTTP Basic and send the token as X-EKINCARE-KEY.
Conventions.
appointment_date_time in UTC (2030-01-15T03:30:00Z).plan_id, wherever accepted, is the plan identifier hlthstack shares at onboarding
(a string). It is optional; when omitted, the entity's base plan is used.422 {"errors":{"messages":["..."]}}.Input validation. Request schemas encode the checks the server applies to the input
itself (required, enum, pattern, minLength, maximum, minItems, ...). Patterns
are ECMAScript/Python regexes and are matched as a search, as JSON Schema specifies:
a pattern is anchored (^...$) only where the server anchors it. Rules that span fields
or need the current date are listed on the operation under x-hlthstack-rules, each
{rule, description, fields}, where rule is one of the kinds in
x-hlthstack-rule-kinds and fields are dotted paths (customers[].dob). Checks that
depend on stored data (plan benefits, slot availability, provider capability) are not
encoded and are reported by the server.
Guides: https://github.com/hlthstack/integration-guide/tree/main/docs. Getting started: https://github.com/hlthstack/integration-guide/blob/main/docs/getting-started.md.
Postman. Import the collection (https://developers.hlthstack.io/postman/hlthstack.postman_collection.json) and the staging (https://developers.hlthstack.io/postman/hlthstack-staging.postman_environment.json) or production (https://developers.hlthstack.io/postman/hlthstack-production.postman_environment.json) environment, then fill in your credentials. Tokens are fetched for you.
Exchanges the username and password issued by hlthstack (HTTP Basic) for a bearer
token. The token expires 1 hour after issue (expires_at). Request a new one before
it expires; there is no refresh token.
{- "access_token": "YOUR_ACCESS_TOKEN",
- "expires_at": "2026-01-15T07:16:21Z"
}Providers, slots and appointments for health checkups, lab tests, dental, vision and vaccinations.
Sent to your status_updates endpoint on every appointment status change.
type is reports_upload when the appointment is partially_received/received
and report links are present, otherwise status_update. Verify the Signature
header (see the webhooks guide). Reply 2xx within 30 seconds.
| Signature required | string HS256 JWT signed with your webhook secret. See the webhooks guide for the claims. |
| type | string Enum: "status_update" "reports_upload" |
| booking_id | string |
| appointment_id | string |
| customer_id | string hlthstack's customer id. |
| customer_name | string |
| mobile_number | string or null |
| api_customer_id | string or null Null for bookings hlthstack's team made on a member's behalf. |
| member_id | string or null Member's employee id, when known. |
| appointment_date_time | string <date-time> |
| event_timestamp | number Epoch seconds of the status change. |
| booking_source | string or null Channel the booking was made through, fixed at booking time. |
| service_type | string The benefit, e.g. |
| plan_id | string or null |
| customer_plan_id | integer or null Subscription that paid; null on the base plan. |
| subscription_id | string or null |
| status | string (AppointmentStatus) Appointment status. Health checkups: |
| status_text | string |
| comment | string or null |
| provider_id | integer |
| provider_name | string or null |
| provider_branch | string or null |
| provider_address | string or null |
| voucher_api_url | string <uri> Present once the appointment is confirmed. |
| phlebo_name | string Present once confirmed, if a phlebotomist is assigned. |
| phlebo_number | string |
| reports | Array of strings <uri> [ items <uri > ] Present in |
| doctor_id | string |
| doctor_name | string |
| doctor_specialities | Array of strings |
| doctor_gender | string or null |
| doctor_qualification | string or null |
| doctor_languages | Array of strings |
| doctor_experience | integer or null |
object or null (FileLink) | |
Array of objects or null (FileLink) | |
| latitude | number or string or null |
| longitude | number or string or null |
| hospital_name | string or null |
| hospital_location | string or null |
| hospital_address | string or null |
| meeting_link | string or null Video consultations only. |
object (AppointmentPayment) |
{- "booking_id": "EKI0000000001700000000",
- "appointment_id": "APT1A2B3C4D5",
- "customer_id": "EKI000000001",
- "customer_name": "Jane Doe",
- "mobile_number": "9999999999",
- "api_customer_id": "CUST1001",
- "member_id": "EMP0001",
- "appointment_date_time": "2030-01-15T02:30:00Z",
- "event_timestamp": 1768440000.123,
- "booking_source": "hlthstack-api",
- "service_type": "ahc",
- "plan_id": "EXAMPLE_PLAN",
- "customer_plan_id": null,
- "subscription_id": null,
- "status": "confirmed",
- "status_text": "Confirmed",
- "comment": "Your appointment is confirmed.",
- "provider_id": 1001,
- "provider_name": "Example Diagnostics",
- "provider_branch": "Madhapur",
- "provider_address": "1 Example Road, Madhapur, Hyderabad",
- "phlebo_name": "John Doe",
- "phlebo_number": "+919999999999",
- "type": "status_update",
- "payment": {
- "status": "captured",
- "total_collected_amount": "0.0",
- "razorpay_amount": "0.0",
- "razorpay_payment_id": null,
- "razorpay_order_id": null,
- "customer_wallet_amount": "0.0",
- "sponsor_wallet_amount": "0.0",
- "promotional_wallet_amount": "0.0",
- "cod_amount": "0.0",
- "h_points_amount": "0.0",
- "refunded_amount": "0.0",
- "captured_at": "2026-01-14T07:03:10Z",
- "refunded_at": null
}
}Sent to your separately registered lab_results endpoint (enabled on request).
| Signature required | string HS256 JWT signed with your webhook secret. See the webhooks guide for the claims. |
| type | string Value: "lab_results" |
| booking_id | string |
| appointment_id | string |
| customer_id | string |
| api_customer_id | string or null |
| member_id | string or null |
| plan_id | string or null |
object |
{- "type": "lab_results",
- "booking_id": "EKI0000000001700000000",
- "appointment_id": "APT1A2B3C4D5",
- "customer_id": "EKI000000001",
- "api_customer_id": "CUST1001",
- "member_id": null,
- "plan_id": "EXAMPLE_PLAN",
- "digitization": {
- "results": [
- {
- "result": "80",
- "units": "mg/dL",
- "ranges": "<70,70-140,>140",
- "test_component_id": 1,
- "test_component_name": "Fasting Blood Sugar",
- "lab_test_id": 1,
- "lab_test_name": "Blood Glucose"
}
]
}
}Lists providers (diagnostic centres, clinics, doctors) near a location that can
serve the given packages, ordered by distance. Use listSlots for availability:
the provider_slots embedded here is deprecated.
Either pincode or both latitude and longitude are required (if only coordinates
are sent the pincode is derived from them). sort_by and gender are supported only
for service_name=inclinic_consultation.
| service_name required | string (BenefitType) Enum: "ahc" "dental" "vision" "fitness" "pharmacy" "eap" "family_doctor" "pre_employment" "covid_vaccination" "flu_vaccination" "other_health_checks" "rtpcr" "specialist_consultation" "pregnancy_care" "ohc" "annual_calendar" "health_coach" "health_insurance" "face_to_face_consults" "daycare_surgeries" "ambulance_on_demand" "supplementary_insurance" "elder_care" "home_care" "healthcare_financing" "nhc" "diet_consultation" "inclinic_consultation" "fertility_treatment" "consultation24x7" "imaging_services" "occupational_medical_rooms" "cancer_screening" "onsite_camp" "filler_benefit_one" "filler_benefit_two" "filler_benefit_three" "filler_benefit_four" "prescribed_diagnostics" "ppmc" "weight_management_program" "diabetic_program" "bp_program" "cervical_vaccination" "physiotherapy" "prescribed_diagnostics_flow" "vision_wearable" "maternity_care" "gym_subscription" "fitness_products" "wellbeing_marketplace" "pcos_program" "parenting_program" "midlife_health_program" "general_health_program" "fertility_care" "cholesterol_program" "financial_wellbeing" The service to search for. Common values: |
| package_ids required | string[0-9]+(,[0-9]+)* Example: package_ids=1001,1002 Comma-separated package ids shared at onboarding, for example |
| pincode | string^[0-9]{6}$ Example: pincode=500081 6-digit pincode. Required unless |
| latitude | number Example: latitude=17.4437 Decimal latitude. Required unless |
| longitude | number Example: longitude=78.386 Decimal longitude. Required unless |
| radius | number Default: 100 Search radius in km for in-clinic providers. Default 100. |
| auto_allocate_provider | boolean Home-collection packages only. Let hlthstack allocate the best provider by availability. The appointment is cancelled if no provider is available at the location, and the slot may change if no provider is free at that time. |
| plan_id | string Plan identifier shared at onboarding. Defaults to the base plan. |
| page | integer Default: 1 Page number. Values below 1 are read as 1. |
| per_page | integer <= 50 Default: 20 Page size, at most 50. Values below 1 are read as 1. |
| sort_by | string Enum: "fee" "experience" "distance" "rating" "visited_before" In-clinic consultations only. |
| sort_asc | boolean In-clinic consultations only. Default ascending for fee/distance, descending for experience/rating. |
| gender | string^(?:[Mm][Aa][Ll][Ee]|[Ff][Ee][Mm][Aa][Ll][Ee]... Examples: gender=Male gender=Female gender=Non-binary In-clinic consultations only. Filter doctors by gender. |
| api_customer_id | string Required with |
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
{- "providers": [
- {
- "provider_id": 1001,
- "provider_name": "Example Diagnostics",
- "locality": "Madhapur",
- "city": "Hyderabad",
- "state": "Telangana",
- "pincode": "500081",
- "timezone": "Asia/Kolkata",
- "timezone_info": "Indian Standard Time (IST) (GMT+5:30)",
- "home_collection_enabled": true,
- "latitude": 17.44,
- "longitude": 78.38,
- "address": "1 Example Road, Madhapur, Hyderabad, Telangana 500081",
- "serviceable": true,
- "is_center_available": true,
- "estimated_time": "15-20 mins",
- "estimated_distance": "2.2 kms",
- "rating": 4.5,
- "slot_lead_time": 1,
- "provider_slots": null
}
]
}Returns bookable slots for one provider and benefit. Pass booking_date for a single
day; omit it for several days (count_days, default 14). Read booking_slots; the
top-level date and slots describe only the first day and are deprecated.
The first bookable date depends on the provider's slot_lead_time and timezone
(from listProviders); a booking_date before it returns 400.
For inclinic_consultation and specialist_consultation the provider must be an
active doctor whose speciality matches the packages.
| provider_id required | integer Example: 1001 |
| benefit_type required | string Examples: ahc dental vision flu_vaccination covid_vaccination inclinic_consultation specialist_consultation The service the slots are for. Same values as |
| package_ids required | string Example: package_ids=1001 Comma-separated package ids. |
| booking_date | string <date> Day to fetch (YYYY-MM-DD). Omit for multiple days. |
| count_days | integer Number of days to return when |
| slot_start_date | string <date> Start the multi-day window no earlier than this date. |
| pincode | string Example: pincode=500081 6-digit pincode of the member's location. Derived from |
| latitude | number Example: latitude=17.4437 Decimal latitude. Required unless |
| longitude | number Example: longitude=78.386 Decimal longitude. Required unless |
| city_name | string City for the pincode. Derived from the pincode when omitted. |
| plan_id | string Plan identifier shared at onboarding. Defaults to the base plan. |
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
{- "date": "2026-01-15",
- "booking_slots": [
- {
- "date": "2026-01-15",
- "slots": [
- {
- "start_time": "08:00:00",
- "end_time": "09:00:00",
- "slot": "08 - 09 AM",
- "available": true,
- "display_text": "08:00 AM",
- "slot_text": "08:00 AM and 09:00 AM",
- "utc_slot_time": "2026-01-15T02:30:00.000Z",
- "start_time_in_timezone": "2026-01-15T08:00:00.000+05:30",
- "end_time_in_timezone": "2026-01-15T09:00:00.000+05:30",
- "remaining_capacity": 12
}
]
}
], - "report_tat": null,
- "interval": 3600,
- "unavailable_reason": null
}Books one appointment per customer at one provider and time. All appointments share
a booking_id; each customer gets an appointment_id.
The booking customer is the last entry with booking_customer: true, else the first;
set it on one entry only. address is required for home_collection. There's no fixed
limit on customers, but all of them must fit in the provider's slot capacity, otherwise
appointment_date_time fails with Booking threshold reached ... (its slots are full).
If the member's wallet covers the cost the booking is placed and status is
confirmed (the appointment itself still starts at new and is confirmed by the
provider). If an amount is due, status is payment_pending and payment_link must
be paid by the member; its appointments are payment_pending until then, then new.
To pay from a specific subscription when a customer holds several on a plan, send
customer_plan_id (hlthstack's id, from listCustomerPlans) or subscription_id
(your own id). customer_plan_id wins when both are sent.
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
| provider_id required | integer or string^[+-]?[0-9]+$ |
| appointment_date_time required | string <date-time> A slot's |
| appointment_type required | string Enum: "home_collection" "inclinic" |
| service_name required | string (BenefitType) Enum: "ahc" "dental" "vision" "fitness" "pharmacy" "eap" "family_doctor" "pre_employment" "covid_vaccination" "flu_vaccination" "other_health_checks" "rtpcr" "specialist_consultation" "pregnancy_care" "ohc" "annual_calendar" "health_coach" "health_insurance" "face_to_face_consults" "daycare_surgeries" "ambulance_on_demand" "supplementary_insurance" "elder_care" "home_care" "healthcare_financing" "nhc" "diet_consultation" "inclinic_consultation" "fertility_treatment" "consultation24x7" "imaging_services" "occupational_medical_rooms" "cancer_screening" "onsite_camp" "filler_benefit_one" "filler_benefit_two" "filler_benefit_three" "filler_benefit_four" "prescribed_diagnostics" "ppmc" "weight_management_program" "diabetic_program" "bp_program" "cervical_vaccination" "physiotherapy" "prescribed_diagnostics_flow" "vision_wearable" "maternity_care" "gym_subscription" "fitness_products" "wellbeing_marketplace" "pcos_program" "parenting_program" "midlife_health_program" "general_health_program" "fertility_care" "cholesterol_program" "financial_wellbeing" A benefit type. The service must also be enabled on your plan. |
required | Array of objects (BookingCustomer) non-empty |
object (BookingAddress) Required for home_collection. | |
| plan_id | string |
| customer_plan_id | integer >= 0 |
| subscription_id | string |
| api_partner_order_id | string Default for customers that do not send their own. |
{- "appointment_date_time": "2030-01-15T02:30:00Z",
- "appointment_type": "home_collection",
- "service_name": "ahc",
- "provider_id": 1001,
- "customers": [
- {
- "name": "Jane Doe",
- "dob": "1990-08-24",
- "mobile_number": "9999999999",
- "api_customer_id": "CUST1001",
- "booking_customer": true,
- "gender": "female",
- "package_ids": [
- 1001
], - "api_partner_order_id": "ORDER-1001"
}
], - "address": {
- "address_line_one": "1 Example Road",
- "address_line_two": "Madhapur",
- "city": "Hyderabad",
- "state": "Telangana",
- "country": "India",
- "pincode": "500081",
- "latitude": 17.4437,
- "longitude": 78.386
}
}{- "provider_id": 1001,
- "home_collection_enable": true,
- "booking_id": "EKI0000000001700000000",
- "status": "confirmed",
- "customers": [
- {
- "customer_id": 5001,
- "name": "Jane Doe",
- "api_customer_id": "CUST1001",
- "package_ids": [
- 1001
], - "appointment_id": "APT1A2B3C4D5",
- "customer_plan_id": null,
- "subscription_id": null
}
]
}Pass only booking_id to get every appointment in the booking; add appointment_id
to get one appointment. Each appointment has the same shape as the appointment
webhook payload.
| booking_id required | string (BookingId) EKI[0-9A-Z_]{19} Example: booking_id=EKI0000000001700000000
|
| appointment_id | string (AppointmentId) APT[0-9A-Z_]{9} Example: appointment_id=APT1A2B3C4D5
|
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
{- "booking_id": "string",
- "service_name": "string",
- "appointments": [
- {
- "type": "status_update",
- "booking_id": "string",
- "appointment_id": "string",
- "customer_id": "string",
- "customer_name": "string",
- "mobile_number": "string",
- "api_customer_id": "string",
- "member_id": "string",
- "appointment_date_time": "2019-08-24T14:15:22Z",
- "event_timestamp": 0,
- "booking_source": "string",
- "service_type": "string",
- "plan_id": "string",
- "customer_plan_id": 0,
- "subscription_id": "string",
- "status": "string",
- "status_text": "string",
- "comment": "string",
- "provider_id": 0,
- "provider_name": "string",
- "provider_branch": "string",
- "provider_address": "string",
- "phlebo_name": "string",
- "phlebo_number": "string",
- "doctor_id": "string",
- "doctor_name": "string",
- "doctor_specialities": [
- "string"
], - "doctor_gender": "string",
- "doctor_qualification": "string",
- "doctor_languages": [
- "string"
], - "doctor_experience": 0,
- "summary": {
- "file_name": "string",
- "file_url": "string"
}, - "doctor_prescriptions": [
- {
- "file_name": "string",
- "file_url": "string"
}
], - "latitude": 0,
- "longitude": 0,
- "hospital_name": "string",
- "hospital_location": "string",
- "hospital_address": "string",
- "meeting_link": "string",
- "payment": {
- "status": "string",
- "total_collected_amount": "string",
- "razorpay_amount": "string",
- "razorpay_payment_id": "string",
- "razorpay_order_id": "string",
- "customer_wallet_amount": "string",
- "sponsor_wallet_amount": "string",
- "promotional_wallet_amount": "string",
- "cod_amount": "string",
- "h_points_amount": "string",
- "refunded_amount": "string",
- "captured_at": "2019-08-24T14:15:22Z",
- "refunded_at": "2019-08-24T14:15:22Z"
}
}
]
}Moves all appointments in the booking. See rescheduleAppointment for the rules.
Some appointments may be moved while others are not; the response then lists both as
comma-separated appointment_ids.
| booking_id required | string (BookingId) EKI[0-9A-Z_]{19} Example: EKI0000000001700000000
|
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
| appointment_date_time required | string <date-time> |
| provider_id | integer or string or null^(?:[+-]?[0-9]+)?$ Only to move to another provider. Blank or null keeps the current provider. |
object (BookingAddress) Home collection only, with provider_id. Checked only when the booking has a home-collection appointment. |
{- "appointment_date_time": "2030-01-16T02:30:00Z"
}{- "message": "Booking rescheduled successfully"
}Home collection: allowed until a phlebotomist is assigned or 30 minutes before the slot, whichever is first. In-clinic: allowed until 30 minutes before the slot.
| booking_id required | string (BookingId) EKI[0-9A-Z_]{19} Example: EKI0000000001700000000
|
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
| reason | string <= 255 characters Recorded as the cancellation reason. Defaults to |
{- "reason": "Member is travelling"
}{- "message": "Booking cancelled successfully"
}appointment_date_time.provider_id. Not allowed once the appointment is confirmed at
the current provider.address together with provider_id.Home collection: allowed until a phlebotomist is assigned or 30 minutes before the slot, whichever is first. In-clinic: until 30 minutes before the slot. An in-clinic appointment cannot become home collection.
| appointment_id required | string (AppointmentId) APT[0-9A-Z_]{9} Example: APT1A2B3C4D5
|
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
| appointment_date_time required | string <date-time> |
| provider_id | integer or string or null^(?:[+-]?[0-9]+)?$ Only to move to another provider. Blank or null keeps the current provider. |
object (BookingAddress) Home collection only, with provider_id. Checked only when the booking has a home-collection appointment. |
{- "appointment_date_time": "2030-01-16T02:30:00Z",
- "provider_id": 1002
}{- "message": "Appointment rescheduled successfully"
}Same cut-offs as cancelBooking.
| appointment_id required | string (AppointmentId) APT[0-9A-Z_]{9} Example: APT1A2B3C4D5
|
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
| reason | string <= 255 characters Recorded as the cancellation reason. Defaults to |
{- "reason": "Member is travelling"
}{- "message": "Appointment cancelled successfully"
}Returns the voucher PDF. Available only once the appointment is confirmed.
| appointment_id required | string (AppointmentId) APT[0-9A-Z_]{9} Example: APT1A2B3C4D5
|
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
{- "errors": {
- "messages": [
- "voucher only available for download when appointment is confirmed"
]
}
}Call when the appointment is partially_received or received. Returns links to
the verified reports, or a message if none are verified yet. Report links are signed
URLs that expire 5 minutes after they're issued: download right away and don't store
them.
| appointment_id required | string (AppointmentId) APT[0-9A-Z_]{9} Example: APT1A2B3C4D5
|
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
{
}Returns the structured lab values for an appointment (same body as the
labResults webhook). Enabled on request: ask hlthstack to register a lab-results
webhook endpoint for you; without one this returns 401.
| appointment_id required | string (AppointmentId) APT[0-9A-Z_]{9} Example: APT1A2B3C4D5
|
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
{- "type": "lab_results",
- "booking_id": "EKI0000000001700000000",
- "appointment_id": "APT1A2B3C4D5",
- "customer_id": "EKI000000001",
- "api_customer_id": "CUST1001",
- "member_id": null,
- "plan_id": "EXAMPLE_PLAN",
- "digitization": {
- "results": [
- {
- "result": "80",
- "units": "mg/dL",
- "ranges": "<70,70-140,>140",
- "test_component_id": 1,
- "test_component_name": "Fasting Blood Sugar",
- "lab_test_id": 1,
- "lab_test_name": "Blood Glucose"
}
]
}
}Same endpoint and envelope as appointmentStatusUpdate, with service_type
inclinic_consultation or specialist_consultation plus doctor fields, summary,
doctor_prescriptions, hospital fields (in-clinic) and meeting_link (video).
| Signature required | string HS256 JWT signed with your webhook secret. See the webhooks guide for the claims. |
| type | string Enum: "status_update" "reports_upload" |
| booking_id | string |
| appointment_id | string |
| customer_id | string hlthstack's customer id. |
| customer_name | string |
| mobile_number | string or null |
| api_customer_id | string or null Null for bookings hlthstack's team made on a member's behalf. |
| member_id | string or null Member's employee id, when known. |
| appointment_date_time | string <date-time> |
| event_timestamp | number Epoch seconds of the status change. |
| booking_source | string or null Channel the booking was made through, fixed at booking time. |
| service_type | string The benefit, e.g. |
| plan_id | string or null |
| customer_plan_id | integer or null Subscription that paid; null on the base plan. |
| subscription_id | string or null |
| status | string (AppointmentStatus) Appointment status. Health checkups: |
| status_text | string |
| comment | string or null |
| provider_id | integer |
| provider_name | string or null |
| provider_branch | string or null |
| provider_address | string or null |
| voucher_api_url | string <uri> Present once the appointment is confirmed. |
| phlebo_name | string Present once confirmed, if a phlebotomist is assigned. |
| phlebo_number | string |
| reports | Array of strings <uri> [ items <uri > ] Present in |
| doctor_id | string |
| doctor_name | string |
| doctor_specialities | Array of strings |
| doctor_gender | string or null |
| doctor_qualification | string or null |
| doctor_languages | Array of strings |
| doctor_experience | integer or null |
object or null (FileLink) | |
Array of objects or null (FileLink) | |
| latitude | number or string or null |
| longitude | number or string or null |
| hospital_name | string or null |
| hospital_location | string or null |
| hospital_address | string or null |
| meeting_link | string or null Video consultations only. |
object (AppointmentPayment) |
{- "booking_id": "EKI0000000001700000000",
- "appointment_id": "APT1A2B3C4D5",
- "customer_id": "EKI000000001",
- "api_customer_id": "CUST1001",
- "appointment_date_time": "2030-01-15T04:30:00Z",
- "booking_source": "hlthstack-api",
- "service_type": "specialist_consultation",
- "status": "confirmed",
- "status_text": "Confirmed",
- "comment": "",
- "provider_id": 3001,
- "doctor_id": "DOC000000002",
- "doctor_name": "Dr. Jane Doe",
- "doctor_specialities": [
- "Neurology"
], - "doctor_gender": "Female",
- "doctor_qualification": "MBBS, MD",
- "doctor_languages": [
- "English"
], - "doctor_experience": 10,
- "summary": null,
- "doctor_prescriptions": [ ],
- "type": "status_update"
}Returns bookable slots for one provider and benefit. Pass booking_date for a single
day; omit it for several days (count_days, default 14). Read booking_slots; the
top-level date and slots describe only the first day and are deprecated.
The first bookable date depends on the provider's slot_lead_time and timezone
(from listProviders); a booking_date before it returns 400.
For inclinic_consultation and specialist_consultation the provider must be an
active doctor whose speciality matches the packages.
| provider_id required | integer Example: 1001 |
| benefit_type required | string Examples: ahc dental vision flu_vaccination covid_vaccination inclinic_consultation specialist_consultation The service the slots are for. Same values as |
| package_ids required | string Example: package_ids=1001 Comma-separated package ids. |
| booking_date | string <date> Day to fetch (YYYY-MM-DD). Omit for multiple days. |
| count_days | integer Number of days to return when |
| slot_start_date | string <date> Start the multi-day window no earlier than this date. |
| pincode | string Example: pincode=500081 6-digit pincode of the member's location. Derived from |
| latitude | number Example: latitude=17.4437 Decimal latitude. Required unless |
| longitude | number Example: longitude=78.386 Decimal longitude. Required unless |
| city_name | string City for the pincode. Derived from the pincode when omitted. |
| plan_id | string Plan identifier shared at onboarding. Defaults to the base plan. |
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
{- "date": "2026-01-15",
- "booking_slots": [
- {
- "date": "2026-01-15",
- "slots": [
- {
- "start_time": "08:00:00",
- "end_time": "09:00:00",
- "slot": "08 - 09 AM",
- "available": true,
- "display_text": "08:00 AM",
- "slot_text": "08:00 AM and 09:00 AM",
- "utc_slot_time": "2026-01-15T02:30:00.000Z",
- "start_time_in_timezone": "2026-01-15T08:00:00.000+05:30",
- "end_time_in_timezone": "2026-01-15T09:00:00.000+05:30",
- "remaining_capacity": 12
}
]
}
], - "report_tat": null,
- "interval": 3600,
- "unavailable_reason": null
}Doctors near a location for the given consultation packages, with doctor details.
| package_ids required | string[0-9]+(,[0-9]+)* Example: package_ids=1001,1002 Comma-separated package ids shared at onboarding, for example |
| pincode | string^[0-9]{6}$ Example: pincode=500081 6-digit pincode. Required unless |
| latitude | number Example: latitude=17.4437 Decimal latitude. Required unless |
| longitude | number Example: longitude=78.386 Decimal longitude. Required unless |
| radius | number Default: 100 Search radius in km. Default 100. |
| plan_id | string Plan identifier shared at onboarding. Defaults to the base plan. |
| page | integer Default: 1 Page number. Values below 1 are read as 1. |
| per_page | integer <= 50 Default: 20 Page size, at most 50. Values below 1 are read as 1. |
| sort_by | string Enum: "fee" "experience" "distance" "rating" "visited_before" In-clinic consultations only. |
| sort_asc | boolean In-clinic consultations only. Default ascending for fee/distance, descending for experience/rating. |
| gender | string^(?:[Mm][Aa][Ll][Ee]|[Ff][Ee][Mm][Aa][Ll][Ee]... Examples: gender=Male gender=Female gender=Non-binary In-clinic consultations only. Filter doctors by gender. |
| api_customer_id | string Required with |
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
{- "providers": [
- {
- "provider_id": 2001,
- "locality": "Madhapur",
- "city": "Hyderabad",
- "pincode": "500081",
- "estimated_distance": "2.2 kms",
- "doctor_id": "DOC000000001",
- "doctor_name": "Dr. Jane Doe",
- "doctor_specialities": [
- "General Medicine"
], - "doctor_experience": 8,
- "doctor_qualification": "MBBS",
- "doctor_languages": [
- "English",
- "Hindi"
], - "doctor_fee_details": {
- "mrp": "1000",
- "selling_price": "800"
}, - "doctor_availability": "2026-01-15",
- "doctor_gender": "Female",
- "hospital_name": "Example Clinic",
- "hospital_location": "Madhapur"
}
], - "total_results": 1,
- "page": 1
}Doctors available for online (audio/video) specialist consultations. No location is
needed. Send default_provider=true to list the providers configured for priority
consultations; an empty list means priority consultation is unavailable for the
package or right now.
| package_ids required | string[0-9]+(,[0-9]+)* Example: package_ids=1001,1002 Comma-separated package ids shared at onboarding, for example |
| default_provider | boolean
|
| plan_id | string Plan identifier shared at onboarding. Defaults to the base plan. |
| page | integer Default: 1 Page number. Values below 1 are read as 1. |
| per_page | integer <= 50 Default: 20 Page size, at most 50. Values below 1 are read as 1. |
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
{- "providers": [
- {
- "provider_id": 3001,
- "timezone": "Asia/Kolkata",
- "rating": 5,
- "doctor_name": "Dr. Jane Doe",
- "doctor_specialities": [
- "Neurology"
], - "doctor_experience": 10,
- "doctor_qualification": "MBBS, MD",
- "doctor_languages": [
- "English"
], - "doctor_fee_details": {
- "mrp": "900",
- "selling_price": "700"
}, - "doctor_availability": "2026-01-15",
- "doctor_gender": "Female"
}
], - "min_price": 700
}Books an in-person consultation at the doctor's clinic. service_mode, when sent,
must be at_provider_location; address (the member's) is required, including
pincode. The booking is made for the first customer in customers. Subscription
selection works as in createAppointment.
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
| appointment_date_time required | string <date-time> Later than now. |
| service_mode | string Value: "at_provider_location" |
| provider_id required | integer or string^[+-]?[0-9]+$ |
required | Array of objects (ConsultationCustomer) non-empty |
required | object (ConsultationAddress) The member's address, as |
| plan_id | string |
| customer_plan_id | integer >= 0 |
| subscription_id | string |
{- "appointment_date_time": "2030-01-15T04:30:00.000Z",
- "service_mode": "at_provider_location",
- "provider_id": 2001,
- "customers": [
- {
- "name": "Jane Doe",
- "dob": "1990-08-24",
- "mobile_number": "9999999999",
- "api_customer_id": "CUST1001",
- "gender": "female",
- "package_ids": [
- 2001
]
}
], - "address": {
- "address_line_one": "1 Example Road",
- "address_line_two": "Kondapur",
- "city": "Hyderabad",
- "state": "Telangana",
- "country": "India",
- "pincode": "500084",
- "latitude": 17.47,
- "longitude": 78.35
}
}{- "provider_id": 2001,
- "booking_id": "EKI0000000001700000000",
- "customers": [
- {
- "customer_id": "EKI000000001",
- "name": "Jane Doe",
- "api_customer_id": "CUST1001",
- "package_ids": [
- 2001
], - "appointment_id": "APT1A2B3C4D5",
- "consultation_status": "new",
- "customer_plan_id": null,
- "subscription_id": null
}
]
}Books an audio or video consultation.
priority_consultation: false): appointment_date_time must be a
slot from listSlots; provider_id must not be a priority provider.priority_consultation: true): a doctor calls within about 4 hours.
Available 8 AM-4 PM IST; provider_id must come from
listSpecialistConsultationProviders with default_provider=true;
appointment_date_time is optional. The consultation is confirmed immediately and
the doctor's details arrive by webhook once a doctor is assigned.| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
| appointment_date_time | string <date-time> Required, and later than now, unless |
| service_mode | string Enum: "audio_call" "video_call" |
| priority_consultation | boolean Default: false |
| provider_id required | integer or string^[+-]?[0-9]+$ |
required | Array of objects (ConsultationCustomer) non-empty |
| plan_id | string |
| customer_plan_id | integer >= 0 |
| subscription_id | string |
{- "appointment_date_time": "2030-01-15T04:30:00.000Z",
- "service_mode": "audio_call",
- "provider_id": 3001,
- "priority_consultation": false,
- "customers": [
- {
- "name": "Jane Doe",
- "dob": "1990-08-24",
- "mobile_number": "9999999999",
- "api_customer_id": "CUST1001",
- "gender": "female",
- "package_ids": [
- 3001
]
}
]
}{- "provider_id": 2001,
- "booking_id": "EKI0000000001700000000",
- "customers": [
- {
- "customer_id": "EKI000000001",
- "name": "Jane Doe",
- "api_customer_id": "CUST1001",
- "package_ids": [
- 2001
], - "appointment_id": "APT1A2B3C4D5",
- "consultation_status": "new",
- "customer_plan_id": null,
- "subscription_id": null
}
]
}| appointment_id required | string (AppointmentId) APT[0-9A-Z_]{9} Example: APT1A2B3C4D5
|
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
{- "booking_id": "EKI0000000001700000000",
- "appointment_id": "APT1A2B3C4D5",
- "appointment_date_time": "2030-01-15T04:30:00Z",
- "status": "confirmed",
- "service_name": "Inclinic consultation",
- "service_mode": "at_provider_location",
- "api_customer_id": "CUST1001",
- "customer_id": "EKI000000001",
- "doctor_id": "DOC000000001",
- "doctor_name": "Dr. Jane Doe",
- "doctor_specialities": [
- "General Medicine"
], - "doctor_gender": "Female",
- "doctor_qualification": "MBBS",
- "doctor_languages": [
- "English",
- "Hindi"
], - "doctor_experience": 8,
- "provider_id": 2001,
- "is_priority_consultation": false,
- "is_default_provider": false,
- "latitude": 17.44,
- "longitude": 78.38,
- "hospital_name": "Example Clinic",
- "hospital_location": "Madhapur",
- "hospital_address": "1 Example Road, Madhapur, Hyderabad, Telangana 500081"
}| appointment_id required | string (AppointmentId) APT[0-9A-Z_]{9} Example: APT1A2B3C4D5
|
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
{- "booking_id": "EKI0000000001700000000",
- "appointment_id": "APT1A2B3C4D5",
- "appointment_date_time": "2030-01-15T04:30:00Z",
- "status": "confirmed",
- "service_name": "Specialist consultation",
- "service_mode": "video_call",
- "api_customer_id": "CUST1001",
- "customer_id": "EKI000000001",
- "doctor_id": "DOC000000002",
- "doctor_name": "Dr. Jane Doe",
- "doctor_specialities": [
- "Neurology"
], - "doctor_gender": "Female",
- "doctor_qualification": "MBBS, MD",
- "doctor_languages": [
- "English"
], - "doctor_experience": 10,
- "provider_id": 3001,
- "is_priority_consultation": false,
- "is_default_provider": false,
- "summary": null,
- "prescriptions": [ ],
}Moves the consultation to a new slot with the same doctor (to change doctor, cancel and book again). Allowed up to 30 minutes before the current slot, and not within 5 minutes of the previous booking or reschedule.
| appointment_id required | string (AppointmentId) APT[0-9A-Z_]{9} Example: APT1A2B3C4D5
|
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
| appointment_date_time required | string <date-time> New slot ( |
| provider_id | integer or string Optional. If sent, must be the consultation's current provider. |
{- "appointment_date_time": "2030-01-16T04:30:00.000Z"
}{- "message": "Appointment rescheduled successfully"
}Allowed up to 30 minutes before the slot, and not after a no-show or rejection.
| appointment_id required | string (AppointmentId) APT[0-9A-Z_]{9} Example: APT1A2B3C4D5
|
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
{- "msg": "Appointment cancelled"
}File links are pre-signed and expire after a few minutes; fetch them when needed.
| appointment_id required | string (AppointmentId) APT[0-9A-Z_]{9} Example: APT1A2B3C4D5
|
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
{- "doctor_prescriptions": [
]
}Returns the voucher PDF for a confirmed in-clinic consultation.
| appointment_id required | string (AppointmentId) APT[0-9A-Z_]{9} Example: APT1A2B3C4D5
|
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
{- "errors": {
- "messages": [
- "voucher only available for download when appointment is confirmed and inclinic"
]
}
}Shares the member's reports with the doctor (online specialist and priority
consultations). Multipart form with one or more files[][name] + files[][value]
pairs, each with a non-blank name and a file. Allowed types: PDF, JPEG, PNG
(password-protected PDFs are refused).
| appointment_id required | string (AppointmentId) APT[0-9A-Z_]{9} Example: APT1A2B3C4D5
|
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
| files[][name] required | string\S Title of the document. Repeat once per file, in the same order as |
| files[][value] required | string <application/octet-stream> The file. |
{- "message": "Document uploaded successfully"
}Sent to your status_updates endpoint on every order status change, including
refunds. Each body is a full snapshot. Delivery order is not guaranteed: use the
signature timestamp and getOrder to reconcile.
| Signature required | string HS256 JWT signed with your webhook secret. See the webhooks guide for the claims. |
| type | string Enum: "status_update" "post_billing" "additional_payment_required" status_update here; post_billing and additional_payment_required extend this payload. |
| order_id | string |
| customer_id | string |
| api_customer_id | string or null |
| member_id | string or null |
| ordered_for_name | string or null |
| mobile_number | string or null |
| order_type | string or null |
| vendor_name | string or null |
| service_type | string Value: "pharmacy" |
| plan_id | string or null |
| customer_plan_id | integer or null |
| subscription_id | string or null |
| status | string (PharmacyOrderStatus) Order status. Match on this, not on |
| status_text | string or null |
| status_description | string or null |
| partner_status | string or null |
Array of objects (OrderItem) | |
| total_amount | number |
| total_selling_price | number |
| total_discount | number |
| sub_total | number Partner-collected only. |
| additional_charge | number Partner-collected only. |
| total_payable | number Partner-collected only. |
| tracking_url | string or null |
| tracking_partner | string or null |
| tracking_number | string or null |
| eta_from | string or null |
| eta_to | string or null |
object (ShipmentDetails) | |
| address | string Present when the order has an address. |
| city | string |
| pincode | string |
| state | string |
object or null (SplitDetails) | |
object (PharmacyPayment) |
{- "type": "status_update",
- "order_id": "EPO000000000001",
- "customer_id": "EKI000000001",
- "api_customer_id": "CUST1001",
- "ordered_for_name": "Jane Doe",
- "mobile_number": "9999999999",
- "order_type": "cart_order",
- "vendor_name": "Example Pharmacy",
- "service_type": "pharmacy",
- "plan_id": "EXAMPLE_PLAN",
- "status": "out_for_delivery",
- "status_text": "Order out for delivery",
- "order_items": [
- {
- "id": 50001,
- "product_id": "SKU-1",
- "name": "Example 500 Tablet",
- "quantity": 2,
- "mrp": 50,
- "offered_price": 45
}
], - "total_amount": 95,
- "total_selling_price": 90,
- "total_discount": 5,
- "shipment_details": {
- "delivery_type": "standard",
- "otp": "1234",
- "tracking_partner": "Example Courier",
- "tracking_number": "TRK1",
- "eta_from": null,
- "eta_to": null,
- "store_details": null
}, - "address": "1 Example Road, Motera, Ahmedabad, Gujarat, 380005",
- "city": "Ahmedabad",
- "pincode": "380005",
- "state": "Gujarat",
- "split_details": {
- "is_splitted": false,
- "parent_order": null,
- "sub_orders": [ ]
}
}Partner-collected flow only. Sent when every order in the tree is final.
settlement.adjustment_amount is what you owe the member back. The latest one wins.
| Signature required | string HS256 JWT signed with your webhook secret. See the webhooks guide for the claims. |
| type | string Enum: "status_update" "post_billing" "additional_payment_required" status_update here; post_billing and additional_payment_required extend this payload. Value: "post_billing" |
| order_id | string |
| customer_id | string |
| api_customer_id | string or null |
| member_id | string or null |
| ordered_for_name | string or null |
| mobile_number | string or null |
| order_type | string or null |
| vendor_name | string or null |
| service_type | string Value: "pharmacy" |
| plan_id | string or null |
| customer_plan_id | integer or null |
| subscription_id | string or null |
| status | string (PharmacyOrderStatus) Order status. Match on this, not on |
| status_text | string or null |
| status_description | string or null |
| partner_status | string or null |
Array of objects (OrderItem) | |
| total_amount | number |
| total_selling_price | number |
| total_discount | number |
| sub_total | number Partner-collected only. |
| additional_charge | number Partner-collected only. |
| total_payable | number Partner-collected only. |
| tracking_url | string or null |
| tracking_partner | string or null |
| tracking_number | string or null |
| eta_from | string or null |
| eta_to | string or null |
object (ShipmentDetails) | |
| address | string Present when the order has an address. |
| city | string |
| pincode | string |
| state | string |
object or null (SplitDetails) | |
object (PharmacyPayment) | |
object |
{- "type": "post_billing",
- "order_id": "EPO000000000001",
- "customer_id": "EKI000000001",
- "api_customer_id": "CUST1001",
- "ordered_for_name": "Jane Doe",
- "mobile_number": "9999999999",
- "order_type": "cart_order",
- "vendor_name": "Example Pharmacy",
- "service_type": "pharmacy",
- "plan_id": "EXAMPLE_PLAN",
- "status": "out_for_delivery",
- "status_text": "Order out for delivery",
- "order_items": [
- {
- "id": 50001,
- "product_id": "SKU-1",
- "name": "Example 500 Tablet",
- "quantity": 2,
- "mrp": 50,
- "offered_price": 45
}
], - "total_amount": 95,
- "total_selling_price": 90,
- "total_discount": 5,
- "shipment_details": {
- "delivery_type": "standard",
- "otp": "1234",
- "tracking_partner": "Example Courier",
- "tracking_number": "TRK1",
- "eta_from": null,
- "eta_to": null,
- "store_details": null
}, - "address": "1 Example Road, Motera, Ahmedabad, Gujarat, 380005",
- "city": "Ahmedabad",
- "pincode": "380005",
- "state": "Gujarat",
- "split_details": {
- "is_splitted": false,
- "parent_order": null,
- "sub_orders": [ ]
}, - "settlement": {
- "original_collected_amount": 0,
- "additional_collected_amount": 0,
- "total_collected_amount": 0,
- "final_amount": 0,
- "adjustment_amount": 0,
- "settled_at": "2019-08-24T14:15:22Z",
- "orders": [
- {
- "order_id": "string",
- "status": "string",
- "selling_price": 0
}
]
}
}Partner-collected flow only. Collect additional_payment.amount_payable from the member.
| Signature required | string HS256 JWT signed with your webhook secret. See the webhooks guide for the claims. |
| type | string Enum: "status_update" "post_billing" "additional_payment_required" status_update here; post_billing and additional_payment_required extend this payload. Value: "additional_payment_required" |
| order_id | string |
| customer_id | string |
| api_customer_id | string or null |
| member_id | string or null |
| ordered_for_name | string or null |
| mobile_number | string or null |
| order_type | string or null |
| vendor_name | string or null |
| service_type | string Value: "pharmacy" |
| plan_id | string or null |
| customer_plan_id | integer or null |
| subscription_id | string or null |
| status | string (PharmacyOrderStatus) Order status. Match on this, not on |
| status_text | string or null |
| status_description | string or null |
| partner_status | string or null |
Array of objects (OrderItem) | |
| total_amount | number |
| total_selling_price | number |
| total_discount | number |
| sub_total | number Partner-collected only. |
| additional_charge | number Partner-collected only. |
| total_payable | number Partner-collected only. |
| tracking_url | string or null |
| tracking_partner | string or null |
| tracking_number | string or null |
| eta_from | string or null |
| eta_to | string or null |
object (ShipmentDetails) | |
| address | string Present when the order has an address. |
| city | string |
| pincode | string |
| state | string |
object or null (SplitDetails) | |
object (PharmacyPayment) | |
object |
{- "type": "additional_payment_required",
- "order_id": "EPO000000000001",
- "customer_id": "EKI000000001",
- "api_customer_id": "CUST1001",
- "ordered_for_name": "Jane Doe",
- "mobile_number": "9999999999",
- "order_type": "cart_order",
- "vendor_name": "Example Pharmacy",
- "service_type": "pharmacy",
- "plan_id": "EXAMPLE_PLAN",
- "status": "out_for_delivery",
- "status_text": "Order out for delivery",
- "order_items": [
- {
- "id": 50001,
- "product_id": "SKU-1",
- "name": "Example 500 Tablet",
- "quantity": 2,
- "mrp": 50,
- "offered_price": 45
}
], - "total_amount": 95,
- "total_selling_price": 90,
- "total_discount": 5,
- "shipment_details": {
- "delivery_type": "standard",
- "otp": "1234",
- "tracking_partner": "Example Courier",
- "tracking_number": "TRK1",
- "eta_from": null,
- "eta_to": null,
- "store_details": null
}, - "address": "1 Example Road, Motera, Ahmedabad, Gujarat, 380005",
- "city": "Ahmedabad",
- "pincode": "380005",
- "state": "Gujarat",
- "split_details": {
- "is_splitted": false,
- "parent_order": null,
- "sub_orders": [ ]
}, - "additional_payment": {
- "order_id": "string",
- "amount_payable": 0,
- "partner_collected_amount": 0,
- "additional_collected_amount": 0,
- "signalled_at": "2019-08-24T14:15:22Z"
}
}Sent to your digitization_results endpoint when a request reaches completed, partial, rejected or failed.
| Signature required | string HS256 JWT signed with your webhook secret. See the webhooks guide for the claims. |
| type | string Value: "digitization_results" |
| event_type | string Value: "pharmacy.prescription.digitized" |
| request_id | string |
| status | string Enum: "completed" "partial" "rejected" "failed" |
| customer_id | string |
| api_customer_id | string or null |
| member_id | string or null |
| plan_id | string or null |
Array of objects or null | |
Array of objects or null | |
| cart_id | integer or null |
Array of objects | |
| comment | string or null |
{- "type": "digitization_results",
- "event_type": "pharmacy.prescription.digitized",
- "request_id": "string",
- "status": "completed",
- "customer_id": "string",
- "api_customer_id": "string",
- "member_id": "string",
- "plan_id": "string",
- "items": [
- { }
], - "reviewed_items": [
- { }
], - "cart_id": 0,
- "documents": [
- {
- "id": 0,
- "url": "string",
- "type": "pdf",
- "name": "string"
}
], - "comment": "string"
}Searches the catalogue. The returned id is the only medicine id the cart accepts.
rx_required: true means a prescription must be attached before ordering.
| name required | string >= 3 characters \S[\s\S]+\S Example: name=paracetamol Search text, at least 3 characters after trimming surrounding whitespace. |
| page | integer >= 1 Default: 1 |
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
{- "medicines": [
- {
- "id": 50001,
- "name": "Example 500 Tablet",
- "composition_with_strength": "Paracetamol (500mg)",
- "manufacturer_name": "Example Pharma Ltd",
- "packing_label": "strip of 10 tablets",
- "mrp": 25,
- "available": true,
- "type": "allopathy",
- "rx_required": false
}
], - "meta": {
- "page": 1
}
}Upload a prescription; hlthstack extracts the medicines and, when done, builds a
cart for the member. Poll getPrescriptionDigitization or wait for the
prescriptionDigitized webhook.
customers is an array with exactly one customer. Send an Idempotency-Key to make
retries safe: repeating a key returns the existing request.
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
| Idempotency-Key | string Optional. A unique key per upload; a repeat returns the original request. |
| customers[][name] required | string\S |
| customers[][api_customer_id] required | string^[a-zA-Z0-9]+$ |
| customers[][mobile_number] required | string^[0-9]{10}$ |
| customers[][gender] required | string Enum: "male" "female" "non-binary" |
| customers[][dob] required | string <date> |
| plan_id | string |
| files[] required | Array of strings non-empty JPEG, PNG or PDF; each up to 10 MB. |
{- "request_id": "DIGI_RQ_A1B2C3D4E",
- "digitization_id": "DIGI_RQ_A1B2C3D4E",
- "status": "pending",
- "message": "Prescription uploaded successfully. You will receive a webhook once digitization is complete."
}Statuses: pending -> ai_processing -> manual_review -> completed | partial |
rejected | failed. On completed/partial the response has the extracted items
and a ready cart_id. File URLs are pre-signed and expire after 5 minutes.
| request_id required | string Example: DIGI_RQ_A1B2C3D4E |
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
{- "request_id": "DIGI_RQ_A1B2C3D4E",
- "status": "completed",
- "api_customer_id": "CUST1001",
- "message": "Prescription digitization is completed.",
- "items": [
- {
- "medicine_id": 50001,
- "name": "Example 500 Tablet",
- "quantity": 1
}
], - "cart_id": 701
}There is one cart per member per plan.
| customer_details[api_customer_id] required | string Your id for the member. |
| plan_id | string Plan identifier shared at onboarding. Defaults to the base plan. |
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
{- "success": true,
- "cart": {
- "id": 0,
- "api_customer_id": "string",
- "plan_id": "string",
- "products": [
- {
- "id": 0,
- "name": "string",
- "type": "string",
- "quantity": 0,
- "mrp": "string",
- "discount_price": 0,
- "discount_percent": "string",
- "rx_required": true,
- "is_available": true,
- "is_banned": true,
- "pack_size_label": "string",
- "limit_per_order": 0,
- "min_limit_per_order": 0,
- "image": "string"
}
], - "prescription_ids": [
- 0
], - "prescriptions": [
- {
- "id": 0,
- "url": "string",
- "name": "string",
- "status": "string"
}
], - "address_id": 0,
- "city": "string",
- "zip_code": "string",
- "coupon_code": "string",
- "doctor_call_required": true,
- "fulfillment_type": "delivery",
- "selected_store_data": { },
- "eta": null
}
}Find-or-create and merge. Send at least one change: products, address or
address_id, prescription_urls / prescription_files, remove_prescription_ids,
or fulfillment_type. The whole update is atomic: on error the cart is unchanged.
products: quantity: 0 removes a line, > 0 adds or updates it; ids not sent are
untouched; duplicate ids are rejected.customer_details other than api_customer_id create or enrich the member; a new
api_customer_id creates the member.rx_required: true.fulfillment_type: store_pickup with selected_chemist_id
(a store id from getFulfillmentOptions).Use multipart/form-data (with bracketed field names) to upload prescription_files[].
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
| plan_id | string |
required | object |
Array of objects non-empty | |
object (PharmacyAddressInput) A new address. | |
| address_id | integer Mutually exclusive with |
| fulfillment_type | string Enum: "delivery" "store_pickup" |
| selected_chemist_id | string Store id; required for store_pickup. |
| medicine_vendor_id | integer |
| prescription_urls | Array of strings <uri> <= 5 items [ items <uri >^https://[^/?#@:]+(?::443)?(?:[/?#]|$) ] Public HTTPS URLs (port 443, no user info) to PDF/PNG/JPEG files under 7 MB. |
| remove_prescription_ids | Array of integers non-empty |
{- "plan_id": "EXAMPLE_PLAN",
- "customer_details": {
- "api_customer_id": "CUST1001",
- "name": "Jane Doe",
- "dob": "1990-08-24",
- "mobile_number": "9999999999",
- "gender": "female"
}, - "products": [
- {
- "id": 50001,
- "quantity": 2
}, - {
- "id": 50002,
- "quantity": 0
}
]
}{- "success": true,
- "cart": {
- "id": 0,
- "api_customer_id": "string",
- "plan_id": "string",
- "products": [
- {
- "id": 0,
- "name": "string",
- "type": "string",
- "quantity": 0,
- "mrp": "string",
- "discount_price": 0,
- "discount_percent": "string",
- "rx_required": true,
- "is_available": true,
- "is_banned": true,
- "pack_size_label": "string",
- "limit_per_order": 0,
- "min_limit_per_order": 0,
- "image": "string"
}
], - "prescription_ids": [
- 0
], - "prescriptions": [
- {
- "id": 0,
- "url": "string",
- "name": "string",
- "status": "string"
}
], - "address_id": 0,
- "city": "string",
- "zip_code": "string",
- "coupon_code": "string",
- "doctor_call_required": true,
- "fulfillment_type": "delivery",
- "selected_store_data": { },
- "eta": null
}
}Live express/standard delivery and store-pickup options for the cart. Slow (typically
3-8 s). Delivery and pickup are evaluated independently: check the nested success
flags, not just the HTTP status.
Each option has a vendor_id (pass it as medicine_vendor_id to
getOrderPaymentDetails) and a location_token (pass it to createOrder). Tokens are
specific to one mode or store; fetch options again if the member changes their choice.
| customer_details[api_customer_id] required | string Your id for the member. |
| cart_id required | integer |
| plan_id | string Plan identifier shared at onboarding. Defaults to the base plan. |
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
{- "success": true,
- "delivery_options": {
- "success": true,
- "standard": {
- "vendor_id": 3,
- "mrp": 360,
- "selling_price": 360,
- "additional_charges": 0,
- "express_premium": 0,
- "total_payable": 360,
- "discount_price": 0,
- "delivery_details": {
- "type": "home_delivery",
- "display_eta": "24-48 hrs"
}, - "products": [ ],
- "missing_products": [ ],
- "location_token": "OPAQUE_TOKEN"
}
}, - "pickup_options": {
- "success": false
}
}Final amounts before ordering, including the wallet split. total_payable is what
the member still owes. Note the field is selected_delivery_option here but
delivery_option on createOrder.
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
| plan_id | string |
required | object (CustomerDetailsRef) |
| cart_id required | integer |
| selected_delivery_option required | string Enum: "express" "standard" "store_pickup" |
| selected_chemist_id | string Required for store_pickup; must match the cart's store. |
| medicine_vendor_id | integer The option's |
| customer_plan_id | integer >= 0 |
| subscription_id | string |
{- "plan_id": "EXAMPLE_PLAN",
- "customer_details": {
- "api_customer_id": "CUST1001"
}, - "cart_id": 701,
- "selected_delivery_option": "standard",
- "medicine_vendor_id": 3
}{- "products": [
- {
- "id": 50001,
- "name": "Example 500 Tablet",
- "item_type": "allopathy",
- "rx_required": false,
- "quantity": 2,
- "mrp": 50,
- "offered_price": 45
}
], - "payment_details": {
- "total_mrp": 50,
- "sub_total": 45,
- "discount": 5,
- "shipping_charge": 50,
- "free_shipping": false,
- "total_amount": 95,
- "wallet_deduction": 95,
- "spending_balance_deduction": 0,
- "total_payable": 0
}, - "estimated_time": "24-48 hrs",
- "fulfillment": {
- "type": "delivery",
- "delivery_details": {
- "mode": "standard",
- "eta": "24-48 hrs",
- "shipping_charge": 50,
- "free_shipping": false
}
}, - "address": { }
}Places an order from the cart. The response status depends on your payment flow
(fixed per contract):
confirmed: the wallet covered the whole amount.payment_pending: send payment_link to the member; unpaid orders are abandoned
after 3 hours.partner_payment_pending: collect amount_to_collect yourself, then call
confirmOrder; unconfirmed orders are abandoned after 3 hours.For store pickup, set it on the cart first (updateCart); don't pass the store here.
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
| plan_id | string |
required | object (CustomerDetailsRef) |
| cart_id required | integer |
| delivery_option | string Default: "standard" Enum: "express" "standard" "store_pickup" |
| delivery_type | string Enum: "delivery" "pickup" Defaults from the cart's fulfillment_type. |
| location_token | string Token of the chosen option from |
| medicine_vendor_id | integer |
| coupon_code | string |
| customer_plan_id | integer >= 0 |
| subscription_id | string |
{- "plan_id": "EXAMPLE_PLAN",
- "customer_details": {
- "api_customer_id": "CUST1001"
}, - "cart_id": 701,
- "delivery_option": "standard",
- "location_token": "OPAQUE_TOKEN"
}{- "success": true,
- "status": "confirmed",
- "booking_id": 90001,
- "user_prescription_details": {
- "status": "confirmed",
- "unique_id": "EPO000000000001"
}
}Newest first.
| customer_details[api_customer_id] required | string Your id for the member. |
| page | integer Default: 1 Page number. Values below 1 are read as 1. |
| per_page | integer Default: 10 |
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
{- "success": true,
- "orders": [
- {
- "unique_id": "string",
- "status": "string",
- "status_text": "string",
- "status_description": "string",
- "partner_status": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "otp": "string",
- "vendor_name": "string",
- "order_type": "string",
- "api_customer_id": "string",
- "tracking_number": "string",
- "tracking_url": "string",
- "tracking_partner": "string",
- "eta_from": "string",
- "eta_to": "string",
- "invoice_url": "string",
- "payment_details": { },
- "products": [
- {
- "id": 0,
- "product_id": "string",
- "name": "string",
- "quantity": 0,
- "mrp": 0,
- "offered_price": 0,
- "selling_price": 0,
- "discounted_price": 0
}
], - "address": { },
- "prescriptions": [
- "string"
], - "split_details": {
- "is_splitted": true,
- "parent_order": null,
- "sub_orders": [
- { }
]
}
}
], - "meta": {
- "current_page": 0,
- "next_page": 0,
- "prev_page": 0,
- "total_pages": 0,
- "total_count": 0
}
}The source of truth for an order's state; use it to reconcile webhooks.
| order_id required | string Example: EPO000000000001 The order's |
| customer_details[api_customer_id] required | string Your id for the member. |
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
{- "success": true,
- "order": {
- "unique_id": "string",
- "status": "string",
- "status_text": "string",
- "status_description": "string",
- "partner_status": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "otp": "string",
- "vendor_name": "string",
- "order_type": "string",
- "api_customer_id": "string",
- "tracking_number": "string",
- "tracking_url": "string",
- "tracking_partner": "string",
- "eta_from": "string",
- "eta_to": "string",
- "invoice_url": "string",
- "payment_details": { },
- "products": [
- {
- "id": 0,
- "product_id": "string",
- "name": "string",
- "quantity": 0,
- "mrp": 0,
- "offered_price": 0,
- "selling_price": 0,
- "discounted_price": 0
}
], - "address": { },
- "prescriptions": [
- "string"
], - "split_details": {
- "is_splitted": true,
- "parent_order": null,
- "sub_orders": [
- { }
]
}
}
}Possible only before the pharmacy ships (vendor-specific) and never for split orders. Refunds to wallets and payment methods run automatically.
| order_id required | string Example: EPO000000000001 The order's |
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
| plan_id | string |
required | object (CustomerDetailsRef) |
| reason | string Default: "Cancel order" |
| message | string Free text, for example when reason is "other". |
{- "customer_details": {
- "api_customer_id": "CUST1001"
}, - "reason": "Ordered by mistake"
}{- "success": true,
- "order_id": "EPO000000000001",
- "status": "cancelled"
}Partner-collected flow only. Tells hlthstack you collected amount_to_collect.
partner_collected_amount must equal it exactly. Safe to retry: the same amount and
reference returns already_confirmed. On 409, back off and retry.
| order_id required | string Example: EPO000000000001 The order's |
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
required | object (CustomerDetailsRef) |
| partner_collected_amount required | string or number > 0 Decimal amount greater than 0, for example "261.0". |
| partner_payment_reference required | string\S Your payment/transaction reference (not blank; surrounding whitespace is trimmed). |
{- "customer_details": {
- "api_customer_id": "CUST1001"
}, - "partner_collected_amount": "261.0",
- "partner_payment_reference": "TXN-0001"
}{- "success": true,
- "status": "confirmed",
- "order_id": "EPO000000000003",
- "partner_collected_amount": 261,
- "partner_payment_reference": "TXN-0001",
- "vendor_order_status": "onhold"
}Allocated and available amounts per benefit for the member and their active family,
primary member first. Identify the member by api_customer_id or customer_id
(api_customer_id wins when both are sent); a dependant's id returns the whole
family. Send customer_plan_id or subscription_id to read one subscription
(upcoming and ended ones included).
| company_slug required | string Your company slug, shared at onboarding. Must match the entity of the access token. |
| plan_id | string Plan identifier shared at onboarding. Defaults to the base plan. |
| api_customer_id | string |
| customer_id | string hlthstack's customer id. |
| customer_plan_id | integer >= 0 hlthstack's subscription id (from |
| subscription_id | string Your own subscription id, if sent at enrollment. |
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
{- "status": "success",
- "data": {
- "members": [
- {
- "name": "Jane Doe",
- "gender": "FEMALE",
- "dob": "1990-08-24",
- "phone": "9999999999",
- "email": "jane@example.com",
- "relationship": "SELF",
- "member_status": "ACTIVE",
- "relation": "self",
- "wallet_details": {
- "benefits": [
- {
- "benefit_type": "pharmacy",
- "allocated_benefit_amount": 12500,
- "available_benefit_amount": 10000,
- "allocated_benefit_utilization_count": 0,
- "current_benefit_utilization_count": 0
}
], - "total_allocated_amount": 12500,
- "available_amount": 10000
}
}
]
}
}One row per subscription (active, upcoming or in grace; fully lapsed ones are left
out). Use customer_plan_id to choose which subscription pays when booking or
ordering.
| company_slug required | string Your company slug, shared at onboarding. Must match the entity of the access token. |
| api_customer_id | string |
| customer_id | string |
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
{- "status": "success",
- "data": {
- "customer_plans": [
- {
- "customer_plan_id": 101,
- "subscription_id": "SUB-0001",
- "plan_id": "EXAMPLE_TOPUP",
- "plan_name": "Top-up",
- "start_date": "2026-01-01",
- "end_date": "2026-12-31",
- "grace_end_date": "2027-01-31",
- "status": "active",
- "available_balance": 1500
}
]
}
}Register, update and deactivate members and their dependants in bulk. Uses its own credentials and token (X-EKINCARE-KEY).
Exchanges your pre-registration credentials (HTTP Basic: the account email and
password hlthstack issued for pre-registration, not your booking API credentials) for
a token. Send it as the X-EKINCARE-KEY header on the other pre-registration calls.
The token is valid for 1 hour. expires_at is a UTC timestamp in the form
2026-01-15 07:16:21 UTC (not ISO 8601). Every call issues a new token; there is no
refresh token.
{- "access_token": "YOUR_PRE_REGISTRATION_TOKEN",
- "expires_at": "2026-01-15 07:16:21 UTC"
}Queues members (employees) and their dependants for registration and returns a
request_id. Processing is asynchronous: poll getPreRegistrationStatus for each
row's outcome. Employees are processed before dependants, so a dependant can refer to
an employee sent in the same request.
employees, dependants or both; at most 250 rows in total per request."" or null). A row missing a required key is dropped silently: it is not
registered and is not reported in the status. If no row is left, the call fails
with 400.company_id (a company your credentials can act on) and an
email or an employee_code.guardian_email, or by company_id
plus guardian_employee_code when the employee has no email.failure_records (see the field patterns and x-hlthstack-rules).Array of objects (PreRegistrationEmployee) | |
Array of objects (PreRegistrationDependant) |
{- "employees": [
- {
- "employee_code": "EMP1001",
- "company_id": "1001",
- "first_name": "Jane",
- "last_name": "Doe",
- "email": "jane.doe@example.com",
- "date_of_birth": "24-08-1990",
- "gender": "Female",
- "employee_office_location": "Hyderabad",
- "department": "Engineering",
- "mobile_number": "9999999999",
- "vip": "No",
- "entity_name": "",
- "grade": "B",
- "date_of_joining": "01-01-2026",
- "voluntary_plan_ids": [
- "EXAMPLE_TOPUP"
]
}
], - "dependants": [
- {
- "guardian_email": "jane.doe@example.com",
- "dependent_code": "DEP-001",
- "first_name": "John",
- "last_name": "Doe",
- "date_of_birth": "10-02-1960",
- "gender": "Male",
- "mobile_number": "9999999998",
- "relation": "Father"
}
]
}{- "message": "Request has been accepted",
- "request_id": "3f2b8c1e-0d4a-4c5e-9b7a-2e6f1d8c9a01"
}Queues updates to registered members and dependants and returns a request_id; poll
getPreRegistrationStatus for each row's outcome. Send only the identifier and the
fields to change. At most 250 rows in total per request.
email, or by company_id plus employee_code when no
email is sent. The email itself can't be changed here.api_customer_id, then dependent_code, under the employee
given by guardian_email (or company_id plus guardian_employee_code); otherwise
by mobile_number, which must match exactly one dependant. At least one of
api_customer_id, dependent_code or mobile_number is required.mobile_number in an update is stored as the member's alternate mobile number.voluntary_plan_ids takes the same entries as createPreRegistrations. On a
dependant it is refused (the rest of the row is still applied).Array of objects (PreRegistrationEmployeeUpdate) | |
Array of objects (PreRegistrationDependantUpdate) |
{- "employees": [
- {
- "email": "jane.doe@example.com",
- "department": "Finance",
- "grade": "C"
}
], - "dependants": [
- {
- "guardian_email": "jane.doe@example.com",
- "dependent_code": "DEP-001",
- "last_name": "Doe-Smith"
}
]
}{- "message": "Request has been accepted",
- "request_id": "3f2b8c1e-0d4a-4c5e-9b7a-2e6f1d8c9a01"
}Queues deactivations and returns a request_id; poll getPreRegistrationStatus for
each one's outcome. employees lists employee emails, dependants lists dependant
mobile numbers. At most 250 entries in total per request.
Deactivating an employee also deactivates all their dependants and cancels their ongoing appointments. Only members of companies your credentials can act on are deactivated.
| employees | Array of strings Emails of the employees to deactivate. |
| dependants | Array of strings Mobile numbers of the dependants to deactivate. |
{- "employees": [
- "jane.doe@example.com"
]
}{- "message": "Request has been accepted",
- "request_id": "3f2b8c1e-0d4a-4c5e-9b7a-2e6f1d8c9a01"
}The request's processing status and its rows, split into success_records and
failure_records. Poll until status is completed; records are added while the
request is inprogress.
guardian_email and relation); employees carry customer_plans.
Each failure record echoes the row with its errors.status (Active/Inactive);
failure records are {"errors": ["..."]} only.| request_id required | string <uuid> Example: 3f2b8c1e-0d4a-4c5e-9b7a-2e6f1d8c9a01 The |
{- "request_id": "3f2b8c1e-0d4a-4c5e-9b7a-2e6f1d8c9a01",
- "status": "completed",
- "success_records": [
- {
- "employee_code": "EMP1001",
- "first_name": "Jane",
- "last_name": "Doe",
- "email": "jane.doe@example.com",
- "date_of_birth": "1990-08-24",
- "gender": "Female",
- "mobile_number": "9999999999",
- "vip": "No",
- "entity_name": null,
- "employee_office_location": "Hyderabad",
- "department": "Engineering",
- "customer_token": "EXAMPLE_CUSTOMER_TOKEN",
- "errors": [ ],
- "grade": "B",
- "guardian_email": null,
- "relation": null,
- "customer_plans": [
- {
- "customer_plan_id": 101,
- "subscription_id": null,
- "plan_id": "EXAMPLE_TOPUP",
- "plan_name": "Top-up",
- "start_date": "2026-01-15",
- "end_date": "2026-12-31",
- "grace_end_date": "2027-01-31",
- "status": "active"
}
]
}
], - "failure_records": [
- {
- "employee_code": "EMP1002",
- "first_name": "Sam",
- "last_name": "Roe",
- "email": "sam.roe@example",
- "date_of_birth": "31-02-1990",
- "gender": "Male",
- "mobile_number": "12345",
- "vip": "No",
- "entity_name": "",
- "employee_office_location": "Hyderabad",
- "department": "Engineering",
- "guardian_email": null,
- "errors": [
- "Email is invalid",
- "Date of birth is invalid - valid format is DD-MM-YYYY or DD/MM/YYYY",
- "Mobile number is not in the correct format for India"
]
}
], - "created_at": "2026-01-15T06:16:21Z"
}Staging-only endpoints that move a booking or order through its lifecycle and fire the real webhooks.
Staging only. Production returns 401. Moves the appointment through its lifecycle and fires the same webhook a real update would.
| appointment_id required | string (AppointmentId) APT[0-9A-Z_]{9} Example: APT1A2B3C4D5
|
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
| status required | string Enum: "confirm" "assign_phlebo" "cancel" "completed" "reschedule" "reports_partially_received" "reports_received" "lab_result"
|
{- "status": "confirm"
}{- "messages": [
- "Appointment status updated successfully"
]
}Staging only; the route does not exist in production (404). Fires the same
webhook as a real update. reports_received attaches a sample summary and
prescription and then moves the consultation to received.
| appointment_id required | string (AppointmentId) APT[0-9A-Z_]{9} Example: APT1A2B3C4D5
|
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
| status required | string Enum: "confirm" "cancel" "completed" "reschedule" "reports_received" |
| reschedule_time | string <date-time> For |
{- "status": "confirm"
}{- "messages": [
- "Appointment status updated successfully"
]
}Staging only; the route does not exist in production (404). Records a status
change and fires the same status_update webhook a pharmacy update would. The
optional text and tracking fields are passed through to the webhook.
| order_id required | string Example: EPO000000000001 The order's |
| API-ENTITY-ID | string Multi-entity partners: the id of the entity to act for. When omitted, the entity
tied to your credentials is used. Requires |
| API-SECRET-KEY | string For multi-entity partners, the secret key issued with your credentials. Required when |
required | object (CustomerDetailsRef) |
| status required | string Enum: "received" "cancellation_request" "cancellation_inprogress" "consultation_required" "processed" "rejected" "invoice_pending" "invoice_generated" "onhold" "cancelled" "abandoned" "packing" "packed" "delivery_postponed" "out_for_delivery" "delivered" "in_transit" "in_delivery" "created" "verification_pending" "verified" "failed" "in_progress" "error" "out_of_stock" "returned_and_refunded" "returned" "under_ops_verification" "prescription_under_verification" "prescription_on_hold" "prescription_rejected" "prescription_cancelled" "ops_verified" "ops_rejected" An order status (see |
| status_text | string |
| status_description | string |
| tracking_number | string |
| tracking_url | string |
| tracking_partner | string |
{- "customer_details": {
- "api_customer_id": "CUST1001"
}, - "status": "in_progress",
- "status_text": "Order is being processed"
}{- "success": true,
- "order_id": "EPO000000000001",
- "status": "in_progress",
- "journey": [
- {
- "id": 501,
- "status": "in_progress",
- "status_text": "Order is being processed",
- "created_at": "2026-01-15T09:26:03.000+05:30"
}
]
}