API Docs
YMS API
Data Models
Location
Location Create CMD

LocationCreateCmd

{
  "locationName": "string",
  "locationType": "DOCK",
  "locationStatus": "AVAILABLE",
  "assignedScore": 0,
  "yardActivity": "DROP_OFF_EMPTY",
  "dockActivity": "LIVE_DELIVERY",
  "locationActivities": [
    "LIVE_DELIVERY"
  ],
  "carrierIds": [
    "string"
  ],
  "customerIds": [
    "string"
  ],
  "stagingLocationIds": [
    "string"
  ],
  "allowedTypes": [
    "TRACTOR_ONLY"
  ],
  "companyCode": "string",
  "activeTimeFrom": "string",
  "activeTimeTo": "string",
  "notes": "string",
  "groupName": "string",
  "displayName": "stri",
  "dynamicFieldValues": [
    {
      "entityId": "string",
      "entityType": "RECEIPT",
      "fieldCode": "string",
      "shortValue": "string",
      "longValue": "string",
      "value": "string"
    }
  ],
  "linkedLocations": [
    {
      "linkId": "string",
      "linkType": "DOCK"
    }
  ],
  "sequenceNo": 0,
  "windowConfigs": [
    {
      "windowId": 0,
      "locationActivity": [
        "string"
      ],
      "carrierIds": [
        "string"
      ],
      "customerIds": [
        "string"
      ]
    }
  ]
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
locationNamestringtruenoneLocation name
locationTypestringtruenoneLocation type (DOCK/SPOT/STAGING)
locationStatusstringtruenoneLocation status (AVAILABLE/OCCUPIED/ASSIGNED)
assignedScoreintegerfalsenoneAssigned score, 0-100
yardActivitystringfalsenonenone
dockActivitystringfalsenonenone
locationActivities[string]falsenoneLocation activities list: DROP_OFF_EMPTY/DROP_OFF_DELIVERY/PICK_UP_PRELOAD/PICK_UP_EMPTY/PARKING/SHARED/LIVE_DELIVERY/LIVE_LOAD/PRE_LOAD/DROP_OFF_FULL
carrierIds[string]falsenoneCarrier IDs list
customerIds[string]falsenoneCustomer IDs list
stagingLocationIds[string]falsenoneStaging Location IDs list
Used to store IDs of staging locations associated with dock-type locations
allowedTypes[string]falsenoneAllowed equipment types list
List of allowed equipment types, used for type filtering during location suggestions
If empty, no equipment type restrictions apply
companyCodestringtruenoneCompany code: UT,UF,CUBEWORK
activeTimeFromstringfalsenoneActive time from
activeTimeTostringfalsenoneActive time to
notesstringfalsenoneNotes
groupNamestringfalsenoneGroup name
displayNamestringfalsenoneDisplay name (limited to 4 characters)
dynamicFieldValues[DynamicFieldValueCreateCmd]falsenoneDynamic field values
linkedLocations[LinkedLocationCreateCmd]falsenoneLinked Locations List
sequenceNointegerfalsenoneSequence No.
windowConfigs[LocationExtendConfigCmd]falsenoneWindow configs list

Enum Values

PropertyValue
locationTypeDOCK
locationTypeSPOT
locationTypeSTAGING
locationTypeLOCATION
locationStatusAVAILABLE
locationStatusOCCUPIED
locationStatusDELETED
locationStatusASSIGNED
yardActivityDROP_OFF_EMPTY
yardActivityDROP_OFF_DELIVERY
yardActivityPICK_UP_PRELOAD
yardActivityPICK_UP_EMPTY
yardActivityPARKING
yardActivitySHARED
dockActivityLIVE_DELIVERY
dockActivityLIVE_LOAD
dockActivityPRE_LOAD
dockActivitySHARED
dockActivityDROP_OFF_DELIVERY