Tuhund - Register Address API

API List

CRM Integration API

Delivery / Shipment Order API

Expense Claims Integration API

Human Resuorce Management Module

Inventory Module Integration API

Risk Management and Mitigation

Sales Module Integration API

Services Module Integration API

Shopping Cart Integration API

Procurement Module API

Manufacturing Module API

API # : 8020 | API Name : addaddress

This API is used to register a new address for an existing entity.

URL : <domain>/apic/addaddress
Methods Allowed : POST

Payload Schema :

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {    
    "parentid": {
        "type": "string",
        "description": "ID of the entity for which the address is being added."
    },    
    "stateid": {
        "type": "string",
        "description": "State ID where available. Please refer to state lookup API for list of states for each country"
    },
    "title": {
        "type": "string",
        "description": "A short descriptive title for the address. Required and useful where multiple addresses are being added."
    },
    "fax": {
        "type": "string",
        "description": "Fax number"
    },
    "country": {
        "type": "string",
        "description": "Two letter country code. Please refer to country lookup API for list of countries with codes."
    },
    "email": {
        "type": "string",
        "description": "Email address of the company."
    },
    "address": {
        "type": "string",
        "description": "Building and Street address. Please combine if you have multiple line address."
    },
    "state": {
        "type": "string",
        "description": "Name of the state."
    },
    "phone2": {
        "type": "string",
        "description": "Alternate phone number"
    },
    "postcode": {
        "type": "string",
        "description": "Post Code / Pin Code / ZIP Code"
    },
    "phone1": {
        "type": "string",
        "description": "Primary phone number"
    },
    "mobile": {
        "type": "string",
        "description": "Mobile Number"
    },
    "city": {
        "type": "string",
        "description": "Name of the city"
    }    
  },
  "required": [
    "parentid",        
    "country"      
  ]
}

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 :

{
    "parentid": "5655455",  
    "stateid": "91012",
    "title": "Billing Address",
    "fax": "+91800000000",
    "country": "in",
    "email": "sampleemail@domain.com",
    "address": "#67, Church Street, Brigade Road",
    "state": "Karnataka",
    "phone2": "+91800000000",
    "postcode": "560001",
    "phone1": "+91800000000",
    "mobile": "+919800000000",
    "city": "Bangalore"
}

Sample success response :

{
  "result": 1,
  "message": "New record added successfully.",
  "id": "1622481914058"
}

Sample failure response :

{
  "response": -1,
  "errors": [
    {
      "error": "Parent ID is a mandatory parameter",
      "param": "parentid"
    },
    {
      "error": "Country is a mandatory parameter",
      "param": "country"
    }
  ]
}