API Docs
YMS API
Data Models
Entry Ticket
Entry Ticket Create CMD

EntryTicketCreateCmd

{
  "createdSource": "SELF_CHECKIN",
  "notes": "string",
  "inboundAction": "LIVE_DELIVERY",
  "outboundAction": "LIVE_LOAD",
  "inYardAction": "DROP_OFF_RECEIVING",
  "tags": [
    "string"
  ]
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
createdSourcestringtruenoneCreated source
The source of entry ticket creation. Valid values: SELF_CHECKIN, PRE_CHECKIN, PRE_SELF, YMS_CHECK_IN, WMS_CHECK_IN, MANUAL_CHECK_IN, YARD_CHECK
notesstringfalsenoneAdditional notes or comments for the entry ticket
inboundActionstringfalsenoneInbound action for Live Task or Drop and Hook operations:
- LIVE_DELIVERY: Driver arrives and leaves after waiting for offloading (wait for offloading) - can combine with outbound LIVE_LOAD
- DROP_OFF_DELIVERY: Driver drops off loaded container and leaves (drop loaded container) - max 1 inbound
- DROP_OFF_EMPTY: Driver drops off empty container and leaves (drop empty container) - max 1 inbound
Note: Cannot be used with inYardAction (mutually exclusive business types)
outboundActionstringfalsenoneOutbound action for Live Task or Drop and Hook operations:
- LIVE_LOAD: Driver arrives and leaves after waiting for loading (wait for loading) - can combine with inbound LIVE_DELIVERY
- PICK_UP_PRELOAD: Driver picks up loaded container and leaves (pickup loaded container) - max 1 outbound
- PICK_UP_EMPTY: Driver picks up empty container and leaves (pickup empty container) - max 1 outbound
Note: Cannot be used with inYardAction (mutually exclusive business types)
inYardActionstringfalsenoneIn-yard action for Internal Task operations (mutually exclusive with inbound/outbound actions):
- DROP_OFF_RECEIVING: Drop-off receiving (drop-off receiving operation)
- PRE_LOAD: Pre-loading (pre-loading operation)

Note: Cannot be combined with inboundAction or outboundAction (different business type)
tags[string]falsenoneList of tags
List of tags for company of the entry ticket

Enum Values

PropertyValue
createdSourceSELF_CHECKIN
createdSourcePRE_CHECKIN
createdSourcePRE_SELF
createdSourceYMS_CHECK_IN
createdSourceWMS_CHECK_IN
createdSourceMANUAL_CHECK_IN
createdSourceYARD_CHECK
createdSourceMANUAL_GATE_CHECKIN
inboundActionLIVE_DELIVERY
inboundActionDROP_OFF_DELIVERY
inboundActionDROP_OFF_EMPTY
inboundActionOTHER
outboundActionLIVE_LOAD
outboundActionPICK_UP_PRELOAD
outboundActionPICK_UP_EMPTY
outboundActionOTHER
inYardActionDROP_OFF_RECEIVING
inYardActionPRE_LOAD
inYardActionPARKING
inYardActionVISITOR