API Docs
YMS API
Data Models
Location
Location Update CMD

LocationUpdateCmd

{
  "locationId": "string",
  "locationName": "string",
  "locationType": "DOCK",
  "locationStatus": "AVAILABLE",
  "assignedScore": 0,
  "yardActivity": "DROP_OFF_EMPTY",
  "dockActivity": "LIVE_DELIVERY",
  "locationActivities": [
    "LIVE_DELIVERY"
  ],
  "loadTaskType": "LIVE_LOAD",
  "carrierIds": [
    "string"
  ],
  "customerIds": [
    "string"
  ],
  "stagingLocationIds": [
    "string"
  ],
  "allowedTypes": [
    "TRACTOR_ONLY"
  ],
  "companyCode": "string",
  "activeTimeFrom": "string",
  "activeTimeTo": "string",
  "notes": "string",
  "locationPhoto": "string",
  "zoneTag": "string",
  "groupName": "string",
  "currentCarrierId": "string",
  "currentTaskType": "string",
  "currentDriverId": "string",
  "currentEntryId": "string",
  "arrivalTime": "string",
  "displayName": "stri",
  "dynamicFieldValues": [
    {
      "entityId": "string",
      "entityType": "RECEIPT",
      "fieldCode": "string",
      "shortValue": "string",
      "longValue": "string",
      "value": "string"
    }
  ],
  "iotResult": {
    "spo_id": "string",
    "s3_image_url": "string",
    "recognize_result": "string",
    "recognize_item": {
      "src_x": 0,
      "src_y": 0,
      "dst_x": 0,
      "dst_y": 0,
      "class_id": 0,
      "class_name": "string",
      "score": 0
    },
    "imageUrl": "string",
    "area": "string",
    "dockEvent": {
      "id": "string",
      "name": "string",
      "type": "string",
      "status": "string",
      "dockStatus": "string",
      "spaceStatus": "string",
      "entryId": "string",
      "category": "string",
      "equipmentNo": [
        "string"
      ],
      "createdWhen": "string",
      "updatedWhen": "string"
    }
  },
  "linkedLocations": [
    {
      "linkId": "string",
      "linkType": "DOCK"
    }
  ],
  "deleted": true,
  "sequenceNo": 0,
  "windowConfigs": [
    {
      "windowId": 0,
      "locationActivity": [
        "string"
      ],
      "carrierIds": [
        "string"
      ],
      "customerIds": [
        "string"
      ]
    }
  ]
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
locationIdstringtruenoneLocation ID
locationNamestringfalsenoneLocation name
locationTypestringfalsenoneLocation type (DOCK/SPOT/STAGING)
locationStatusstringfalsenoneLocation status (AVAILABLE/OCCUPIED/ASSIGNED)
assignedScoreintegerfalsenoneAssigned score, 0-100
yardActivitystringfalsenonenone
dockActivitystringfalsenonenone
locationActivities[string]falsenoneLocation activities list: LIVE_DELIVERY/LIVE_LOAD/PRE_LOAD/SHARED/DROP_OFF_DELIVERY/DROP_OFF_EMPTY/PICK_UP_PRELOAD/PICK_UP_EMPTY/PARKING/DROP_OFF_FULL
loadTaskTypestringfalsenoneLoad task type: LIVE_LOAD/PRE_LOAD/ALL
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
companyCodestringfalsenoneCompany code: UT,UF,CUBEWORK
activeTimeFromstringfalsenoneActive time from
activeTimeTostringfalsenoneActive time to
notesstringfalsenoneNotes
locationPhotostringfalsenoneLocation photo
zoneTagstringfalsenoneZone tag
groupNamestringfalsenoneGroup name
currentCarrierIdstringfalsenoneCurrent Carrier Id
currentTaskTypestringfalsenonenone
currentDriverIdstringfalsenoneCurrent Driver Id
currentEntryIdstringfalsenoneCurrent Entry Ticket ID
arrivalTimestringfalsenoneArrival time
displayNamestringfalsenoneDisplay name (limited to 4 characters)
dynamicFieldValues[DynamicFieldValueCreateCmd]falsenoneDynamic field values
iotResultDockIotResultfalsenonenone
linkedLocations[LinkedLocationCreateCmd]falsenoneLinked locations list
deletedbooleanfalsenonedeleted
sequenceNointegerfalsenonenone
windowConfigs[LocationExtendConfigCmd]falsenoneWindow configs list
null means do not modify window configs
empty list means clear all window configs

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
loadTaskTypeLIVE_LOAD
loadTaskTypePRE_LOAD
loadTaskTypeALL