Create Appointment Order

Developing

POST

/api/service/v1/appointment/order

Request

Header Params

Body Params application/json

Example

{
    "user": "679b8374713bace311b470bf",
    "payment_mode": "cod",
    "slot_timing": {
        "date" : "2025-08-08",
        "start_time" : "12:00",
        "end_time": "14:30"
    },
    "address": "67ecd54993b15074f6c02b25",
    "gender_preference": "male",
    "coupon_code" : "ABC",
    "timezone" : "Asia/Calcutta",
    "currency" : "SAR",
    "technician" : "67696c610a1530f912459bfa",
    "items": [{
        "family_member_id" : "67a464e077f8e578abba1217",
        "product_id" : "689355bd2c35ae1f081d463e"
    }]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://afyahealth.doctodoor.com:5600/api/service/v1/appointment/order' \
--header 'Accept: application/json' \
--header 'practice-code: DEFAULT' \
--header 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3YjJkZmZlNWJmMjdlMzk1NTUzMjE0MyIsImVtYWlsIjoiZGVlcC5tYXJzb25pYUBwbGVuYXJ0ZWNoLmNvbSIsInN1YiI6IjY3YjJkZmZlNWJmMjdlMzk1NTUzMjE0MyIsImlhdCI6MTc0OTY0MjAwNiwiZXhwIjoxNzU3NDE4MDA2fQ.g8snnbceKqWwfhQ7lKdzebnlVq_bcYyRlDKR3GGWk8s' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user": "679b8374713bace311b470bf",
    "payment_mode": "cod",
    "slot_timing": {
        "date" : "2025-08-08",
        "start_time" : "12:00",
        "end_time": "14:30"
    },
    "address": "67ecd54993b15074f6c02b25",
    "gender_preference": "male",
    "coupon_code" : "ABC",
    "timezone" : "Asia/Calcutta",
    "currency" : "SAR",
    "technician" : "67696c610a1530f912459bfa",
    "items": [{
        "family_member_id" : "67a464e077f8e578abba1217",
        "product_id" : "689355bd2c35ae1f081d463e"
    }]
}'

Responses

🟢200Success

application/json

Body

Examples

SuccessException

