API Docs
YMS API
Data Models
Customer
Customer Create CMD

CustomerCreateCmd

{
  "customerName": "Acme Corp",
  "customerCode": "string",
  "customerStatus": "ACTIVE",
  "companyCode": "UT",
  "yardIds": "[\"YARD-01\", \"YARD-02\"]",
  "mainContact": "Jane Smith",
  "mainEmail": "jane.smith@example.com",
  "altContact": "Bob Lee",
  "altEmail": "bob.lee@example.com"
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
customerNamestringtruenoneCustomer name. Not pure digits, max 150 characters
customerCodestringfalsenoneCustomer code
customerStatusstringtruenoneCustomer status, allowed values: ACTIVE, INACTIVE, EXCEPTION
companyCodestringtruenoneCompany code, allowed values: UT,UF,CUBEWORK
yardIds[string]falsenoneList of yard identifiers
mainContactstringfalsenonePrimary contact person
mainEmailstringfalsenonePrimary contact email
altContactstringfalsenoneSecondary contact person
altEmailstringfalsenoneSecondary contact email

Enum Values

PropertyValue
customerStatusACTIVE
customerStatusINACTIVE
customerStatusEXCEPTION
companyCodeUT
companyCodeUF
companyCodeCUBEWORK