Search Customer Location Master API

Inbound | GET | /master/customers/{customerCode}/locations/{customerLocationCode}

Summary

This API returns customer location master data available for a customer code and customer location code in Omni.

Description

This API returns customer location master data available for a customer code and customer location code in Omni. Can be used to search the customer location before creating/updating.

Request

EmptyBody

Response

{
  "customerCode": "customerCode",
  "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"
  }
}

HttpStatus : 200

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