API Docs
YMS API
Data Models
Customer
Customer Query

CustomerQuery

{
  "currentPage": 0,
  "pageSize": 0,
  "sortingFields": [
    {
      "field": "string",
      "orderBy": "NONE"
    }
  ],
  "customerId": "string",
  "customerIds": [
    "string"
  ],
  "customerNames": [
    "string"
  ],
  "customerName": "string",
  "customerCode": "string",
  "companyCode": "UT,UF,CUBEWORK",
  "customerStatus": "ACTIVE",
  "yardId": "YARD-01"
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
currentPageintegerfalsenonenone
pageSizeintegerfalsenonenone
sortingFields[SortingField]falsenonenone
customerIdstringfalsenoneCustomer identifier
customerIds[string]falsenoneList of customer identifiers for inclusion match
customerNames[string]falsenonenone
customerNamestringfalsenoneCustomer name
customerCodestringfalsenoneCustomer code
companyCodestringfalsenoneCompany code
customerStatusstringfalsenoneCustomer status
yardIdstringfalsenoneYard ID for inclusion match against yardIds array

Enum Values

PropertyValue
customerStatusACTIVE
customerStatusINACTIVE
customerStatusEXCEPTION