API Docs
YMS API
Data Models
Appointment
Appointment Query

AppointmentQuery

{
  "currentPage": 0,
  "pageSize": 0,
  "sortingFields": [
    {
      "field": "string",
      "orderBy": "NONE"
    }
  ],
  "appointmentId": "string",
  "appointmentIds": [
    "string"
  ],
  "appointmentType": "INBOUND",
  "appointmentTypes": [
    "INBOUND"
  ],
  "carrierId": "string",
  "carrierIds": [
    "string"
  ],
  "serviceTypes": "Pickup Preload, Live Load, Live Delivery, Drop off Empty, Drop Off Delivery",
  "appointmentTimePeriod": [
    "string"
  ],
  "appointmentTimeStart": "string",
  "appointmentTimeEnd": "string",
  "appointmentStatus": "NEW",
  "excludeAppointmentStatus": "NEW",
  "excludeAppointmentStatuses": [
    "NEW"
  ],
  "appointmentStatuses": [
    "string"
  ],
  "customerIds": [
    "string"
  ],
  "customerId": "string",
  "externalId": 0,
  "entryId": "string",
  "entryIds": [
    "string"
  ],
  "referenceCode": "string",
  "referenceNo": "string",
  "driverId": "string",
  "driverIds": [
    "string"
  ],
  "receiptId": "string",
  "loadId": "string",
  "loadNo": "string",
  "masterBol": "string",
  "poNo": "string",
  "orderId": "string",
  "keyword": "string",
  "createdTimePeriod": [
    "string"
  ],
  "reason": "string",
  "loadIds": "string"
}

Properties

NameTypeRequiredConstraintsChinese NameDescription
currentPageintegerfalsenonenone
pageSizeintegerfalsenonenone
sortingFields[SortingField (opens in a new tab)]falsenonenone
appointmentIdstringfalsenoneSpecific appointment identifier
appointmentIds[string]falsenoneList of appointment identifiers for batch query
appointmentTypestringfalsenoneAppointment type filter
appointmentTypes[string]falsenoneList of appointment types for batch query
carrierIdstringfalsenoneCarrier identifier filter
carrierIds[string]falsenoneList of carrier identifiers for batch query
serviceTypes[string]falsenoneList of service types for filtering
appointmentTimePeriod[string]falsenoneAppointment time range for filtering
appointmentTimeStartstringfalsenoneAppointment time start
appointmentTimeEndstringfalsenoneAppointment time end
appointmentStatusstringfalsenoneAppointment status
excludeAppointmentStatusstringfalsenoneAppointment exclude status
excludeAppointmentStatuses[string]falsenoneAppointment exclude statuses
appointmentStatuses[string]falsenoneList of appointment statuses
customerIds[string]falsenoneList of customer identifiers
customerIdstringfalsenoneSingle customer identifier
externalIdinteger(int64)falsenoneExternal system identifier
entryIdstringfalsenoneEntry ticket identifier
entryIds[string]falsenoneList of entry ticket identifiers
referenceCodestringfalsenoneReference code for check-in binding
referenceNostringfalsenoneReference number
driverIdstringfalsenoneDriver identifier
driverIds[string]falsenoneDriver identifier
receiptIdstringfalsenoneReceipt identifier
loadIdstringfalsenoneLoad identifier
loadNostringfalsenoneLoad number
masterBolstringfalsenoneMaster bill of lading number
poNostringfalsenonePurchase order number
orderIdstringfalsenoneOrder identifier
keywordstringfalsenoneKeyword for fuzzy search on referenceIds
createdTimePeriod[string]falsenoneAppointment time range for filtering
reasonstringfalsenoneAppointment change reason
loadIdsstringfalsenoneLoad identifier

Enum Values

PropertyValue
appointmentTypeINBOUND
appointmentTypeOUTBOUND
appointmentTypeBOTH
appointmentStatusNEW
appointmentStatusCANCELED
appointmentStatusNOT_CONFIRMED
appointmentStatusPENDING_DISPATCH
appointmentStatusWAITING_FOR_DRIVER
appointmentStatusPRE_CHECK_IN_COMPLETE
appointmentStatusCHECKED_IN
excludeAppointmentStatusNEW
excludeAppointmentStatusCANCELED
excludeAppointmentStatusNOT_CONFIRMED
excludeAppointmentStatusPENDING_DISPATCH
excludeAppointmentStatusWAITING_FOR_DRIVER
excludeAppointmentStatusPRE_CHECK_IN_COMPLETE
excludeAppointmentStatusCHECKED_IN
RPage Result Appointment ViewAppointment Action Create CMD