Item Logo
Yms apiData modelsLocation

Location Create CMD

LocationCreateCmd

Properties

Name

Type

Required

Constraints

Chinese Name

Description

locationName

string

true

none


Location name

locationType

string

true

none


Location type (DOCK/SPOT/STAGING)

locationStatus

string

true

none


Location status (AVAILABLE/OCCUPIED/ASSIGNED)

assignedScore

integer

false

none


Assigned score, 0-100

yardActivity

string

false

none


none

dockActivity

string

false

none


none

locationActivities

[string]

false

none


Location activities list: DROPOFFEMPTY/DROPOFFDELIVERY/PICKUPPRELOAD/PICKUPEMPTY/PARKING/SHARED/LIVEDELIVERY/LIVELOAD/PRELOAD/DROPOFF_FULL

carrierIds

[string]

false

none


Carrier IDs list

customerIds

[string]

false

none


Customer IDs list

stagingLocationIds

[string]

false

none


Staging Location IDs list<br />Used to store IDs of staging locations associated with dock-type locations

allowedTypes

[string]

false

none


Allowed equipment types list<br />List of allowed equipment types, used for type filtering during location suggestions<br />If empty, no equipment type restrictions apply

companyCode

string

true

none


Company code: UT,UF,CUBEWORK

activeTimeFrom

string

false

none


Active time from

activeTimeTo

string

false

none


Active time to

notes

string

false

none


Notes

groupName

string

false

none


Group name

displayName

string

false

none


Display name (limited to 4 characters)

dynamicFieldValues

[DynamicFieldValueCreateCmd]

false

none


Dynamic field values

linkedLocations

[LinkedLocationCreateCmd]

false

none


Linked Locations List

sequenceNo

integer

false

none


Sequence No.

windowConfigs

[LocationExtendConfigCmd]

false

none


Window configs list

Enum Values

Property

Value

locationType

DOCK

locationType

SPOT

locationType

STAGING

locationType

LOCATION

locationStatus

AVAILABLE

locationStatus

OCCUPIED

locationStatus

DELETED

locationStatus

ASSIGNED

yardActivity

DROPOFFEMPTY

yardActivity

DROPOFFDELIVERY

yardActivity

PICKUPPRELOAD

yardActivity

PICKUPEMPTY

yardActivity

PARKING

yardActivity

SHARED

dockActivity

LIVE_DELIVERY

dockActivity

LIVE_LOAD

dockActivity

PRE_LOAD

dockActivity

SHARED

dockActivity

DROPOFFDELIVERY