Search Suppliers

This endpoint makes an HTTP GET request to search for suppliers based on the provided search query. The response returns a JSON object with a "success" status, an optional "message", and a "data" array containing information about the suppliers matching the search query. Each supplier object in the "data" array includes details such as ID, user ID, business ID, name, phone, thumbnail, creation and update timestamps, address, email, social media handles, and related business and user details.

Example Response:

{
    "success": true,
    "message": "",
    "data": [
        {
            "id": "",
            "user_id": "",
            "business_id": "",
            "app_id": "",
            "name": "",
            "phone": null,
            "thumbnail": null,
            "app_created_at": "",
            "raw": "",
            "deleted_at": null,
            "created_at": "",
            "updated_at": "",
            "app_updated_at": "",
            "address": null,
            "email": null,
            "instagram": null,
            "facebook": null,
            "tiktok": null,
            "created_by": "",
            "business": {
                "id": "",
                "business_id": "",
                "user_id": "",
                "business_type_id": "",
                "name": "",
                "code": null,
                "country": "",
                "state": "",
                "address": null,
                "currency": "",
                "logo": "",
                "is_verified": true,
                "is_active": true,
                "created_at": "",
                "updated_at": ""
            },
            "user": {
                "id": "",
                "user_id": "",
                "business_id": "",
                "first_name": "",
                "last_name": "",
                "phone": "",
                "email": "",
                "gender": "",
                "avatar": null,
                "dial_code": "",
                "role": "",
                "timezone": "",
                "is_subscribed": true,
                "email_verified": true,
                "created_at": "",
                "updated_at": "",
                "fullName": ""
            }
        }
    ]
}

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

{ "success": true, "message": "Suppliers found Successfully!", "data": { "meta": { "total": 1, "per_page": 50, "current_page": 1, "last_page": 1, "first_page": 1, "first_page_url": "/?page=1", "last_page_url": "/?page=1", "next_page_url": null, "previous_page_url": null }, "data": [ { "id": "870", "name": "Mikkyrichy", "phone": "09028107327", "address": null, "thumbnail": null, "email": null, "instagram": null, "facebook": null, "app_created_at": "2024-04-01T19:11:50.000Z", "no_of_purchases": "9", "total_amount_spent": "2156000.000000000000", "amount_spent": "$ 2,156,000.00" } ] } }

Search Suppliers

Request

Responses