Afya-Health
  1. Products
Afya-Health
  • Auth
    • Login
      POST
    • Signup
      POST
  • ForgotPassword
    • Verify OTP
      POST
    • ForgotPassword
      POST
    • ResetPassword
      POST
  • Profile
    • Get User Profile
      GET
    • Update user profile
      POST
  • Family Members
    • Add Family Member
      POST
    • Update Family Members
      PUT
    • Delete Family Member
      DELETE
  • Address
    • Get User address
      GET
    • Add Address
      POST
    • Update address
      PUT
    • Delete Address
      DELETE
  • Languages
    • List AppLabels
      GET
    • Add/Update Label
      POST
    • List Languages
      GET
  • Products
    • Get Products
      GET
    • Create Product
      POST
    • Update Product
      PUT
    • Delete Product
      DELETE
    • Update product items
      PUT
  • Permissions
    • Get Permissions
  • Config
    • List Practice Config
    • Add Update Config
    • List Master Config
    • Add Update Master Config
  • Appointment Schedule
    • Create Schedule
    • Update Schedule
    • Delete Schedule
    • Get Schedule by ID
    • Get Schedule list
  • Test Tags
    • Get Test Tags
    • Create Test Tag
    • Update Test Tag
    • Delete Test Tag
  • Test Parameters
    • Get Test Parameters
    • Create Test Parameters
    • Update Test Parameters
    • Delete Test Parameters
  • Category
    • Get Category
    • Create Category
    • Update Category
    • Delete Category
  • Device
    • Register Device
  • File
    • Upload File
  • Appointment
    • Create Appointment Order
    • Get Appointments List
    • Update Appointment Status
    • Get Appointment by ID
    • Get Appointment Slots
    • GetStartJourneyDirection
  • Reports
    • Upload Report
    • List All Reports
    • List Reports By Appointment
    • Delete Report
    • Update Report File
  • Staff
    • Add Staff Member
    • List Staff Member
    • Update Staff Member
    • Delete Staff Member
    • Get Staff member by ID
  • Patient
    • List Patients
    • Add Patient
    • Update Patient
    • Delete Patient
    • Get patient by ID
  • Notifications
    • List User Notifications
    • Update Notification read status
  1. Products

Get Products

Developing
GET
/api/service/v1/products

Request

Query Params
t
string 
optional
type: can be "package" or "test"
Example:
package
sc_id
string 
optional
service category id, optional
Example:
6790d7c19975d85c7b447c54
sort_option
string 
optional
For Mobile App use. Values can be, "SORT_TITLE_ASC" , "SORT_TITLE_DESC", "SORT_PRICE_ASC", "SORT_PRICE_DESC", "SORT_OFFERS", "SORT_POPULAR"
Example:
SORT_PRICE_ASC
f_title
string 
optional
For mobile app use
Example:
title
f_price_min
string 
optional
For mobile app use
Example:
500
f_price_max
string 
optional
For mobile app use.
Example:
900
f_type
string 
optional
For mobile app use. product type package/test
Example:
package
f_service_category
string 
optional
For mobile app use. service category id.
Example:
6790d7c19975d85c7b447c54
Header Params
Accept
string 
optional
Example:
application/json
Content-Type
string 
optional
Example:
application/json
practice-code
string 
optional
Example:
DEFAULT

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://afyahealth.doctodoor.com:5600/api/service/v1/products?t=package&sc_id=6790d7c19975d85c7b447c54&sort_option=SORT_PRICE_ASC&f_title=title&f_price_min=500&f_price_max=900&f_type=package&f_service_category=6790d7c19975d85c7b447c54' \
--header 'Accept: application/json' \
--header 'practice-code: DEFAULT' \
--header 'Content-Type: application/json'

Responses

