Add a Customer

post/add/C

Inserts a customer to the Master Data - Customers table.

Please note: The data sent in your request might be different from our sample request schema. The custom fields (attribute1..attribute30) can be retrieved using the /fetch/CAM operation.

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
required
object
customerId
required
string non-empty
name
string non-empty
attribute1
string non-empty
attribute2
string non-empty
userGroupEdit
string non-empty
operation
required
string non-empty
Responses
200

Returns customer record details.

Response Schema: application/json
object or object
Any of:
node
string non-empty
Array of objects (Customer) non-empty unique

The Customer object. The Type code is C.

Array (non-empty)
createDate
string <date-time>
createdBy
integer
customerId
string <= 255 characters
isParent
boolean or null
lastUpdateBy
integer
lastUpdateDate
string <date-time>
name
string <= 255 characters
nodeId
integer
parentId
integer
typedId
string
userGroupEdit
string <= 255 characters
userGroupViewDetails
string <= 255 characters
version
integer
attribute1
string <= 255 characters
attribute2
string <= 255 characters
attribute3
string <= 255 characters
attribute4
string <= 255 characters
attribute5
string <= 255 characters
attribute6
string <= 255 characters
attribute7
string <= 255 characters
attribute8
string <= 255 characters
attribute9
string <= 255 characters
attribute10
string <= 255 characters
attribute11
string <= 255 characters
attribute12
string <= 255 characters
attribute13
string <= 255 characters
attribute14
string <= 255 characters
attribute15
string <= 255 characters
attribute16
string <= 255 characters
attribute17
string <= 255 characters
attribute18
string <= 255 characters
attribute19
string <= 255 characters
attribute20
string <= 255 characters
attribute21
string <= 255 characters
attribute22
string <= 255 characters
attribute23
string <= 255 characters
attribute24
string <= 255 characters
attribute25
string <= 255 characters
attribute26
string <= 255 characters
attribute27
string <= 255 characters
attribute28
string <= 255 characters
attribute29
string <= 255 characters
attribute30
string <= 255 characters
status
number
Request samples
application/json
{
  • "data": {
    • "customerId": "123456",
    • "name": "Acme",
    • "attribute1": "High Street 23",
    • "attribute2": "+44 12345678",
    • "userGroupEdit": "Administrators"
    },
  • "operation": "add"
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "data": [
      • {
        • "createDate": "2019-08-24T14:15:22Z",
        • "createdBy": 0,
        • "customerId": "string",
        • "isParent": true,
        • "lastUpdateBy": 0,
        • "lastUpdateDate": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "nodeId": 0,
        • "parentId": 0,
        • "typedId": "string",
        • "userGroupEdit": "string",
        • "userGroupViewDetails": "string",
        • "version": 0,
        • "attribute1": "string",
        • "attribute2": "string",
        • "attribute3": "string",
        • "attribute4": "string",
        • "attribute5": "string",
        • "attribute6": "string",
        • "attribute7": "string",
        • "attribute8": "string",
        • "attribute9": "string",
        • "attribute10": "string",
        • "attribute11": "string",
        • "attribute12": "string",
        • "attribute13": "string",
        • "attribute14": "string",
        • "attribute15": "string",
        • "attribute16": "string",
        • "attribute17": "string",
        • "attribute18": "string",
        • "attribute19": "string",
        • "attribute20": "string",
        • "attribute21": "string",
        • "attribute22": "string",
        • "attribute23": "string",
        • "attribute24": "string",
        • "attribute25": "string",
        • "attribute26": "string",
        • "attribute27": "string",
        • "attribute28": "string",
        • "attribute29": "string",
        • "attribute30": "string"
        }
      ],
    • "status": 0
    }
}