Item Logo
Yms apiData modelsLocation

Location Query

LocationQuery

Properties

Name

Type

Required

Constraints

Chinese Name

Description

currentPage

integer

false

none


none

pageSize

integer

false

none


none

sortingFields

[SortingField]

false

none


none

id

integer(int64)

false

none


Location ID

ids

[integer]

false

none


Location IDs

excludeLocationIds

[string]

false

none


none

locationId

string

false

none


Location ID

locationIds

[string]

false

none


Location IDs

locationName

string

false

none


Location name

groupName

string

false

none


none

locationType

string

false

none


Location type

locationTypes

[string]

false

none


Location types

locationStatus

string

false

none


Location status

locationStatuses

[string]

false

none


Location statuses

enabled

boolean

false

none


Whether the location is enabled

yardActivity

string

false

none


Yard Activity

dockActivity

string

false

none


Dock Activity

customerIds

[string]

false

none


Customer ID

customerId

string

false

none


Customer ID

carrierIds

[string]

false

none


Carrier ID

carrierId

string

false

none


Carrier ID

stagingLocationIds

[string]

false

none


none

stagingLocationId

string

false

none


none

allowedTypes

[string]

false

none


Allowed equipment types<br />Allowed equipment type filter, query locations containing the specified equipment type

allowedType

string

false

none


Single allowed equipment type<br />Single allowed equipment type filter

notEqStatus

string

false

none


Not equal to a specific location status

deleted

boolean

false

none


deleted

currentEntryId

string

false

none


deleted

sequenceNo

integer

false

none


Sequence No.

companyCode

string

false

none


Company code: UT,UF,CUBEWORK

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

allowedType

TRACTOR_ONLY

allowedType

BOX_TRUCK

allowedType

CAR

allowedType

TRACTOR_COMBO

allowedType

OTHER

notEqStatus

AVAILABLE

notEqStatus

OCCUPIED

notEqStatus

DELETED

notEqStatus

ASSIGNED