Diagnostics Merchant Order Updates

We have an Order Update webhook which is responsible for sending the order status updates to the merchant partner. The merchant partner can use this webhook to update the order status at their end accordingly.

Details to be confirmed by the Merchant team for the APIs:

• The API endpoints are to be decided by the merchant team.
• Sample response payloads in case of non-200 responses for all the APIs
• Authentication mechanism can be used in these APIs. Assuming that the token-based mechanism will be used, the merchant team needs to share the auth-token to be sent in the request header.

Order Status Diagnostics Payload Examples

Booked

"data": {
        "order_id": "SO3277723609-878",
        "phelbo_out_for_collection": null,
        "phone_no": "8920856405",
        "user_paid": null,
        "merchant_paid": null,
        "patient": {
            "id": null,
            "name": "Tony Stark",
            "age": 30,
            "gender": "male",
            "mobile_number": "8920856405"
        },
        "email": "[email protected]",
        "category": "PATHOLOGY",
        "super_order_id": "SO3277723609-878",
        "address": {
            "pincode": null,
            "city": "GURGAON",
            "state": "DL",
            "landmark": null,
            "street": "5 TARAK DUTTA ROAD, 1ST FLOOR, BESIDE KARAYA POLICE STATION",
            "street1": null,
            "street2": null,
            "locality": null,
            "city_id": null
        },
        "reports": null,
        "bookings": [
            {
                "referral": "EXAMPLE_VENDOR_API",
                "reports": [
                    "https://s3-ap-south-1.amazonaws.com/labs-stag-diagnostic-reports/Mohit_Rajput_Swasthfit_Basic_Health_Checkup_f547db07-4dfc-4f1e-9511-1aacc5a3cd0b.pdf"
                ],
                "delivery_time": null,
                "create_time": "09-22-2023, 04:16:13",
                "cancel_time": null,
                "reporting_tat": 24,
                "status": "booked",
                "cancel_reason": null,
                "coupon_code": null,
                "is_cancellable": true,
                "sample_collection_time": "07-23-2024 16:12:53",
                "test": {
                    "name": "Complete Haemogram",
                    "id": 1743
                },
                "id": "SB1548599800-273"
            }
        ],
        "lab": {
            "name": "Tata 1mg Labs (Tata 1mg Technologies Private Limited)",
            "id": 95
        }
    },

Confirmed

    "data": {
        "order_id": "SO3593738574-669",
        "phelbo_out_for_collection": null,
        "phone_no": "8920856405",
        "user_paid": null,
        "merchant_paid": null,
        "patient": {
            "id": null,
            "name": "pk",
            "age": 30,
            "gender": "male",
            "mobile_number": "8920856405"
        },
        "email": "[email protected]",
        "category": "PATHOLOGY",
        "super_order_id": "SO3593738574-669",
        "address": {
            "pincode": null,
            "city": "GURGAON",
            "state": "HARYANA",
            "landmark": null,
            "street": "5 TARAK DUTTA ROAD, 1ST FLOOR, BESIDE KARAYA POLICE STATION",
            "street1": null,
            "street2": null,
            "locality": null,
            "city_id": null
        },
        "reports": null,
        "bookings": [
            {
                "referral": "ZYLA",
                "reports": null,
                "delivery_time": null,
                "create_time": "03-06-2024, 07:13:46",
                "cancel_time": null,
                "reporting_tat": 72,
                "status": "confirmed",
                "cancel_reason": null,
                "coupon_code": null,
                "is_cancellable": true,
                "sample_collection_time": "03-06-2024 09:30:00",
                "test": {
                    "name": "Hepatitis B (Core) IgM Antibody",
                    "id": 1745
                },
                "id": "SB1894424942-420"
            },
            {
                "referral": "ZYLA",
                "reports": null,
                "delivery_time": null,
                "create_time": "03-06-2024, 07:13:46",
                "cancel_time": null,
                "reporting_tat": 48,
                "status": "confirmed",
                "cancel_reason": null,
                "coupon_code": null,
                "is_cancellable": true,
                "sample_collection_time": "03-06-2024 09:30:00",
                "test": {
                    "name": "Complete Haemogram",
                    "id": 1743
                },
                "id": "SB1643966432-327"
            }
        ],
        "lab": {
            "name": "1mg Labs (1MG Technologies Private Limited)",
            "id": 95
        }
    }

