Shipments
List Shipment Appointments
List the appointments linked to a shipment
GET
Returns the full appointment objects linked to this shipment, oldest-link first. The inverse read
is List Shipments with
?appointment_id=.
Empty array when no appointments are linked. To check just the IDs without the full appointment
payloads, read the appointments field on Get Shipment.
Requires the shipments_view, shipments_manage or test_sessions_view scope.
Request
Path parameters
string
required
Shipment reference ID (e.g.,
P2604154821).Response
On success, the API returns200 OK with an array of appointment objects. Each entry has the
same shape as Get Appointment.