Add Customer Location Master API

Inbound | POST | /master/customers/{customerCode}/locations

Summary

This API creates a customer's location in Omni.

Description

ERP systems recognise their customer’s location with a code which is commonly referred to as customer location code. This API can be used to create a customer's location corresponding to the ERP customers in Increff Omni.

Request

{
  "customerLocationCode": "customerLocationCode",
  "gstin": "ABBDEG67889",
  "billingAddress": {
    "name": "name",
    "line1": "address line 1",
    "line2": "address line 2",
    "line3": "address line 3",
    "city": "Bengaluru",
    "state": "Karnataka",
    "zip": "560076",
    "country": "INDIA",
    "email": "email.com",
    "phone": "9999999999"
  },
  "shippingAddress": {
    "name": "name",
    "line1": "address line 1",
    "line2": "address line 2",
    "line3": "address line 3",
    "city": "Bengaluru",
    "state": "Karnataka",
    "zip": "560076",
    "country": "INDIA",
    "email": "email.com",
    "phone": "9999999999"
  }
}

Parameter Name	Data Type	Description	Mandatory
`customerCode`	String	Code of already created customer in Increff Omni by ERP	yes
`gstin`	String	GSTIN number	yes
`customerLocationCode`	String	Code of new location to be added	yes
`billingAddress`	Object	Address of vendor’s location	yes
`billingAddress.name`	String	Name of vendor’s location	yes
`billingAddress.line1`	String	1st line of vendor location’s address	yes
`billingAddress.line2`	String	2nd line of vendor location’s address	no
`billingAddress.line3`	String	3rd line of vendor location’s address	no
`billingAddress.city`	String	City of vendor’s location	yes
`billingAddress.state`	String	State of vendor’s location	yes
`billingAddress.zip`	String	ZIP/Pin code of vendor’s location	yes
`billingAddress.country`	String	Country of vendor’s location	yes
`billingAddress.email`	String	Email of vendor’s location	yes
`shippingAddress`	Object	Address of vendor’s location	yes
`shippingAddress.name`	String	Name of vendor’s location	yes
`shippingAddress.line1`	String	1st line of vendor location’s address	yes
`shippingAddress.line2`	String	2nd line of vendor location’s address	no
`shippingAddress.line3`	String	3rd line of vendor location’s address	no
`shippingAddress.city`	String	City of vendor’s location	yes
`shippingAddress.state`	String	State of vendor’s location	yes
`shippingAddress.zip`	String	ZIP/Pin code of vendor’s location	yes
`shippingAddress.country`	String	Country of vendor’s location	yes
`shippingAddress.email`	String	Email of vendor’s location	yes

Response

EmptyBody

HttpStatus : 200