Sample Collection Date Changed

"data": {
        "order_id": "SO1600595522-249",
        "phelbo_out_for_collection": null,
        "phone_no": "8505089989",
        "user_paid": null,
        "merchant_paid": null,
        "patient": {
            "id": null,
            "name": "Tony Stark",
            "age": 30,
            "gender": "male",
            "mobile_number": "8505089989"
        },
        "email": "[email protected]",
        "category": "PATHOLOGY",
        "super_order_id": "SO1600595522-249",
        "address": {
            "pincode": null,
            "city": "GURGAON",
            "state": "HARYANA",
            "landmark": null,
            "street": "5 TARAK DUTTA ROAD, 1ST FLOOR, BESIDE KARAYA POLICE STATION",
            "street1": null,
            "street2": null,
            "locality": null,
            "city_id": null
        },
        "reports": null,
        "bookings": [
            {
                "referral": "ZYLA",
                "reports": null,
                "delivery_time": null,
                "create_time": "03-04-2024, 08:38:26",
                "cancel_time": null,
                "reporting_tat": 24,
                "status": "confirmed",
                "cancel_reason": null,
                "coupon_code": null,
                "is_cancellable": true,
                "sample_collection_time": "05-02-2024 11:30:00",
                "test": {
                    "name": "Complete Haemogram",
                    "id": 1743
                },
                "id": "SB3902080269-978",
                "phlebo_details": null
            }
        ],
        "lab": {
            "name": "Tata 1mg Labs (Tata 1mg Technologies Private Limited)",
            "id": 95
        }
    },

Recollection Required

    "data": {
        "order_id": "SO1600595522-249",
        "phelbo_out_for_collection": null,
        "phone_no": "8505089989",
        "user_paid": null,
        "merchant_paid": null,
        "patient": {
            "id": null,
            "name": "Tony Stark",
            "age": 30,
            "gender": "male",
            "mobile_number": "8505089989"
        },
        "email": "[email protected]",
        "category": "PATHOLOGY",
        "super_order_id": "SO1600595522-249",
        "address": {
            "pincode": null,
            "city": "GURGAON",
            "state": "HARYANA",
            "landmark": null,
            "street": "5 TARAK DUTTA ROAD, 1ST FLOOR, BESIDE KARAYA POLICE STATION",
            "street1": null,
            "street2": null,
            "locality": null,
            "city_id": null
        },
        "reports": null,
        "bookings": [
            {
                "referral": "ZYLA",
                "reports": null,
                "delivery_time": null,
                "create_time": "03-04-2024, 08:38:26",
                "cancel_time": null,
                "reporting_tat": 24,
                "status": "recollection_required",
                "cancel_reason": null,
                "coupon_code": null,
                "is_cancellable": false,
                "sample_collection_time": "05-02-2024 11:30:00",
                "test": {
                    "name": "Complete Haemogram",
                    "id": 1743
                },
                "id": "SB3902080269-978",
                "phlebo_details": null
            }
        ],
        "lab": {
            "name": "Tata 1mg Labs (Tata 1mg Technologies Private Limited)",
            "id": 95
        }
    },

Phlebo Assigned

