Serach vendor

API Endpoint: Search Vendor

This endpoint allows users to search for vendors based on a query string. The search is performed using the vendor’s name or related keywords, and it returns a list of matching vendors along with their details.

Request

• Method: GET

• URL: {{host}}/apis/external/search/searchVendor

• Query Parameters:

  • q (string): The search query for the vendor name. This parameter is required and should be URL-encoded.

Example Request

GET {{host}}/apis/external/search/searchVendor?q=UJJIVAN SMALL FINANCE BANK LIMITED

Response

The response is a JSON object containing the following structure:

• vendors (array): A list of vendor objects that match the search criteria.

  • Each vendor object contains:

    • id (integer): Unique identifier for the vendor.

    • title (string): Title of the vendor.

    • tradeName (string): Trade name of the vendor.

    • currency (string): Currency used by the vendor.

    • code (string): Vendor code.

    • email (string): Email address of the vendor.

    • mobile (string): Mobile number of the vendor.

    • vendor (boolean): Indicates if the entity is a vendor.

    • customer (boolean): Indicates if the entity is a customer.

    • gstin (string): GST identification number.

    • bank (object): Bank details of the vendor.

      • accountId (string): Bank account ID.

      • ifsc (string): IFSC code of the bank.

      • account (string): Bank account number.

      • name (string): Name associated with the bank account.

      • email (string): Email associated with the bank account.

      • bankName (string): Name of the bank.

      • branchName (string): Name of the branch.

      • customTags (object): Any custom tags associated with the bank.

      • bankAndVendorNameMatch (boolean): Indicates if the bank name matches the vendor name.

      • valid (boolean): Indicates if the bank details are valid.

      • validSyncedAt (integer): Timestamp of the last validation sync.

    • data (array): Additional data related to the vendor.

      • Each entry contains:

        • key (string): Key for the data entry.

        • id (string): Identifier for the data entry.

        • value (string): Value for the data entry.

        • encrypt (boolean): Indicates if the value is encrypted.

    • pan (string): PAN number of the vendor.

    • vendorId (string): Unique vendor ID.

    • connection (string): Connection details.

    • validPan (boolean): Indicates if the PAN is valid.

    • validAccount (boolean): Indicates if the bank account is valid.

    • validGst (boolean): Indicates if the GST is valid.

    • address (object): Address details of the vendor.

      • Contains fields like id, title, address, city, state, country, pincode, and validation flags for GST and PAN.

    • msme (object): MSME details if applicable.

      • Contains fields like msmeId and certificate.

    • paymentTerms (object): Payment terms associated with the vendor.

    • createdAt (integer): Timestamp of when the vendor was created.

    • updatedAt (integer): Timestamp of when the vendor was last updated.

    • basicOnboarding (boolean): Indicates if basic onboarding is completed.

• total (integer): Total number of vendors matching the search.

• currentPage (integer): Current page number of the results.

• totalPages (integer): Total number of pages available for the results.

Example Response