Tuhund - List of companies with basic details API

API List

Shopping Cart Integration API

API # : 8007 | API Name : companies

This API gets filtered, sort and ordered records from companies (known business entities) master database.

URL : <domain>/apic/companies
Methods Allowed : POST
Request Body : JSON Payload

Payload Structure :

Name	Description	Type
search	Search text.	String
show	Relation with the organization. Examples : CUSTOMERS : All customers of various branches and entities. VENDORS : All vendors of various branches and entities. NCUSTOMERS : All entities other than customers. NVENDORS : All entities other than customers. NONE : Entities that are neither customers nor vendors.	String
show2	Industry	String
show3	Country. Two character country code.	String
pp	Number of records per page. All the matching records are split in sets similar to pages. This value tells the system how many records have to be grouped under each page. Default value is 100	Integer
page	Page number. Default is 1	Integer
srt	Sort by. Possible values are : COMPANYNAME : Company name COMPANYNUMBER : Company number SHORTNAME : Short name CITY : City STATE : State COUNTRYNAME : Country GSTIN : GST Number	String
order	Sort Order. ASC or DESC	String

Request Headers :

Name	Description
device	A short name of your application. Device is mandatory but any value between 3 and 20 characters is accepted.
Authentication	Authentication code generated for API call.

Sample Payload :

{
    "search": "computers",
    "page": 1,
    "pp": 50
}

Sample success response :

{
  "response": 1,
  "totalitems": 100,
  "list": [
    {
      "stateid": "91012",
      "countrycode": "in",
      "companynumber": 1210,
      "children": 0,
      "companyname": "TSTS Infotech Co. Pvt Ltd.",
      "city": "Bangalore",
      "isagent": false,
      "companyid": "TejEpR",
      "address": "No6 4th stage 7 th block Basweshwar nagar Bangalore 25",
      "priority": 4,
      "shortname": "TST",
      "statename": "Karnataka",
      "countryname": "India",
      "email": "Ramprakash@e-centric.net",
      "phone1":"+9199xxx998998",
      "phone2":"+9199xxx998999"
    },
    {
      "countrycode": "bd",
      "companynumber": 1265,
      "children": 0,
      "parentid": "1373601433520",
      "phone2": "92977415",
      "parentname": "DIVINE GROUP",
      "companyname": "Chowgacha Printing Ltd.",
      "phone1": "92976525",
      "isagent": false,
      "companyid": "1373601433527",
      "address": "Walsow Tower Pent- House 16th Fl 21 & 23 Kazi Nazrul Avenue",
      "priority": 4,
      "countryname": "Bangladesh"
    },
     {
      "fax": "87987987",
      "countrycode": "au",
      "companynumber": 1045,
      "children": 0,
      "phone2": "09876543421",
      "postcode": "0696969",
      "companyname": "CDF Holdings Limited",
      "phone1": "098765432113",
      "city": "Sydney",
      "isagent": true,
      "companyid": "qVFWYN",
      "address": "AB Avenue",
      "priority": 4,
      "shortname": "CDF",
      "countryname": "Australia"
    }
  ]
}

Response Interpretation :

Key	Description
totalitems	Total Number of items matching search criteria