{
    "data": {
        "order_id": "SO1600595522-249",
        "phelbo_out_for_collection": null,
        "phone_no": "8505089989",
        "user_paid": null,
        "merchant_paid": null,
        "patient": {
            "id": null,
            "name": "Tony Stark",
            "age": 30,
            "gender": "male",
            "mobile_number": "8505089989"
        },
        "email": "[email protected]",
        "category": "PATHOLOGY",
        "super_order_id": "SO1600595522-249",
        "address": {
            "pincode": null,
            "city": "GURGAON",
            "state": "HARYANA",
            "landmark": null,
            "street": "5 TARAK DUTTA ROAD, 1ST FLOOR, BESIDE KARAYA POLICE STATION",
            "street1": null,
            "street2": null,
            "locality": null,
            "city_id": null
        },
        "reports": null,
        "bookings": [
            {
                "referral": "ZYLA",
                "reports": null,
                "delivery_time": null,
                "create_time": "03-04-2024, 08:38:26",
                "cancel_time": null,
                "reporting_tat": 24,
                "status": "phlebo_assigned",
                "cancel_reason": null,
                "coupon_code": null,
                "is_cancellable": false,
                "sample_collection_time": "05-02-2024 11:30:00",
                "test": {
                    "name": "Complete Haemogram",
                    "id": 1743
                },
                "id": "SB3902080269-978",
                "phlebo_details": {
                    "name": "Akanksha",
                    "phone_no": "+911166765308"
                }
            }
        ],
        "lab": {
            "name": "Tata 1mg Labs (Tata 1mg Technologies Private Limited)",
            "id": 95
        }
    }
}

Sample_collected

{
    "data": {
        "order_id": "SO1600595522-249",
        "phelbo_out_for_collection": null,
        "phone_no": "8505089989",
        "user_paid": null,
        "merchant_paid": null,
        "patient": {
            "id": null,
            "name": "Tony Stark",
            "age": 30,
            "gender": "male",
            "mobile_number": "8505089989"
        },
        "email": "[email protected]",
        "category": "PATHOLOGY",
        "super_order_id": "SO1600595522-249",
        "address": {
            "pincode": null,
            "city": "GURGAON",
            "state": "HARYANA",
            "landmark": null,
            "street": "5 TARAK DUTTA ROAD, 1ST FLOOR, BESIDE KARAYA POLICE STATION",
            "street1": null,
            "street2": null,
            "locality": null,
            "city_id": null
        },
        "reports": null,
        "bookings": [
            {
                "referral": "ZYLA",
                "reports": null,
                "delivery_time": null,
                "create_time": "03-04-2024, 08:38:26",
                "cancel_time": null,
                "reporting_tat": 24,
                "status": "sample_collected",
                "cancel_reason": null,
                "coupon_code": null,
                "is_cancellable": false,
                "sample_collection_time": "05-02-2024 11:30:00",
                "test": {
                    "name": "Complete Haemogram",
                    "id": 1743
                },
                "id": "SB3902080269-978",
                "phlebo_details": {
                    "name": "Akanksha",
                    "phone_no": "+911166765308"
                }
            }
        ],
        "lab": {
            "name": "Tata 1mg Labs (Tata 1mg Technologies Private Limited)",
            "id": 95
        }
    }
}

Specimen_reached_lfs_center

"data": {
        "order_id": "SO1600595522-249",
        "phelbo_out_for_collection": null,
        "phone_no": "8505089989",
        "user_paid": null,
        "merchant_paid": null,
        "patient": {
            "id": null,
            "name": "Tony Stark",
            "age": 30,
            "gender": "male",
            "mobile_number": "8505089989"
        },
        "email": "[email protected]",
        "category": "PATHOLOGY",
        "super_order_id": "SO1600595522-249",
        "address": {
            "pincode": null,
            "city": "GURGAON",
            "state": "HARYANA",
            "landmark": null,
            "street": "5 TARAK DUTTA ROAD, 1ST FLOOR, BESIDE KARAYA POLICE STATION",
            "street1": null,
            "street2": null,
            "locality": null,
            "city_id": null
        },
        "reports": null,
        "bookings": [
            {
                "referral": "ZYLA",
                "reports": null,
                "delivery_time": null,
                "create_time": "03-04-2024, 08:38:26",
                "cancel_time": null,
                "reporting_tat": 24,
                "status": "specimen_reached_lfs_center",
                "cancel_reason": null,
                "coupon_code": null,
                "is_cancellable": false,
                "sample_collection_time": "05-02-2024 11:30:00",
                "test": {
                    "name": "Complete Haemogram",
                    "id": 1743
                },
                "id": "SB3902080269-978",
                "phlebo_details": {
                    "name": "Akanksha",
                    "phone_no": "+911166765308"
                }
            }
        ],
        "lab": {
            "name": "Tata 1mg Labs (Tata 1mg Technologies Private Limited)",
            "id": 95
        }
}

