List All Appointments

List Appointments

SecurityAPIKeyHeader

Request

query Parameters

q	string (q) Free-text search across all Appointment reference values
status	string (status) Filter for appointments with a specific status Enum: "UNSCHEDULED" "SCHEDULED" "RESCHEDULED" "CANCELLED" "ARRIVED" "ARRIVED_LATE" "DELAYED" "DOCK_IN_USE" "REJECTED" "REQUESTED" "NO_SHOW" "COMPLETED" "DOCK_IS_READY"
planned_date	string <date> (planned_date) Filter for appointments with planned date
carrier_assigned	boolean (carrier_assigned) Filter for appointments with an assigned carrier
point_of_contact_user_id	string (point_of_contact_user_id) Filter for appointments at facilities where one of the point of contacts' user IDs matches this value
page	integer (Page) >= 1 Default: 1
limit	integer (Limit) [ 1 .. 1000 ] Default: 50
sort	string (Sort)
facility_id	string (Facility Id) = 26 characters Filter by only Appointments that take place at this Facility. Results may include both Facility-level Appointments and Dock-level Appointments, but all will take place at the provided Facility.
dock_id	string (Dock Id) = 26 characters Filter by only Appointments scheduled at this Dock.

Responses

200

Successful Response

Response Schema: application/json

required	Array of objects (Data)
total_count required	integer (Total Count)

400

Validation Error

get/facilities/appointments

Request samples

curl
Node.js
JavaScript
Python
Java

Response samples

application/json

{"data": [{"name": "string",
"reason": "PRE_LOAD",
"reference_id": "string",
"description": "string",
"is_all_day": false,
"matched_load_type_id": "string",
"references": [ ],
"start": {"timestamp": "2019-08-24T14:15:22Z",
"timezone": "America/Chicago"
},
"end": {"timestamp": "2019-08-24T14:15:22Z",
"timezone": "America/Chicago"
},
"stop_id": "stringstringstringstringst",
"carrier_name": "string",
"carrier_contact": "string",
"carrier_tenant_id": "stringstringstringstringst",
"driver_id": "stringstringstringstringst",
"appointment_type": "BY_APPOINTMENT_ONLY",
"delivery_type": "RECEIVING",
"scheduled_resource_type": "FREIGHT_GENERAL",
"scheduled_resource_id": "stringstringstringstringst",
"scheduled_resource_metadata": {"resource_type": "FREIGHT_GENERAL",
"reference_number": "string",
"reference_number_type": "PO_NUMBER",
"linked_appointment_reference_number": "string",
"delivery_type": "RECEIVING",
"mode": "FTL",
"equipment_type": "DRY_VAN",
"product_category": ["string"
],
"product_references": ["string"
],
"stackable": true,
"is_hazmat": true,
"carrier_name": "string",
"carrier_email": "user@example.com",
"carrier_phone_number": "string",
"notes": "string"
},
"notes": "string",
"id": "stringstringstringstringst",
"facility_id": "string",
"dock_id": "string",
"status": "UNSCHEDULED",
"is_closed": true,
"created_by": "stringstringstringstringst",
"deleted_by": "stringstringstringstringst",
"checked_in_at": {"timestamp": "2019-08-24T14:15:22Z",
"timezone": "America/Chicago"
},
"checked_in_by_user_id": "stringstringstringstringst",
"checked_out_at": {"timestamp": "2019-08-24T14:15:22Z",
"timezone": "America/Chicago"
},
"checked_out_by_user_id": "stringstringstringstringst",
"rejected_at": {"timestamp": "2019-08-24T14:15:22Z",
"timezone": "America/Chicago"
},
"rejected_reasons": "string",
"declined_at": {"timestamp": "2019-08-24T14:15:22Z",
"timezone": "America/Chicago"
},
"declined_reasons": "string",
"declined_by_user_id": "stringstringstringstringst",
"requested_at": {"timestamp": "2019-08-24T14:15:22Z",
"timezone": "America/Chicago"
},
"requested_by_user_id": "stringstringstringstringst",
"scheduled_resource_reference_id": "string",
"shipment": {"reference_id": "string",
"bol_number": "string",
"customer_reference_number": "string",
"pro_number": "string",
"purchase_order_number": "string",
"order_number": "string",
"mode": {"id": 0,
"code": "FTL",
"description": "string"
},
"equipment_type": {"id": 0,
"machine_readable": "DRY_VAN",
"name": "string"
},
"temperature_lower_limit": 0,
"temperature_upper_limit": 0,
"temperature_unit": "string",
"drayage_seal_number": "string",
"drayage_carrier_scac_code": "string",
"trailer_name": "string",
"custom_data": { },
"product_categories": ["string"
],
"product_reference": "string",
"stop": {"id": "string",
"is_pickup": true,
"is_dropoff": true,
"planned_date": "2019-08-24",
"location": {"created_using_address_book_entry_id": "string",
"facility_id": "string",
"company_name": "string",
"identification_code": "string"
},
"custom_data": { },
"planning_window": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z"
}
},
"equipment_config": {"id": "string",
"driver": {"id": "string",
"first_name": "string",
"last_name": "string",
"phone_number": "string"
}
},
"relationship_to_vendor": {"vendor": {"id": "string",
"name": "string",
"identifying_codes": [{"type": null,
"value": null
}
]
}
},
"line_items": [{"id": "string",
"total_packages": 0,
"package_type": "PLT",
"product_ref": "string",
"product_category": "string",
"stackable": true,
"hazmat_identification_number": "string",
"total_pieces": 0,
"package_weight": 0,
"weight_unit": "string",
"height": 0,
"width": 0,
"length": 0,
"length_unit": "string"
}
]
}
}
],
"total_count": 0
}