🟢200Success
application/json
Body
error
boolean 
required
status_code
integer 
required
message
string 
required
data
array [object {16}] 
required
sample_requirements
array[string]
required
estimated_report_delivery_time
integer 
required
tests
array [object {7}] 
required
is_deleted
integer 
required
title
object 
required
subtitle
object 
required
description
object 
required
prerequisites
object 
required
price
integer 
required
currency
string 
required
discount_amount
integer 
required
discount_type
string 
required
created_at
string 
required
updated_at
string 
required
id
string 
required
category
object 
optional
Example
{
    "error": false,
    "status_code": 200,
    "message": "",
    "data": [
        {
            "sample_requirements": [
                "blood"
            ],
            "estimated_report_delivery_time": 0,
            "tests": [
                {
                    "tags": [
                        {
                            "is_deleted": 0,
                            "title": {
                                "en": "en title edit",
                                "ar": "ar title edit"
                            },
                            "created_at": "2025-01-01T10:03:13.816Z",
                            "updated_at": "2025-01-01T10:03:13.816Z",
                            "id": "677512e1af93c427bbbd2f4e"
                        },
                        {
                            "is_deleted": 0,
                            "title": {
                                "en": "en title edit",
                                "ar": "ar title edit"
                            },
                            "created_at": "2025-01-01T10:03:52.332Z",
                            "updated_at": "2025-01-01T10:03:52.332Z",
                            "id": "67751308af93c427bbbd2f51"
                        }
                    ],
                    "is_deleted": 0,
                    "title": {
                        "en": "English title edit",
                        "ar": "arabic title edit"
                    },
                    "lab_type": {
                        "is_deleted": 0,
                        "title": {
                            "en": "title english default",
                            "ar": "title arablic default"
                        },
                        "description": {
                            "en": "descritption english default",
                            "ar": "desc arablic default"
                        },
                        "created_at": "2024-12-31T13:17:50.665Z",
                        "updated_at": "2024-12-31T13:18:23.301Z",
                        "id": "6773eefed1502baf73238a43"
                    },
                    "created_at": "2025-01-01T10:04:45.650Z",
                    "updated_at": "2025-01-01T10:06:10.201Z",
                    "id": "6775133daf93c427bbbd2f54"
                }
            ],
            "is_deleted": 0,
            "title": {
                "en": "tittleee EEEDDDITTT"
            },
            "subtitle": {
                "en": "Sub ttile"
            },
            "description": {
                "en": "desriptin "
            },
            "prerequisites": {
                "en": "prerquu ui"
            },
            "price": 420,
            "currency": "INR",
            "discount_amount": 100,
            "discount_type": "flat",
            "created_at": "2025-01-01T13:18:43.168Z",
            "updated_at": "2025-01-02T06:10:35.951Z",
            "id": "677540b3c8e55b63896cc7b8"
        },
        {
            "sample_requirements": [],
            "estimated_report_delivery_time": 0,
            "tests": [
                {
                    "tags": [
                        {
                            "is_deleted": 0,
                            "title": {
                                "en": "en title edit",
                                "ar": "ar title edit"
                            },
                            "created_at": "2025-01-01T10:03:13.816Z",
                            "updated_at": "2025-01-01T10:03:13.816Z",
                            "id": "677512e1af93c427bbbd2f4e"
                        },
                        {
                            "is_deleted": 0,
                            "title": {
                                "en": "en title edit",
                                "ar": "ar title edit"
                            },
                            "created_at": "2025-01-01T10:03:52.332Z",
                            "updated_at": "2025-01-01T10:03:52.332Z",
                            "id": "67751308af93c427bbbd2f51"
                        }
                    ],
                    "is_deleted": 0,
                    "title": {
                        "en": "English title edit",
                        "ar": "arabic title edit"
                    },
                    "lab_type": {
                        "is_deleted": 0,
                        "title": {
                            "en": "title english default",
                            "ar": "title arablic default"
                        },
                        "description": {
                            "en": "descritption english default",
                            "ar": "desc arablic default"
                        },
                        "created_at": "2024-12-31T13:17:50.665Z",
                        "updated_at": "2024-12-31T13:18:23.301Z",
                        "id": "6773eefed1502baf73238a43"
                    },
                    "created_at": "2025-01-01T10:04:45.650Z",
                    "updated_at": "2025-01-01T10:06:10.201Z",
                    "id": "6775133daf93c427bbbd2f54"
                }
            ],
            "is_deleted": 0,
            "title": {
                "en": "tittleee"
            },
            "subtitle": {
                "en": "Sub ttile"
            },
            "description": {
                "en": "desriptin "
            },
            "prerequisites": {
                "en": "prerquu ui"
            },
            "price": 420,
            "currency": "INR",
            "discount_amount": 100,
            "discount_type": "flat",
            "created_at": "2025-01-01T13:21:05.356Z",
            "updated_at": "2025-01-01T13:21:05.356Z",
            "id": "67754141c8e55b63896cc7bc"
        },
        {
            "sample_requirements": [
                "blood"
            ],
            "estimated_report_delivery_time": 0,
            "tests": [
                {
                    "tags": [
                        {
                            "is_deleted": 0,
                            "title": {
                                "en": "en title edit",
                                "ar": "ar title edit"
                            },
                            "created_at": "2025-01-01T10:03:13.816Z",
                            "updated_at": "2025-01-01T10:03:13.816Z",
                            "id": "677512e1af93c427bbbd2f4e"
                        },
                        {
                            "is_deleted": 0,
                            "title": {
                                "en": "en title edit",
                                "ar": "ar title edit"
                            },
                            "created_at": "2025-01-01T10:03:52.332Z",
                            "updated_at": "2025-01-01T10:03:52.332Z",
                            "id": "67751308af93c427bbbd2f51"
                        }
                    ],
                    "is_deleted": 0,
                    "title": {
                        "en": "English title edit",
                        "ar": "arabic title edit"
                    },
                    "lab_type": {
                        "is_deleted": 0,
                        "title": {
                            "en": "title english default",
                            "ar": "title arablic default"
                        },
                        "description": {
                            "en": "descritption english default",
                            "ar": "desc arablic default"
                        },
                        "created_at": "2024-12-31T13:17:50.665Z",
                        "updated_at": "2024-12-31T13:18:23.301Z",
                        "id": "6773eefed1502baf73238a43"
                    },
                    "created_at": "2025-01-01T10:04:45.650Z",
                    "updated_at": "2025-01-01T10:06:10.201Z",
                    "id": "6775133daf93c427bbbd2f54"
                }
            ],
            "is_deleted": 0,
            "title": {
                "en": "tittleee"
            },
            "subtitle": {
                "en": "Sub ttile"
            },
            "description": {
                "en": "desriptin "
            },
            "prerequisites": {
                "en": "prerquu ui"
            },
            "price": 420,
            "currency": "INR",
            "discount_amount": 100,
            "discount_type": "flat",
            "created_at": "2025-01-01T13:21:25.209Z",
            "updated_at": "2025-01-01T13:21:25.209Z",
            "id": "67754155b3280e64061c8de7"
        },
        {
            "sample_requirements": [
                "blood"
            ],
            "estimated_report_delivery_time": 0,
            "tests": [
                {
                    "tags": [
                        {
                            "is_deleted": 0,
                            "title": {
                                "en": "en title edit",
                                "ar": "ar title edit"
                            },
                            "created_at": "2025-01-01T10:03:13.816Z",
                            "updated_at": "2025-01-01T10:03:13.816Z",
                            "id": "677512e1af93c427bbbd2f4e"
                        },
                        {
                            "is_deleted": 0,
                            "title": {
                                "en": "en title edit",
                                "ar": "ar title edit"
                            },
                            "created_at": "2025-01-01T10:03:52.332Z",
                            "updated_at": "2025-01-01T10:03:52.332Z",
                            "id": "67751308af93c427bbbd2f51"
                        }
                    ],
                    "is_deleted": 0,
                    "title": {
                        "en": "English title edit",
                        "ar": "arabic title edit"
                    },
                    "lab_type": {
                        "is_deleted": 0,
                        "title": {
                            "en": "title english default",
                            "ar": "title arablic default"
                        },
                        "description": {
                            "en": "descritption english default",
                            "ar": "desc arablic default"
                        },
                        "created_at": "2024-12-31T13:17:50.665Z",
                        "updated_at": "2024-12-31T13:18:23.301Z",
                        "id": "6773eefed1502baf73238a43"
                    },
                    "created_at": "2025-01-01T10:04:45.650Z",
                    "updated_at": "2025-01-01T10:06:10.201Z",
                    "id": "6775133daf93c427bbbd2f54"
                }
            ],
            "is_deleted": 0,
            "title": {
                "en": "tittleee"
            },
            "subtitle": {
                "en": "Sub ttile"
            },
            "description": {
                "en": "desriptin "
            },
            "prerequisites": {
                "en": "prerquu ui"
            },
            "price": 420,
            "currency": "INR",
            "discount_amount": 100,
            "discount_type": "flat",
            "created_at": "2025-01-01T13:23:28.779Z",
            "updated_at": "2025-01-01T13:23:28.779Z",
            "id": "677541d0250b4b66973e2367"
        },
        {
            "sample_requirements": [
                "blood"
            ],
            "estimated_report_delivery_time": 0,
            "tests": [
                {
                    "tags": [
                        {
                            "is_deleted": 0,
                            "title": {
                                "en": "en title edit",
                                "ar": "ar title edit"
                            },
                            "created_at": "2025-01-01T10:03:13.816Z",
                            "updated_at": "2025-01-01T10:03:13.816Z",
                            "id": "677512e1af93c427bbbd2f4e"
                        },
                        {
                            "is_deleted": 0,
                            "title": {
                                "en": "en title edit",
                                "ar": "ar title edit"
                            },
                            "created_at": "2025-01-01T10:03:52.332Z",
                            "updated_at": "2025-01-01T10:03:52.332Z",
                            "id": "67751308af93c427bbbd2f51"
                        }
                    ],
                    "is_deleted": 0,
                    "title": {
                        "en": "English title edit",
                        "ar": "arabic title edit"
                    },
                    "lab_type": {
                        "is_deleted": 0,
                        "title": {
                            "en": "title english default",
                            "ar": "title arablic default"
                        },
                        "description": {
                            "en": "descritption english default",
                            "ar": "desc arablic default"
                        },
                        "created_at": "2024-12-31T13:17:50.665Z",
                        "updated_at": "2024-12-31T13:18:23.301Z",
                        "id": "6773eefed1502baf73238a43"
                    },
                    "created_at": "2025-01-01T10:04:45.650Z",
                    "updated_at": "2025-01-01T10:06:10.201Z",
                    "id": "6775133daf93c427bbbd2f54"
                }
            ],
            "is_deleted": 0,
            "title": {
                "en": "tittleee"
            },
            "subtitle": {
                "en": "Sub ttile"
            },
            "description": {
                "en": "desriptin "
            },
            "prerequisites": {
                "en": "prerquu ui"
            },
            "price": 420,
            "currency": "INR",
            "discount_amount": 100,
            "discount_type": "flat",
            "created_at": "2025-01-01T13:23:38.781Z",
            "updated_at": "2025-01-01T13:23:38.781Z",
            "id": "677541da8685be66d614bc6a"
        },
        {
            "sample_requirements": [
                "blood"
            ],
            "estimated_report_delivery_time": 0,
            "tests": [
                {
                    "tags": [
                        {
                            "is_deleted": 0,
                            "title": {
                                "en": "en title edit",
                                "ar": "ar title edit"
                            },
                            "created_at": "2025-01-01T10:03:13.816Z",
                            "updated_at": "2025-01-01T10:03:13.816Z",
                            "id": "677512e1af93c427bbbd2f4e"
                        },
                        {
                            "is_deleted": 0,
                            "title": {
                                "en": "en title edit",
                                "ar": "ar title edit"
                            },
                            "created_at": "2025-01-01T10:03:52.332Z",
                            "updated_at": "2025-01-01T10:03:52.332Z",
                            "id": "67751308af93c427bbbd2f51"
                        }
                    ],
                    "is_deleted": 0,
                    "title": {
                        "en": "English title edit",
                        "ar": "arabic title edit"
                    },
                    "lab_type": {
                        "is_deleted": 0,
                        "title": {
                            "en": "title english default",
                            "ar": "title arablic default"
                        },
                        "description": {
                            "en": "descritption english default",
                            "ar": "desc arablic default"
                        },
                        "created_at": "2024-12-31T13:17:50.665Z",
                        "updated_at": "2024-12-31T13:18:23.301Z",
                        "id": "6773eefed1502baf73238a43"
                    },
                    "created_at": "2025-01-01T10:04:45.650Z",
                    "updated_at": "2025-01-01T10:06:10.201Z",
                    "id": "6775133daf93c427bbbd2f54"
                }
            ],
            "is_deleted": 0,
            "title": {
                "en": "tittleee"
            },
            "subtitle": {
                "en": "Sub ttile"
            },
            "description": {
                "en": "desriptin "
            },
            "prerequisites": {
                "en": "prerquu ui"
            },
            "price": 420,
            "currency": "INR",
            "discount_amount": 100,
            "discount_type": "flat",
            "created_at": "2025-01-01T13:24:30.959Z",
            "updated_at": "2025-01-01T13:24:30.959Z",
            "id": "6775420e8ba1fc672abb7e94"
        },
        {
            "sample_requirements": [
                "blood"
            ],
            "estimated_report_delivery_time": 0,
            "tests": [
                {
                    "tags": [
                        {
                            "is_deleted": 0,
                            "title": {
                                "en": "en title edit",
                                "ar": "ar title edit"
                            },
                            "created_at": "2025-01-01T10:03:13.816Z",
                            "updated_at": "2025-01-01T10:03:13.816Z",
                            "id": "677512e1af93c427bbbd2f4e"
                        },
                        {
                            "is_deleted": 0,
                            "title": {
                                "en": "en title edit",
                                "ar": "ar title edit"
                            },
                            "created_at": "2025-01-01T10:03:52.332Z",
                            "updated_at": "2025-01-01T10:03:52.332Z",
                            "id": "67751308af93c427bbbd2f51"
                        }
                    ],
                    "is_deleted": 0,
                    "title": {
                        "en": "English title edit",
                        "ar": "arabic title edit"
                    },
                    "lab_type": {
                        "is_deleted": 0,
                        "title": {
                            "en": "title english default",
                            "ar": "title arablic default"
                        },
                        "description": {
                            "en": "descritption english default",
                            "ar": "desc arablic default"
                        },
                        "created_at": "2024-12-31T13:17:50.665Z",
                        "updated_at": "2024-12-31T13:18:23.301Z",
                        "id": "6773eefed1502baf73238a43"
                    },
                    "created_at": "2025-01-01T10:04:45.650Z",
                    "updated_at": "2025-01-01T10:06:10.201Z",
                    "id": "6775133daf93c427bbbd2f54"
                }
            ],
            "is_deleted": 0,
            "title": {
                "en": "tittleee"
            },
            "subtitle": {
                "en": "Sub ttile"
            },
            "description": {
                "en": "desriptin "
            },
            "prerequisites": {
                "en": "prerquu ui"
            },
            "price": 420,
            "currency": "INR",
            "discount_amount": 100,
            "discount_type": "flat",
            "created_at": "2025-01-01T13:25:12.469Z",
            "updated_at": "2025-01-01T13:25:12.469Z",
            "id": "67754238dd696b678ee78c4c"
        },
        {
            "sample_requirements": [
                "blood"
            ],
            "estimated_report_delivery_time": 0,
            "tests": [
                {
                    "tags": [
                        {
                            "is_deleted": 0,
                            "title": {
                                "en": "en title edit",
                                "ar": "ar title edit"
                            },
                            "created_at": "2025-01-01T10:03:13.816Z",
                            "updated_at": "2025-01-01T10:03:13.816Z",
                            "id": "677512e1af93c427bbbd2f4e"
                        },
                        {
                            "is_deleted": 0,
                            "title": {
                                "en": "en title edit",
                                "ar": "ar title edit"
                            },
                            "created_at": "2025-01-01T10:03:52.332Z",
                            "updated_at": "2025-01-01T10:03:52.332Z",
                            "id": "67751308af93c427bbbd2f51"
                        }
                    ],
                    "is_deleted": 0,
                    "title": {
                        "en": "English title edit",
                        "ar": "arabic title edit"
                    },
                    "lab_type": {
                        "is_deleted": 0,
                        "title": {
                            "en": "title english default",
                            "ar": "title arablic default"
                        },
                        "description": {
                            "en": "descritption english default",
                            "ar": "desc arablic default"
                        },
                        "created_at": "2024-12-31T13:17:50.665Z",
                        "updated_at": "2024-12-31T13:18:23.301Z",
                        "id": "6773eefed1502baf73238a43"
                    },
                    "created_at": "2025-01-01T10:04:45.650Z",
                    "updated_at": "2025-01-01T10:06:10.201Z",
                    "id": "6775133daf93c427bbbd2f54"
                }
            ],
            "is_deleted": 0,
            "title": {
                "en": "tittleee EEEDDDITTT"
            },
            "subtitle": {
                "en": "Sub ttile"
            },
            "description": {
                "en": "desriptin "
            },
            "prerequisites": {
                "en": "prerquu ui"
            },
            "category": {
                "is_deleted": 0,
                "title": {
                    "en": "tittleee"
                },
                "created_at": "2025-01-01T13:17:04.205Z",
                "updated_at": "2025-01-01T13:17:04.205Z",
                "id": "67754050996a7562f77ec68c"
            },
            "price": 420,
            "currency": "INR",
            "discount_amount": 100,
            "discount_type": "flat",
            "created_at": "2025-01-02T06:26:44.772Z",
            "updated_at": "2025-01-02T06:26:44.772Z",
            "id": "677631a44e45602cb4f45a8b"
        }
    ]
}
Previous
List Languages
Next
Create Product
Built with