Ready_for_dispatch

    "data": {
        "order_id": "SO1600595522-249",
        "phelbo_out_for_collection": null,
        "phone_no": "8505089989",
        "user_paid": null,
        "merchant_paid": null,
        "patient": {
            "id": null,
            "name": "Tony Stark",
            "age": 30,
            "gender": "male",
            "mobile_number": "8505089989"
        },
        "email": "[email protected]",
        "category": "PATHOLOGY",
        "super_order_id": "SO1600595522-249",
        "address": {
            "pincode": null,
            "city": "GURGAON",
            "state": "HARYANA",
            "landmark": null,
            "street": "5 TARAK DUTTA ROAD, 1ST FLOOR, BESIDE KARAYA POLICE STATION",
            "street1": null,
            "street2": null,
            "locality": null,
            "city_id": null
        },
        "reports": null,
        "bookings": [
            {
                "referral": "ZYLA",
                "reports": null,
                "delivery_time": null,
                "create_time": "03-04-2024, 08:38:26",
                "cancel_time": null,
                "reporting_tat": 24,
                "status": "ready_for_dispatch",
                "cancel_reason": null,
                "coupon_code": null,
                "is_cancellable": false,
                "sample_collection_time": "05-02-2024 11:30:00",
                "test": {
                    "name": "Complete Haemogram",
                    "id": 1743
                },
                "id": "SB3902080269-978",
                "phlebo_details": {
                    "name": "Akanksha",
                    "phone_no": "+911166765308"
                }
            }
        ],
        "lab": {
            "name": "Tata 1mg Labs (Tata 1mg Technologies Private Limited)",
            "id": 95
        }
    },

Sent_to_lab

    "data": {
        "order_id": "SO1600595522-249",
        "phelbo_out_for_collection": null,
        "phone_no": "8505089989",
        "user_paid": null,
        "merchant_paid": null,
        "patient": {
            "id": null,
            "name": "Tony Stark",
            "age": 30,
            "gender": "male",
            "mobile_number": "8505089989"
        },
        "email": "[email protected]",
        "category": "PATHOLOGY",
        "super_order_id": "SO1600595522-249",
        "address": {
            "pincode": null,
            "city": "GURGAON",
            "state": "HARYANA",
            "landmark": null,
            "street": "5 TARAK DUTTA ROAD, 1ST FLOOR, BESIDE KARAYA POLICE STATION",
            "street1": null,
            "street2": null,
            "locality": null,
            "city_id": null
        },
        "reports": null,
        "bookings": [
            {
                "referral": "ZYLA",
                "reports": null,
                "delivery_time": null,
                "create_time": "03-04-2024, 08:38:26",
                "cancel_time": null,
                "reporting_tat": 24,
                "status": "sent_to_lab",
                "cancel_reason": null,
                "coupon_code": null,
                "is_cancellable": false,
                "sample_collection_time": "05-02-2024 11:30:00",
                "test": {
                    "name": "Complete Haemogram",
                    "id": 1743
                },
                "id": "SB3902080269-978",
                "phlebo_details": {
                    "name": "Akanksha",
                    "phone_no": "+911166765308"
                }
            }
        ],
        "lab": {
            "name": "Tata 1mg Labs (Tata 1mg Technologies Private Limited)",
            "id": 95
        }
    },

