API Docs
YMS API
Data Models
Appointment
Appointment Action View

AppointmentActionView

{
  "id": 0,
  "appointmentId": "string",
  "appointmentType": "INBOUND",
  "serviceType": "string",
  "appointmentTime": "string",
  "referenceIds": [
    "string"
  ],
  "createdTime": "string",
  "createdBy": "string",
  "updatedTime": "string",
  "updatedBy": "string",
  "loadViews": [
    {
      "id": "string",
      "loadId": "LOAD-12345",
      "loadStatus": "string",
      "loadNo": "string",
      "shipMethod": "string",
      "carrierId": "string",
      "appointmentTime": "2025-08-08T10:00:00",
      "appointmentId": "string",
      "orderIds": [
        "string"
      ],
      "customerId": "string",
      "masterBol": "string",
      "sealNo": "123456",
      "customerName": "string",
      "carrierName": "string",
      "orderViews": [
        {
          "id": 0,
          "orderId": "string",
          "orderStatus": "string",
          "customerId": "string",
          "poNo": "string",
          "referenceNo": "string",
          "retailer": "string",
          "shipFrom": "string",
          "shipTo": "string",
          "totalPalletQty": 0,
          "totalCartonQty": 0,
          "itemInfos": [
            {}
          ],
          "customerName": "string",
          "carrierName": "string",
          "shipToAddress": {
            "id": null,
            "name": null,
            "country": null,
            "state": null,
            "city": null,
            "zipCode": null,
            "fax": null,
            "address1": null,
            "address2": null,
            "contact": null,
            "phone": null,
            "extension": null,
            "email": null,
            "orgId": null,
            "orgName": null,
            "referenceNo": null,
            "batchCode": null,
            "storeNo": null,
            "shorthand": null,
            "toHome": null,
            "tags": null,
            "latitude": null,
            "longitude": null,
            "crmAddressId": null
          },
          "shipFromAddress": {
            "id": null,
            "name": null,
            "country": null,
            "state": null,
            "city": null,
            "zipCode": null,
            "fax": null,
            "address1": null,
            "address2": null,
            "contact": null,
            "phone": null,
            "extension": null,
            "email": null,
            "orgId": null,
            "orgName": null,
            "referenceNo": null,
            "batchCode": null,
            "storeNo": null,
            "shorthand": null,
            "toHome": null,
            "tags": null,
            "latitude": null,
            "longitude": null,
            "crmAddressId": null
          },
          "appointmentTime": "string",
          "dynamicFieldValues": [
            {}
          ],
          "proNos": [
            "string"
          ],
          "invoicePros": [
            "string"
          ],
          "doNos": [
            "string"
          ],
          "tripNo": "string",
          "shippedTime": "string"
        }
      ],
      "dynamicFieldValues": [
        {
          "entityId": "string",
          "entityType": "RECEIPT",
          "fieldCode": "string",
          "value": "string",
          "fieldName": "string",
          "longValue": "string",
          "shortValue": "string"
        }
      ],
      "equipmentType": "TRAILER",
      "equipmentNo": "string",
      "referenceNoList": [
        "string"
      ],
      "poNoList": [
        "string"
      ],
      "templateLoadKey": "string",
      "proNos": [
        "string"
      ],
      "invoicePros": [
        "string"
      ],
      "doNos": [
        "string"
      ],
      "tripNos": [
        "string"
      ],
      "loadType": "string",
      "stagingLocationName": "string",
      "shippedTime": "string"
    }
  ],
  "receiptViews": [
    {
      "id": 0,
      "receiptId": "string",
      "receiptStatus": "string",
      "receiptType": "string",
      "poNo": "string",
      "carrierId": "string",
      "customerId": "string",
      "referenceNo": "string",
      "equipmentType": "string",
      "equipmentNo": "string",
      "totalPalletQty": 0,
      "itemLines": [
        {
          "itemId": "string",
          "itemName": "string",
          "itemQty": "string",
          "palletQty": "string",
          "itemSpecDesc": "string",
          "itemSpecName": "string",
          "uomId": "string",
          "qty": "string"
        }
      ],
      "appointmentTime": "string",
      "appointmentId": "string",
      "sealNo": "string",
      "dataChannel": "YMS",
      "eventTime": "string",
      "extraData": "string",
      "carrierName": "string",
      "customerName": "string",
      "dynamicFieldValues": [
        {
          "entityId": "string",
          "entityType": "RECEIPT",
          "fieldCode": "string",
          "value": "string",
          "fieldName": "string",
          "longValue": "string",
          "shortValue": "string"
        }
      ],
      "proNos": [
        "string"
      ],
      "invoicePros": [
        "string"
      ],
      "doNos": [
        "string"
      ],
      "tripNo": "string"
    }
  ]
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
idinteger(int64)falsenoneInternal database ID
appointmentIdstringfalsenoneUnique appointment identifier
appointmentTypestringfalsenoneType of appointment
serviceTypestringfalsenoneService type code
appointmentTimestringfalsenoneScheduled appointment time
referenceIds[string]falsenoneList of reference identifiers
createdTimestringfalsenoneRecord creation timestamp
createdBystringfalsenoneUser who created the record
updatedTimestringfalsenoneRecord last update timestamp
updatedBystringfalsenoneUser who last updated the record
loadViews[LoadView (opens in a new tab)]falsenoneList of load views
receiptViews[ReceiptView (opens in a new tab)]falsenoneList of receipt views

Enum Values

PropertyValue
appointmentTypeINBOUND
appointmentTypeOUTBOUND
appointmentTypeBOTH