PRproject44
Milestones

Update appointment milestones

Update milestones for a specific appointment

put/services/appointments/v1/appointment/{appointmentId}/milestones

Request

Path parameters

appointmentIdinteger required

The ID of the appointment

Request body

Example request

{
  "milestones": [
    {
      "event": "ARRIVED",
      "scheduledDateTime": "2024-01-15T10:00:00Z",
      "actualDateTime": "2024-01-15T10:30:00Z"
    }
  ]
}

Response

Milestones updated successfully

statusstring

Status of the operation

Example response

{
  "appointment": {
    "appointmentId": 12345,
    "scheduleStartDateTime": "2024-01-15T10:00:00Z",
    "scheduleEndDateTime": "2024-01-15T12:00:00Z",
    "slotDurationInMinutes": 120
  },
  "location": {
    "identifier": [
      "EXT001",
      "EXT002"
    ],
    "siteCode": "SITE001",
    "siteName": "Main Distribution Center"
  },
  "milestones": [
    {
      "actualDateTime": "2024-01-15T10:30:00Z",
      "event": "ARRIVED",
      "scheduledDateTime": "2024-01-15T10:00:00Z"
    }
  ],
  "status": "SUCCESS",
  "yardShipment": {
    "carrier": "ABC Trucking",
    "cabNo": "CAB789",
    "customer": "Customer Inc",
    "comment": "Handle with care",
    "commodity": "Electronics",
    "id": "shipment_123",
    "loadType": "live",
    "licensePlateNo": "ABC123",
    "loadInformation": [
      {
        "productType": "Laptop",
        "quantity": 25,
        "sku": "SKU123"
      }
    ],
    "orderIds": [
      "ORD001",
      "ORD002"
    ],
    "pallets": 25,
    "reference1": "SHIP123456",
    "reference2": "REF789",
    "serviceType": "delivery",
    "status": "SCHEDULED",
    "trailer": "TRL123456",
    "units": 50,
    "vendor": "Vendor Corp",
    "weight": 5000
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.