Delivered

"data": {
        "order_id": "SO1600595522-249",
        "phelbo_out_for_collection": null,
        "phone_no": "8505089989",
        "user_paid": null,
        "merchant_paid": null,
        "patient": {
            "id": null,
            "name": "Tony Stark",
            "age": 30,
            "gender": "male",
            "mobile_number": "8505089989"
        },
        "email": "[email protected]",
        "category": "PATHOLOGY",
        "super_order_id": "SO1600595522-249",
        "address": {
            "pincode": null,
            "city": "GURGAON",
            "state": "HARYANA",
            "landmark": null,
            "street": "5 TARAK DUTTA ROAD, 1ST FLOOR, BESIDE KARAYA POLICE STATION",
            "street1": null,
            "street2": null,
            "locality": null,
            "city_id": null
        },
        "reports": null,
        "bookings": [
            {
                "referral": "ZYLA",
                "reports": [
                    "https://s3.ap-south-1.amazonaws.com/1mg-droplet-staging/upload/reports/280236/report-2e70c11e6fbba82a85c83cd44af62e41af8de161.pdf"
                ],
                "delivery_time": "05-02-2024, 07:39:06",
                "create_time": "03-04-2024, 08:38:26",
                "cancel_time": null,
                "reporting_tat": 24,
                "status": "delivered",
                "cancel_reason": null,
                "coupon_code": null,
                "is_cancellable": false,
                "sample_collection_time": "05-02-2024 11:30:00",
                "test": {
                    "name": "Complete Haemogram",
                    "id": 1743
                },
                "id": "SB3902080269-978",
                "phlebo_details": {
                    "name": "Akanksha",
                    "phone_no": "+911166765308"
                }
            }
        ],
        "lab": {
            "name": "Tata 1mg Labs (Tata 1mg Technologies Private Limited)",
            "id": 95
        }
    },

Cancelled

    "data": {
        "order_id": "SO3849944885-121",
        "phelbo_out_for_collection": null,
        "phone_no": "6666620038",
        "user_paid": null,
        "merchant_paid": null,
        "patient": {
            "id": null,
            "name": "Spyke",
            "age": 88,
            "gender": "Male",
            "mobile_number": "6666620038"
        },
        "email": "[email protected]",
        "category": "PATHOLOGY",
        "super_order_id": "SO3849944885-121",
        "address": {
            "pincode": null,
            "city": "GURGAON",
            "state": "DL",
            "landmark": null,
            "street": "3rd Floor, Motorola Building",
            "street1": null,
            "street2": null,
            "locality": null,
            "city_id": null
        },
        "reports": null,
        "bookings": [
            {
                "referral": "ZYLA",
                "reports": [
                    "https://s3-ap-south-1.amazonaws.com/labs-stag-diagnostic-reports/Spyke_Complete_Blood_Count_6bdaba45-3e8a-4ca1-ab47-42f57a832b16.pdf"
                ],
                "delivery_time": null,
                "create_time": "05-22-2023, 12:01:34",
                "cancel_time": "05-22-2023, 12:01:35",
                "reporting_tat": 12,
                "status": "cancelled",
                "cancel_reason": {
                    "source": "API",
                    "level1": "Other",
                    "level2": "Third Party Cancelled"
                },
                "coupon_code": null,
                "is_cancellable": false,
                "sample_collection_time": "05-23-2023 00:30:00",
                "test": {
                    "name": "Complete Blood Count",
                    "id": 1717
                },
                "id": "SB2783697574-988",
                "phlebo_details": null
            }
        ],
        "lab": {
            "name": "Tata 1mg Labs (Tata 1mg Technologies Private Limited)",
            "id": 95
        }
    },