Inbound | POST | /master/customers

Summary

This api creates customer masters in Omni.

Description

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

Request

{
  "customerCode": "ErpCustomerCode",
  "name": "name",
  "isExcessGrnAllowed": true,
  "address": {
    "name": "customerName",
    "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"
  },
  "priority": 1
}
Parameter Name Data Type Description Mandatory
customerCode String Code used by ERP to identify customers
(unique) yes
name String Name of customer
(unique) yes
isExcessGrnAllowed boolean isExcessGrnAllowed for the supplier No
address Object Address of customer yes
address.name String Address Name of customer yes
address.line1 String 1st line of customer’s address yes
address.line2 String 2nd line of customer’s address no
address.line3 String 3rd line of customer’s address no
address.city String City of customer yes
address.state String State of customer yes
address.zip String ZIP/Pin code of customer yes
address.country String Country of customer yes
address.email String Email of customer yes
priority Integer The priority of the customer during picking of orders
Highest priority -1 and lowest - 5
null value will be considered as priority 3 in OMS no

Response

EmptyBody

HttpStatus : 200