{
    "error": false,
    "status_code": 200,
    "message": "Appointment Order success",
    "data": {
        "slot_timing": {
            "date": "2025-02-26T00:00:00.000Z",
            "start_time": "09:00",
            "end_time": "10:00"
        },
        "status": "order_confirmed",
        "reports": [],
        "is_deleted": 0,
        "items": [
            {
                "discount_amount": 0,
                "title": "test 1 ##",
                "estimated_report_delivery_time": "0",
                "product": {
                    "items": [
                        {
                            "items": [
                                "6793680981770556165f150d"
                            ],
                            "test_parameters": [
                                "6788b0121322454d3e643f64"
                            ],
                            "sample_requirements": [
                                "blood"
                            ],
                            "estimated_report_delivery_time": 0,
                            "is_deleted": 0,
                            "title": {
                                "en": "test 1 ##"
                            },
                            "subtitle": {
                                "en": "Sub ttile"
                            },
                            "description": {
                                "en": "desriptin "
                            },
                            "prerequisites": {
                                "en": "prerquu ui"
                            },
                            "type": "package",
                            "category": "6788c93bd798f459e8c8d7cc",
                            "price": 420,
                            "currency": "INR",
                            "discount_amount": 10,
                            "discount_type": "percentage",
                            "service_category": "6790d7c19975d85c7b447c53",
                            "image": "6797541deb8b1053d7d780c1",
                            "final_total": 378,
                            "created_at": "2025-01-31T05:49:17.945Z",
                            "updated_at": "2025-01-31T05:49:17.945Z",
                            "id": "679c645d7f29ad2d81113ad7"
                        }
                    ],
                    "test_parameters": [
                        "6788b0121322454d3e643f64"
                    ],
                    "sample_requirements": [
                        "blood"
                    ],
                    "estimated_report_delivery_time": 0,
                    "is_deleted": 0,
                    "title": {
                        "en": "test 1 ##"
                    },
                    "subtitle": {
                        "en": "Sub ttile"
                    },
                    "description": {
                        "en": "desriptin "
                    },
                    "prerequisites": {
                        "en": "prerquu ui"
                    },
                    "type": "package",
                    "category": "6788c93bd798f459e8c8d7cc",
                    "price": 420,
                    "currency": "INR",
                    "discount_amount": 12,
                    "discount_type": "percentage",
                    "service_category": "6790d7c19975d85c7b447c53",
                    "image": "6797541deb8b1053d7d780c1",
                    "final_total": 369.6,
                    "created_at": "2025-01-31T05:49:45.287Z",
                    "updated_at": "2025-02-05T09:44:19.792Z",
                    "id": "679c64797f29ad2d81113ae4"
                },
                "total": 420,
                "family_member": "67aaf94bdda840588315f62f",
                "discount_type": "percentage",
                "final_total": 369.6,
                "created_at": "2025-02-12T09:07:43.157Z",
                "updated_at": "2025-02-12T09:07:43.157Z",
                "id": "67ac64dfa2f1e11c07a5e44f"
            }
        ],
        "status_activity": [
            {
                "date": "2025-02-12T09:07:43.154Z",
                "status": "order_confirmed",
                "created_at": "2025-02-12T09:07:43.157Z",
                "updated_at": "2025-02-12T09:07:43.157Z",
                "id": "67ac64dfa2f1e11c07a5e453"
            },
            {
                "date": null,
                "status": "lab_agent_arrived",
                "created_at": "2025-02-12T09:07:43.157Z",
                "updated_at": "2025-02-12T09:07:43.157Z",
                "id": "67ac64dfa2f1e11c07a5e454"
            },
            {
                "date": null,
                "status": "sample_collected",
                "created_at": "2025-02-12T09:07:43.157Z",
                "updated_at": "2025-02-12T09:07:43.157Z",
                "id": "67ac64dfa2f1e11c07a5e455"
            },
            {
                "date": null,
                "status": "completed",
                "created_at": "2025-02-12T09:07:43.157Z",
                "updated_at": "2025-02-12T09:07:43.157Z",
                "id": "67ac64dfa2f1e11c07a5e456"
            },
            {
                "date": null,
                "status": "cancelled",
                "created_at": "2025-02-12T09:07:43.157Z",
                "updated_at": "2025-02-12T09:07:43.157Z",
                "id": "67ac64dfa2f1e11c07a5e457"
            }
        ],
        "user": {
            "roles": [
                "677bb5bd4291b96cd0623e9a"
            ],
            "is_master_admin": 1,
            "is_temporary_password": 0,
            "is_deleted": 0,
            "is_active": 1,
            "deleted_at": null,
            "language_code": "en",
            "first_name": "Deep",
            "middle_name": "",
            "last_name": "Marsonia",
            "full_name": "Deep Marsonia",
            "email": "deep.marsonia+lt1@plenartech.com",
            "created_at": "2025-01-06T10:51:41.468Z",
            "updated_at": "2025-02-11T07:16:27.156Z",
            "family_members": [
                {
                    "name": "test2",
                    "gender": "male",
                    "birth_date": "2000-01-01T00:00:00.000Z",
                    "updated_at": "2025-02-11T07:16:27.156Z",
                    "created_at": "2025-02-11T07:16:27.156Z",
                    "id": "67aaf94bdda840588315f62f"
                }
            ],
            "id": "677bb5bd4291b96cd0623ef2"
        },
        "payment_mode": "cod",
        "technician": {
            "roles": [
                "677bb5bd4291b96cd0623e9a"
            ],
            "is_master_admin": 1,
            "is_temporary_password": 0,
            "is_deleted": 0,
            "is_active": 1,
            "deleted_at": null,
            "language_code": "en",
            "first_name": "Hardik",
            "middle_name": "",
            "last_name": "Shah",
            "full_name": "Hardik Shah",
            "email": "hardik+lt1@plenartech.com",
            "created_at": "2025-01-06T10:51:41.424Z",
            "updated_at": "2025-01-06T10:51:41.424Z",
            "family_members": [],
            "id": "677bb5bd4291b96cd0623ee6"
        },
        "address": {
            "is_deleted": 0,
            "user": "677bb5bd4291b96cd0623eea",
            "title": "primary addres ",
            "long": 74.23,
            "lat": 72.4545,
            "address": "123 street, india",
            "created_at": "2025-01-17T11:46:59.450Z",
            "updated_at": "2025-01-17T11:46:59.450Z",
            "id": "678a433390b9c678ccb677f6"
        },
        "gender_preference": "male",
        "coupon_code": "ABC",
        "currency": "AED",
        "fee": 10,
        "total": 420,
        "final_total": 359.6,
        "created_at": "2025-02-12T09:07:43.157Z",
        "updated_at": "2025-02-12T09:07:43.157Z",
        "id": "67ac64dfa2f1e11c07a5e44c"
    }
}

Modified at 2025-08-08 09:30:40

Upload File

Get Appointments List