API Docs
YMS API
Data Models
Appointment
RAppointment View

RAppointmentView

{
  "code": 0,
  "msg": "string",
  "success": true,
  "data": {
    "id": 0,
    "appointmentId": "string",
    "appointmentType": "INBOUND",
    "carrierId": "string",
    "carrierName": "string",
    "finalCarrierId": "string",
    "subCarrierName": "string",
    "appointmentTime": "string",
    "appointmentStatus": "NEW",
    "customerIds": [
      "string"
    ],
    "externalId": 0,
    "entryId": "string",
    "referenceCode": "string",
    "driverId": "string",
    "createdTime": "string",
    "createdBy": "string",
    "updatedTime": "string",
    "updatedBy": "string",
    "customerNames": [
      "string"
    ],
    "appointmentActionViews": [
      {
        "id": 0,
        "appointmentId": "string",
        "appointmentType": "INBOUND",
        "serviceType": "string",
        "appointmentTime": "string",
        "referenceIds": [
          "string"
        ],
        "createdTime": "string",
        "createdBy": "string",
        "updatedTime": "string",
        "updatedBy": "string",
        "loadViews": [
          {
            "id": null,
            "loadId": null,
            "loadStatus": null,
            "loadNo": null,
            "shipMethod": null,
            "carrierId": null,
            "appointmentTime": null,
            "appointmentId": null,
            "orderIds": null,
            "customerId": null,
            "masterBol": null,
            "sealNo": null,
            "customerName": null,
            "carrierName": null,
            "orderViews": null,
            "dynamicFieldValues": null,
            "equipmentType": null,
            "equipmentNo": null,
            "referenceNoList": null,
            "poNoList": null,
            "templateLoadKey": null,
            "proNos": null,
            "invoicePros": null,
            "doNos": null,
            "tripNos": null,
            "loadType": null,
            "stagingLocationName": null,
            "shippedTime": null
          }
        ],
        "receiptViews": [
          {
            "id": null,
            "receiptId": null,
            "receiptStatus": null,
            "receiptType": null,
            "poNo": null,
            "carrierId": null,
            "customerId": null,
            "referenceNo": null,
            "equipmentType": null,
            "equipmentNo": null,
            "totalPalletQty": null,
            "itemLines": null,
            "appointmentTime": null,
            "appointmentId": null,
            "sealNo": null,
            "dataChannel": null,
            "eventTime": null,
            "extraData": null,
            "carrierName": null,
            "customerName": null,
            "dynamicFieldValues": null,
            "proNos": null,
            "invoicePros": null,
            "doNos": null,
            "tripNo": null
          }
        ]
      }
    ],
    "driverSnapshot": "string",
    "driverSnapshotParse": {
      "driverId": "string",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "driverPhone": "string",
      "phone": "string",
      "licenseNumber": "string",
      "licenseExpirationDate": "string",
      "licenseState": "string",
      "email": "string",
      "licensePlate": "ABC123",
      "carrierName": "string",
      "carrierId": "string",
      "usdot": "string",
      "equipmentNo": "string",
      "equipmentType": "VEHICLE",
      "cargoStatus": "UNKNOWN"
    },
    "serviceTypes": [
      "string"
    ],
    "checkedInTime": "string",
    "carrierFinishTime": "string",
    "driverFinishTime": "string",
    "finalCarrierView": {
      "carrierId": "string",
      "carrierName": "string",
      "scac": [
        "string"
      ],
      "usdot": "string",
      "mcNumber": "string",
      "verified": true,
      "createdTime": "string",
      "createdBy": "string",
      "updatedTime": "string",
      "updatedBy": "string",
      "carrierStatus": "ACTIVE,INACTIVE,EXCEPTION",
      "knownName": "string",
      "orgIds": [
        "string"
      ]
    },
    "cargoStatus": "UNKNOWN",
    "notes": "string"
  }
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
codeinteger(int64)falsenonenone
msgstringfalsenonenone
successbooleanfalsenonenone
dataAppointmentView (opens in a new tab)falsenonenone