{"componentChunkName":"component---src-templates-redoc-operation-js","path":"/openapi_pages/dock-scheduling/operation/search_references_facilities__facility_id__references_search_get/","result":{"data":{"contentItem":{"type":"redoc-operation","link":"/openapi_pages/dock-scheduling/operation/search_references_facilities__facility_id__references_search_get/","data":{"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.1.0\",\"info\":{\"title\":\"Dock Scheduling\",\"version\":\"0.4.47\"},\"servers\":[{\"url\":\"https://dev-api.shipwell.com\"}],\"security\":[{\"APIKeyHeader\":[]}],\"paths\":{\"/facilities/{facility_id}/appointments/document-requirements/check\":{\"post\":{\"tags\":[\"appointments\"],\"summary\":\"Check Appointment Document Requirements\",\"description\":\"Documents this facility requires for an appointment, which of them the given references already carry, and which are still missing. Read-only preview of the check that runs at booking time; send the references the appointment is being built with.\",\"operationId\":\"check_appointment_document_requirements_facilities__facility_id__appointments_document_requirements_check_post\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"maxLength\":26,\"minLength\":26,\"title\":\"Facility Id\"},\"name\":\"facility_id\",\"in\":\"path\"}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/DocumentRequirementsCheckRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/DocumentRequirementsCheckResponse\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/{facility_id}/docks/{dock_id}/appointments\":{\"post\":{\"tags\":[\"appointments\"],\"summary\":\"Create Dock Appointment\",\"description\":\"Create an appointment at a dock.\",\"operationId\":\"create_dock_appointment_facilities__facility_id__docks__dock_id__appointments_post\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"maxLength\":26,\"minLength\":26,\"title\":\"Facility Id\"},\"name\":\"facility_id\",\"in\":\"path\"},{\"required\":true,\"schema\":{\"type\":\"string\",\"maxLength\":26,\"minLength\":26,\"title\":\"Dock Id\"},\"name\":\"dock_id\",\"in\":\"path\"},{\"description\":\"Bypass any restrictions on appointment scheduling that would normally apply. This allows you to ignore things such as facility hours of operation, holidays, max appointment capacity, etc. Providing a true value for this parameter will fail if the user does not have override permissions.\",\"required\":false,\"schema\":{\"type\":\"boolean\",\"title\":\"Override Availability Restrictions\",\"description\":\"Bypass any restrictions on appointment scheduling that would normally apply. This allows you to ignore things such as facility hours of operation, holidays, max appointment capacity, etc. Providing a true value for this parameter will fail if the user does not have override permissions.\",\"default\":false},\"name\":\"override_availability_restrictions\",\"in\":\"query\"}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateAppointment\"}}},\"required\":true},\"responses\":{\"201\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Appointment\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/{facility_id}/docks/{dock_id}/appointment-requests\":{\"post\":{\"tags\":[\"appointments\"],\"summary\":\"Create Dock Appointment Request\",\"description\":\"Submit a request for an appointment time the facility does not currently offer. Always created in REQUESTED status, awaiting facility approval.\",\"operationId\":\"create_dock_appointment_request_facilities__facility_id__docks__dock_id__appointment_requests_post\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"maxLength\":26,\"minLength\":26,\"title\":\"Facility Id\"},\"name\":\"facility_id\",\"in\":\"path\"},{\"required\":true,\"schema\":{\"type\":\"string\",\"maxLength\":26,\"minLength\":26,\"title\":\"Dock Id\"},\"name\":\"dock_id\",\"in\":\"path\"}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateAppointmentRequest\"}}},\"required\":true},\"responses\":{\"201\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Appointment\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/appointments/{appointment_id}/documents\":{\"get\":{\"tags\":[\"appointments\"],\"summary\":\"List Appointment Documents\",\"description\":\"List the documents attached to an appointment, newest first. Metadata only.\",\"operationId\":\"list_appointment_documents_facilities_appointments__appointment_id__documents_get\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Appointment Id\"},\"name\":\"appointment_id\",\"in\":\"path\"},{\"required\":false,\"schema\":{\"type\":\"integer\",\"minimum\":1,\"title\":\"Page\",\"default\":1},\"name\":\"page\",\"in\":\"query\"},{\"required\":false,\"schema\":{\"type\":\"integer\",\"maximum\":1000,\"minimum\":1,\"title\":\"Limit\",\"default\":50},\"name\":\"limit\",\"in\":\"query\"},{\"required\":false,\"schema\":{\"type\":\"string\",\"title\":\"Sort\"},\"name\":\"sort\",\"in\":\"query\"}],\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppointmentDocumentList\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false},\"post\":{\"tags\":[\"appointments\"],\"summary\":\"Upload Appointment Document\",\"description\":\"Attach one document to an appointment, including a TEMP_DRAFT created by /drafts. Send one request per file.\",\"operationId\":\"upload_appointment_document_facilities_appointments__appointment_id__documents_post\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Appointment Id\"},\"name\":\"appointment_id\",\"in\":\"path\"}],\"requestBody\":{\"content\":{\"multipart/form-data\":{\"schema\":{\"$ref\":\"#/components/schemas/Body_upload_appointment_document_facilities_appointments__appointment_id__documents_post\"}}},\"required\":true},\"responses\":{\"201\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppointmentDocument\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/appointments/{appointment_id}/documents/{document_id}/download-url\":{\"get\":{\"tags\":[\"appointments\"],\"summary\":\"Get Appointment Document Download Url\",\"description\":\"A short-lived URL to download one appointment document.\",\"operationId\":\"get_appointment_document_download_url_facilities_appointments__appointment_id__documents__document_id__download_url_get\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Appointment Id\"},\"name\":\"appointment_id\",\"in\":\"path\"},{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Document Id\"},\"name\":\"document_id\",\"in\":\"path\"}],\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppointmentDocumentDownloadUrl\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/appointments/{appointment_id}/documents/{document_id}\":{\"delete\":{\"tags\":[\"appointments\"],\"summary\":\"Delete Appointment Document\",\"description\":\"Delete an appointment document. Only the facility's users can delete, and only documents the facility uploaded.\",\"operationId\":\"delete_appointment_document_facilities_appointments__appointment_id__documents__document_id__delete\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Appointment Id\"},\"name\":\"appointment_id\",\"in\":\"path\"},{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Document Id\"},\"name\":\"document_id\",\"in\":\"path\"}],\"responses\":{\"204\":{\"description\":\"Successful Response\"},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/appointments\":{\"get\":{\"tags\":[\"appointments\"],\"summary\":\"List All Appointments\",\"description\":\"List Appointments\",\"operationId\":\"list_all_appointments_facilities_appointments_get\",\"parameters\":[{\"description\":\"Free-text search across all Appointment reference values, and an exact match on the Appointment confirmation number (e.g. `SCH8EH4L5`). The confirmation number match is case-insensitive and ignores surrounding whitespace, but must be the complete code\",\"required\":false,\"schema\":{\"type\":\"string\",\"title\":\"q\",\"description\":\"Free-text search across all Appointment reference values, and an exact match on the Appointment confirmation number (e.g. `SCH8EH4L5`). The confirmation number match is case-insensitive and ignores surrounding whitespace, but must be the complete code\"},\"name\":\"q\",\"in\":\"query\"},{\"description\":\"Exact-match filter on the full Appointment confirmation number (e.g. `SCH8EH4L5`). Case-insensitive; surrounding whitespace is ignored. Partial codes are not matched. Operator forms such as `confirmation_number.exact` and `confirmation_number.in` remain case-sensitive; only this bare form is normalised\",\"required\":false,\"schema\":{\"type\":\"string\",\"title\":\"confirmation_number\",\"description\":\"Exact-match filter on the full Appointment confirmation number (e.g. `SCH8EH4L5`). Case-insensitive; surrounding whitespace is ignored. Partial codes are not matched. Operator forms such as `confirmation_number.exact` and `confirmation_number.in` remain case-sensitive; only this bare form is normalised\"},\"name\":\"confirmation_number\",\"in\":\"query\"},{\"description\":\"Filter for appointments by status. Comma-separated for multiple values, returning appointments matching any of them (OR).\",\"required\":false,\"schema\":{\"type\":\"string\",\"title\":\"status\",\"description\":\"Filter for appointments by status. Comma-separated for multiple values, returning appointments matching any of them (OR).\"},\"name\":\"status\",\"in\":\"query\"},{\"description\":\"Filter for appointments with planned date. Range variants `planned_date.gte` / `planned_date.lte` are also supported. Note the bounds are asymmetric: `.gte` compares the planned window's start (`planned_date`) while `.lte` compares its end (`planned_date_range_end`), so a multi-day window that starts inside the range but ends after `.lte` is excluded\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date\",\"title\":\"planned_date\",\"description\":\"Filter for appointments with planned date. Range variants `planned_date.gte` / `planned_date.lte` are also supported. Note the bounds are asymmetric: `.gte` compares the planned window's start (`planned_date`) while `.lte` compares its end (`planned_date_range_end`), so a multi-day window that starts inside the range but ends after `.lte` is excluded\"},\"name\":\"planned_date\",\"in\":\"query\"},{\"description\":\"Filter for appointments by their expected date: the appointment's own scheduled date if it has been booked, otherwise the planned date of its linked stop. This is the only date filter that reaches both booked appointments and unscheduled shipment stubs, so it returns the complete list where `planned_date` and the `start_datetime_utc`/`end_datetime_utc` window each return only one class. Range variants `expected_start_date.gte` / `expected_start_date.lte` are also supported.\\n\\nDates are **facility-local calendar days**, not UTC instants: a booking at 23:00 local time belongs to that local day even though it falls on the next UTC day.\\n\\nBounds are **overlap**, not containment — an appointment matches when its date range intersects the requested one at all. This differs from `planned_date.lte`, which compares the planned window's end and therefore excludes a multi-day window that starts inside the range but ends after `.lte`. The exact form is overlap too, not equality: `expected_start_date=2026-01-03` is the degenerate range `[2026-01-03, 2026-01-03]`, so a multi-day appointment spanning that day matches even if it *started* earlier (e.g. an appointment running 01/01 to 01/03).\\n\\nAppointments carrying no date at all are never returned by this filter, and sort last under `sort=expected_start_date` in both directions. Freight appointments have no date field to derive one from, so this is by construction rather than a data gap\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date\",\"title\":\"expected_start_date\",\"description\":\"Filter for appointments by their expected date: the appointment's own scheduled date if it has been booked, otherwise the planned date of its linked stop. This is the only date filter that reaches both booked appointments and unscheduled shipment stubs, so it returns the complete list where `planned_date` and the `start_datetime_utc`/`end_datetime_utc` window each return only one class. Range variants `expected_start_date.gte` / `expected_start_date.lte` are also supported.\\n\\nDates are **facility-local calendar days**, not UTC instants: a booking at 23:00 local time belongs to that local day even though it falls on the next UTC day.\\n\\nBounds are **overlap**, not containment — an appointment matches when its date range intersects the requested one at all. This differs from `planned_date.lte`, which compares the planned window's end and therefore excludes a multi-day window that starts inside the range but ends after `.lte`. The exact form is overlap too, not equality: `expected_start_date=2026-01-03` is the degenerate range `[2026-01-03, 2026-01-03]`, so a multi-day appointment spanning that day matches even if it *started* earlier (e.g. an appointment running 01/01 to 01/03).\\n\\nAppointments carrying no date at all are never returned by this filter, and sort last under `sort=expected_start_date` in both directions. Freight appointments have no date field to derive one from, so this is by construction rather than a data gap\"},\"name\":\"expected_start_date\",\"in\":\"query\"},{\"description\":\"Filter for appointments with an assigned carrier\",\"required\":false,\"schema\":{\"type\":\"boolean\",\"title\":\"carrier_assigned\",\"description\":\"Filter for appointments with an assigned carrier\"},\"name\":\"carrier_assigned\",\"in\":\"query\"},{\"description\":\"Filter for appointments at facilities where one of the point of contacts' user IDs matches this value\",\"required\":false,\"schema\":{\"type\":\"string\",\"title\":\"point_of_contact_user_id\",\"description\":\"Filter for appointments at facilities where one of the point of contacts' user IDs matches this value\"},\"name\":\"point_of_contact_user_id\",\"in\":\"query\"},{\"description\":\"Case-sensitive exact match filter on the facility name\",\"required\":false,\"schema\":{\"type\":\"string\",\"title\":\"facility_name\",\"description\":\"Case-sensitive exact match filter on the facility name\"},\"name\":\"facility_name\",\"in\":\"query\"},{\"description\":\"Filter by appointment type\",\"required\":false,\"schema\":{\"allOf\":[{\"$ref\":\"#/components/schemas/FacilityAppointmentType\"}],\"title\":\"appointment_type\",\"description\":\"Filter by appointment type\"},\"name\":\"appointment_type\",\"in\":\"query\"},{\"description\":\"Filter by carrier tenant ID. Comma-separated for multiple values\",\"required\":false,\"schema\":{\"type\":\"string\",\"title\":\"carrier_id\",\"description\":\"Filter by carrier tenant ID. Comma-separated for multiple values\"},\"name\":\"carrier_id\",\"in\":\"query\"},{\"description\":\"Filter appointments matched to this load type ID\",\"required\":false,\"schema\":{\"type\":\"string\",\"title\":\"load_type_id\",\"description\":\"Filter appointments matched to this load type ID\"},\"name\":\"load_type_id\",\"in\":\"query\"},{\"description\":\"Filter pickup appointments (delivery_type=shipping) by their stop's planned date. Range variants `planned_pu_date.gte` / `planned_pu_date.lte` are also supported\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date\",\"title\":\"planned_pu_date\",\"description\":\"Filter pickup appointments (delivery_type=shipping) by their stop's planned date. Range variants `planned_pu_date.gte` / `planned_pu_date.lte` are also supported\"},\"name\":\"planned_pu_date\",\"in\":\"query\"},{\"description\":\"Filter delivery appointments (delivery_type=receiving) by their stop's planned date. Range variants `planned_dl_date.gte` / `planned_dl_date.lte` are also supported\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date\",\"title\":\"planned_dl_date\",\"description\":\"Filter delivery appointments (delivery_type=receiving) by their stop's planned date. Range variants `planned_dl_date.gte` / `planned_dl_date.lte` are also supported\"},\"name\":\"planned_dl_date\",\"in\":\"query\"},{\"required\":false,\"schema\":{\"type\":\"string\",\"title\":\"Sort\"},\"name\":\"sort\",\"in\":\"query\"},{\"required\":false,\"schema\":{\"type\":\"integer\",\"minimum\":1,\"title\":\"Page\",\"default\":1},\"name\":\"page\",\"in\":\"query\"},{\"required\":false,\"schema\":{\"type\":\"integer\",\"maximum\":1000,\"minimum\":1,\"title\":\"Limit\",\"default\":50},\"name\":\"limit\",\"in\":\"query\"},{\"description\":\"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.\",\"required\":false,\"schema\":{\"type\":\"string\",\"maxLength\":26,\"minLength\":26,\"title\":\"Facility Id\",\"description\":\"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.\"},\"name\":\"facility_id\",\"in\":\"query\"},{\"description\":\"Filter by only Appointments scheduled at this Dock.\",\"required\":false,\"schema\":{\"type\":\"string\",\"maxLength\":26,\"minLength\":26,\"title\":\"Dock Id\",\"description\":\"Filter by only Appointments scheduled at this Dock.\"},\"name\":\"dock_id\",\"in\":\"query\"}],\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PaginatedResponse_AppointmentListItem_\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/appointments/{appointment_id}\":{\"get\":{\"tags\":[\"appointments\"],\"summary\":\"Retrieve Appointment\",\"description\":\"Retrieve an Appointment by ID\",\"operationId\":\"retrieve_appointment_facilities_appointments__appointment_id__get\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Appointment Id\"},\"name\":\"appointment_id\",\"in\":\"path\"}],\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Appointment\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/appointments/{appointment_id}/schedule\":{\"post\":{\"tags\":[\"appointments\"],\"summary\":\"Schedule Appointment\",\"description\":\"Schedule an unscheduled Appointment\",\"operationId\":\"schedule_appointment_facilities_appointments__appointment_id__schedule_post\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Appointment Id\"},\"name\":\"appointment_id\",\"in\":\"path\"},{\"description\":\"Bypass any restrictions on appointment scheduling that would normally apply. This allows you to ignore things such as facility hours of operation, holidays, max appointment capacity, etc. Providing a true value for this parameter will fail if the user does not have override permissions.\",\"required\":false,\"schema\":{\"type\":\"boolean\",\"title\":\"Override Availability Restrictions\",\"description\":\"Bypass any restrictions on appointment scheduling that would normally apply. This allows you to ignore things such as facility hours of operation, holidays, max appointment capacity, etc. Providing a true value for this parameter will fail if the user does not have override permissions.\",\"default\":false},\"name\":\"override_availability_restrictions\",\"in\":\"query\"}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ScheduleAppointmentRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Appointment\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/appointments/{appointment_id}/request-time\":{\"post\":{\"tags\":[\"appointments\"],\"summary\":\"Request Appointment Time\",\"description\":\"Request a window the facility does not offer for an UNSCHEDULED shipment Appointment: availability is not checked and the Appointment lands in REQUESTED, awaiting the facility.\",\"operationId\":\"request_appointment_time_facilities_appointments__appointment_id__request_time_post\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Appointment Id\"},\"name\":\"appointment_id\",\"in\":\"path\"}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RequestAppointmentTimeRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Appointment\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/appointments/{appointment_id}/reschedule\":{\"post\":{\"tags\":[\"appointments\"],\"summary\":\"Reschedule Appointment\",\"description\":\"Reschedule an Appointment\",\"operationId\":\"reschedule_appointment_facilities_appointments__appointment_id__reschedule_post\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Appointment Id\"},\"name\":\"appointment_id\",\"in\":\"path\"},{\"description\":\"Bypass any restrictions on appointment scheduling that would normally apply. This allows you to ignore things such as facility hours of operation, holidays, max appointment capacity, etc. Providing a true value for this parameter will fail if the user does not have override permissions.\",\"required\":false,\"schema\":{\"type\":\"boolean\",\"title\":\"Override Availability Restrictions\",\"description\":\"Bypass any restrictions on appointment scheduling that would normally apply. This allows you to ignore things such as facility hours of operation, holidays, max appointment capacity, etc. Providing a true value for this parameter will fail if the user does not have override permissions.\",\"default\":false},\"name\":\"override_availability_restrictions\",\"in\":\"query\"}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RescheduleAppointmentRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Appointment\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/appointments/{appointment_id}/reject\":{\"post\":{\"tags\":[\"appointments\"],\"summary\":\"Reject Appointment\",\"description\":\"Reject an Appointment\",\"operationId\":\"reject_appointment_facilities_appointments__appointment_id__reject_post\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Appointment Id\"},\"name\":\"appointment_id\",\"in\":\"path\"}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppointmentRejectRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Appointment\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/appointments/{appointment_id}/check-in\":{\"post\":{\"tags\":[\"appointments\"],\"summary\":\"Check In Appointment\",\"description\":\"Check in an Appointment\",\"operationId\":\"check_in_appointment_facilities_appointments__appointment_id__check_in_post\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Appointment Id\"},\"name\":\"appointment_id\",\"in\":\"path\"}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppointmentCheckInRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Appointment\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/appointments/{appointment_id}/check-out\":{\"post\":{\"tags\":[\"appointments\"],\"summary\":\"Check Out Appointment\",\"description\":\"Check out an Appointment\",\"operationId\":\"check_out_appointment_facilities_appointments__appointment_id__check_out_post\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Appointment Id\"},\"name\":\"appointment_id\",\"in\":\"path\"}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppointmentCheckOutRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Appointment\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/appointments/{appointment_id}/cancel\":{\"post\":{\"tags\":[\"appointments\"],\"summary\":\"Cancel Appointment\",\"description\":\"Cancel an Appointment\",\"operationId\":\"cancel_appointment_facilities_appointments__appointment_id__cancel_post\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Appointment Id\"},\"name\":\"appointment_id\",\"in\":\"path\"}],\"responses\":{\"204\":{\"description\":\"Successful Response\"},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/appointments/{appointment_id}/approve\":{\"post\":{\"tags\":[\"appointments\"],\"summary\":\"Approve Appointment\",\"description\":\"Approve a specific appointment with optional date/time changes\",\"operationId\":\"approve_appointment_facilities_appointments__appointment_id__approve_post\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Appointment Id\"},\"name\":\"appointment_id\",\"in\":\"path\"}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppointmentApprovalRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Appointment\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/appointments/{appointment_id}/decline\":{\"post\":{\"tags\":[\"appointments\"],\"summary\":\"Decline Appointment\",\"description\":\"Decline a specific appointment with a reason\",\"operationId\":\"decline_appointment_facilities_appointments__appointment_id__decline_post\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Appointment Id\"},\"name\":\"appointment_id\",\"in\":\"path\"}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppointmentDeclineRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Appointment\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/{facility_id}/load-types\":{\"get\":{\"tags\":[\"facilities\"],\"summary\":\"List Load Types\",\"description\":\"Get a list of load types, optionally filtered.\",\"operationId\":\"list_load_types_facilities__facility_id__load_types_get\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Facility Id\"},\"name\":\"facility_id\",\"in\":\"path\"},{\"required\":false,\"schema\":{\"type\":\"integer\",\"minimum\":1,\"title\":\"Page\",\"default\":1},\"name\":\"page\",\"in\":\"query\"},{\"required\":false,\"schema\":{\"type\":\"integer\",\"maximum\":1000,\"minimum\":1,\"title\":\"Limit\",\"default\":50},\"name\":\"limit\",\"in\":\"query\"},{\"required\":false,\"schema\":{\"type\":\"string\",\"title\":\"Sort\"},\"name\":\"sort\",\"in\":\"query\"}],\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PaginatedResponse_LoadType_\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/{facility_id}/load-types/{load_type_id}\":{\"get\":{\"tags\":[\"facilities\"],\"summary\":\"Retrieve Load Type\",\"description\":\"Retrieve an individual LoadType.\",\"operationId\":\"retrieve_load_type_facilities__facility_id__load_types__load_type_id__get\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Load Type Id\"},\"name\":\"load_type_id\",\"in\":\"path\"},{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Facility Id\"},\"name\":\"facility_id\",\"in\":\"path\"}],\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/LoadType\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/{facility_id}/docks/{dock_id}/rules\":{\"get\":{\"tags\":[\"facilities\"],\"summary\":\"List Facility Dock Appointment Rules\",\"description\":\"Get a list of dock appointment rules at a specified facility.\",\"operationId\":\"list_facility_dock_appointment_rules_facilities__facility_id__docks__dock_id__rules_get\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"maxLength\":26,\"minLength\":26,\"title\":\"Facility Id\"},\"name\":\"facility_id\",\"in\":\"path\"},{\"required\":true,\"schema\":{\"type\":\"string\",\"maxLength\":26,\"minLength\":26,\"title\":\"Dock Id\"},\"name\":\"dock_id\",\"in\":\"path\"},{\"required\":false,\"schema\":{\"type\":\"integer\",\"minimum\":1,\"title\":\"Page\",\"default\":1},\"name\":\"page\",\"in\":\"query\"},{\"required\":false,\"schema\":{\"type\":\"integer\",\"maximum\":1000,\"minimum\":1,\"title\":\"Limit\",\"default\":50},\"name\":\"limit\",\"in\":\"query\"},{\"required\":false,\"schema\":{\"type\":\"string\",\"title\":\"Sort\"},\"name\":\"sort\",\"in\":\"query\"}],\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FacilityDockAppointmentRuleList\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/{facility_id}/docks/{dock_id}/rules/{rule_id}\":{\"get\":{\"tags\":[\"facilities\"],\"summary\":\"Retrieve Facility Dock Appointment Rule\",\"description\":\"Get a dock appointment rule at a specified facility by a given id.\",\"operationId\":\"retrieve_facility_dock_appointment_rule_facilities__facility_id__docks__dock_id__rules__rule_id__get\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Rule Id\"},\"name\":\"rule_id\",\"in\":\"path\"},{\"required\":true,\"schema\":{\"type\":\"string\",\"maxLength\":26,\"minLength\":26,\"title\":\"Facility Id\"},\"name\":\"facility_id\",\"in\":\"path\"},{\"required\":true,\"schema\":{\"type\":\"string\",\"maxLength\":26,\"minLength\":26,\"title\":\"Dock Id\"},\"name\":\"dock_id\",\"in\":\"path\"}],\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FacilityDockAppointmentRule\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/{facility_id}/docks\":{\"get\":{\"tags\":[\"facilities\"],\"summary\":\"List Facility Docks\",\"description\":\"Get a list of docks at a specified facility.\",\"operationId\":\"list_facility_docks_facilities__facility_id__docks_get\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"maxLength\":26,\"minLength\":26,\"title\":\"Facility Id\"},\"name\":\"facility_id\",\"in\":\"path\"},{\"required\":false,\"schema\":{\"type\":\"integer\",\"minimum\":1,\"title\":\"Page\",\"default\":1},\"name\":\"page\",\"in\":\"query\"},{\"required\":false,\"schema\":{\"type\":\"integer\",\"maximum\":1000,\"minimum\":1,\"title\":\"Limit\",\"default\":50},\"name\":\"limit\",\"in\":\"query\"},{\"required\":false,\"schema\":{\"type\":\"string\",\"title\":\"Sort\"},\"name\":\"sort\",\"in\":\"query\"}],\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FacilityDockList\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/{facility_id}/docks/{dock_id}\":{\"get\":{\"tags\":[\"facilities\"],\"summary\":\"Retrieve Dock\",\"description\":\"Get a dock at a specified facility by a given id.\",\"operationId\":\"retrieve_dock_facilities__facility_id__docks__dock_id__get\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Dock Id\"},\"name\":\"dock_id\",\"in\":\"path\"},{\"required\":true,\"schema\":{\"type\":\"string\",\"maxLength\":26,\"minLength\":26,\"title\":\"Facility Id\"},\"name\":\"facility_id\",\"in\":\"path\"}],\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FacilityDock\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/{facility_id}/references/search\":{\"get\":{\"tags\":[\"facilities\",\"references\"],\"summary\":\"Search References\",\"description\":\"Search shipments and orders matching an exact reference value at a given facility.\",\"operationId\":\"search_references_facilities__facility_id__references_search_get\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"maxLength\":26,\"minLength\":26,\"title\":\"Facility Id\"},\"name\":\"facility_id\",\"in\":\"path\"},{\"description\":\"Exact value to match against shipment reference fields and order identifiers\",\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Q\",\"description\":\"Exact value to match against shipment reference fields and order identifiers\"},\"name\":\"q\",\"in\":\"query\"}],\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReferenceSearchResponse\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities\":{\"get\":{\"tags\":[\"facilities\"],\"summary\":\"List Facilities\",\"description\":\"Get a list of facilities, optionally filtered.\",\"operationId\":\"list_facilities_facilities_get\",\"parameters\":[{\"description\":\"Filter facilities by point of contact user ID\",\"required\":false,\"schema\":{\"type\":\"string\",\"title\":\"Point Of Contact User Id\",\"description\":\"Filter facilities by point of contact user ID\"},\"name\":\"point_of_contact_user_id\",\"in\":\"query\"},{\"required\":false,\"schema\":{\"type\":\"integer\",\"minimum\":1,\"title\":\"Page\",\"default\":1},\"name\":\"page\",\"in\":\"query\"},{\"required\":false,\"schema\":{\"type\":\"integer\",\"maximum\":1000,\"minimum\":1,\"title\":\"Limit\",\"default\":50},\"name\":\"limit\",\"in\":\"query\"},{\"required\":false,\"schema\":{\"type\":\"string\",\"title\":\"Sort\"},\"name\":\"sort\",\"in\":\"query\"},{\"description\":\"Include child entities that are not returned by default\",\"required\":false,\"schema\":{\"items\":{\"$ref\":\"#/components/schemas/FacilityIncludeQueryOptionEnum\"},\"type\":\"array\",\"description\":\"Include child entities that are not returned by default\"},\"name\":\"include\",\"in\":\"query\"}],\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PaginatedResponse_Facility_\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/{facility_id}\":{\"get\":{\"tags\":[\"facilities\"],\"summary\":\"Retrieve Facility\",\"description\":\"Retrieve a facility by a given id.\",\"operationId\":\"retrieve_facility_facilities__facility_id__get\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Facility Id\"},\"name\":\"facility_id\",\"in\":\"path\"},{\"description\":\"Include child entities that are not returned by default\",\"required\":false,\"schema\":{\"items\":{\"$ref\":\"#/components/schemas/FacilityIncludeQueryOptionEnum\"},\"type\":\"array\",\"description\":\"Include child entities that are not returned by default\"},\"name\":\"include\",\"in\":\"query\"}],\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Facility\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/{facility_id}/availability\":{\"post\":{\"tags\":[\"facilities\"],\"summary\":\"List Facility Availability\",\"description\":\"Get a list of availabilities at a specified facility.\",\"operationId\":\"list_facility_availability_facilities__facility_id__availability_post\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Facility Id\"},\"name\":\"facility_id\",\"in\":\"path\"},{\"required\":false,\"schema\":{\"items\":{\"$ref\":\"#/components/schemas/AvailabilityIncludeParams\"},\"type\":\"array\",\"default\":[]},\"name\":\"include\",\"in\":\"query\"},{\"description\":\"Return the union of every Dock's availability as non-overlapping windows, each naming a single Dock, instead of one overlapping set of windows per Dock. A stretch of availability goes to the best-matching Dock open when it starts and stays with that Dock while it remains open. Use this when the person choosing a time should not have to choose a Dock.\",\"required\":false,\"schema\":{\"type\":\"boolean\",\"title\":\"Merge Docks\",\"description\":\"Return the union of every Dock's availability as non-overlapping windows, each naming a single Dock, instead of one overlapping set of windows per Dock. A stretch of availability goes to the best-matching Dock open when it starts and stays with that Dock while it remains open. Use this when the person choosing a time should not have to choose a Dock.\",\"default\":false},\"name\":\"merge_docks\",\"in\":\"query\"}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AvailabilityRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Availability\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}},\"/facilities/{facility_id}/load-type-dock-rule-matching\":{\"post\":{\"tags\":[\"facilities\"],\"summary\":\"Match Load Type Dock Rules\",\"description\":\"Match characteristics of freight to LoadTypes and Docks at a given Facility.\",\"operationId\":\"match_load_type_dock_rules_facilities__facility_id__load_type_dock_rule_matching_post\",\"parameters\":[{\"required\":true,\"schema\":{\"type\":\"string\",\"title\":\"Facility Id\"},\"name\":\"facility_id\",\"in\":\"path\"},{\"required\":false,\"schema\":{\"items\":{\"$ref\":\"#/components/schemas/ShipmentMatchingIncludeParams\"},\"type\":\"array\",\"default\":[]},\"name\":\"include\",\"in\":\"query\"}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/LoadTypeDockRuleMatchRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successful Response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/LoadTypeDockRuleMatchResults\"}}}},\"400\":{\"description\":\"Validation Error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ShipwellApiErrorResponse\"}}}}},\"x-internal\":false}}},\"components\":{\"schemas\":{\"Appointment\":{\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Name\"},\"reason\":{\"allOf\":[{\"$ref\":\"#/components/schemas/AppointmentReason\"}],\"description\":\"Reason for the Appointment.\"},\"reference_id\":{\"type\":\"string\",\"title\":\"Reference Id\"},\"description\":{\"type\":\"string\",\"title\":\"Description\"},\"is_all_day\":{\"type\":\"boolean\",\"title\":\"Is All Day\",\"description\":\"If true, indicates that the Appointment's start/end should equal the operating hours of the Facility/Dock at which it is scheduled.\",\"default\":false},\"matched_load_type_id\":{\"type\":\"string\",\"title\":\"Matched Load Type Id\",\"description\":\"ID of the LoadType whose fields should be used to determine if it matches an Appointment.\"},\"references\":{\"items\":{\"$ref\":\"#/components/schemas/Reference\"},\"type\":\"array\",\"title\":\"References\",\"description\":\"List of references for the appointment that can be used to search for the appointment later.\",\"default\":[]},\"start\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"end\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"stop_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Stop Id\"},\"carrier_name\":{\"type\":\"string\",\"title\":\"Carrier Name\"},\"carrier_contact\":{\"type\":\"string\",\"title\":\"Carrier Contact\"},\"carrier_tenant_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Carrier Tenant Id\"},\"driver_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Driver Id\"},\"appointment_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/FacilityAppointmentType\"}],\"default\":\"BY_APPOINTMENT_ONLY\"},\"delivery_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DeliveryTypeEnum\"}],\"description\":\"Whether the delivery type is loading or unloading Freight.\"},\"scheduled_resource_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/ScheduledResourceTypeEnum\"}],\"description\":\"Required when the scheduled_resource_id field is provided.\"},\"scheduled_resource_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Scheduled Resource Id\"},\"scheduled_resource_metadata\":{\"oneOf\":[{\"$ref\":\"#/components/schemas/FreightAppointmentScheduledResource\"},{\"$ref\":\"#/components/schemas/ShipmentAppointmentScheduledResource\"}],\"title\":\"Scheduled Resource Metadata\",\"description\":\"Additional details about the resource for which this Appointment is scheduling, or null if the Appointment does not relate to any scheduled resource. For example, if this Appointment relates to a Shipment, these details will be described by a ShipmentAppointmentScheduledResource. Or if the Appointment is managing off-platform freight, the details will instead be described using the FreightAppointmentScheduledResource schema.\",\"discriminator\":{\"propertyName\":\"resource_type\",\"mapping\":{\"FREIGHT_GENERAL\":\"#/components/schemas/FreightAppointmentScheduledResource\",\"SHIPMENT\":\"#/components/schemas/ShipmentAppointmentScheduledResource\"}}},\"notes\":{\"type\":\"string\",\"title\":\"Notes\"},\"appointment_orders\":{\"items\":{\"$ref\":\"#/components/schemas/CreateAppointmentOrder\"},\"type\":\"array\",\"title\":\"Appointment Orders\"},\"id\":{\"type\":\"string\",\"maxLength\":26,\"minLength\":26,\"title\":\"Id\"},\"facility_id\":{\"type\":\"string\",\"title\":\"Facility Id\",\"description\":\"Facility at which the appointment takes place\"},\"dock_id\":{\"type\":\"string\",\"title\":\"Dock Id\",\"description\":\"Dock at which the appointment is scheduled, or null if the appointment is not scheduled for any specific dock.\"},\"status\":{\"$ref\":\"#/components/schemas/AppointmentStatusEnum\"},\"is_closed\":{\"type\":\"boolean\",\"title\":\"Is Closed\",\"description\":\"Check the status of appointment to see why it's closed.\"},\"created_by\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Created By\",\"description\":\"Unique identifier of Entity creating the appointment. e.g. Freight Authority ID, User, Company, System, etc.\"},\"deleted_by\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Deleted By\",\"description\":\"Unique identifier of Entity creating the appointment. e.g. Freight Authority ID, User, Company, System, etc.\"},\"checked_in_at\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"checked_in_by_user_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Checked In By User Id\"},\"checked_out_at\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"checked_out_by_user_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Checked Out By User Id\"},\"dock_in_at\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Dock In At\",\"description\":\"When the truck moved onto the dock. Free-form: not validated against the other timestamps or the appointment window, and it does not change the status.\"},\"dock_out_at\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Dock Out At\",\"description\":\"When the truck left the dock. Same freedom as `dock_in_at`.\"},\"actual_start_at\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Actual Start At\",\"description\":\"When loading or unloading actually began, as opposed to `start`.\"},\"actual_stop_at\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Actual Stop At\",\"description\":\"When loading or unloading actually finished, as opposed to `end`.\"},\"rejected_at\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"rejected_reasons\":{\"type\":\"string\",\"title\":\"Rejected Reasons\"},\"declined_at\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"declined_reasons\":{\"type\":\"string\",\"title\":\"Declined Reasons\"},\"declined_by_user_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Declined By User Id\"},\"requested_at\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"requested_by_user_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Requested By User Id\"},\"request_note\":{\"type\":\"string\",\"title\":\"Request Note\",\"description\":\"Message from the requester, set when the appointment was submitted as a time request.\"},\"scheduled_resource_reference_id\":{\"type\":\"string\",\"maxLength\":8,\"minLength\":6,\"title\":\"Scheduled Resource Reference Id\"},\"confirmation_number\":{\"type\":\"string\",\"maxLength\":9,\"minLength\":9,\"title\":\"Confirmation Number\",\"description\":\"Customer-facing confirmation number assigned once at creation and immutable for the life of the Appointment. 'SCH' followed by 6 upper-case alphanumeric characters, excluding 0/1/I/O, e.g. 'SCH8EH4L5'.\"},\"carrier_scac\":{\"type\":\"string\",\"maxLength\":256,\"title\":\"Carrier Scac\",\"description\":\"Standard Carrier Alpha Code of the assigned carrier, mirrored from the carrier's backend-core identifying codes beside `carrier_tenant_id` and `carrier_name`. Read-only, and eventually consistent like the rest of that copy: the shipment's carrier events refresh it, and they do not cover every appointment status. Null when there is no carrier, when the carrier has no SCAC, or when it has not been resolved yet.\",\"readOnly\":true}},\"type\":\"object\",\"required\":[\"id\",\"facility_id\",\"status\"],\"title\":\"Appointment\"},\"AppointmentApprovalRequest\":{\"properties\":{\"approved_start\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Approved Start\",\"description\":\"New start time for the approved appointment (optional)\"},\"approved_end\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Approved End\",\"description\":\"New end time for the approved appointment (optional)\"}},\"type\":\"object\",\"title\":\"AppointmentApprovalRequest\",\"description\":\"Request schema for approving a single appointment\"},\"AppointmentCheckInRequest\":{\"properties\":{\"checked_in_at\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}},\"type\":\"object\",\"required\":[\"checked_in_at\"],\"title\":\"AppointmentCheckInRequest\"},\"AppointmentCheckOutRequest\":{\"properties\":{\"checked_out_at\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}},\"type\":\"object\",\"required\":[\"checked_out_at\"],\"title\":\"AppointmentCheckOutRequest\"},\"AppointmentDeclineRequest\":{\"properties\":{\"declined_reasons\":{\"type\":\"string\",\"title\":\"Declined Reasons\",\"description\":\"Human-readable message describing why this appointment is being declined\"}},\"type\":\"object\",\"title\":\"AppointmentDeclineRequest\",\"description\":\"Request schema for declining a single appointment\"},\"AppointmentDocument\":{\"properties\":{\"id\":{\"type\":\"string\",\"title\":\"Id\"},\"appointment_id\":{\"type\":\"string\",\"title\":\"Appointment Id\"},\"document_type\":{\"$ref\":\"#/components/schemas/AppointmentDocumentTypeEnum\"},\"filename\":{\"type\":\"string\",\"title\":\"Filename\"},\"description\":{\"type\":\"string\",\"title\":\"Description\"},\"uploaded_by_user_id\":{\"type\":\"string\",\"title\":\"Uploaded By User Id\"},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Created At\"},\"updated_at\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Updated At\"}},\"type\":\"object\",\"required\":[\"id\",\"appointment_id\",\"document_type\",\"filename\",\"created_at\",\"updated_at\"],\"title\":\"AppointmentDocument\"},\"AppointmentDocumentDownloadUrl\":{\"properties\":{\"download_url\":{\"type\":\"string\",\"title\":\"Download Url\"},\"expires_in\":{\"type\":\"integer\",\"title\":\"Expires In\",\"description\":\"Seconds until download_url stops working.\"}},\"type\":\"object\",\"required\":[\"download_url\",\"expires_in\"],\"title\":\"AppointmentDocumentDownloadUrl\"},\"AppointmentDocumentList\":{\"properties\":{\"data\":{\"items\":{\"$ref\":\"#/components/schemas/AppointmentDocument\"},\"type\":\"array\",\"title\":\"Data\"},\"total_count\":{\"type\":\"integer\",\"title\":\"Total Count\"}},\"type\":\"object\",\"required\":[\"data\",\"total_count\"],\"title\":\"AppointmentDocumentList\"},\"AppointmentDocumentTypeEnum\":{\"type\":\"string\",\"enum\":[\"BOL\",\"PACKING_SLIPS\",\"DELIVERY_RECEIPT\",\"PURCHASE_ORDER\",\"OTHER\"],\"title\":\"AppointmentDocumentTypeEnum\",\"description\":\"Caller-declared type of a document attached to an appointment. Spelled like backend-core's\\n`ShipmentDocumentTypes` and corrogo's `DocumentType` where a literal match exists, so the\\nfacility required-documents check can compare across services without a mapping for these.\"},\"AppointmentListItem\":{\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Name\"},\"reason\":{\"allOf\":[{\"$ref\":\"#/components/schemas/AppointmentReason\"}],\"description\":\"Reason for the Appointment.\"},\"reference_id\":{\"type\":\"string\",\"title\":\"Reference Id\"},\"description\":{\"type\":\"string\",\"title\":\"Description\"},\"is_all_day\":{\"type\":\"boolean\",\"title\":\"Is All Day\",\"description\":\"If true, indicates that the Appointment's start/end should equal the operating hours of the Facility/Dock at which it is scheduled.\",\"default\":false},\"matched_load_type_id\":{\"type\":\"string\",\"title\":\"Matched Load Type Id\",\"description\":\"ID of the LoadType whose fields should be used to determine if it matches an Appointment.\"},\"references\":{\"items\":{\"$ref\":\"#/components/schemas/Reference\"},\"type\":\"array\",\"title\":\"References\",\"description\":\"List of references for the appointment that can be used to search for the appointment later.\",\"default\":[]},\"start\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"end\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"stop_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Stop Id\"},\"carrier_name\":{\"type\":\"string\",\"title\":\"Carrier Name\"},\"carrier_contact\":{\"type\":\"string\",\"title\":\"Carrier Contact\"},\"carrier_tenant_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Carrier Tenant Id\"},\"driver_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Driver Id\"},\"appointment_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/FacilityAppointmentType\"}],\"default\":\"BY_APPOINTMENT_ONLY\"},\"delivery_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DeliveryTypeEnum\"}],\"description\":\"Whether the delivery type is loading or unloading Freight.\"},\"scheduled_resource_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/ScheduledResourceTypeEnum\"}],\"description\":\"Required when the scheduled_resource_id field is provided.\"},\"scheduled_resource_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Scheduled Resource Id\"},\"scheduled_resource_metadata\":{\"oneOf\":[{\"$ref\":\"#/components/schemas/FreightAppointmentScheduledResource\"},{\"$ref\":\"#/components/schemas/ShipmentAppointmentScheduledResource\"}],\"title\":\"Scheduled Resource Metadata\",\"description\":\"Additional details about the resource for which this Appointment is scheduling, or null if the Appointment does not relate to any scheduled resource. For example, if this Appointment relates to a Shipment, these details will be described by a ShipmentAppointmentScheduledResource. Or if the Appointment is managing off-platform freight, the details will instead be described using the FreightAppointmentScheduledResource schema.\",\"discriminator\":{\"propertyName\":\"resource_type\",\"mapping\":{\"FREIGHT_GENERAL\":\"#/components/schemas/FreightAppointmentScheduledResource\",\"SHIPMENT\":\"#/components/schemas/ShipmentAppointmentScheduledResource\"}}},\"notes\":{\"type\":\"string\",\"title\":\"Notes\"},\"id\":{\"type\":\"string\",\"maxLength\":26,\"minLength\":26,\"title\":\"Id\"},\"facility_id\":{\"type\":\"string\",\"title\":\"Facility Id\",\"description\":\"Facility at which the appointment takes place\"},\"dock_id\":{\"type\":\"string\",\"title\":\"Dock Id\",\"description\":\"Dock at which the appointment is scheduled, or null if the appointment is not scheduled for any specific dock.\"},\"status\":{\"$ref\":\"#/components/schemas/AppointmentStatusEnum\"},\"is_closed\":{\"type\":\"boolean\",\"title\":\"Is Closed\",\"description\":\"Check the status of appointment to see why it's closed.\"},\"created_by\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Created By\",\"description\":\"Unique identifier of Entity creating the appointment. e.g. Freight Authority ID, User, Company, System, etc.\"},\"deleted_by\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Deleted By\",\"description\":\"Unique identifier of Entity creating the appointment. e.g. Freight Authority ID, User, Company, System, etc.\"},\"checked_in_at\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"checked_in_by_user_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Checked In By User Id\"},\"checked_out_at\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"checked_out_by_user_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Checked Out By User Id\"},\"dock_in_at\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Dock In At\",\"description\":\"When the truck moved onto the dock. Free-form: not validated against the other timestamps or the appointment window, and it does not change the status.\"},\"dock_out_at\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Dock Out At\",\"description\":\"When the truck left the dock. Same freedom as `dock_in_at`.\"},\"actual_start_at\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Actual Start At\",\"description\":\"When loading or unloading actually began, as opposed to `start`.\"},\"actual_stop_at\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Actual Stop At\",\"description\":\"When loading or unloading actually finished, as opposed to `end`.\"},\"rejected_at\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"rejected_reasons\":{\"type\":\"string\",\"title\":\"Rejected Reasons\"},\"declined_at\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"declined_reasons\":{\"type\":\"string\",\"title\":\"Declined Reasons\"},\"declined_by_user_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Declined By User Id\"},\"requested_at\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"requested_by_user_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Requested By User Id\"},\"request_note\":{\"type\":\"string\",\"title\":\"Request Note\",\"description\":\"Message from the requester, set when the appointment was submitted as a time request.\"},\"scheduled_resource_reference_id\":{\"type\":\"string\",\"maxLength\":8,\"minLength\":6,\"title\":\"Scheduled Resource Reference Id\"},\"confirmation_number\":{\"type\":\"string\",\"maxLength\":9,\"minLength\":9,\"title\":\"Confirmation Number\",\"description\":\"Customer-facing confirmation number assigned once at creation and immutable for the life of the Appointment. 'SCH' followed by 6 upper-case alphanumeric characters, excluding 0/1/I/O, e.g. 'SCH8EH4L5'.\"},\"carrier_scac\":{\"type\":\"string\",\"maxLength\":256,\"title\":\"Carrier Scac\",\"description\":\"Standard Carrier Alpha Code of the assigned carrier, mirrored from the carrier's backend-core identifying codes beside `carrier_tenant_id` and `carrier_name`. Read-only, and eventually consistent like the rest of that copy: the shipment's carrier events refresh it, and they do not cover every appointment status. Null when there is no carrier, when the carrier has no SCAC, or when it has not been resolved yet.\",\"readOnly\":true},\"shipment\":{\"$ref\":\"#/components/schemas/AppointmentShipmentData\"},\"planning\":{\"allOf\":[{\"$ref\":\"#/components/schemas/AppointmentPlanning\"}],\"title\":\"Planning\",\"description\":\"Planning lock state and staged preview; null when the appointment has no active planning lock.\"}},\"type\":\"object\",\"required\":[\"id\",\"facility_id\",\"status\"],\"title\":\"AppointmentListItem\",\"description\":\"Appointment schema for list responses — excludes appointment_orders for performance.\"},\"AppointmentLock\":{\"properties\":{\"planning_session_id\":{\"type\":\"string\",\"title\":\"Planning Session Id\"},\"locked_by_user_id\":{\"type\":\"string\",\"title\":\"Locked By User Id\"},\"locked_by_display_name\":{\"type\":\"string\",\"title\":\"Locked By Display Name\"},\"planned_new_start\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Planned New Start\"},\"planned_new_end\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Planned New End\"},\"planned_new_dock\":{\"type\":\"string\",\"title\":\"Planned New Dock\"}},\"type\":\"object\",\"required\":[\"planning_session_id\",\"locked_by_user_id\",\"planned_new_start\",\"planned_new_end\"],\"title\":\"AppointmentLock\",\"description\":\"A planning session's hold on an appointment: the owning plan and its staged date/time/dock.\"},\"AppointmentPlanning\":{\"properties\":{\"is_locked\":{\"type\":\"boolean\",\"title\":\"Is Locked\",\"default\":false},\"locks\":{\"items\":{\"$ref\":\"#/components/schemas/AppointmentLock\"},\"type\":\"array\",\"title\":\"Locks\"}},\"type\":\"object\",\"title\":\"AppointmentPlanning\",\"description\":\"Planning lock state for an appointment: `is_locked`, and the `locks` holding it.\"},\"AppointmentReason\":{\"type\":\"string\",\"enum\":[\"PRE_LOAD\",\"MAINTENANCE\",\"FREIGHT\",\"STAGING\",\"OTHER\"],\"title\":\"AppointmentReason\",\"description\":\"An enumeration.\"},\"AppointmentRejectRequest\":{\"properties\":{\"rejected_reasons\":{\"type\":\"string\",\"title\":\"Rejected Reasons\",\"description\":\"Human-readable message describing why this appointment is being rejected\"}},\"type\":\"object\",\"title\":\"AppointmentRejectRequest\"},\"AppointmentShipmentData\":{\"properties\":{\"reference_id\":{\"type\":\"string\",\"title\":\"Reference Id\"},\"bol_number\":{\"type\":\"string\",\"title\":\"Bol Number\"},\"customer_reference_number\":{\"type\":\"string\",\"title\":\"Customer Reference Number\"},\"pro_number\":{\"type\":\"string\",\"title\":\"Pro Number\"},\"purchase_order_number\":{\"type\":\"string\",\"title\":\"Purchase Order Number\"},\"order_number\":{\"type\":\"string\",\"title\":\"Order Number\"},\"related_orders\":{\"items\":{\"$ref\":\"#/components/schemas/BeCoreRelatedOrder\"},\"type\":\"array\",\"title\":\"Related Orders\"},\"mode\":{\"$ref\":\"#/components/schemas/BeCoreShipmentModeObj\"},\"equipment_type\":{\"$ref\":\"#/components/schemas/BeCoreEquipmentTypeObj\"},\"temperature_lower_limit\":{\"type\":\"number\",\"title\":\"Temperature Lower Limit\"},\"temperature_upper_limit\":{\"type\":\"number\",\"title\":\"Temperature Upper Limit\"},\"temperature_unit\":{\"type\":\"string\",\"title\":\"Temperature Unit\"},\"drayage_seal_number\":{\"type\":\"string\",\"title\":\"Drayage Seal Number\"},\"drayage_carrier_scac_code\":{\"type\":\"string\",\"title\":\"Drayage Carrier Scac Code\"},\"trailer_name\":{\"type\":\"string\",\"title\":\"Trailer Name\"},\"custom_data\":{\"type\":\"object\",\"title\":\"Custom Data\"},\"product_categories\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"title\":\"Product Categories\"},\"product_reference\":{\"type\":\"string\",\"title\":\"Product Reference\"},\"stop\":{\"$ref\":\"#/components/schemas/BeCoreStop\"},\"equipment_config\":{\"$ref\":\"#/components/schemas/BECoreEquipmentConfig\"},\"relationship_to_vendor\":{\"$ref\":\"#/components/schemas/BeCoreVendorAssignment\"},\"line_items\":{\"items\":{\"$ref\":\"#/components/schemas/BeCoreShipmentLineItem\"},\"type\":\"array\",\"title\":\"Line Items\"},\"description\":{\"type\":\"string\",\"title\":\"Description\"},\"notes_for_carrier\":{\"type\":\"string\",\"title\":\"Notes For Carrier\"},\"total_weight_override\":{\"$ref\":\"#/components/schemas/BeCoreWeightOverride\"},\"total_quantity_override\":{\"type\":\"number\",\"title\":\"Total Quantity Override\"},\"customer\":{\"$ref\":\"#/components/schemas/BeCoreCompany\"},\"current_carrier\":{\"$ref\":\"#/components/schemas/BeCoreCompany\"},\"is_hazmat\":{\"type\":\"boolean\",\"title\":\"Is Hazmat\"},\"total_pieces\":{\"type\":\"integer\",\"title\":\"Total Pieces\"},\"origin\":{\"$ref\":\"#/components/schemas/BeCoreStopLocation\"},\"destination\":{\"$ref\":\"#/components/schemas/BeCoreStopLocation\"}},\"type\":\"object\",\"title\":\"AppointmentShipmentData\",\"description\":\"Shipment-sourced fields embedded on an appointment: on each list item, and on the PATCH\\nresponse. Mirrors the backend-core shipment structure.\"},\"AppointmentStatusEnum\":{\"type\":\"string\",\"enum\":[\"TEMP_DRAFT\",\"UNSCHEDULED\",\"SCHEDULED\",\"RESCHEDULED\",\"CANCELLED\",\"ARRIVED\",\"ARRIVED_LATE\",\"DELAYED\",\"DOCK_IN_USE\",\"REJECTED\",\"REQUESTED\",\"NO_SHOW\",\"COMPLETED\",\"DOCK_IS_READY\"],\"title\":\"AppointmentStatusEnum\",\"description\":\"An enumeration.\"},\"Availability\":{\"properties\":{\"available_windows\":{\"items\":{\"$ref\":\"#/components/schemas/AvailabilityWindow\"},\"type\":\"array\",\"title\":\"Available Windows\"},\"load_type_dock_rule_match_results\":{\"allOf\":[{\"$ref\":\"#/components/schemas/LoadTypeDockRuleMatchResults\"}],\"title\":\"Load Type Dock Rule Match Results\",\"description\":\"Dock rules and LoadTypes that match the requested freight criteria. Will be null if Availability was searched without regard to any particular criteria such as mode, equipment_type, or a specific shipment_id.\"},\"availability_restrictions\":{\"items\":{\"$ref\":\"#/components/schemas/AvailabilityRestriction\"},\"type\":\"array\",\"title\":\"Availability Restrictions\",\"description\":\"List of restrictions that collectively determined the returned availability windows (and lack thereof). Each record in this list represents an individual rule violation during some timespan when that rule would apply. For example, you might see a record whose fields collectively describe the situation: 'Dock {some_dock_id} will be unavailable from 08:00-12:30 on Jan 5 2022 because it has already reached its max appointment capacity.' It is possible for multiple restrictions to be enforced over the same time period. For example, you could have one restriction on Dec 25, 2022 like 'Facility closes at 5pm' and another restriction that overlaps with the first because 'Facility is closed on Christmas Day.'\"}},\"type\":\"object\",\"required\":[\"available_windows\",\"availability_restrictions\"],\"title\":\"Availability\"},\"AvailabilityIncludeParams\":{\"type\":\"string\",\"enum\":[\"load_type_dock_rule_match_results.best_matched_load_type\",\"load_type_dock_rule_match_results.all_matched_dock_rules\"],\"title\":\"AvailabilityIncludeParams\",\"description\":\"An enumeration.\"},\"AvailabilityRequest\":{\"oneOf\":[{\"$ref\":\"#/components/schemas/FreightAppointmentAvailabilityRequest\"},{\"$ref\":\"#/components/schemas/ShipmentAvailabilityRequest\"},{\"$ref\":\"#/components/schemas/NoCriteriaAvailabilityRequest\"}],\"title\":\"AvailabilityRequest\",\"discriminator\":{\"propertyName\":\"request_criteria_type\",\"mapping\":{\"FREIGHT_GENERAL\":\"#/components/schemas/FreightAppointmentAvailabilityRequest\",\"SHIPMENT\":\"#/components/schemas/ShipmentAvailabilityRequest\",\"NO_CRITERIA\":\"#/components/schemas/NoCriteriaAvailabilityRequest\"}}},\"AvailabilityRestriction\":{\"properties\":{\"dock_id\":{\"type\":\"string\",\"title\":\"Dock Id\",\"description\":\"ID of the Dock at which this restriction takes place, or null if this gap modifies generalized Facility availability not specific to any Dock.\"},\"start\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Start\",\"description\":\"Start of the restriction, inclusive of this timestamp. For example, if the start is at 00:00:00, this means that this rule will be violated starting at that time.\",\"example\":\"2023-03-06T00:00:00-06:00\"},\"end\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"End\",\"description\":\"End of the restriction, exclusive of this timestamp. For example, if the end is at 08:00:00, this means that this restriction restricts availability up until that instant, and is no longer applicable once the clock strikes 08:00:00.\",\"example\":\"2023-03-06T08:00:00-06:00\"},\"reason\":{\"type\":\"string\",\"title\":\"Reason\",\"description\":\"Human-readable description of why this chunk of time is not available\",\"example\":\"Facility opens at 08:00:00\"}},\"type\":\"object\",\"required\":[\"start\",\"end\",\"reason\"],\"title\":\"AvailabilityRestriction\",\"description\":\"A constraint enforced by scheduling rules that marks a certain span of availability as \\\"not available.\\\" This will\\nhave a human-readable reason explaining why this span is not available.\"},\"AvailabilityWindow\":{\"properties\":{\"start\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Start\",\"description\":\"Start of the availability, inclusive of this timestamp. For example, if the start is at 08:00:00, this means that a location is available at that time.\"},\"end\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"End\",\"description\":\"End of the availability, exclusive of this timestamp. For example, if the end is at 09:00:00, this means that a location is available up until that instant, but IS NOT available when the clock strikes 09:00:00.\"},\"dock_id\":{\"type\":\"string\",\"title\":\"Dock Id\",\"description\":\"ID of the Dock at which this availability takes place, or null if this availability represents generalized Facility availability not specific to any Dock.\"}},\"type\":\"object\",\"required\":[\"start\",\"end\"],\"title\":\"AvailabilityWindow\"},\"BECoreDriver\":{\"properties\":{\"id\":{\"type\":\"string\",\"title\":\"Id\"},\"first_name\":{\"type\":\"string\",\"title\":\"First Name\"},\"last_name\":{\"type\":\"string\",\"title\":\"Last Name\"},\"phone_number\":{\"type\":\"string\",\"title\":\"Phone Number\"}},\"type\":\"object\",\"required\":[\"id\"],\"title\":\"BECoreDriver\"},\"BECoreEquipmentConfig\":{\"properties\":{\"id\":{\"type\":\"string\",\"title\":\"Id\"},\"driver\":{\"$ref\":\"#/components/schemas/BECoreDriver\"},\"trailer\":{\"$ref\":\"#/components/schemas/BeCoreTrailer\"},\"power_unit\":{\"$ref\":\"#/components/schemas/BeCorePowerUnit\"}},\"type\":\"object\",\"required\":[\"id\"],\"title\":\"BECoreEquipmentConfig\"},\"BeCoreCompany\":{\"properties\":{\"id\":{\"type\":\"string\",\"title\":\"Id\"},\"name\":{\"type\":\"string\",\"title\":\"Name\"},\"dba_name\":{\"type\":\"string\",\"title\":\"Dba Name\"}},\"type\":\"object\",\"required\":[\"id\"],\"title\":\"BeCoreCompany\",\"description\":\"Slim company representation backing both `BeCoreShipment.customer` and `.current_carrier`\\n(backend-core renders both via `SlimCompanySerializer`).\"},\"BeCoreEquipmentTypeObj\":{\"properties\":{\"id\":{\"type\":\"integer\",\"title\":\"Id\"},\"machine_readable\":{\"$ref\":\"#/components/schemas/DockSchedulingEquipmentTypeEnum\"},\"name\":{\"type\":\"string\",\"title\":\"Name\"}},\"type\":\"object\",\"required\":[\"id\",\"machine_readable\",\"name\"],\"title\":\"BeCoreEquipmentTypeObj\"},\"BeCoreIdentifyingCode\":{\"properties\":{\"type\":{\"type\":\"string\",\"title\":\"Type\"},\"value\":{\"type\":\"string\",\"title\":\"Value\"}},\"type\":\"object\",\"required\":[\"type\",\"value\"],\"title\":\"BeCoreIdentifyingCode\"},\"BeCorePowerUnit\":{\"properties\":{\"id\":{\"type\":\"string\",\"title\":\"Id\"},\"name\":{\"type\":\"string\",\"title\":\"Name\"},\"description\":{\"type\":\"string\",\"title\":\"Description\"}},\"type\":\"object\",\"required\":[\"id\"],\"title\":\"BeCorePowerUnit\"},\"BeCoreRelatedOrder\":{\"properties\":{\"order_id\":{\"type\":\"string\",\"title\":\"Order Id\"},\"order_number\":{\"type\":\"string\",\"title\":\"Order Number\"},\"order_type\":{\"type\":\"string\",\"title\":\"Order Type\"},\"custom_data\":{\"type\":\"object\",\"title\":\"Custom Data\"}},\"type\":\"object\",\"title\":\"BeCoreRelatedOrder\"},\"BeCoreShipment\":{\"properties\":{\"id\":{\"type\":\"string\",\"title\":\"Id\"},\"state\":{\"type\":\"string\",\"title\":\"State\"},\"stops\":{\"items\":{\"$ref\":\"#/components/schemas/BeCoreStop\"},\"type\":\"array\",\"title\":\"Stops\"},\"line_items\":{\"items\":{\"$ref\":\"#/components/schemas/BeCoreShipmentLineItem\"},\"type\":\"array\",\"title\":\"Line Items\"},\"metadata\":{\"$ref\":\"#/components/schemas/BeCoreShipmentMetadata\"},\"mode\":{\"$ref\":\"#/components/schemas/BeCoreShipmentModeObj\"},\"equipment_type\":{\"$ref\":\"#/components/schemas/BeCoreEquipmentTypeObj\"},\"equipment_config\":{\"$ref\":\"#/components/schemas/BECoreEquipmentConfig\"},\"relationship_to_vendor\":{\"$ref\":\"#/components/schemas/BeCoreVendorAssignment\"},\"reference_id\":{\"type\":\"string\",\"title\":\"Reference Id\"},\"bol_number\":{\"type\":\"string\",\"title\":\"Bol Number\"},\"customer_reference_number\":{\"type\":\"string\",\"title\":\"Customer Reference Number\"},\"pro_number\":{\"type\":\"string\",\"title\":\"Pro Number\"},\"purchase_order_number\":{\"type\":\"string\",\"title\":\"Purchase Order Number\"},\"order_number\":{\"type\":\"string\",\"title\":\"Order Number\"},\"drayage_carrier_scac_code\":{\"type\":\"string\",\"title\":\"Drayage Carrier Scac Code\"},\"temperature_lower_limit\":{\"type\":\"number\",\"title\":\"Temperature Lower Limit\"},\"temperature_upper_limit\":{\"type\":\"number\",\"title\":\"Temperature Upper Limit\"},\"temperature_unit\":{\"type\":\"string\",\"title\":\"Temperature Unit\"},\"drayage_seal_number\":{\"type\":\"string\",\"title\":\"Drayage Seal Number\"},\"trailer_name\":{\"type\":\"string\",\"title\":\"Trailer Name\"},\"custom_data\":{\"type\":\"object\",\"title\":\"Custom Data\"},\"related_orders\":{\"items\":{\"$ref\":\"#/components/schemas/BeCoreRelatedOrder\"},\"type\":\"array\",\"title\":\"Related Orders\"},\"description\":{\"type\":\"string\",\"title\":\"Description\"},\"notes_for_carrier\":{\"type\":\"string\",\"title\":\"Notes For Carrier\"},\"total_weight_override\":{\"$ref\":\"#/components/schemas/BeCoreWeightOverride\"},\"total_quantity_override\":{\"type\":\"number\",\"title\":\"Total Quantity Override\"},\"customer\":{\"$ref\":\"#/components/schemas/BeCoreCompany\"},\"current_carrier\":{\"$ref\":\"#/components/schemas/BeCoreCompany\"}},\"type\":\"object\",\"required\":[\"id\",\"state\",\"stops\",\"line_items\",\"metadata\",\"mode\",\"equipment_type\"],\"title\":\"BeCoreShipment\"},\"BeCoreShipmentLineItem\":{\"properties\":{\"id\":{\"type\":\"string\",\"title\":\"Id\"},\"total_packages\":{\"type\":\"number\",\"title\":\"Total Packages\"},\"package_type\":{\"$ref\":\"#/components/schemas/PackagingTypes\"},\"product_ref\":{\"type\":\"string\",\"title\":\"Product Ref\"},\"product_category\":{\"type\":\"string\",\"title\":\"Product Category\"},\"stackable\":{\"type\":\"boolean\",\"title\":\"Stackable\"},\"hazmat_identification_number\":{\"type\":\"string\",\"title\":\"Hazmat Identification Number\"},\"total_pieces\":{\"type\":\"integer\",\"title\":\"Total Pieces\"},\"package_weight\":{\"type\":\"number\",\"title\":\"Package Weight\"},\"weight_unit\":{\"type\":\"string\",\"title\":\"Weight Unit\"},\"height\":{\"type\":\"number\",\"title\":\"Height\"},\"width\":{\"type\":\"number\",\"title\":\"Width\"},\"length\":{\"type\":\"number\",\"title\":\"Length\"},\"length_unit\":{\"type\":\"string\",\"title\":\"Length Unit\"},\"custom_data\":{\"type\":\"object\",\"title\":\"Custom Data\"},\"description\":{\"type\":\"string\",\"title\":\"Description\"},\"formatted_description\":{\"type\":\"string\",\"title\":\"Formatted Description\"}},\"type\":\"object\",\"required\":[\"id\",\"total_packages\",\"package_type\",\"product_ref\",\"product_category\",\"stackable\",\"hazmat_identification_number\"],\"title\":\"BeCoreShipmentLineItem\"},\"BeCoreShipmentMetadata\":{\"properties\":{\"archived\":{\"type\":\"boolean\",\"title\":\"Archived\"}},\"type\":\"object\",\"required\":[\"archived\"],\"title\":\"BeCoreShipmentMetadata\"},\"BeCoreShipmentModeObj\":{\"properties\":{\"id\":{\"type\":\"integer\",\"title\":\"Id\"},\"code\":{\"$ref\":\"#/components/schemas/DockSchedulingModeEnum\"},\"description\":{\"type\":\"string\",\"title\":\"Description\"}},\"type\":\"object\",\"required\":[\"id\",\"code\",\"description\"],\"title\":\"BeCoreShipmentModeObj\"},\"BeCoreStop\":{\"properties\":{\"id\":{\"type\":\"string\",\"title\":\"Id\"},\"is_pickup\":{\"type\":\"boolean\",\"title\":\"Is Pickup\"},\"is_dropoff\":{\"type\":\"boolean\",\"title\":\"Is Dropoff\"},\"planned_date\":{\"type\":\"string\",\"format\":\"date\",\"title\":\"Planned Date\"},\"planned_time_window_start\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"Planned Time Window Start\"},\"planned_time_window_end\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"Planned Time Window End\"},\"location\":{\"$ref\":\"#/components/schemas/BeCoreStopLocation\"},\"custom_data\":{\"type\":\"object\",\"title\":\"Custom Data\"},\"planning_window\":{\"$ref\":\"#/components/schemas/BeCoreStopPlanningWindow\"},\"instructions\":{\"type\":\"string\",\"title\":\"Instructions\"},\"internal_notes\":{\"type\":\"string\",\"title\":\"Internal Notes\"},\"sequence_number\":{\"type\":\"integer\",\"title\":\"Sequence Number\"}},\"type\":\"object\",\"required\":[\"id\",\"is_pickup\",\"is_dropoff\",\"location\",\"planning_window\"],\"title\":\"BeCoreStop\"},\"BeCoreStopAddress\":{\"properties\":{\"timezone\":{\"type\":\"string\",\"title\":\"Timezone\"},\"city\":{\"type\":\"string\",\"title\":\"City\"},\"state_province\":{\"type\":\"string\",\"title\":\"State Province\"}},\"type\":\"object\",\"title\":\"BeCoreStopAddress\"},\"BeCoreStopLocation\":{\"properties\":{\"created_using_address_book_entry_id\":{\"type\":\"string\",\"title\":\"Created Using Address Book Entry Id\"},\"address_book_entry_reference_id\":{\"type\":\"string\",\"title\":\"Address Book Entry Reference Id\"},\"facility_id\":{\"type\":\"string\",\"title\":\"Facility Id\"},\"company_name\":{\"type\":\"string\",\"title\":\"Company Name\"},\"identification_code\":{\"type\":\"string\",\"title\":\"Identification Code\"},\"address\":{\"$ref\":\"#/components/schemas/BeCoreStopAddress\"},\"custom_data\":{\"type\":\"object\",\"title\":\"Custom Data\"}},\"type\":\"object\",\"title\":\"BeCoreStopLocation\"},\"BeCoreStopPlanningWindow\":{\"properties\":{\"start\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Start\"},\"end\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"End\"}},\"type\":\"object\",\"title\":\"BeCoreStopPlanningWindow\"},\"BeCoreTrailer\":{\"properties\":{\"id\":{\"type\":\"string\",\"title\":\"Id\"},\"name\":{\"type\":\"string\",\"title\":\"Name\"},\"description\":{\"type\":\"string\",\"title\":\"Description\"}},\"type\":\"object\",\"required\":[\"id\"],\"title\":\"BeCoreTrailer\"},\"BeCoreVendorAssignment\":{\"properties\":{\"vendor\":{\"$ref\":\"#/components/schemas/BeCoreVendorAssignmentCompany\"}},\"type\":\"object\",\"required\":[\"vendor\"],\"title\":\"BeCoreVendorAssignment\"},\"BeCoreVendorAssignmentCompany\":{\"properties\":{\"id\":{\"type\":\"string\",\"title\":\"Id\"},\"name\":{\"type\":\"string\",\"title\":\"Name\"},\"identifying_codes\":{\"items\":{\"$ref\":\"#/components/schemas/BeCoreIdentifyingCode\"},\"type\":\"array\",\"title\":\"Identifying Codes\"}},\"type\":\"object\",\"required\":[\"id\",\"name\"],\"title\":\"BeCoreVendorAssignmentCompany\"},\"BeCoreWeightOverride\":{\"properties\":{\"value\":{\"type\":\"number\",\"title\":\"Value\"},\"unit\":{\"type\":\"string\",\"title\":\"Unit\"}},\"type\":\"object\",\"title\":\"BeCoreWeightOverride\",\"description\":\"Shape of `BeCoreShipment.total_weight_override` — a user-entered override of the shipment's\\ncomputed total weight. `value` is commonly null (no override set); see `get_total_weight`.\"},\"Body_create_facility_document_facilities__facility_id__documents_post\":{\"properties\":{\"file\":{\"type\":\"string\",\"format\":\"binary\",\"title\":\"File\"},\"document_type\":{\"type\":\"string\",\"title\":\"Document Type\",\"default\":\"OTHER\"},\"description\":{\"type\":\"string\",\"title\":\"Description\"}},\"type\":\"object\",\"required\":[\"file\"],\"title\":\"Body_create_facility_document_facilities__facility_id__documents_post\"},\"Body_upload_appointment_document_facilities_appointments__appointment_id__documents_post\":{\"properties\":{\"file\":{\"type\":\"string\",\"format\":\"binary\",\"title\":\"File\"},\"document_type\":{\"$ref\":\"#/components/schemas/AppointmentDocumentTypeEnum\"},\"description\":{\"type\":\"string\",\"title\":\"Description\"}},\"type\":\"object\",\"required\":[\"file\",\"document_type\"],\"title\":\"Body_upload_appointment_document_facilities_appointments__appointment_id__documents_post\"},\"BulkUpdateFacilityCapacityLimitsRequest\":{\"properties\":{\"capacity_limits\":{\"items\":{\"$ref\":\"#/components/schemas/CreateFacilityCapacityLimit\"},\"type\":\"array\",\"title\":\"Capacity Limits\"}},\"type\":\"object\",\"required\":[\"capacity_limits\"],\"title\":\"BulkUpdateFacilityCapacityLimitsRequest\",\"description\":\"Request body for situations in which a client wants to replace all FacilityCapacityLimits on a\\nsingle Facility in a single request. An empty list clears the Facility's configuration.\"},\"BulkUpdateHoursOfOperationRequest\":{\"properties\":{\"hours_of_operation\":{\"items\":{\"$ref\":\"#/components/schemas/CreateFacilityHoursOfOperation\"},\"type\":\"array\",\"title\":\"Hours Of Operation\"}},\"type\":\"object\",\"required\":[\"hours_of_operation\"],\"title\":\"BulkUpdateHoursOfOperationRequest\",\"description\":\"Request body for situations in which a client wants to update all FacilityHoursOfOperation on a single Facility\\nin a single request.\"},\"ConflictPair\":{\"properties\":{\"appointment_id\":{\"type\":\"string\",\"title\":\"Appointment Id\"},\"conflicting_appointment_id\":{\"type\":\"string\",\"title\":\"Conflicting Appointment Id\"}},\"type\":\"object\",\"required\":[\"appointment_id\",\"conflicting_appointment_id\"],\"title\":\"ConflictPair\"},\"CorrogoMeasurement\":{\"properties\":{\"value\":{\"type\":\"string\",\"title\":\"Value\"},\"unit\":{\"type\":\"string\",\"title\":\"Unit\"}},\"type\":\"object\",\"title\":\"CorrogoMeasurement\",\"description\":\"corrogo renders both `item.amount` and `gross_weight` as `{value, unit}`.\\n\\n`value` stays a string: corrogo serialises a `Decimal`, and a float would round quantities.\\n`unit` stays a plain string: `amount.unit` is usually a packaging type but not always — real\\nrows carry weight units too, so a `PackagingType` enum would reject them.\"},\"CorrogoOrder\":{\"properties\":{\"id\":{\"type\":\"string\",\"title\":\"Id\"},\"order_number\":{\"type\":\"string\",\"title\":\"Order Number\"},\"order_type\":{\"type\":\"string\",\"title\":\"Order Type\"},\"name\":{\"type\":\"string\",\"title\":\"Name\"},\"status\":{\"type\":\"string\",\"title\":\"Status\"},\"references\":{\"items\":{\"$ref\":\"#/components/schemas/CorrogoOrderReference\"},\"type\":\"array\",\"title\":\"References\",\"default\":[]},\"customer\":{\"$ref\":\"#/components/schemas/CorrogoOrderParty\"},\"supplier\":{\"$ref\":\"#/components/schemas/CorrogoOrderParty\"},\"shipping_requirements\":{\"$ref\":\"#/components/schemas/CorrogoOrderShippingRequirements\"},\"ship_from\":{\"$ref\":\"#/components/schemas/CorrogoOrderStop\"},\"ship_to\":{\"$ref\":\"#/components/schemas/CorrogoOrderStop\"},\"items\":{\"items\":{\"$ref\":\"#/components/schemas/CorrogoOrderItem\"},\"type\":\"array\",\"title\":\"Items\",\"default\":[]}},\"type\":\"object\",\"required\":[\"id\",\"order_number\",\"status\"],\"title\":\"CorrogoOrder\",\"description\":\"The order half of a reference-search match, narrowed to what the Link Reference Numbers card\\nrenders. Names and nesting follow corrogo's order contract so the consumer can reuse its\\ncorrogo types.\\n\\nThis schema is the allow-list: `to_corrogo_order` runs a full corrogo order through `parse_obj`,\\nso anything absent here is dropped. Excluded: `custom_data` at every level (the owner's private\\ncustom-field values; this caller can be out-of-tenant), `releases[]` (unbounded), `tags[]`,\\n`groups[]`, `charges`, `description`, `start_date`, `expiration_date`.\"},\"CorrogoOrderItem\":{\"properties\":{\"description\":{\"type\":\"string\",\"title\":\"Description\"},\"amount\":{\"$ref\":\"#/components/schemas/CorrogoMeasurement\"},\"shipping_requirements\":{\"$ref\":\"#/components/schemas/CorrogoOrderItemShippingRequirements\"}},\"type\":\"object\",\"title\":\"CorrogoOrderItem\",\"description\":\"One row of the card's Items table: QTY, DESCRIPTION, PACKAGING, WEIGHT.\\n\\n`packaging_type` and `gross_weight` are frequently null, so PACKAGING falls back to\\n`amount.unit` and WEIGHT has to render empty.\\n\\nOmits `id` (no per-row action, and this caller is not authorized against corrogo),\\n`product_category`, `total_pieces` and `references[]` — `PRODUCT_REF`, an exact per-line SKU\\nthat no column shows.\"},\"CorrogoOrderItemShippingRequirements\":{\"properties\":{\"packaging_type\":{\"type\":\"string\",\"title\":\"Packaging Type\"},\"gross_weight\":{\"$ref\":\"#/components/schemas/CorrogoMeasurement\"}},\"type\":\"object\",\"title\":\"CorrogoOrderItemShippingRequirements\"},\"CorrogoOrderParty\":{\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Name\"}},\"type\":\"object\",\"title\":\"CorrogoOrderParty\",\"description\":\"Subset of corrogo's `OrderSupplier` / `OrderCustomer`.\"},\"CorrogoOrderReference\":{\"properties\":{\"qualifier\":{\"type\":\"string\",\"title\":\"Qualifier\"},\"value\":{\"type\":\"string\",\"title\":\"Value\"}},\"type\":\"object\",\"required\":[\"qualifier\",\"value\"],\"title\":\"CorrogoOrderReference\"},\"CorrogoOrderShippingRequirements\":{\"properties\":{\"ship_by_date\":{\"type\":\"string\",\"title\":\"Ship By Date\"},\"required_delivery_date\":{\"type\":\"string\",\"title\":\"Required Delivery Date\"},\"references\":{\"items\":{\"$ref\":\"#/components/schemas/CorrogoOrderShippingRequirementsReference\"},\"type\":\"array\",\"title\":\"References\",\"default\":[]}},\"type\":\"object\",\"title\":\"CorrogoOrderShippingRequirements\",\"description\":\"The card's `Required` dates and `Pickup #`. `ship_by_date` maps to the ship-from `Required`,\\n`required_delivery_date` to the ship-to one; both are order-level, so neither can vary per stop.\\n\\nDates stay strings. corrogo normalises them, so a date-only entry comes back as midnight UTC —\\ntreat such a value as a date, or it renders as the previous evening in any US timezone.\\n\\nOmits `bill_to` (the owner's billing party and account number), `temperature` and\\n`non_managed_freight`.\"},\"CorrogoOrderShippingRequirementsReference\":{\"properties\":{\"qualifier\":{\"type\":\"string\",\"title\":\"Qualifier\"},\"value\":{\"anyOf\":[{\"type\":\"string\"},{\"items\":{\"type\":\"string\"},\"type\":\"array\"}],\"title\":\"Value\"}},\"type\":\"object\",\"required\":[\"qualifier\",\"value\"],\"title\":\"CorrogoOrderShippingRequirementsReference\",\"description\":\"The card's `Pickup #` (`qualifier` `PICKUP_NUMBER`). corrogo types `value` as a string or a\\nlist of strings, so both are accepted.\"},\"CorrogoOrderStop\":{\"properties\":{\"company_name\":{\"type\":\"string\",\"title\":\"Company Name\"},\"location_name\":{\"type\":\"string\",\"title\":\"Location Name\"},\"line_1\":{\"type\":\"string\",\"title\":\"Line 1\"},\"line_2\":{\"type\":\"string\",\"title\":\"Line 2\"},\"locality\":{\"type\":\"string\",\"title\":\"Locality\"},\"region\":{\"type\":\"string\",\"title\":\"Region\"},\"postal_code\":{\"type\":\"string\",\"title\":\"Postal Code\"},\"timezone\":{\"type\":\"string\",\"title\":\"Timezone\"},\"shipping_requirements\":{\"$ref\":\"#/components/schemas/CorrogoOrderStopShippingRequirements\"}},\"type\":\"object\",\"title\":\"CorrogoOrderStop\",\"description\":\"One location column of the card: header, address line, `Planned` window. `locality` is the\\ncity, `region` the state/province, `timezone` the label on the rendered window. Every field is\\nnullable in corrogo, `location_name` and `timezone` most often — the header falls back to\\n`company_name`.\\n\\nOmits `line_3` and `country` (not rendered; the shipment half omits country too) and\\n`custom_data` — the owner's private custom-field values, and this caller can be out-of-tenant.\"},\"CorrogoOrderStopShippingRequirements\":{\"properties\":{\"plan_window\":{\"$ref\":\"#/components/schemas/CorrogoPlanWindow\"}},\"type\":\"object\",\"title\":\"CorrogoOrderStopShippingRequirements\"},\"CorrogoPlanWindow\":{\"properties\":{\"start\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Start\"},\"end\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"End\"}},\"type\":\"object\",\"title\":\"CorrogoPlanWindow\",\"description\":\"The card's `Planned` row; the order-side analogue of `BeCoreStopPlanningWindow`.\"},\"CreateAppointment\":{\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Name\"},\"reason\":{\"allOf\":[{\"$ref\":\"#/components/schemas/AppointmentReason\"}],\"description\":\"Reason for the Appointment.\"},\"reference_id\":{\"type\":\"string\",\"title\":\"Reference Id\"},\"description\":{\"type\":\"string\",\"title\":\"Description\"},\"is_all_day\":{\"type\":\"boolean\",\"title\":\"Is All Day\",\"description\":\"If true, indicates that the Appointment's start/end should equal the operating hours of the Facility/Dock at which it is scheduled.\",\"default\":false},\"matched_load_type_id\":{\"type\":\"string\",\"title\":\"Matched Load Type Id\",\"description\":\"ID of the LoadType whose fields should be used to determine if it matches an Appointment.\"},\"references\":{\"items\":{\"$ref\":\"#/components/schemas/Reference\"},\"type\":\"array\",\"title\":\"References\",\"description\":\"List of references for the appointment that can be used to search for the appointment later.\",\"default\":[]},\"start\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"end\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"stop_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Stop Id\"},\"carrier_name\":{\"type\":\"string\",\"title\":\"Carrier Name\"},\"carrier_contact\":{\"type\":\"string\",\"title\":\"Carrier Contact\"},\"carrier_tenant_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Carrier Tenant Id\"},\"driver_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Driver Id\"},\"appointment_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/FacilityAppointmentType\"}],\"default\":\"BY_APPOINTMENT_ONLY\"},\"delivery_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DeliveryTypeEnum\"}],\"description\":\"Whether the delivery type is loading or unloading Freight.\"},\"scheduled_resource_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/ScheduledResourceTypeEnum\"}],\"description\":\"Required when the scheduled_resource_id field is provided.\"},\"scheduled_resource_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Scheduled Resource Id\"},\"scheduled_resource_metadata\":{\"oneOf\":[{\"$ref\":\"#/components/schemas/FreightAppointmentScheduledResource\"},{\"$ref\":\"#/components/schemas/ShipmentAppointmentScheduledResource\"}],\"title\":\"Scheduled Resource Metadata\",\"description\":\"Additional details about the resource for which this Appointment is scheduling, or null if the Appointment does not relate to any scheduled resource. For example, if this Appointment relates to a Shipment, these details will be described by a ShipmentAppointmentScheduledResource. Or if the Appointment is managing off-platform freight, the details will instead be described using the FreightAppointmentScheduledResource schema.\",\"discriminator\":{\"propertyName\":\"resource_type\",\"mapping\":{\"FREIGHT_GENERAL\":\"#/components/schemas/FreightAppointmentScheduledResource\",\"SHIPMENT\":\"#/components/schemas/ShipmentAppointmentScheduledResource\"}}},\"notes\":{\"type\":\"string\",\"title\":\"Notes\"},\"appointment_orders\":{\"items\":{\"$ref\":\"#/components/schemas/CreateAppointmentOrder\"},\"type\":\"array\",\"title\":\"Appointment Orders\"}},\"type\":\"object\",\"title\":\"CreateAppointment\"},\"CreateAppointmentDraft\":{\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Name\"},\"reason\":{\"allOf\":[{\"$ref\":\"#/components/schemas/AppointmentReason\"}],\"description\":\"Reason for the Appointment.\"},\"reference_id\":{\"type\":\"string\",\"title\":\"Reference Id\"},\"description\":{\"type\":\"string\",\"title\":\"Description\"},\"is_all_day\":{\"type\":\"boolean\",\"title\":\"Is All Day\",\"description\":\"If true, indicates that the Appointment's start/end should equal the operating hours of the Facility/Dock at which it is scheduled.\",\"default\":false},\"matched_load_type_id\":{\"type\":\"string\",\"title\":\"Matched Load Type Id\",\"description\":\"ID of the LoadType whose fields should be used to determine if it matches an Appointment.\"},\"references\":{\"items\":{\"$ref\":\"#/components/schemas/Reference\"},\"type\":\"array\",\"title\":\"References\",\"description\":\"List of references for the appointment that can be used to search for the appointment later.\",\"default\":[]},\"start\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"end\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"stop_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Stop Id\"},\"carrier_name\":{\"type\":\"string\",\"title\":\"Carrier Name\"},\"carrier_contact\":{\"type\":\"string\",\"title\":\"Carrier Contact\"},\"carrier_tenant_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Carrier Tenant Id\"},\"driver_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Driver Id\"},\"appointment_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/FacilityAppointmentType\"}],\"default\":\"BY_APPOINTMENT_ONLY\"},\"delivery_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DeliveryTypeEnum\"}],\"description\":\"Whether the delivery type is loading or unloading Freight.\"},\"scheduled_resource_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/ScheduledResourceTypeEnum\"}],\"description\":\"Required when the scheduled_resource_id field is provided.\"},\"scheduled_resource_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Scheduled Resource Id\"},\"scheduled_resource_metadata\":{\"oneOf\":[{\"$ref\":\"#/components/schemas/FreightAppointmentScheduledResource\"},{\"$ref\":\"#/components/schemas/ShipmentAppointmentScheduledResource\"}],\"title\":\"Scheduled Resource Metadata\",\"description\":\"Additional details about the resource for which this Appointment is scheduling, or null if the Appointment does not relate to any scheduled resource. For example, if this Appointment relates to a Shipment, these details will be described by a ShipmentAppointmentScheduledResource. Or if the Appointment is managing off-platform freight, the details will instead be described using the FreightAppointmentScheduledResource schema.\",\"discriminator\":{\"propertyName\":\"resource_type\",\"mapping\":{\"FREIGHT_GENERAL\":\"#/components/schemas/FreightAppointmentScheduledResource\",\"SHIPMENT\":\"#/components/schemas/ShipmentAppointmentScheduledResource\"}}},\"notes\":{\"type\":\"string\",\"title\":\"Notes\"},\"appointment_orders\":{\"items\":{\"$ref\":\"#/components/schemas/CreateAppointmentOrder\"},\"type\":\"array\",\"title\":\"Appointment Orders\"}},\"type\":\"object\",\"title\":\"CreateAppointmentDraft\",\"description\":\"Body for a temporary draft: the full booking payload, minus the window.\\n\\nThe wizard sends everything it has collected so uploaded documents attach to a row that already\\ncarries the references and orders the requirement is checked against. The window arrives with\\n`/submit`, so sending one here is a mistake worth reporting rather than silently ignoring.\"},\"CreateAppointmentOrder\":{\"properties\":{\"order_number\":{\"type\":\"string\",\"title\":\"Order Number\"},\"corrogo_order_id\":{\"type\":\"string\",\"maxLength\":36,\"title\":\"Corrogo Order Id\",\"description\":\"ID of an existing Corrogo / backend-core order that this appointment order links to. Null for manually created orders.\"},\"references\":{\"items\":{\"$ref\":\"#/components/schemas/CreateAppointmentOrderReference\"},\"type\":\"array\",\"title\":\"References\",\"default\":[]},\"items\":{\"items\":{\"$ref\":\"#/components/schemas/CreateAppointmentOrderItem\"},\"type\":\"array\",\"title\":\"Items\",\"default\":[]}},\"type\":\"object\",\"title\":\"CreateAppointmentOrder\"},\"CreateAppointmentOrderItem\":{\"properties\":{\"package_type\":{\"type\":\"string\",\"title\":\"Package Type\"},\"quantity\":{\"type\":\"integer\",\"title\":\"Quantity\"},\"package_weight\":{\"type\":\"string\",\"format\":\"decimal\",\"title\":\"Package Weight\"},\"weight_unit\":{\"type\":\"string\",\"title\":\"Weight Unit\"},\"piece_type\":{\"type\":\"string\",\"title\":\"Piece Type\"},\"num_pieces\":{\"type\":\"integer\",\"title\":\"Num Pieces\"}},\"type\":\"object\",\"title\":\"CreateAppointmentOrderItem\"},\"CreateAppointmentOrderReference\":{\"properties\":{\"reference_type\":{\"type\":\"string\",\"title\":\"Reference Type\"},\"reference_number\":{\"type\":\"string\",\"title\":\"Reference Number\"}},\"type\":\"object\",\"required\":[\"reference_type\",\"reference_number\"],\"title\":\"CreateAppointmentOrderReference\"},\"CreateAppointmentRequest\":{\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Name\"},\"reason\":{\"allOf\":[{\"$ref\":\"#/components/schemas/AppointmentReason\"}],\"description\":\"Reason for the Appointment.\"},\"reference_id\":{\"type\":\"string\",\"title\":\"Reference Id\"},\"description\":{\"type\":\"string\",\"title\":\"Description\"},\"matched_load_type_id\":{\"type\":\"string\",\"title\":\"Matched Load Type Id\",\"description\":\"ID of the LoadType whose fields should be used to determine if it matches an Appointment.\"},\"references\":{\"items\":{\"$ref\":\"#/components/schemas/Reference\"},\"type\":\"array\",\"title\":\"References\",\"description\":\"List of references for the appointment that can be used to search for the appointment later.\",\"default\":[]},\"start\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"end\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"stop_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Stop Id\"},\"carrier_name\":{\"type\":\"string\",\"title\":\"Carrier Name\"},\"carrier_contact\":{\"type\":\"string\",\"title\":\"Carrier Contact\"},\"delivery_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DeliveryTypeEnum\"}],\"description\":\"Whether the delivery type is loading or unloading Freight.\"},\"scheduled_resource_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/ScheduledResourceTypeEnum\"}],\"description\":\"Required when the scheduled_resource_id field is provided.\"},\"scheduled_resource_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Scheduled Resource Id\"},\"scheduled_resource_metadata\":{\"oneOf\":[{\"$ref\":\"#/components/schemas/FreightAppointmentScheduledResource\"},{\"$ref\":\"#/components/schemas/ShipmentAppointmentScheduledResource\"}],\"title\":\"Scheduled Resource Metadata\",\"description\":\"Additional details about the resource for which this Appointment is scheduling, or null if the Appointment does not relate to any scheduled resource. For example, if this Appointment relates to a Shipment, these details will be described by a ShipmentAppointmentScheduledResource. Or if the Appointment is managing off-platform freight, the details will instead be described using the FreightAppointmentScheduledResource schema.\",\"discriminator\":{\"propertyName\":\"resource_type\",\"mapping\":{\"FREIGHT_GENERAL\":\"#/components/schemas/FreightAppointmentScheduledResource\",\"SHIPMENT\":\"#/components/schemas/ShipmentAppointmentScheduledResource\"}}},\"notes\":{\"type\":\"string\",\"title\":\"Notes\"},\"appointment_orders\":{\"items\":{\"$ref\":\"#/components/schemas/CreateAppointmentOrder\"},\"type\":\"array\",\"title\":\"Appointment Orders\"},\"request_note\":{\"type\":\"string\",\"title\":\"Request Note\",\"description\":\"Message from the requester explaining what they are asking for.\"}},\"type\":\"object\",\"required\":[\"start\",\"end\"],\"title\":\"CreateAppointmentRequest\",\"description\":\"Body for a time request: a request for a day/time the facility does not currently offer.\\n\\nSubclasses `CreateAppointment` so any field added there is picked up automatically; the\\nprivileged fields a requester must never set are removed below.\"},\"CreateFacility\":{\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Name\"},\"location_type\":{\"$ref\":\"#/components/schemas/LocationTypes\"},\"address\":{\"$ref\":\"#/components/schemas/FacilityAddress\"},\"facility_services\":{\"items\":{\"$ref\":\"#/components/schemas/FacilityServices\"},\"type\":\"array\"},\"external_reference\":{\"type\":\"string\",\"maxLength\":255,\"title\":\"External Reference\"},\"notes\":{\"type\":\"string\",\"title\":\"Notes\"},\"carrier_instructions\":{\"type\":\"string\",\"title\":\"Carrier Instructions\"},\"disclaimers\":{\"type\":\"string\",\"title\":\"Disclaimers\"},\"appointment_lead_time_duration\":{\"type\":\"string\",\"format\":\"duration\",\"title\":\"Appointment Lead Time Duration\",\"example\":\"P1DT23H30M4.000000S\"},\"late_appointment_threshold_duration\":{\"type\":\"string\",\"format\":\"duration\",\"title\":\"Late Appointment Threshold Duration\",\"example\":\"P1DT23H30M4.000000S\"},\"first_appointment_start_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"First Appointment Start Time\"},\"last_appointment_end_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"Last Appointment End Time\"},\"exclude_dock_assignment_from_appointment_scheduling\":{\"type\":\"boolean\",\"title\":\"Exclude Dock Assignment From Appointment Scheduling\"},\"appointment_approval_required\":{\"type\":\"boolean\",\"title\":\"Appointment Approval Required\",\"description\":\"Whether appointments at this facility require approval before being scheduled\",\"default\":false},\"appointment_required_document_types\":{\"items\":{\"$ref\":\"#/components/schemas/AppointmentDocumentTypeEnum\"},\"type\":\"array\",\"description\":\"Document types an external (cross-tenant) scheduler must provide before an appointment at this facility can be booked. A type counts as provided when a matching document is attached to the appointment, its shipment or its orders. Empty means no requirement. OTHER is not allowed.\",\"default\":[]},\"enhanced_dock_rules\":{\"type\":\"boolean\",\"title\":\"Enhanced Dock Rules\",\"description\":\"Turn on Enhanced Dock Rules to enable more granular rules including for Product Categories and References.\",\"default\":false}},\"type\":\"object\",\"required\":[\"name\",\"location_type\",\"address\",\"facility_services\",\"appointment_lead_time_duration\",\"late_appointment_threshold_duration\",\"exclude_dock_assignment_from_appointment_scheduling\"],\"title\":\"CreateFacility\"},\"CreateFacilityCapacityLimit\":{\"properties\":{\"unit_of_measure\":{\"$ref\":\"#/components/schemas/PackagingTypes\"},\"max_units_per_day\":{\"type\":\"integer\",\"maximum\":2147483647,\"minimum\":1,\"title\":\"Max Units Per Day\"}},\"type\":\"object\",\"required\":[\"unit_of_measure\",\"max_units_per_day\"],\"title\":\"CreateFacilityCapacityLimit\"},\"CreateFacilityDock\":{\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Name\"},\"color\":{\"type\":\"string\",\"pattern\":\"^#([A-Fa-f0-9]{6})$\",\"title\":\"Color\"},\"total_max_concurrent_appointments\":{\"type\":\"integer\",\"title\":\"Total Max Concurrent Appointments\",\"description\":\"Maximum number of appointments of all types that may be loading/unloading at this dock simultaneously\",\"default\":10000}},\"type\":\"object\",\"required\":[\"name\",\"color\"],\"title\":\"CreateFacilityDock\"},\"CreateFacilityDockAppointmentRule\":{\"properties\":{\"delivery_type\":{\"$ref\":\"#/components/schemas/DeliveryTypeEnum\"},\"mode\":{\"$ref\":\"#/components/schemas/DockSchedulingModeEnum\"},\"equipment_type\":{\"$ref\":\"#/components/schemas/DockSchedulingEquipmentTypeEnum\"},\"product_references\":{\"items\":{\"type\":\"string\",\"maxLength\":256},\"type\":\"array\",\"maxLength\":256,\"maxItems\":10,\"minItems\":1,\"title\":\"Product References\",\"description\":\"One or more product references this rule applies to. Canonical field.\"},\"product_reference\":{\"type\":\"string\",\"maxLength\":256,\"title\":\"Product Reference\",\"description\":\"DEPRECATED — use `product_references` instead. On input this single value is folded into `product_references` (and `product_references` wins if both are provided). On output it mirrors the first element of `product_references` for backwards compatibility with pre-array clients.\",\"deprecated\":true},\"product_category\":{\"items\":{\"type\":\"string\",\"maxLength\":256},\"type\":\"array\",\"maxLength\":256,\"maxItems\":10,\"minItems\":1,\"title\":\"Product Category\"},\"product_category_matching_mode\":{\"allOf\":[{\"$ref\":\"#/components/schemas/MatchingModeEnum\"}],\"description\":\"Whether every product category on the load must be on this rule's category list (`ALL`) or only one of them (`AT_LEAST_ONE`).\",\"default\":\"ALL\"},\"product_reference_matching_mode\":{\"allOf\":[{\"$ref\":\"#/components/schemas/MatchingModeEnum\"}],\"description\":\"Whether every line item on the load must be satisfied by an allowed product reference (`ALL`) or only one of them (`AT_LEAST_ONE`).\",\"default\":\"ALL\"},\"packaging_type\":{\"$ref\":\"#/components/schemas/PackagingTypes\"},\"stackable\":{\"type\":\"boolean\",\"title\":\"Stackable\"},\"is_hazmat\":{\"type\":\"boolean\",\"title\":\"Is Hazmat\"},\"load_type_id\":{\"type\":\"string\",\"title\":\"Load Type Id\",\"description\":\"ID of the LoadType whose fields should be used to determine if this rule matches a shipment\"},\"dock_accessorials\":{\"items\":{\"$ref\":\"#/components/schemas/DockSchedulingAccessorialTypeEnum\"},\"type\":\"array\"},\"temperature\":{\"$ref\":\"#/components/schemas/Temperature\"},\"appointment_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/FacilityAppointmentType\"}],\"default\":\"BY_APPOINTMENT_ONLY\"},\"first_appointment_start_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"First Appointment Start Time\"},\"last_appointment_end_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"Last Appointment End Time\"},\"max_concurrent_appointments\":{\"type\":\"integer\",\"minimum\":1,\"title\":\"Max Concurrent Appointments\",\"default\":1},\"is_public\":{\"type\":\"boolean\",\"title\":\"Is Public\"}},\"type\":\"object\",\"required\":[\"dock_accessorials\",\"is_public\"],\"title\":\"CreateFacilityDockAppointmentRule\"},\"CreateFacilityHoliday\":{\"properties\":{\"standard_holiday_name\":{\"allOf\":[{\"$ref\":\"#/components/schemas/StandardHolidays\"}],\"description\":\"StandardHoliday enum member to which this holiday refers. If this is not-null, the `custom_holiday_*` fields must all be null.\",\"example\":null},\"custom_holiday_name\":{\"type\":\"string\",\"title\":\"Custom Holiday Name\",\"description\":\"Human-readable name for a custom holiday. If not-null, then `custom_holiday_date` must also be provided and `standard_holiday_name` must be null.\",\"example\":\"National Puppy Day\"},\"custom_holiday_date\":{\"type\":\"string\",\"format\":\"date\",\"title\":\"Custom Holiday Date\",\"description\":\"Date for a custom holiday. If not-null, then `custom_holiday_name` must also be provided and `standard_holiday_name` must be null.\",\"example\":\"2023-03-23\"},\"first_appointment_start_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"First Appointment Start Time\",\"example\":null},\"last_appointment_end_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"Last Appointment End Time\",\"example\":null},\"closed_all_day\":{\"type\":\"boolean\",\"title\":\"Closed All Day\",\"description\":\"If true, indicates that the Facility is closed for the entire day of the holiday. If this value is true, then `first_appointment_start_time` and `last_appointment_end_time` must both be null.\",\"example\":true}},\"type\":\"object\",\"required\":[\"closed_all_day\"],\"title\":\"CreateFacilityHoliday\"},\"CreateFacilityHoursOfOperation\":{\"properties\":{\"day\":{\"$ref\":\"#/components/schemas/DaysOfWeek\"},\"is_facility_open\":{\"type\":\"boolean\",\"title\":\"Is Facility Open\"},\"open_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"Open Time\"},\"close_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"Close Time\"},\"daily_max_capacity\":{\"type\":\"integer\",\"title\":\"Daily Max Capacity\"}},\"type\":\"object\",\"required\":[\"day\",\"is_facility_open\"],\"title\":\"CreateFacilityHoursOfOperation\"},\"CreateFacilityPointOfContact\":{\"properties\":{\"person_name\":{\"type\":\"string\",\"title\":\"Person Name\"},\"facility_role\":{\"$ref\":\"#/components/schemas/FacilityPointOfContactRole\"},\"phone_number\":{\"type\":\"string\",\"title\":\"Phone Number\"},\"is_default_for_facility\":{\"type\":\"boolean\",\"title\":\"Is Default For Facility\",\"default\":false},\"email\":{\"type\":\"string\",\"format\":\"email\",\"title\":\"Email\"}},\"type\":\"object\",\"required\":[\"person_name\",\"facility_role\"],\"title\":\"CreateFacilityPointOfContact\"},\"CreateLoadType\":{\"properties\":{\"delivery_type\":{\"$ref\":\"#/components/schemas/DeliveryTypeEnum\"},\"mode\":{\"$ref\":\"#/components/schemas/DockSchedulingModeEnum\"},\"equipment_type\":{\"$ref\":\"#/components/schemas/DockSchedulingEquipmentTypeEnum\"},\"product_references\":{\"items\":{\"type\":\"string\",\"maxLength\":256},\"type\":\"array\",\"maxLength\":256,\"maxItems\":10,\"minItems\":1,\"title\":\"Product References\",\"description\":\"One or more product references this rule applies to. Canonical field.\"},\"product_reference\":{\"type\":\"string\",\"maxLength\":256,\"title\":\"Product Reference\",\"description\":\"DEPRECATED — use `product_references` instead. On input this single value is folded into `product_references` (and `product_references` wins if both are provided). On output it mirrors the first element of `product_references` for backwards compatibility with pre-array clients.\",\"deprecated\":true},\"product_category\":{\"items\":{\"type\":\"string\",\"maxLength\":256},\"type\":\"array\",\"maxLength\":256,\"maxItems\":10,\"minItems\":1,\"title\":\"Product Category\"},\"product_category_matching_mode\":{\"allOf\":[{\"$ref\":\"#/components/schemas/MatchingModeEnum\"}],\"description\":\"Whether every product category on the load must be on this rule's category list (`ALL`) or only one of them (`AT_LEAST_ONE`).\",\"default\":\"ALL\"},\"product_reference_matching_mode\":{\"allOf\":[{\"$ref\":\"#/components/schemas/MatchingModeEnum\"}],\"description\":\"Whether every line item on the load must be satisfied by an allowed product reference (`ALL`) or only one of them (`AT_LEAST_ONE`).\",\"default\":\"ALL\"},\"packaging_type\":{\"$ref\":\"#/components/schemas/PackagingTypes\"},\"stackable\":{\"type\":\"boolean\",\"title\":\"Stackable\"},\"is_hazmat\":{\"type\":\"boolean\",\"title\":\"Is Hazmat\"},\"name\":{\"type\":\"string\",\"title\":\"Name\"},\"load_unload_duration\":{\"type\":\"string\",\"format\":\"duration\",\"title\":\"Load Unload Duration\",\"example\":\"P1DT23H30M4.000000S\"},\"appointment_duration\":{\"type\":\"string\",\"format\":\"duration\",\"title\":\"Appointment Duration\",\"example\":\"P1DT23H30M4.000000S\"},\"all_day_appointment\":{\"type\":\"boolean\",\"title\":\"All Day Appointment\",\"description\":\"If true, indicates that the Appointment is placed for the entire day. If this value is true, then `load_unload_duration` and `appointment_duration` must both be null.\",\"default\":false}},\"type\":\"object\",\"required\":[\"delivery_type\",\"name\"],\"title\":\"CreateLoadType\"},\"CustomFieldPlanningWindow\":{\"properties\":{\"start\":{\"type\":\"string\",\"format\":\"date\",\"title\":\"Start\",\"description\":\"First available day of the planning window, inclusive\"},\"end\":{\"type\":\"string\",\"format\":\"date\",\"title\":\"End\",\"description\":\"Last available day of the planning window, inclusive\"}},\"type\":\"object\",\"required\":[\"start\",\"end\"],\"title\":\"CustomFieldPlanningWindow\",\"description\":\"Potentially multi-day planning window during which an Appointment for a Stop may be scheduled. Derived from the\\n`.custom_data` of the Stop using a workaround since the Stop data model originally does not support multi-day\\nplanned windows. Or if that custom data does not contain a value, it may also be calculated as a single-day window\\nof the `Stop.planned_date` alone. It's possible that the `start` and `end` may be identical, in which case the\\nplanning window is valid but only lasts a single day.\"},\"DateTimeWithTimezone\":{\"properties\":{\"timestamp\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Timestamp\"},\"timezone\":{\"type\":\"string\",\"title\":\"Timezone\",\"description\":\"Name of a timezone that exists in the tz database\",\"example\":\"America/Chicago\"}},\"type\":\"object\",\"required\":[\"timestamp\",\"timezone\"],\"title\":\"DateTimeWithTimezone\"},\"DaysOfWeek\":{\"type\":\"string\",\"enum\":[\"MONDAY\",\"TUESDAY\",\"WEDNESDAY\",\"THURSDAY\",\"FRIDAY\",\"SATURDAY\",\"SUNDAY\"],\"title\":\"DaysOfWeek\",\"description\":\"An enumeration.\"},\"DeliveryTypeEnum\":{\"type\":\"string\",\"enum\":[\"RECEIVING\",\"SHIPPING\"],\"title\":\"DeliveryTypeEnum\",\"description\":\"An enumeration.\"},\"DockSchedulingAccessorialTypeEnum\":{\"type\":\"string\",\"enum\":[\"FORK\",\"LIFT_GATE\",\"PJACK\",\"TARP\",\"HAZM\",\"DOLLY\"],\"title\":\"DockSchedulingAccessorialTypeEnum\",\"description\":\"An enumeration.\"},\"DockSchedulingEquipmentTypeEnum\":{\"type\":\"string\",\"enum\":[\"DRY_VAN\",\"REEFER\",\"FLATBED\",\"CONTAINER\",\"AUTOHAULER\",\"BULK\",\"TANKER\",\"CURTAIN_SIDE\",\"HOPPER\",\"DROP_DECK\",\"OTHER\",\"TILT\",\"CONTAINER_INSULATED\",\"CONESTOGA\",\"FLATBED_CONESTOGA\",\"STEPDECK_CONESTOGA\",\"CONTAINER_REFRIGERATED\",\"B_TRAIN\",\"DOUBLE_DROP\",\"DROP_DECK_LANDOLL\",\"DUMP_TRAILER\",\"FLATBED_HOTSHOT\",\"FLATBED_MAXI\",\"LOWBOY\",\"LOWBOY_OVERDIMENSION\",\"REMOVABLE_GOOSENECK\",\"STRETCH_TRAILER\",\"TRUCK_AND_TRAILER\",\"STEP_DECK\",\"HOPPER_BOTTOM\",\"PNEUMATIC\",\"FLATBED_53_FOOT\",\"FLATBED_AIR_RIDE\",\"FLATBED_DOUBLE\",\"FLATBED_OVERDIMENSION\",\"AUTO_CARRIER\",\"CONVEYOR\",\"POWER_ONLY\",\"STRAIGHT_BOX_TRUCK\",\"INSULATED_VAN\",\"REEFER_AIR_RIDE\",\"REEFER_DOUBLE\",\"REEFER_INTERMODAL\",\"TANKER_ALUMINUM\",\"TANKER_INTERMODAL\",\"TANKER_STEEL\",\"MOVING_VAN\",\"VAN_DOUBLE\",\"VAN_INSULATED\",\"VAN_INTERMODAL\",\"VAN_OPEN_TOP\",\"VAN_ROLLER_BED\",\"VAN_TRIPLE\",\"VAN_VENTED\",\"VAN_WITH_CURTAINS\",\"VAN_AIR_RIDE\",\"VAN_SPRINTER\",\"CONTAINER_BREAK_BULK\",\"CONTAINER_FLAT_TRACK_20_FOOT\",\"CONTAINER_FLAT_TRACK_40_FOOT\",\"CONTAINER_HEAVY_TESTED_20_FOOT\",\"CONTAINER_HIGH_CUBE_20_FOOT\",\"CONTAINER_HIGH_CUBE_40_FOOT\",\"CONTAINER_OPEN_TOP_20_FOOT\",\"CONTAINER_OPEN_TOP_40_FOOT\",\"CONTAINER_REEFER_20_FOOT\",\"CONTAINER_REEFER_40_FOOT\",\"CONTAINER_REEFER_TANK_20_FOOT\",\"CONTAINER_STANDARD_20_FOOT\",\"CONTAINER_STANDARD_40_FOOT\",\"CONTAINER_HIGH_CUBE_45_FOOT\",\"CONTAINER_ISO_TANK_20_FOOT\",\"CONTAINER_ISO_TANK_24_FOOT\",\"CONTAINER_ISO_TANK_40_FOOT\",\"CONTAINER_53_FOOT\",\"CONTAINER_OVERSIZE\",\"MULTI_COMPARTMENT\",\"LIQUID_BULK_TANKER\",\"DRY_BULK_TANKER\",\"CARGO_VAN\",\"MINI_VAN\",\"SEDAN\",\"TBOX_RAILCAR\",\"CRYO_RAILCAR\",\"DRIVEAWAY\",\"CUSTOMER_PICKUP\",\"DROP_TRAILER\",\"AUTO_RACK_BI_LEVEL\",\"AUTO_RACK_TRI_LEVEL\",\"AUTO_MAX\",\"BOXCAR\",\"BULKHEAD_FLATCAR\",\"CENTERBEAM_FLATCAR\",\"CHAIN_TIE_DOWN_FLATCAR\",\"COAL_CAR\",\"COIL_STEEL_RAILCAR\",\"COVERED_COIL_RAILCAR\",\"COVERED_HOPPER\",\"GONDOLA\",\"OPEN_TOP_HOPPER\",\"PIPE_FLATCAR\",\"REFRIGERATED_BOXCAR\",\"TEMP_CONTROLLED_TRAILER\",\"TRAILER\",\"HALF_TON_TRUCK\",\"ONE_TON_TRUCK\",\"MINI_FLOAT_TRAILER_AND_TRUCK\",\"TOWING\",\"CONESTOGA_48\",\"CONESTOGA_53\",\"FLATBED_CONESTOGA_48\",\"FLATBED_CONESTOGA_53\",\"STEPDECK_CONESTOGA_48\",\"STEPDECK_CONESTOGA_53\",\"CO_FLATBED\",\"CO_STAKE_BED\",\"TILTBED_48_WENCH\",\"WRECKER_TILTBED\",\"AIRCRAFT\",\"FOUR_AXLE_HEAVY_HAUL_TRAILER\",\"A_TRAINS\",\"BODY_TANKS\",\"SUPER_BODY_TANKS\",\"SEMI\",\"HOT_TRAILERS\",\"ASPHALT\",\"EMULSION\",\"BLUE_DOT\",\"GREEN_DOT\",\"UNKNOWN\"],\"title\":\"DockSchedulingEquipmentTypeEnum\",\"description\":\"An enumeration.\"},\"DockSchedulingModeEnum\":{\"type\":\"string\",\"enum\":[\"FTL\",\"LTL\",\"VLTL\",\"DRAYAGE\",\"PARCEL\",\"INTERMODAL\",\"RAIL_CAR\",\"AIR\",\"FCL\",\"LCL\"],\"title\":\"DockSchedulingModeEnum\",\"description\":\"An enumeration.\"},\"DocumentRequirementsCheckRequest\":{\"properties\":{\"appointment_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Appointment Id\"},\"scheduled_resource_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/ScheduledResourceTypeEnum\"}],\"description\":\"Required when the scheduled_resource_id field is provided.\"},\"scheduled_resource_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Scheduled Resource Id\"},\"appointment_orders\":{\"items\":{\"$ref\":\"#/components/schemas/CreateAppointmentOrder\"},\"type\":\"array\",\"title\":\"Appointment Orders\"}},\"type\":\"object\",\"title\":\"DocumentRequirementsCheckRequest\",\"description\":\"The references a scheduler is about to book with. Sent before the appointment exists, so the\\nappointment id is optional. When it is given, the check uses what `/schedule` would enforce\\nagainst: that appointment's uploads, its stored scheduled resource (the body's pair is\\nignored), and its linked orders unless `appointment_orders` is sent.\"},\"DocumentRequirementsCheckResponse\":{\"properties\":{\"required\":{\"items\":{\"$ref\":\"#/components/schemas/AppointmentDocumentTypeEnum\"},\"type\":\"array\",\"description\":\"Document types this facility requires, in the order the facility set them.\"},\"documents\":{\"items\":{\"$ref\":\"#/components/schemas/RequiredDocumentMatch\"},\"type\":\"array\",\"title\":\"Documents\",\"description\":\"Documents of a required type already attached to any of the given references.\"},\"missing\":{\"items\":{\"$ref\":\"#/components/schemas/AppointmentDocumentTypeEnum\"},\"type\":\"array\",\"description\":\"Required types no document covers yet, in the facility's configured order. Only a cross-tenant scheduling user is refused on this basis; for facility-tenant users, carriers, drivers and API callers it is informational, and booking succeeds with it set.\"}},\"type\":\"object\",\"required\":[\"required\",\"documents\",\"missing\"],\"title\":\"DocumentRequirementsCheckResponse\"},\"DocumentSourceEnum\":{\"type\":\"string\",\"enum\":[\"APPOINTMENT\",\"SHIPMENT\",\"ORDER\",\"ORDER_RELEASE\"],\"title\":\"DocumentSourceEnum\",\"description\":\"Where a document satisfying a facility's required type was found. `ORDER_RELEASE` is a document\\nattached to a release of a linked order, not to the order itself.\"},\"Facility\":{\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Name\"},\"location_type\":{\"$ref\":\"#/components/schemas/LocationTypes\"},\"address\":{\"$ref\":\"#/components/schemas/FacilityAddress\"},\"facility_services\":{\"items\":{\"$ref\":\"#/components/schemas/FacilityServices\"},\"type\":\"array\"},\"external_reference\":{\"type\":\"string\",\"maxLength\":255,\"title\":\"External Reference\"},\"notes\":{\"type\":\"string\",\"title\":\"Notes\"},\"carrier_instructions\":{\"type\":\"string\",\"title\":\"Carrier Instructions\"},\"disclaimers\":{\"type\":\"string\",\"title\":\"Disclaimers\"},\"appointment_lead_time_duration\":{\"type\":\"string\",\"format\":\"duration\",\"title\":\"Appointment Lead Time Duration\",\"example\":\"P1DT23H30M4.000000S\"},\"late_appointment_threshold_duration\":{\"type\":\"string\",\"format\":\"duration\",\"title\":\"Late Appointment Threshold Duration\",\"example\":\"P1DT23H30M4.000000S\"},\"first_appointment_start_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"First Appointment Start Time\"},\"last_appointment_end_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"Last Appointment End Time\"},\"exclude_dock_assignment_from_appointment_scheduling\":{\"type\":\"boolean\",\"title\":\"Exclude Dock Assignment From Appointment Scheduling\"},\"appointment_approval_required\":{\"type\":\"boolean\",\"title\":\"Appointment Approval Required\",\"description\":\"Whether appointments at this facility require approval before being scheduled\",\"default\":false},\"appointment_required_document_types\":{\"items\":{\"$ref\":\"#/components/schemas/AppointmentDocumentTypeEnum\"},\"type\":\"array\",\"description\":\"Document types an external (cross-tenant) scheduler must provide before an appointment at this facility can be booked. A type counts as provided when a matching document is attached to the appointment, its shipment or its orders. Empty means no requirement. OTHER is not allowed.\",\"default\":[]},\"enhanced_dock_rules\":{\"type\":\"boolean\",\"title\":\"Enhanced Dock Rules\",\"description\":\"Turn on Enhanced Dock Rules to enable more granular rules including for Product Categories and References.\",\"default\":false},\"id\":{\"type\":\"string\",\"title\":\"Id\"},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Created At\"},\"updated_at\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Updated At\"},\"dock_count\":{\"type\":\"integer\",\"title\":\"Dock Count\",\"description\":\"Number of Docks at the Facility.\"},\"contact_count\":{\"type\":\"integer\",\"title\":\"Contact Count\",\"description\":\"Number of Contacts at the Facility.\"},\"load_type_count\":{\"type\":\"integer\",\"title\":\"Load Type Count\",\"description\":\"Number of LoadTypes at the Facility.\"},\"docks\":{\"items\":{\"$ref\":\"#/components/schemas/FacilityDock\"},\"type\":\"array\",\"title\":\"Docks\",\"description\":\"Child docks\"},\"company_name\":{\"type\":\"string\",\"title\":\"Company Name\",\"description\":\"Name of the company that owns the Facility. Always returned, and supported as a filter and sort field (e.g. `company_name.icontains=%acme%`, `sort=company_name`). Null when the name has not been resolved from the owning company yet.\"},\"point_of_contacts\":{\"items\":{\"$ref\":\"#/components/schemas/FacilityPointOfContact\"},\"type\":\"array\",\"title\":\"Point Of Contacts\",\"description\":\"The Facility's points of contact, identical to what `GET /facilities/{facilityId}/point-of-contacts` returns. Requires `include=POINT_OF_CONTACTS`.\"}},\"type\":\"object\",\"required\":[\"name\",\"location_type\",\"address\",\"facility_services\",\"appointment_lead_time_duration\",\"late_appointment_threshold_duration\",\"exclude_dock_assignment_from_appointment_scheduling\",\"id\",\"created_at\",\"updated_at\"],\"title\":\"Facility\"},\"FacilityAddress\":{\"properties\":{\"line_1\":{\"type\":\"string\",\"maxLength\":255,\"title\":\"Line 1\",\"description\":\"Street name and address\"},\"line_2\":{\"type\":\"string\",\"maxLength\":255,\"title\":\"Line 2\",\"description\":\"Optional apartment, suite, unit number, etc.\"},\"line_3\":{\"type\":\"string\",\"maxLength\":255,\"title\":\"Line 3\",\"description\":\"Optional city, state, zip code.\"},\"locality\":{\"type\":\"string\",\"maxLength\":128,\"title\":\"Locality\",\"description\":\"Next specific categorization within a 'region' such as a city\"},\"country\":{\"type\":\"string\",\"maxLength\":2,\"minLength\":2,\"title\":\"Country\",\"description\":\"2-letter ISO-3166 country code\",\"example\":\"US CN IN ID PK BR NG BD RU\"},\"region\":{\"type\":\"string\",\"maxLength\":3,\"minLength\":2,\"title\":\"Region\",\"description\":\"Up to 3 letters ISO region code, can represent a state or province\",\"example\":\"TX CA FL NY PA IL OH GA\"},\"postal_code\":{\"type\":\"string\",\"maxLength\":16,\"title\":\"Postal Code\",\"description\":\"Next specific categorization within a 'city' such as a zipcode or postal code\"},\"timezone\":{\"type\":\"string\",\"title\":\"Timezone\",\"description\":\"Name of a timezone that exists in the tz database\",\"example\":\"America/Chicago\"},\"geolocation\":{\"allOf\":[{\"$ref\":\"#/components/schemas/GeoLocationPoint\"}],\"title\":\"Geolocation\",\"description\":\"Latitude and longitude of the address\"},\"formatted_address\":{\"type\":\"string\",\"title\":\"Formatted Address\",\"description\":\"Read-only, human-readable formatting of the address fields\",\"readOnly\":true}},\"type\":\"object\",\"required\":[\"timezone\"],\"title\":\"FacilityAddress\"},\"FacilityAppointmentType\":{\"type\":\"string\",\"enum\":[\"BY_APPOINTMENT_ONLY\",\"FIRST_COME_FIRST_SERVE\"],\"title\":\"FacilityAppointmentType\",\"description\":\"An enumeration.\"},\"FacilityAvailabilityWindow\":{\"properties\":{\"start\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Start\",\"description\":\"Start of the availability, inclusive of this timestamp. For example, if the start is at 08:00:00, this means that a location is available at that time.\"},\"end\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"End\",\"description\":\"End of the availability, exclusive of this timestamp. For example, if the end is at 09:00:00, this means that a location is available up until that instant, but IS NOT available when the clock strikes 09:00:00.\"}},\"type\":\"object\",\"required\":[\"start\",\"end\"],\"title\":\"FacilityAvailabilityWindow\"},\"FacilityCapacityLimit\":{\"properties\":{\"unit_of_measure\":{\"$ref\":\"#/components/schemas/PackagingTypes\"},\"max_units_per_day\":{\"type\":\"integer\",\"maximum\":2147483647,\"minimum\":1,\"title\":\"Max Units Per Day\"},\"id\":{\"type\":\"string\",\"title\":\"Id\"},\"facility_id\":{\"type\":\"string\",\"title\":\"Facility Id\"}},\"type\":\"object\",\"required\":[\"unit_of_measure\",\"max_units_per_day\",\"id\",\"facility_id\"],\"title\":\"FacilityCapacityLimit\"},\"FacilityCapacityLimitList\":{\"properties\":{\"data\":{\"items\":{\"$ref\":\"#/components/schemas/FacilityCapacityLimit\"},\"type\":\"array\",\"title\":\"Data\"},\"total_count\":{\"type\":\"integer\",\"title\":\"Total Count\"}},\"type\":\"object\",\"required\":[\"data\",\"total_count\"],\"title\":\"FacilityCapacityLimitList\"},\"FacilityDock\":{\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Name\"},\"color\":{\"type\":\"string\",\"pattern\":\"^#([A-Fa-f0-9]{6})$\",\"title\":\"Color\"},\"total_max_concurrent_appointments\":{\"type\":\"integer\",\"title\":\"Total Max Concurrent Appointments\",\"description\":\"Maximum number of appointments of all types that may be loading/unloading at this dock simultaneously\",\"default\":10000},\"id\":{\"type\":\"string\",\"title\":\"Id\"},\"facility_id\":{\"type\":\"string\",\"title\":\"Facility Id\"}},\"type\":\"object\",\"required\":[\"name\",\"color\",\"id\",\"facility_id\"],\"title\":\"FacilityDock\"},\"FacilityDockAppointmentRule\":{\"properties\":{\"delivery_type\":{\"$ref\":\"#/components/schemas/DeliveryTypeEnum\"},\"mode\":{\"$ref\":\"#/components/schemas/DockSchedulingModeEnum\"},\"equipment_type\":{\"$ref\":\"#/components/schemas/DockSchedulingEquipmentTypeEnum\"},\"product_references\":{\"items\":{\"type\":\"string\",\"maxLength\":256},\"type\":\"array\",\"maxLength\":256,\"maxItems\":10,\"minItems\":1,\"title\":\"Product References\",\"description\":\"One or more product references this rule applies to. Canonical field.\"},\"product_reference\":{\"type\":\"string\",\"maxLength\":256,\"title\":\"Product Reference\",\"description\":\"DEPRECATED — use `product_references` instead. On input this single value is folded into `product_references` (and `product_references` wins if both are provided). On output it mirrors the first element of `product_references` for backwards compatibility with pre-array clients.\",\"deprecated\":true},\"product_category\":{\"items\":{\"type\":\"string\",\"maxLength\":256},\"type\":\"array\",\"maxLength\":256,\"maxItems\":10,\"minItems\":1,\"title\":\"Product Category\"},\"product_category_matching_mode\":{\"allOf\":[{\"$ref\":\"#/components/schemas/MatchingModeEnum\"}],\"description\":\"Whether every product category on the load must be on this rule's category list (`ALL`) or only one of them (`AT_LEAST_ONE`).\",\"default\":\"ALL\"},\"product_reference_matching_mode\":{\"allOf\":[{\"$ref\":\"#/components/schemas/MatchingModeEnum\"}],\"description\":\"Whether every line item on the load must be satisfied by an allowed product reference (`ALL`) or only one of them (`AT_LEAST_ONE`).\",\"default\":\"ALL\"},\"packaging_type\":{\"$ref\":\"#/components/schemas/PackagingTypes\"},\"stackable\":{\"type\":\"boolean\",\"title\":\"Stackable\"},\"is_hazmat\":{\"type\":\"boolean\",\"title\":\"Is Hazmat\"},\"load_type_id\":{\"type\":\"string\",\"title\":\"Load Type Id\",\"description\":\"ID of the LoadType whose fields should be used to determine if this rule matches a shipment\"},\"dock_accessorials\":{\"items\":{\"$ref\":\"#/components/schemas/DockSchedulingAccessorialTypeEnum\"},\"type\":\"array\"},\"temperature\":{\"$ref\":\"#/components/schemas/Temperature\"},\"appointment_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/FacilityAppointmentType\"}],\"default\":\"BY_APPOINTMENT_ONLY\"},\"first_appointment_start_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"First Appointment Start Time\"},\"last_appointment_end_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"Last Appointment End Time\"},\"max_concurrent_appointments\":{\"type\":\"integer\",\"minimum\":1,\"title\":\"Max Concurrent Appointments\",\"default\":1},\"is_public\":{\"type\":\"boolean\",\"title\":\"Is Public\"},\"id\":{\"type\":\"string\",\"title\":\"Id\"},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Created At\"},\"updated_at\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Updated At\"},\"dock_id\":{\"type\":\"string\",\"title\":\"Dock Id\"}},\"type\":\"object\",\"required\":[\"dock_accessorials\",\"is_public\",\"id\",\"created_at\",\"updated_at\",\"dock_id\"],\"title\":\"FacilityDockAppointmentRule\"},\"FacilityDockAppointmentRuleList\":{\"properties\":{\"data\":{\"items\":{\"$ref\":\"#/components/schemas/FacilityDockAppointmentRule\"},\"type\":\"array\",\"title\":\"Data\"},\"total_count\":{\"type\":\"integer\",\"title\":\"Total Count\"}},\"type\":\"object\",\"required\":[\"data\",\"total_count\"],\"title\":\"FacilityDockAppointmentRuleList\"},\"FacilityDockList\":{\"properties\":{\"data\":{\"items\":{\"$ref\":\"#/components/schemas/FacilityDock\"},\"type\":\"array\",\"title\":\"Data\"},\"total_count\":{\"type\":\"integer\",\"title\":\"Total Count\"}},\"type\":\"object\",\"required\":[\"data\",\"total_count\"],\"title\":\"FacilityDockList\"},\"FacilityDocument\":{\"properties\":{\"document_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/FacilityDocumentTypeEnum\"}],\"default\":\"OTHER\"},\"description\":{\"type\":\"string\",\"title\":\"Description\"},\"id\":{\"type\":\"string\",\"title\":\"Id\"},\"facility_id\":{\"type\":\"string\",\"title\":\"Facility Id\"},\"filename\":{\"type\":\"string\",\"title\":\"Filename\"},\"url\":{\"type\":\"string\",\"title\":\"Url\"}},\"type\":\"object\",\"required\":[\"id\",\"facility_id\",\"filename\",\"url\"],\"title\":\"FacilityDocument\"},\"FacilityDocumentList\":{\"properties\":{\"data\":{\"items\":{\"$ref\":\"#/components/schemas/FacilityDocument\"},\"type\":\"array\",\"title\":\"Data\"},\"total_count\":{\"type\":\"integer\",\"title\":\"Total Count\"}},\"type\":\"object\",\"required\":[\"data\",\"total_count\"],\"title\":\"FacilityDocumentList\"},\"FacilityDocumentTypeEnum\":{\"type\":\"string\",\"enum\":[\"MAP\",\"OTHER\"],\"title\":\"FacilityDocumentTypeEnum\",\"description\":\"An enumeration.\"},\"FacilityHoliday\":{\"properties\":{\"standard_holiday_name\":{\"allOf\":[{\"$ref\":\"#/components/schemas/StandardHolidays\"}],\"description\":\"StandardHoliday enum member to which this holiday refers. If this is not-null, the `custom_holiday_*` fields must all be null.\",\"example\":null},\"custom_holiday_name\":{\"type\":\"string\",\"title\":\"Custom Holiday Name\",\"description\":\"Human-readable name for a custom holiday. If not-null, then `custom_holiday_date` must also be provided and `standard_holiday_name` must be null.\",\"example\":\"National Puppy Day\"},\"custom_holiday_date\":{\"type\":\"string\",\"format\":\"date\",\"title\":\"Custom Holiday Date\",\"description\":\"Date for a custom holiday. If not-null, then `custom_holiday_name` must also be provided and `standard_holiday_name` must be null.\",\"example\":\"2023-03-23\"},\"first_appointment_start_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"First Appointment Start Time\",\"example\":null},\"last_appointment_end_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"Last Appointment End Time\",\"example\":null},\"closed_all_day\":{\"type\":\"boolean\",\"title\":\"Closed All Day\",\"description\":\"If true, indicates that the Facility is closed for the entire day of the holiday. If this value is true, then `first_appointment_start_time` and `last_appointment_end_time` must both be null.\",\"example\":true},\"is_custom\":{\"type\":\"boolean\",\"title\":\"Is Custom\",\"description\":\"True iff this holiday represents a \\\"custom\\\" holiday, otherwise will be false for \\\"standard\\\" holidays\",\"example\":true},\"facility_id\":{\"type\":\"string\",\"title\":\"Facility Id\"},\"id\":{\"type\":\"string\",\"title\":\"Id\"},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Created At\"},\"updated_at\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Updated At\"}},\"type\":\"object\",\"required\":[\"closed_all_day\",\"is_custom\",\"facility_id\",\"id\",\"created_at\",\"updated_at\"],\"title\":\"FacilityHoliday\"},\"FacilityHolidayList\":{\"properties\":{\"data\":{\"items\":{\"$ref\":\"#/components/schemas/FacilityHoliday\"},\"type\":\"array\",\"title\":\"Data\"},\"total_count\":{\"type\":\"integer\",\"title\":\"Total Count\"}},\"type\":\"object\",\"required\":[\"data\",\"total_count\"],\"title\":\"FacilityHolidayList\"},\"FacilityHolidaySchedule\":{\"properties\":{\"data\":{\"items\":{\"$ref\":\"#/components/schemas/ScheduledFacilityHoliday\"},\"type\":\"array\",\"title\":\"Data\"},\"total_count\":{\"type\":\"integer\",\"title\":\"Total Count\"}},\"type\":\"object\",\"required\":[\"data\",\"total_count\"],\"title\":\"FacilityHolidaySchedule\"},\"FacilityHoursOfOperation\":{\"properties\":{\"day\":{\"$ref\":\"#/components/schemas/DaysOfWeek\"},\"is_facility_open\":{\"type\":\"boolean\",\"title\":\"Is Facility Open\"},\"open_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"Open Time\"},\"close_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"Close Time\"},\"daily_max_capacity\":{\"type\":\"integer\",\"title\":\"Daily Max Capacity\"},\"id\":{\"type\":\"string\",\"title\":\"Id\"},\"facility_id\":{\"type\":\"string\",\"title\":\"Facility Id\"}},\"type\":\"object\",\"required\":[\"day\",\"is_facility_open\",\"id\",\"facility_id\"],\"title\":\"FacilityHoursOfOperation\"},\"FacilityHoursOfOperationList\":{\"properties\":{\"data\":{\"items\":{\"$ref\":\"#/components/schemas/FacilityHoursOfOperation\"},\"type\":\"array\",\"title\":\"Data\"},\"total_count\":{\"type\":\"integer\",\"title\":\"Total Count\"}},\"type\":\"object\",\"required\":[\"data\",\"total_count\"],\"title\":\"FacilityHoursOfOperationList\"},\"FacilityIncludeQueryOptionEnum\":{\"type\":\"string\",\"enum\":[\"DOCKS\",\"DOCK_COUNT\",\"CONTACT_COUNT\",\"LOAD_TYPE_COUNT\",\"POINT_OF_CONTACTS\"],\"title\":\"FacilityIncludeQueryOptionEnum\",\"description\":\"An enumeration.\"},\"FacilityOperatingDate\":{\"properties\":{\"date\":{\"type\":\"string\",\"format\":\"date\",\"title\":\"Date\",\"description\":\"Date on which the Facility may be open or closed, as indicated by the rest of this record\"},\"is_open\":{\"type\":\"boolean\",\"title\":\"Is Open\",\"description\":\"True if the Facility is open for any period of time during this date, else false\"},\"localized_open_datetime\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Localized Open Datetime\",\"description\":\"Localized timestamp of the opening time of this Facility on this date, or null if the Facility is closed on this date\"},\"localized_close_datetime\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Localized Close Datetime\",\"description\":\"Localized timestamp of the closing time of this Facility on this date, or null if the Facility is closed on this date\"}},\"type\":\"object\",\"required\":[\"date\",\"is_open\",\"localized_open_datetime\",\"localized_close_datetime\"],\"title\":\"FacilityOperatingDate\"},\"FacilityOperatingDatesResponse\":{\"properties\":{\"data\":{\"items\":{\"$ref\":\"#/components/schemas/FacilityOperatingDate\"},\"type\":\"array\",\"title\":\"Data\"},\"total_count\":{\"type\":\"integer\",\"title\":\"Total Count\"}},\"type\":\"object\",\"required\":[\"data\",\"total_count\"],\"title\":\"FacilityOperatingDatesResponse\"},\"FacilityOverallAvailability\":{\"properties\":{\"available_windows\":{\"items\":{\"$ref\":\"#/components/schemas/FacilityAvailabilityWindow\"},\"type\":\"array\",\"title\":\"Available Windows\"}},\"type\":\"object\",\"required\":[\"available_windows\"],\"title\":\"FacilityOverallAvailability\"},\"FacilityPointOfContact\":{\"properties\":{\"person_name\":{\"type\":\"string\",\"title\":\"Person Name\"},\"facility_role\":{\"$ref\":\"#/components/schemas/FacilityPointOfContactRole\"},\"phone_number\":{\"type\":\"string\",\"title\":\"Phone Number\"},\"is_default_for_facility\":{\"type\":\"boolean\",\"title\":\"Is Default For Facility\",\"default\":false},\"email\":{\"type\":\"string\",\"format\":\"email\",\"title\":\"Email\"},\"id\":{\"type\":\"string\",\"title\":\"Id\"},\"facility_id\":{\"type\":\"string\",\"title\":\"Facility Id\"},\"user_id\":{\"type\":\"string\",\"title\":\"User Id\"}},\"type\":\"object\",\"required\":[\"person_name\",\"facility_role\",\"id\",\"facility_id\"],\"title\":\"FacilityPointOfContact\"},\"FacilityPointOfContactList\":{\"properties\":{\"data\":{\"items\":{\"$ref\":\"#/components/schemas/FacilityPointOfContact\"},\"type\":\"array\",\"title\":\"Data\"},\"total_count\":{\"type\":\"integer\",\"title\":\"Total Count\"}},\"type\":\"object\",\"required\":[\"data\",\"total_count\"],\"title\":\"FacilityPointOfContactList\"},\"FacilityPointOfContactRole\":{\"type\":\"string\",\"enum\":[\"ADMIN\",\"DOCK_WORKER\",\"DOCK_SUPERVISOR\",\"GATE_SECURITY\"],\"title\":\"FacilityPointOfContactRole\",\"description\":\"An enumeration.\"},\"FacilityServices\":{\"type\":\"string\",\"enum\":[\"RESTROOMS\",\"OVERNIGHT_PARKING\",\"INTERIOR_PARKING\",\"EXTERIOR_PARKING\",\"LOUNGE_AREA\",\"WIFI\",\"FOOD\",\"SECURITY\",\"SPANISH\"],\"title\":\"FacilityServices\",\"description\":\"An enumeration.\"},\"FreightAppointmentAvailabilityRequest\":{\"properties\":{\"delivery_type\":{\"$ref\":\"#/components/schemas/DeliveryTypeEnum\"},\"mode\":{\"$ref\":\"#/components/schemas/DockSchedulingModeEnum\"},\"equipment_type\":{\"$ref\":\"#/components/schemas/DockSchedulingEquipmentTypeEnum\"},\"product_reference\":{\"type\":\"string\",\"title\":\"Product Reference\"},\"product_category\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"title\":\"Product Category\"},\"packaging_type\":{\"$ref\":\"#/components/schemas/PackagingTypes\"},\"stackable\":{\"type\":\"boolean\",\"title\":\"Stackable\"},\"is_hazmat\":{\"type\":\"boolean\",\"title\":\"Is Hazmat\"},\"request_criteria_type\":{\"type\":\"string\",\"enum\":[\"FREIGHT_GENERAL\"],\"title\":\"Request Criteria Type\",\"default\":\"FREIGHT_GENERAL\"},\"start_datetime\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Start Datetime\"},\"end_datetime\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"End Datetime\"},\"dock_ids\":{\"items\":{\"type\":\"string\",\"minLength\":1},\"type\":\"array\",\"minLength\":1,\"title\":\"Dock Ids\",\"description\":\"Filter results to only the desired dock ID(s)\"},\"rescheduling_for_appointment_id\":{\"type\":\"string\",\"minLength\":1,\"title\":\"Rescheduling For Appointment Id\",\"description\":\"Indicates that the user wants availability in order to reschedule this Appointment\"}},\"type\":\"object\",\"required\":[\"start_datetime\",\"end_datetime\"],\"title\":\"FreightAppointmentAvailabilityRequest\",\"description\":\"Set of attributes against which LoadTypes and DockRules may be matched. This payload may be used in order to find\\nLoadTypes and DockRules that are able to handle a particular type of Appointment, particularly when there isn't\\na full-fledged Shipment being scheduled for the Appointment.\"},\"FreightAppointmentScheduledResource\":{\"properties\":{\"resource_type\":{\"type\":\"string\",\"enum\":[\"FREIGHT_GENERAL\"],\"title\":\"Resource Type\",\"default\":\"FREIGHT_GENERAL\"},\"reference_number\":{\"type\":\"string\",\"title\":\"Reference Number\",\"description\":\"Main reference number that the supplier uses to identify the freight. Deprecated in favour of appointment_orders[].references — set to null for new appointments.\"},\"reference_number_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/ReferenceQualifierEnum\"}],\"description\":\"Type of the reference_number being provided. Required when reference_number is set.\",\"example\":\"PO_NUMBER\"},\"linked_appointment_reference_number\":{\"type\":\"string\",\"title\":\"Linked Appointment Reference Number\",\"description\":\"Free-text reference number of another Freight Appointment to which this Freight Appointment has some relationship.\"},\"delivery_type\":{\"$ref\":\"#/components/schemas/DeliveryTypeEnum\"},\"mode\":{\"$ref\":\"#/components/schemas/DockSchedulingModeEnum\"},\"equipment_type\":{\"$ref\":\"#/components/schemas/DockSchedulingEquipmentTypeEnum\"},\"product_category\":{\"items\":{\"type\":\"string\",\"maxLength\":256},\"type\":\"array\",\"maxLength\":256,\"maxItems\":10,\"minItems\":1,\"title\":\"Product Category\"},\"product_references\":{\"items\":{\"type\":\"string\",\"maxLength\":256},\"type\":\"array\",\"maxLength\":256,\"maxItems\":10,\"minItems\":1,\"title\":\"Product References\",\"description\":\"One or more product references this freight is carrying. Forwarded into the Load Type / Dock Rule matching when validating appointment availability.\"},\"stackable\":{\"type\":\"boolean\",\"title\":\"Stackable\"},\"is_hazmat\":{\"type\":\"boolean\",\"title\":\"Is Hazmat\"},\"carrier_name\":{\"type\":\"string\",\"title\":\"Carrier Name\",\"description\":\"Name of the carrier company who will be handling this freight\"},\"carrier_email\":{\"type\":\"string\",\"format\":\"email\",\"title\":\"Carrier Email\",\"description\":\"Email address of the carrier company who will be handling this freight\"},\"carrier_phone_number\":{\"type\":\"string\",\"title\":\"Carrier Phone Number\",\"description\":\"Phone number of the carrier company who will be handling this freight\"},\"driver_name\":{\"type\":\"string\",\"title\":\"Driver Name\",\"description\":\"Name of the driver who will be arriving with this freight\"},\"driver_phone_number\":{\"type\":\"string\",\"title\":\"Driver Phone Number\",\"description\":\"Phone number of the driver who will be handling this freight\"},\"notes\":{\"type\":\"string\",\"title\":\"Notes\",\"description\":\"Free-text notes to be shared amongst all parties involved with the Appointment\"}},\"type\":\"object\",\"required\":[\"delivery_type\",\"carrier_name\",\"carrier_email\"],\"title\":\"FreightAppointmentScheduledResource\",\"description\":\"Supplier-created Appointment data that does not reference an on-platform Shipment, but still has details similar to\\na real Shipment like mode, equipment_type, stackable, etc.\"},\"GeoLocationPoint\":{\"properties\":{\"latitude\":{\"type\":\"number\",\"maximum\":90,\"minimum\":-90,\"title\":\"Latitude\"},\"longitude\":{\"type\":\"number\",\"maximum\":180,\"minimum\":-180,\"title\":\"Longitude\"}},\"type\":\"object\",\"required\":[\"latitude\",\"longitude\"],\"title\":\"GeoLocationPoint\"},\"LoadType\":{\"properties\":{\"delivery_type\":{\"$ref\":\"#/components/schemas/DeliveryTypeEnum\"},\"mode\":{\"$ref\":\"#/components/schemas/DockSchedulingModeEnum\"},\"equipment_type\":{\"$ref\":\"#/components/schemas/DockSchedulingEquipmentTypeEnum\"},\"product_references\":{\"items\":{\"type\":\"string\",\"maxLength\":256},\"type\":\"array\",\"maxLength\":256,\"maxItems\":10,\"minItems\":1,\"title\":\"Product References\",\"description\":\"One or more product references this rule applies to. Canonical field.\"},\"product_reference\":{\"type\":\"string\",\"maxLength\":256,\"title\":\"Product Reference\",\"description\":\"DEPRECATED — use `product_references` instead. On input this single value is folded into `product_references` (and `product_references` wins if both are provided). On output it mirrors the first element of `product_references` for backwards compatibility with pre-array clients.\",\"deprecated\":true},\"product_category\":{\"items\":{\"type\":\"string\",\"maxLength\":256},\"type\":\"array\",\"maxLength\":256,\"maxItems\":10,\"minItems\":1,\"title\":\"Product Category\"},\"product_category_matching_mode\":{\"allOf\":[{\"$ref\":\"#/components/schemas/MatchingModeEnum\"}],\"description\":\"Whether every product category on the load must be on this rule's category list (`ALL`) or only one of them (`AT_LEAST_ONE`).\",\"default\":\"ALL\"},\"product_reference_matching_mode\":{\"allOf\":[{\"$ref\":\"#/components/schemas/MatchingModeEnum\"}],\"description\":\"Whether every line item on the load must be satisfied by an allowed product reference (`ALL`) or only one of them (`AT_LEAST_ONE`).\",\"default\":\"ALL\"},\"packaging_type\":{\"$ref\":\"#/components/schemas/PackagingTypes\"},\"stackable\":{\"type\":\"boolean\",\"title\":\"Stackable\"},\"is_hazmat\":{\"type\":\"boolean\",\"title\":\"Is Hazmat\"},\"name\":{\"type\":\"string\",\"title\":\"Name\"},\"load_unload_duration\":{\"type\":\"string\",\"format\":\"duration\",\"title\":\"Load Unload Duration\",\"example\":\"P1DT23H30M4.000000S\"},\"appointment_duration\":{\"type\":\"string\",\"format\":\"duration\",\"title\":\"Appointment Duration\",\"example\":\"P1DT23H30M4.000000S\"},\"all_day_appointment\":{\"type\":\"boolean\",\"title\":\"All Day Appointment\",\"description\":\"If true, indicates that the Appointment is placed for the entire day. If this value is true, then `load_unload_duration` and `appointment_duration` must both be null.\",\"default\":false},\"id\":{\"type\":\"string\",\"title\":\"Id\"},\"created_at\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Created At\"},\"updated_at\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Updated At\"},\"display_name\":{\"type\":\"string\",\"title\":\"Display Name\"},\"facility_id\":{\"type\":\"string\",\"title\":\"Facility Id\"}},\"type\":\"object\",\"required\":[\"delivery_type\",\"name\",\"id\",\"created_at\",\"updated_at\",\"display_name\",\"facility_id\"],\"title\":\"LoadType\"},\"LoadTypeDockRuleMatchRequest\":{\"properties\":{\"delivery_type\":{\"$ref\":\"#/components/schemas/DeliveryTypeEnum\"},\"mode\":{\"$ref\":\"#/components/schemas/DockSchedulingModeEnum\"},\"equipment_type\":{\"$ref\":\"#/components/schemas/DockSchedulingEquipmentTypeEnum\"},\"product_reference\":{\"type\":\"string\",\"title\":\"Product Reference\"},\"product_category\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"title\":\"Product Category\"},\"packaging_type\":{\"$ref\":\"#/components/schemas/PackagingTypes\"},\"stackable\":{\"type\":\"boolean\",\"title\":\"Stackable\"},\"is_hazmat\":{\"type\":\"boolean\",\"title\":\"Is Hazmat\"}},\"type\":\"object\",\"title\":\"LoadTypeDockRuleMatchRequest\",\"description\":\"Set of attributes against which LoadTypes and DockRules may be matched. This payload may be used in order to find\\nLoadTypes and DockRules that are able to handle a particular type of Appointment, particularly when there isn't\\na full-fledged Shipment being scheduled for the Appointment.\"},\"LoadTypeDockRuleMatchResults\":{\"properties\":{\"facility_id\":{\"type\":\"string\",\"title\":\"Facility Id\",\"description\":\"ID of the Facility whose Docks and LoadTypes are being matched\"},\"matched_load_type_ids\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"title\":\"Matched Load Type Ids\",\"description\":\"LoadTypes whose criteria match the provided criteria attributes\"},\"matched_docks\":{\"items\":{\"$ref\":\"#/components/schemas/MatchedDockAndRules\"},\"type\":\"array\",\"title\":\"Matched Docks\",\"description\":\"Docks capable of accommodating these criteria, along with the FacilityDockAppointmentRules that make the accommodation possible. Docks in this list are returned in order of best match. That order is a contract rather than presentation: `POST /facilities/{facility_id}/availability` with `merge_docks` uses it to decide which Dock each span of availability is attributed to. Rules listed on each dock are also in best match order for that dock but that order is not guaranteed across different docks. Just because a Dock shows up in this list does not necessarily mean that the Dock is actively available. It just means that the Dock can theoretically accommodate the criteria when it has availability.\"},\"bypassed_docks\":{\"items\":{\"$ref\":\"#/components/schemas/MatchedDockAndRules\"},\"type\":\"array\",\"title\":\"Bypassed Docks\",\"description\":\"Docks that do NOT match the requested criteria (the Docks that would normally be removed from availability), each with all of its FacilityDockAppointmentRules. This is populated regardless of whether the `dock_scheduling.bypass_scheduling_rules` permission is held. When the permission IS held, `matched_docks` is widened to include every Dock that has at least one applicable rule, so these bypassed Docks also appear there (the two lists overlap). When it is NOT held, `matched_docks` and `bypassed_docks` are disjoint and their union covers every Dock that has at least one applicable rule. (Docks with no rules appear in neither list, since they cannot be scheduled against.)\",\"default\":[]},\"potential_appointment_types\":{\"items\":{\"$ref\":\"#/components/schemas/FacilityAppointmentType\"},\"type\":\"array\",\"minItems\":1,\"description\":\"All legal methods of scheduling an appointment for these freight criteria. Since appointment types are managed at the level of individual FacilityDockAppointmentRules, this aggregates all possible values of `appointment_type` across those rules. Only FacilityDockAppointmentRules that have `is_public=True` will be considered when determining this set. This defaults to a single element list of `BY_APPOINTMENT_ONLY` if no public rules were matched.\",\"default\":[\"BY_APPOINTMENT_ONLY\"]},\"all_matched_dock_rules\":{\"items\":{\"$ref\":\"#/components/schemas/FacilityDockAppointmentRule\"},\"type\":\"array\",\"title\":\"All Matched Dock Rules\",\"description\":\"All FacilityDockAppointmentRules that match the freight criteria, fully-expanded. This will be null by default for performance purposes, but if desired the consumer may request to populate this list by using the `include` query parameter.\"},\"best_matched_load_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/LoadType\"}],\"title\":\"Best Matched Load Type\",\"description\":\"Fully-expanded LoadType that best matches the criteria. This should have the same ID as the first entry in `matched_load_type_ids`. This will only ever be non-null if explicitly requested using the `include` query parameter. Even so, it may still be null if not a single LoadType matched the criteria.\"}},\"type\":\"object\",\"required\":[\"facility_id\",\"matched_load_type_ids\",\"matched_docks\"],\"title\":\"LoadTypeDockRuleMatchResults\",\"description\":\"Search results for which LoadTypes, Docks, and DockAppointmentRules match provided freight criteria at a given\\nFacility.\"},\"LocationTypes\":{\"type\":\"string\",\"enum\":[\"AIRPORT\",\"BUSINESS_WITH_DOCK_OR_FORKLIFT\",\"BUSINESS_WITHOUT_DOCK_OR_FORKLIFT\",\"COMMERCIAL_FARM_RANCH_MARINA\",\"CONSTRUCTION_SITE\",\"GOVERNMENT_LOCATION\",\"MILITARY_BASE\",\"OTHER_SECURED_OR_LIMITED_ACCESS_LOCATION\",\"RELIGIOUS_INSTITUTION\",\"RESIDENCE_HOME_BUSINESS\",\"RESTAURANT_HOTEL_GOLF_COURSE_PARK\",\"SCHOOL_COLLEGE\",\"SELF_MINI_STORAGE_FACILITY\",\"TERMINAL\",\"TRADE_SHOW_CONVENTION_CENTER\"],\"title\":\"LocationTypes\",\"description\":\"An enumeration.\"},\"MatchedDockAndRules\":{\"properties\":{\"dock_id\":{\"type\":\"string\",\"title\":\"Dock Id\"},\"dock_rule_ids\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"minItems\":1,\"title\":\"Dock Rule Ids\"}},\"type\":\"object\",\"required\":[\"dock_id\",\"dock_rule_ids\"],\"title\":\"MatchedDockAndRules\"},\"MatchingModeEnum\":{\"type\":\"string\",\"enum\":[\"ALL\",\"AT_LEAST_ONE\"],\"title\":\"MatchingModeEnum\",\"description\":\"How a rule's allowed-product list is compared against the products on a load.\"},\"NoCriteriaAvailabilityRequest\":{\"properties\":{\"request_criteria_type\":{\"type\":\"string\",\"enum\":[\"NO_CRITERIA\"],\"title\":\"Request Criteria Type\",\"default\":\"NO_CRITERIA\"},\"start_datetime\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Start Datetime\"},\"end_datetime\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"End Datetime\"},\"dock_ids\":{\"items\":{\"type\":\"string\",\"minLength\":1},\"type\":\"array\",\"minLength\":1,\"title\":\"Dock Ids\",\"description\":\"Filter results to only the desired dock ID(s)\"},\"rescheduling_for_appointment_id\":{\"type\":\"string\",\"minLength\":1,\"title\":\"Rescheduling For Appointment Id\",\"description\":\"Indicates that the user wants availability in order to reschedule this Appointment\"}},\"type\":\"object\",\"required\":[\"start_datetime\",\"end_datetime\"],\"title\":\"NoCriteriaAvailabilityRequest\"},\"PackagingTypes\":{\"type\":\"string\",\"enum\":[\"PLT\",\"PKG\",\"FLOOR_LOADED\",\"BAG\",\"BALE\",\"BIN\",\"BOTTLE\",\"BOX\",\"BUCKET\",\"PAIL\",\"BUNDLE\",\"CAN\",\"CARTON\",\"CASE\",\"COIL\",\"CRATE\",\"CYLINDER\",\"DRUM\",\"JERRICAN\",\"PACKAGE\",\"PIECES\",\"REEL\",\"ROLL\",\"SKID\",\"TUBE\",\"TOTE_BIN\",\"TOTE_CAN\",\"UNIT\",\"BARREL\",\"VOLUME_GAL\",\"VOLUME_L\",\"OTHER\"],\"title\":\"PackagingTypes\",\"description\":\"An enumeration.\"},\"PaginatedResponse_AppointmentListItem_\":{\"properties\":{\"data\":{\"items\":{\"$ref\":\"#/components/schemas/AppointmentListItem\"},\"type\":\"array\",\"title\":\"Data\"},\"total_count\":{\"type\":\"integer\",\"title\":\"Total Count\"}},\"type\":\"object\",\"required\":[\"data\",\"total_count\"],\"title\":\"PaginatedResponse[AppointmentListItem]\"},\"PaginatedResponse_Facility_\":{\"properties\":{\"data\":{\"items\":{\"$ref\":\"#/components/schemas/Facility\"},\"type\":\"array\",\"title\":\"Data\"},\"total_count\":{\"type\":\"integer\",\"title\":\"Total Count\"}},\"type\":\"object\",\"required\":[\"data\",\"total_count\"],\"title\":\"PaginatedResponse[Facility]\"},\"PaginatedResponse_LoadType_\":{\"properties\":{\"data\":{\"items\":{\"$ref\":\"#/components/schemas/LoadType\"},\"type\":\"array\",\"title\":\"Data\"},\"total_count\":{\"type\":\"integer\",\"title\":\"Total Count\"}},\"type\":\"object\",\"required\":[\"data\",\"total_count\"],\"title\":\"PaginatedResponse[LoadType]\"},\"PatchAppointmentRequest\":{\"properties\":{\"start\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Start\",\"description\":\"New appointment window start. Replays the reschedule rules.\"},\"end\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"End\",\"description\":\"New appointment window end. Replays the reschedule rules.\"},\"dock_id\":{\"type\":\"string\",\"title\":\"Dock Id\",\"description\":\"Dock to move the appointment to, or null to detach it from any specific dock.\"},\"checked_in_at\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Checked In At\",\"description\":\"Check-in time. Replays the check-in rules, including lateness.\"},\"checked_out_at\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Checked Out At\",\"description\":\"Check-out time. Replays the check-out rules.\"},\"dock_in_at\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Dock In At\",\"description\":\"When the truck moved onto the dock. Written as sent: no ordering against the other timestamps, no window check, no effect on status.\"},\"dock_out_at\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Dock Out At\",\"description\":\"When the truck left the dock. Same freedom as `dock_in_at`.\"},\"actual_start_at\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Actual Start At\",\"description\":\"When loading or unloading actually began. Same freedom as `dock_in_at`.\"},\"actual_stop_at\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Actual Stop At\",\"description\":\"When loading or unloading actually finished. Same freedom as `dock_in_at`.\"},\"delivery_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DeliveryTypeEnum\"}],\"description\":\"Whether the freight is being received or shipped. Lives on the appointment and on its freight details; sending it writes both. Cannot be cleared.\"},\"carrier_name\":{\"type\":\"string\",\"minLength\":1,\"title\":\"Carrier Name\",\"description\":\"Carrier handling the freight, by name. FREIGHT_GENERAL only: lives on the appointment and on its freight details; sending it writes both. Cannot be cleared. A SHIPMENT appointment takes `carrier_id` instead.\"},\"carrier_id\":{\"type\":\"string\",\"minLength\":1,\"title\":\"Carrier Id\",\"description\":\"Carrier handling the freight, as the backend-core company id. SHIPMENT only: assigns the carrier on the shipment. Cannot be cleared here. Changing the carrier also drops the shipment's driver, trailer and power unit unless sent in the same request, since they belonged to the previous carrier. The appointment itself is not touched: the existing carrier-change rules then apply through the shipment events -- a SCHEDULED by-appointment slot held for another carrier is released and goes back to UNSCHEDULED, and an appointment in any other status is not touched at all. So this response still carries the previous carrier in `carrier_tenant_id`, `carrier_name`, `carrier_scac` and `driver_id`; the carrier backend-core just saved is in `shipment.relationship_to_vendor.vendor` on the same response.\"},\"trailer_name\":{\"type\":\"string\",\"minLength\":1,\"title\":\"Trailer Name\",\"description\":\"Trailer assigned to the shipment. SHIPMENT only. Null clears it.\"},\"driver_name\":{\"type\":\"string\",\"minLength\":1,\"title\":\"Driver Name\",\"description\":\"Driver arriving with the freight. FREIGHT_GENERAL only. Null clears it.\"},\"driver_phone_number\":{\"type\":\"string\",\"title\":\"Driver Phone Number\",\"description\":\"Driver's phone number, any parseable format. Null clears it. On a SHIPMENT appointment this is how the driver is identified, so it selects (or removes) the shipment's driver.\"},\"mode\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DockSchedulingModeEnum\"}],\"description\":\"Transport mode. Null clears it.\"},\"equipment_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DockSchedulingEquipmentTypeEnum\"}],\"description\":\"Equipment type. Null clears it.\"},\"reference_number\":{\"type\":\"string\",\"minLength\":1,\"title\":\"Reference Number\",\"description\":\"The appointment's typed reference. Lives on the freight details and is mirrored into the appointment's `reference_id`; sending it writes both. Null clears.\"},\"reference_number_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/ReferenceQualifierEnum\"}],\"description\":\"What kind of reference `reference_number` is. Meaningless without a `reference_number`, so it cannot be set while that is empty. Null clears.\"},\"references\":{\"items\":{\"$ref\":\"#/components/schemas/Reference\"},\"type\":\"array\",\"title\":\"References\",\"description\":\"The appointment's searchable references, replacing the stored list as a whole -- the same semantics as `/schedule`. An empty list (or null) clears it. Available regardless of resource type; which types the panel shows it for is the client's call. On a SHIPMENT appointment only BOL_NUMBER, PRO_NUMBER and CUSTOMER_REFERENCE_NUMBER (one each) can change -- they are written to the shipment; SHIPMENT_REFERENCE_ID, STOP_EXTERNAL_REFERENCE_ID, PO_NUMBER and ORDER_NUMBER are mirrored from the shipment and its purchase orders and must come back unchanged (or be left out entirely).\"},\"line_items\":{\"items\":{\"$ref\":\"#/components/schemas/PatchShipmentLineItem\"},\"type\":\"array\",\"title\":\"Line Items\",\"description\":\"Existing line items of the shipment to change, each by `id` with only the fields to change. SHIPMENT only. Line items not listed are left alone; none are created or deleted. An unknown id is a 400.\"},\"location_company\":{\"type\":\"string\",\"minLength\":1,\"title\":\"Location Company\",\"description\":\"Company name at the shipment stop this appointment is booked for -- the panel's Location Company. SHIPMENT only; the other stops are untouched. Null clears it.\"}},\"type\":\"object\",\"title\":\"PatchAppointmentRequest\",\"description\":\"Partial update of an appointment.\\n\\nEvery field is optional and the three states are distinguishable: **absent** leaves the stored\\nvalue alone, a **value** sets it, and **null** clears it where clearing is supported --\\n``checked_in_at`` and ``checked_out_at`` cannot be cleared, and ``carrier_name`` and\\n``delivery_type`` are required on a FREIGHT_GENERAL appointment, so null on those is a 400.\\nRead the payload with ``__fields_set__`` / ``exclude_unset=True`` -- never with plain attribute\\naccess, which cannot tell an omitted field from one explicitly sent as null.\\n\\nThe contract is resource-type agnostic and uses the same field names as the create and\\nschedule contracts (``start``, ``dock_id``, ``checked_in_at``, ``carrier_name``, ``mode``,\\n``references``, ...), so API clients see one vocabulary regardless of how each type stores a\\nfield. It deliberately carries no ``scheduled_resource_metadata``, which would leak the\\npolymorphic table into the API and has no meaning for a SHIPMENT appointment.\\n\\nA few fields only exist for one resource type and are a 400 on the other: ``carrier_name``,\\n``driver_name`` and the typed reference are FREIGHT_GENERAL only (a shipment's carrier is a\\ncompany, its driver a record identified by phone); ``carrier_id``, ``trailer_name``,\\n``line_items`` and ``location_company`` are SHIPMENT only. Which fields the panel shows for\\neach type is the client's call.\\n\\n``start`` / ``end`` are not validated as a pair here: a request may send only one of them, and\\nthe other then comes from the stored row. The merged pair is validated by the service.\"},\"PatchShipmentLineItem\":{\"properties\":{\"id\":{\"type\":\"string\",\"minLength\":1,\"title\":\"Id\",\"description\":\"The backend-core line item id. Required.\"},\"description\":{\"type\":\"string\",\"title\":\"Description\"},\"product_ref\":{\"type\":\"string\",\"title\":\"Product Ref\"},\"product_category\":{\"type\":\"string\",\"title\":\"Product Category\"},\"total_packages\":{\"type\":\"number\",\"minimum\":0,\"title\":\"Total Packages\"},\"package_type\":{\"$ref\":\"#/components/schemas/PackagingTypes\"},\"package_weight\":{\"type\":\"number\",\"minimum\":0,\"title\":\"Package Weight\"},\"weight_unit\":{\"type\":\"string\",\"minLength\":1,\"title\":\"Weight Unit\"},\"piece_type\":{\"type\":\"string\",\"minLength\":1,\"title\":\"Piece Type\"},\"total_pieces\":{\"type\":\"integer\",\"minimum\":0,\"title\":\"Total Pieces\"},\"refrigeration_min_temp\":{\"type\":\"number\",\"title\":\"Refrigeration Min Temp\"},\"refrigeration_max_temp\":{\"type\":\"number\",\"title\":\"Refrigeration Max Temp\"},\"temp_unit\":{\"type\":\"string\",\"enum\":[\"F\",\"C\"],\"title\":\"Temp Unit\"}},\"type\":\"object\",\"required\":[\"id\"],\"title\":\"PatchShipmentLineItem\",\"description\":\"One existing line item of a SHIPMENT appointment's shipment, partially updated.\\n\\nField names are backend-core's own (`ShipmentLineItem`), so the values travel into the\\nshipment `PUT` without translation. Only the fields sent are changed; the others keep the\\nstored value. ``id`` is required: this route edits line items, it does not create or delete\\nthem. The set is deliberately what the edit panel shows -- backend-core's line item has many\\nmore columns, which can be added here as the panel needs them.\"},\"PatchedAppointment\":{\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Name\"},\"reason\":{\"allOf\":[{\"$ref\":\"#/components/schemas/AppointmentReason\"}],\"description\":\"Reason for the Appointment.\"},\"reference_id\":{\"type\":\"string\",\"title\":\"Reference Id\"},\"description\":{\"type\":\"string\",\"title\":\"Description\"},\"is_all_day\":{\"type\":\"boolean\",\"title\":\"Is All Day\",\"description\":\"If true, indicates that the Appointment's start/end should equal the operating hours of the Facility/Dock at which it is scheduled.\",\"default\":false},\"matched_load_type_id\":{\"type\":\"string\",\"title\":\"Matched Load Type Id\",\"description\":\"ID of the LoadType whose fields should be used to determine if it matches an Appointment.\"},\"references\":{\"items\":{\"$ref\":\"#/components/schemas/Reference\"},\"type\":\"array\",\"title\":\"References\",\"description\":\"List of references for the appointment that can be used to search for the appointment later.\",\"default\":[]},\"start\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"end\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"stop_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Stop Id\"},\"carrier_name\":{\"type\":\"string\",\"title\":\"Carrier Name\"},\"carrier_contact\":{\"type\":\"string\",\"title\":\"Carrier Contact\"},\"carrier_tenant_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Carrier Tenant Id\"},\"driver_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Driver Id\"},\"appointment_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/FacilityAppointmentType\"}],\"default\":\"BY_APPOINTMENT_ONLY\"},\"delivery_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DeliveryTypeEnum\"}],\"description\":\"Whether the delivery type is loading or unloading Freight.\"},\"scheduled_resource_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/ScheduledResourceTypeEnum\"}],\"description\":\"Required when the scheduled_resource_id field is provided.\"},\"scheduled_resource_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Scheduled Resource Id\"},\"scheduled_resource_metadata\":{\"oneOf\":[{\"$ref\":\"#/components/schemas/FreightAppointmentScheduledResource\"},{\"$ref\":\"#/components/schemas/ShipmentAppointmentScheduledResource\"}],\"title\":\"Scheduled Resource Metadata\",\"description\":\"Additional details about the resource for which this Appointment is scheduling, or null if the Appointment does not relate to any scheduled resource. For example, if this Appointment relates to a Shipment, these details will be described by a ShipmentAppointmentScheduledResource. Or if the Appointment is managing off-platform freight, the details will instead be described using the FreightAppointmentScheduledResource schema.\",\"discriminator\":{\"propertyName\":\"resource_type\",\"mapping\":{\"FREIGHT_GENERAL\":\"#/components/schemas/FreightAppointmentScheduledResource\",\"SHIPMENT\":\"#/components/schemas/ShipmentAppointmentScheduledResource\"}}},\"notes\":{\"type\":\"string\",\"title\":\"Notes\"},\"appointment_orders\":{\"items\":{\"$ref\":\"#/components/schemas/CreateAppointmentOrder\"},\"type\":\"array\",\"title\":\"Appointment Orders\"},\"id\":{\"type\":\"string\",\"maxLength\":26,\"minLength\":26,\"title\":\"Id\"},\"facility_id\":{\"type\":\"string\",\"title\":\"Facility Id\",\"description\":\"Facility at which the appointment takes place\"},\"dock_id\":{\"type\":\"string\",\"title\":\"Dock Id\",\"description\":\"Dock at which the appointment is scheduled, or null if the appointment is not scheduled for any specific dock.\"},\"status\":{\"$ref\":\"#/components/schemas/AppointmentStatusEnum\"},\"is_closed\":{\"type\":\"boolean\",\"title\":\"Is Closed\",\"description\":\"Check the status of appointment to see why it's closed.\"},\"created_by\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Created By\",\"description\":\"Unique identifier of Entity creating the appointment. e.g. Freight Authority ID, User, Company, System, etc.\"},\"deleted_by\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Deleted By\",\"description\":\"Unique identifier of Entity creating the appointment. e.g. Freight Authority ID, User, Company, System, etc.\"},\"checked_in_at\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"checked_in_by_user_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Checked In By User Id\"},\"checked_out_at\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"checked_out_by_user_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Checked Out By User Id\"},\"dock_in_at\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Dock In At\",\"description\":\"When the truck moved onto the dock. Free-form: not validated against the other timestamps or the appointment window, and it does not change the status.\"},\"dock_out_at\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Dock Out At\",\"description\":\"When the truck left the dock. Same freedom as `dock_in_at`.\"},\"actual_start_at\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Actual Start At\",\"description\":\"When loading or unloading actually began, as opposed to `start`.\"},\"actual_stop_at\":{\"allOf\":[{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"}],\"title\":\"Actual Stop At\",\"description\":\"When loading or unloading actually finished, as opposed to `end`.\"},\"rejected_at\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"rejected_reasons\":{\"type\":\"string\",\"title\":\"Rejected Reasons\"},\"declined_at\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"declined_reasons\":{\"type\":\"string\",\"title\":\"Declined Reasons\"},\"declined_by_user_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Declined By User Id\"},\"requested_at\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"requested_by_user_id\":{\"type\":\"string\",\"maxLength\":36,\"minLength\":26,\"title\":\"Requested By User Id\"},\"request_note\":{\"type\":\"string\",\"title\":\"Request Note\",\"description\":\"Message from the requester, set when the appointment was submitted as a time request.\"},\"scheduled_resource_reference_id\":{\"type\":\"string\",\"maxLength\":8,\"minLength\":6,\"title\":\"Scheduled Resource Reference Id\"},\"confirmation_number\":{\"type\":\"string\",\"maxLength\":9,\"minLength\":9,\"title\":\"Confirmation Number\",\"description\":\"Customer-facing confirmation number assigned once at creation and immutable for the life of the Appointment. 'SCH' followed by 6 upper-case alphanumeric characters, excluding 0/1/I/O, e.g. 'SCH8EH4L5'.\"},\"carrier_scac\":{\"type\":\"string\",\"maxLength\":256,\"title\":\"Carrier Scac\",\"description\":\"Standard Carrier Alpha Code of the assigned carrier, mirrored from the carrier's backend-core identifying codes beside `carrier_tenant_id` and `carrier_name`. Read-only, and eventually consistent like the rest of that copy: the shipment's carrier events refresh it, and they do not cover every appointment status. Null when there is no carrier, when the carrier has no SCAC, or when it has not been resolved yet.\",\"readOnly\":true},\"shipment\":{\"allOf\":[{\"$ref\":\"#/components/schemas/AppointmentShipmentData\"}],\"title\":\"Shipment\",\"description\":\"The shipment this appointment is booked for, as tempus last cached it. Holds the values backend-core owns -- among them the carrier this request may have just assigned, in `relationship_to_vendor.vendor`, well before the appointment's own carrier columns catch up. Null for a FREIGHT_GENERAL appointment, which has no shipment, and on a cache miss. Refreshed on a best-effort basis by the save, so if that refresh was skipped or failed this is whatever was last cached, which may be arbitrarily stale.\",\"readOnly\":true}},\"type\":\"object\",\"required\":[\"id\",\"facility_id\",\"status\"],\"title\":\"PatchedAppointment\",\"description\":\"The PATCH response: the appointment plus the cached projection of its shipment.\\n\\nDeliberately a sibling of `AppointmentListItem` rather than a relative. The two happen to\\nembed the same projection, but the list item drops `appointment_orders` for list performance\\nand this response must keep them, so sharing a base would couple two contracts that are free\\nto diverge.\\n\\nThe projection is read-through cache, not appointment state, and it is the only place several\\nshipment-owned values this route edits are readable -- `trailer_name`, the stop's company name,\\nthe mode and equipment type, and the line item ids the request takes. A response that changed\\nthem and did not carry it back would leave the client to re-read from a different endpoint.\\n\\nRead through the shipment cache, which the save refreshes on a best-effort basis. With caching\\ndisabled, or if that refresh fails, the read still happens and returns whatever was last cached\\nfor this tenant -- the shipment events populate it either way -- so the projection can be\\narbitrarily stale rather than merely pre-save.\"},\"PersonaDescriptionSchema\":{\"properties\":{\"should_display_appointments_nav\":{\"type\":\"boolean\",\"title\":\"Should Display Appointments Nav\"}},\"type\":\"object\",\"required\":[\"should_display_appointments_nav\"],\"title\":\"PersonaDescriptionSchema\"},\"PlanningSessionResponse\":{\"properties\":{\"id\":{\"type\":\"string\",\"title\":\"Id\"},\"user_id\":{\"type\":\"string\",\"title\":\"User Id\"},\"planner_display_name\":{\"type\":\"string\",\"title\":\"Planner Display Name\"},\"status\":{\"$ref\":\"#/components/schemas/PlanningSessionStatusEnum\"},\"started_at\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Started At\"},\"expires_at\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Expires At\"},\"locked_appointment_ids\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"title\":\"Locked Appointment Ids\"}},\"type\":\"object\",\"required\":[\"id\",\"user_id\",\"status\",\"started_at\",\"expires_at\"],\"title\":\"PlanningSessionResponse\",\"description\":\"Active-session status returned by enter and get-active.\"},\"PlanningSessionStatusEnum\":{\"type\":\"string\",\"enum\":[\"ACTIVE\",\"SAVED\",\"EXPIRED\",\"DISCARDED\"],\"title\":\"PlanningSessionStatusEnum\",\"description\":\"An enumeration.\"},\"Reference\":{\"properties\":{\"qualifier\":{\"$ref\":\"#/components/schemas/ReferenceQualifierEnum\"},\"value\":{\"type\":\"string\",\"title\":\"Value\"}},\"type\":\"object\",\"required\":[\"qualifier\",\"value\"],\"title\":\"Reference\"},\"ReferenceQualifierEnum\":{\"type\":\"string\",\"enum\":[\"PO_NUMBER\",\"ORDER_NUMBER\",\"BOL_NUMBER\",\"PRO_NUMBER\",\"CUSTOMER_REFERENCE_NUMBER\",\"SHIPMENT_REFERENCE_ID\",\"STOP_EXTERNAL_REFERENCE_ID\"],\"title\":\"ReferenceQualifierEnum\",\"description\":\"An enumeration.\"},\"ReferenceSearchAppointment\":{\"properties\":{\"id\":{\"type\":\"string\",\"title\":\"Id\"},\"status\":{\"$ref\":\"#/components/schemas/AppointmentStatusEnum\"},\"stop_id\":{\"type\":\"string\",\"title\":\"Stop Id\"}},\"type\":\"object\",\"required\":[\"id\",\"status\"],\"title\":\"ReferenceSearchAppointment\",\"description\":\"One appointment of a matched shipment at the searched facility: what the wizard needs to\\nbranch (schedule the placeholder, or show it as booked) and to call `/schedule` or\\n`/request-time`. `stop_id` pairs it with the shipment stop it belongs to, since a shipment can\\nstop at the same facility twice. No window, dock or booker on purpose: the caller can be a\\ncross-tenant scheduler, who otherwise only sees the appointments it booked.\"},\"ReferenceSearchResponse\":{\"properties\":{\"shipments\":{\"items\":{\"$ref\":\"#/components/schemas/BeCoreShipment\"},\"type\":\"array\",\"title\":\"Shipments\"},\"orders\":{\"items\":{\"$ref\":\"#/components/schemas/CorrogoOrder\"},\"type\":\"array\",\"title\":\"Orders\"},\"shipment_appointments\":{\"additionalProperties\":{\"items\":{\"$ref\":\"#/components/schemas/ReferenceSearchAppointment\"},\"type\":\"array\"},\"type\":\"object\",\"title\":\"Shipment Appointments\",\"description\":\"Per matched shipment id, its appointments at the searched facility. Every matched shipment has an entry; an empty list means it has no appointment here.\"}},\"type\":\"object\",\"required\":[\"shipments\",\"orders\"],\"title\":\"ReferenceSearchResponse\"},\"RequestAppointmentTimeRequest\":{\"properties\":{\"start\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"end\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"dock_id\":{\"type\":\"string\",\"title\":\"Dock Id\",\"description\":\"Dock at which we want to schedule the appointment, or null if the appointment should not be scheduled for any specific dock.\"},\"name\":{\"type\":\"string\",\"title\":\"Name\"},\"reason\":{\"allOf\":[{\"$ref\":\"#/components/schemas/AppointmentReason\"}],\"description\":\"Reason for the Appointment.\"},\"reference_id\":{\"type\":\"string\",\"title\":\"Reference Id\"},\"description\":{\"type\":\"string\",\"title\":\"Description\"},\"is_all_day\":{\"type\":\"boolean\",\"title\":\"Is All Day\",\"description\":\"If true, indicates that the Appointment's start/end should equal the operating hours of the Facility/Dock at which it is scheduled.\",\"default\":false},\"matched_load_type_id\":{\"type\":\"string\",\"title\":\"Matched Load Type Id\",\"description\":\"ID of the LoadType whose fields should be used to determine if it matches an Appointment.\"},\"references\":{\"items\":{\"$ref\":\"#/components/schemas/Reference\"},\"type\":\"array\",\"title\":\"References\",\"description\":\"List of references for the appointment that can be used to search for the appointment later, or null if appointment references should not be modified by this request.\"},\"appointment_orders\":{\"items\":{\"$ref\":\"#/components/schemas/CreateAppointmentOrder\"},\"type\":\"array\",\"title\":\"Appointment Orders\",\"description\":\"List of orders for the appointment, or null if appointment_orders should not be modified by this request.\"},\"request_note\":{\"type\":\"string\",\"title\":\"Request Note\",\"description\":\"Message from the requester explaining what they are asking for.\"}},\"type\":\"object\",\"required\":[\"start\",\"end\"],\"title\":\"RequestAppointmentTimeRequest\",\"description\":\"Body for `POST /facilities/appointments/{id}/request-time`: a window the facility does not offer.\"},\"RequiredDocumentMatch\":{\"properties\":{\"document_type\":{\"$ref\":\"#/components/schemas/AppointmentDocumentTypeEnum\"},\"filename\":{\"type\":\"string\",\"title\":\"Filename\"},\"source\":{\"$ref\":\"#/components/schemas/DocumentSourceEnum\"},\"source_id\":{\"type\":\"string\",\"title\":\"Source Id\",\"description\":\"ID of the appointment, shipment or order the document hangs off. For an ORDER_RELEASE document this is the order, not the release.\"}},\"additionalProperties\":false,\"type\":\"object\",\"required\":[\"document_type\",\"filename\",\"source\"],\"title\":\"RequiredDocumentMatch\",\"description\":\"One document that satisfies a required type. Deliberately an allow-list: no URL, no content and\\nno description, because this is served to a cross-tenant scheduler who is only admitted to read\\nthe facility, not the shipment or the orders behind it.\"},\"RescheduleAppointmentRequest\":{\"properties\":{\"start\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"end\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"dock_id\":{\"type\":\"string\",\"title\":\"Dock Id\",\"description\":\"Dock at which we want to reschedule the appointment, or null if the appointment should not be rescheduled for any specific dock.\"},\"appointment_orders\":{\"items\":{\"$ref\":\"#/components/schemas/CreateAppointmentOrder\"},\"type\":\"array\",\"title\":\"Appointment Orders\",\"description\":\"List of orders for the appointment, or null if appointment_orders should not be modified by this request.\"}},\"type\":\"object\",\"required\":[\"start\",\"end\"],\"title\":\"RescheduleAppointmentRequest\"},\"SaveFailure\":{\"properties\":{\"appointment_id\":{\"type\":\"string\",\"title\":\"Appointment Id\"},\"reason\":{\"type\":\"string\",\"title\":\"Reason\"}},\"type\":\"object\",\"required\":[\"appointment_id\",\"reason\"],\"title\":\"SaveFailure\"},\"SavePlanningResponse\":{\"properties\":{\"applied\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"title\":\"Applied\"},\"failed\":{\"items\":{\"$ref\":\"#/components/schemas/SaveFailure\"},\"type\":\"array\",\"title\":\"Failed\"},\"conflicts\":{\"items\":{\"$ref\":\"#/components/schemas/ConflictPair\"},\"type\":\"array\",\"title\":\"Conflicts\"}},\"type\":\"object\",\"title\":\"SavePlanningResponse\",\"description\":\"Result of an atomic save. Full rollback when `failed` or `conflicts` is non-empty.\"},\"ScheduleAppointmentRequest\":{\"properties\":{\"start\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"end\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"dock_id\":{\"type\":\"string\",\"title\":\"Dock Id\",\"description\":\"Dock at which we want to schedule the appointment, or null if the appointment should not be scheduled for any specific dock.\"},\"name\":{\"type\":\"string\",\"title\":\"Name\"},\"reason\":{\"allOf\":[{\"$ref\":\"#/components/schemas/AppointmentReason\"}],\"description\":\"Reason for the Appointment.\"},\"reference_id\":{\"type\":\"string\",\"title\":\"Reference Id\"},\"description\":{\"type\":\"string\",\"title\":\"Description\"},\"is_all_day\":{\"type\":\"boolean\",\"title\":\"Is All Day\",\"description\":\"If true, indicates that the Appointment's start/end should equal the operating hours of the Facility/Dock at which it is scheduled.\",\"default\":false},\"matched_load_type_id\":{\"type\":\"string\",\"title\":\"Matched Load Type Id\",\"description\":\"ID of the LoadType whose fields should be used to determine if it matches an Appointment.\"},\"references\":{\"items\":{\"$ref\":\"#/components/schemas/Reference\"},\"type\":\"array\",\"title\":\"References\",\"description\":\"List of references for the appointment that can be used to search for the appointment later, or null if appointment references should not be modified by this request.\"},\"appointment_orders\":{\"items\":{\"$ref\":\"#/components/schemas/CreateAppointmentOrder\"},\"type\":\"array\",\"title\":\"Appointment Orders\",\"description\":\"List of orders for the appointment, or null if appointment_orders should not be modified by this request.\"}},\"type\":\"object\",\"required\":[\"start\",\"end\"],\"title\":\"ScheduleAppointmentRequest\"},\"ScheduledFacilityHoliday\":{\"properties\":{\"human_readable_holiday_name\":{\"type\":\"string\",\"title\":\"Human Readable Holiday Name\"},\"date\":{\"type\":\"string\",\"format\":\"date\",\"title\":\"Date\"},\"observed\":{\"type\":\"boolean\",\"title\":\"Observed\",\"description\":\"Whether this date is an observance of a holiday, rather than the exact holiday date\"},\"standard_holiday_name\":{\"allOf\":[{\"$ref\":\"#/components/schemas/StandardHolidays\"}],\"description\":\"StandardHoliday enum member to which this holiday refers. If this is not-null, the `custom_holiday_*` fields must all be null.\",\"example\":null},\"custom_holiday_name\":{\"type\":\"string\",\"title\":\"Custom Holiday Name\",\"description\":\"Human-readable name for a custom holiday. If not-null, then `custom_holiday_date` must also be provided and `standard_holiday_name` must be null.\",\"example\":\"National Puppy Day\"},\"custom_holiday_date\":{\"type\":\"string\",\"format\":\"date\",\"title\":\"Custom Holiday Date\",\"description\":\"Date for a custom holiday. If not-null, then `custom_holiday_name` must also be provided and `standard_holiday_name` must be null.\",\"example\":\"2023-03-23\"},\"first_appointment_start_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"First Appointment Start Time\",\"example\":null},\"last_appointment_end_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"Last Appointment End Time\",\"example\":null},\"closed_all_day\":{\"type\":\"boolean\",\"title\":\"Closed All Day\",\"description\":\"If true, indicates that the Facility is closed for the entire day of the holiday. If this value is true, then `first_appointment_start_time` and `last_appointment_end_time` must both be null.\",\"example\":true},\"is_custom\":{\"type\":\"boolean\",\"title\":\"Is Custom\",\"description\":\"True iff this holiday represents a \\\"custom\\\" holiday, otherwise will be false for \\\"standard\\\" holidays\",\"example\":true},\"facility_id\":{\"type\":\"string\",\"title\":\"Facility Id\"},\"facility_holiday_id\":{\"type\":\"string\",\"title\":\"Facility Holiday Id\"}},\"type\":\"object\",\"required\":[\"human_readable_holiday_name\",\"date\",\"observed\",\"closed_all_day\",\"is_custom\",\"facility_id\",\"facility_holiday_id\"],\"title\":\"ScheduledFacilityHoliday\"},\"ScheduledResourceTypeEnum\":{\"type\":\"string\",\"enum\":[\"FREIGHT_GENERAL\",\"SHIPMENT\",\"SERVICE\",\"LEG\"],\"title\":\"ScheduledResourceTypeEnum\",\"description\":\"An enumeration.\"},\"ShipmentAppointmentScheduledResource\":{\"properties\":{\"resource_type\":{\"type\":\"string\",\"enum\":[\"SHIPMENT\"],\"title\":\"Resource Type\",\"default\":\"SHIPMENT\"},\"shipment_id\":{\"type\":\"string\",\"maxLength\":36,\"title\":\"Shipment Id\"},\"planned_date\":{\"type\":\"string\",\"format\":\"date\",\"title\":\"Planned Date\",\"description\":\"Planned date of the Stop associated with this appointment.\",\"example\":\"2020-02-20\"}},\"type\":\"object\",\"required\":[\"shipment_id\"],\"title\":\"ShipmentAppointmentScheduledResource\"},\"ShipmentAvailabilityRequest\":{\"properties\":{\"request_criteria_type\":{\"type\":\"string\",\"enum\":[\"SHIPMENT\"],\"title\":\"Request Criteria Type\",\"default\":\"SHIPMENT\"},\"start_datetime\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Start Datetime\"},\"end_datetime\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"End Datetime\"},\"dock_ids\":{\"items\":{\"type\":\"string\",\"minLength\":1},\"type\":\"array\",\"minLength\":1,\"title\":\"Dock Ids\",\"description\":\"Filter results to only the desired dock ID(s)\"},\"rescheduling_for_appointment_id\":{\"type\":\"string\",\"minLength\":1,\"title\":\"Rescheduling For Appointment Id\",\"description\":\"Indicates that the user wants availability in order to reschedule this Appointment\"},\"shipment_id\":{\"type\":\"string\",\"minLength\":1,\"title\":\"Shipment Id\",\"description\":\"ID of a Shipment for which the user wants to find availability. Used to filter availability to only those Docks and LoadTypes that can accommodate the Shipment.\"},\"stop_id\":{\"type\":\"string\",\"minLength\":1,\"title\":\"Stop Id\",\"description\":\"Specific Stop ID related to the Shipment ID query param provided. The Stop's details will help inform Dock and LoadType availability selection.\"}},\"type\":\"object\",\"required\":[\"start_datetime\",\"end_datetime\",\"shipment_id\",\"stop_id\"],\"title\":\"ShipmentAvailabilityRequest\"},\"ShipmentMatchResults\":{\"properties\":{\"facility_id\":{\"type\":\"string\",\"title\":\"Facility Id\",\"description\":\"ID of the Facility whose Docks and LoadTypes are being matched\"},\"matched_load_type_ids\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"title\":\"Matched Load Type Ids\",\"description\":\"LoadTypes whose criteria match the provided criteria attributes\"},\"matched_docks\":{\"items\":{\"$ref\":\"#/components/schemas/MatchedDockAndRules\"},\"type\":\"array\",\"title\":\"Matched Docks\",\"description\":\"Docks capable of accommodating these criteria, along with the FacilityDockAppointmentRules that make the accommodation possible. Docks in this list are returned in order of best match. That order is a contract rather than presentation: `POST /facilities/{facility_id}/availability` with `merge_docks` uses it to decide which Dock each span of availability is attributed to. Rules listed on each dock are also in best match order for that dock but that order is not guaranteed across different docks. Just because a Dock shows up in this list does not necessarily mean that the Dock is actively available. It just means that the Dock can theoretically accommodate the criteria when it has availability.\"},\"bypassed_docks\":{\"items\":{\"$ref\":\"#/components/schemas/MatchedDockAndRules\"},\"type\":\"array\",\"title\":\"Bypassed Docks\",\"description\":\"Docks that do NOT match the requested criteria (the Docks that would normally be removed from availability), each with all of its FacilityDockAppointmentRules. This is populated regardless of whether the `dock_scheduling.bypass_scheduling_rules` permission is held. When the permission IS held, `matched_docks` is widened to include every Dock that has at least one applicable rule, so these bypassed Docks also appear there (the two lists overlap). When it is NOT held, `matched_docks` and `bypassed_docks` are disjoint and their union covers every Dock that has at least one applicable rule. (Docks with no rules appear in neither list, since they cannot be scheduled against.)\",\"default\":[]},\"potential_appointment_types\":{\"items\":{\"$ref\":\"#/components/schemas/FacilityAppointmentType\"},\"type\":\"array\",\"minItems\":1,\"description\":\"All legal methods of scheduling an appointment for these freight criteria. Since appointment types are managed at the level of individual FacilityDockAppointmentRules, this aggregates all possible values of `appointment_type` across those rules. Only FacilityDockAppointmentRules that have `is_public=True` will be considered when determining this set. This defaults to a single element list of `BY_APPOINTMENT_ONLY` if no public rules were matched.\",\"default\":[\"BY_APPOINTMENT_ONLY\"]},\"all_matched_dock_rules\":{\"items\":{\"$ref\":\"#/components/schemas/FacilityDockAppointmentRule\"},\"type\":\"array\",\"title\":\"All Matched Dock Rules\",\"description\":\"All FacilityDockAppointmentRules that match the freight criteria, fully-expanded. This will be null by default for performance purposes, but if desired the consumer may request to populate this list by using the `include` query parameter.\"},\"best_matched_load_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/LoadType\"}],\"title\":\"Best Matched Load Type\",\"description\":\"Fully-expanded LoadType that best matches the criteria. This should have the same ID as the first entry in `matched_load_type_ids`. This will only ever be non-null if explicitly requested using the `include` query parameter. Even so, it may still be null if not a single LoadType matched the criteria.\"},\"shipment_id\":{\"type\":\"string\",\"title\":\"Shipment Id\",\"description\":\"ID of the Shipment being matched against Docks and LoadTypes\"},\"stop_id\":{\"type\":\"string\",\"title\":\"Stop Id\",\"description\":\"ID of the Stop being matched against Docks and LoadTypes\"}},\"type\":\"object\",\"required\":[\"facility_id\",\"matched_load_type_ids\",\"matched_docks\",\"shipment_id\",\"stop_id\"],\"title\":\"ShipmentMatchResults\",\"description\":\"Search results for which LoadTypes, Docks, and DockAppointmentRules match a provided (Shipment, Stop) pair at\\na given Facility.\"},\"ShipmentMatchingIncludeParams\":{\"type\":\"string\",\"enum\":[\"all_matched_dock_rules\",\"best_matched_load_type\"],\"title\":\"ShipmentMatchingIncludeParams\",\"description\":\"Optional fields to expand when rendering shipment match results\"},\"StageAppointmentChangeRequest\":{\"properties\":{\"appointment_id\":{\"type\":\"string\",\"title\":\"Appointment Id\"},\"new_start_datetime_utc\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"New Start Datetime Utc\"},\"new_end_datetime_utc\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"New End Datetime Utc\"},\"new_dock_id\":{\"type\":\"string\",\"title\":\"New Dock Id\"}},\"type\":\"object\",\"required\":[\"appointment_id\",\"new_start_datetime_utc\",\"new_end_datetime_utc\"],\"title\":\"StageAppointmentChangeRequest\",\"description\":\"Body for staging (or re-staging) a single appointment change.\"},\"StagedAppointmentChange\":{\"properties\":{\"appointment_id\":{\"type\":\"string\",\"title\":\"Appointment Id\"},\"new_start_datetime_utc\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"New Start Datetime Utc\"},\"new_end_datetime_utc\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"New End Datetime Utc\"},\"new_dock_id\":{\"type\":\"string\",\"title\":\"New Dock Id\"},\"conflict_error\":{\"type\":\"string\",\"title\":\"Conflict Error\"}},\"type\":\"object\",\"required\":[\"appointment_id\",\"new_start_datetime_utc\",\"new_end_datetime_utc\"],\"title\":\"StagedAppointmentChange\",\"description\":\"A single staged change, enriched with conflict metadata for the GET list.\"},\"StandardHolidaySchedule\":{\"properties\":{\"data\":{\"items\":{\"$ref\":\"#/components/schemas/StandardScheduledHoliday\"},\"type\":\"array\",\"title\":\"Data\"},\"total_count\":{\"type\":\"integer\",\"title\":\"Total Count\"}},\"type\":\"object\",\"required\":[\"data\",\"total_count\"],\"title\":\"StandardHolidaySchedule\"},\"StandardHolidays\":{\"type\":\"string\",\"enum\":[\"NEW_YEARS_DAY\",\"MARTIN_LUTHER_KING_JR_DAY\",\"PRESIDENTS_DAY\",\"GOOD_FRIDAY\",\"MEMORIAL_DAY\",\"JUNETEENTH\",\"INDEPENDENCE_DAY\",\"LABOR_DAY\",\"THANKSGIVING\",\"CHRISTMAS_DAY\"],\"title\":\"StandardHolidays\",\"description\":\"An enumeration.\"},\"StandardScheduledHoliday\":{\"properties\":{\"human_readable_holiday_name\":{\"type\":\"string\",\"title\":\"Human Readable Holiday Name\"},\"date\":{\"type\":\"string\",\"format\":\"date\",\"title\":\"Date\"},\"observed\":{\"type\":\"boolean\",\"title\":\"Observed\",\"description\":\"Whether this date is an observance of a holiday, rather than the exact holiday date\"},\"standard_holiday_name\":{\"$ref\":\"#/components/schemas/StandardHolidays\"}},\"type\":\"object\",\"required\":[\"human_readable_holiday_name\",\"date\",\"observed\",\"standard_holiday_name\"],\"title\":\"StandardScheduledHoliday\"},\"StopCustomDataRequest\":{\"properties\":{\"stop_planned_date\":{\"type\":\"string\",\"format\":\"date\",\"title\":\"Stop Planned Date\",\"description\":\"The value of the `Stop.planned_date`\"},\"stop_custom_data\":{\"type\":\"object\",\"title\":\"Stop Custom Data\",\"description\":\"The value of the `Stop.custom_data`\"}},\"type\":\"object\",\"required\":[\"stop_planned_date\",\"stop_custom_data\"],\"title\":\"StopCustomDataRequest\",\"description\":\"Request body that should contain copies of data from fields on a Stop object. Used to parse that Stop's custom\\ndata and look for a \\\"planning window\\\" workaround in the custom field values.\"},\"StopCustomFieldPlannedWindowResponse\":{\"properties\":{\"planning_window\":{\"allOf\":[{\"$ref\":\"#/components/schemas/CustomFieldPlanningWindow\"}],\"title\":\"Planning Window\",\"description\":\"Planning window parsed from a `Stop.custom_data` or `Stop.planned_date`, or null if no such planning window could be found.\"}},\"type\":\"object\",\"required\":[\"planning_window\"],\"title\":\"StopCustomFieldPlannedWindowResponse\"},\"SubmitAppointmentDraftRequest\":{\"properties\":{\"start\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"end\":{\"$ref\":\"#/components/schemas/DateTimeWithTimezone\"},\"dock_id\":{\"type\":\"string\",\"title\":\"Dock Id\",\"description\":\"Dock at which to book the appointment, or null if it should not be booked for any specific dock.\"},\"is_time_request\":{\"type\":\"boolean\",\"title\":\"Is Time Request\",\"description\":\"Ask the facility for a window it does not offer instead of booking an offered one. Availability is not checked and the appointment lands in REQUESTED.\",\"default\":false},\"request_note\":{\"type\":\"string\",\"title\":\"Request Note\",\"description\":\"Message from the requester explaining what they are asking for.\"}},\"type\":\"object\",\"required\":[\"start\",\"end\"],\"title\":\"SubmitAppointmentDraftRequest\",\"description\":\"Body for `POST /facilities/appointments/drafts/{id}/submit`: the window for a `TEMP_DRAFT`.\"},\"Temperature\":{\"properties\":{\"unit\":{\"$ref\":\"#/components/schemas/TemperatureUnitEnum\"},\"minimum\":{\"type\":\"string\",\"format\":\"decimal\",\"title\":\"Minimum\"},\"maximum\":{\"type\":\"string\",\"format\":\"decimal\",\"title\":\"Maximum\"}},\"type\":\"object\",\"required\":[\"unit\"],\"title\":\"Temperature\"},\"TemperatureUnitEnum\":{\"type\":\"string\",\"enum\":[\"C\",\"F\"],\"title\":\"TemperatureUnitEnum\",\"description\":\"An enumeration.\"},\"UpdateFacility\":{\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Name\"},\"location_type\":{\"$ref\":\"#/components/schemas/LocationTypes\"},\"address\":{\"$ref\":\"#/components/schemas/FacilityAddress\"},\"facility_services\":{\"items\":{\"$ref\":\"#/components/schemas/FacilityServices\"},\"type\":\"array\"},\"external_reference\":{\"type\":\"string\",\"maxLength\":255,\"title\":\"External Reference\"},\"notes\":{\"type\":\"string\",\"title\":\"Notes\"},\"carrier_instructions\":{\"type\":\"string\",\"title\":\"Carrier Instructions\"},\"disclaimers\":{\"type\":\"string\",\"title\":\"Disclaimers\"},\"appointment_lead_time_duration\":{\"type\":\"string\",\"format\":\"duration\",\"title\":\"Appointment Lead Time Duration\",\"example\":\"P1DT23H30M4.000000S\"},\"late_appointment_threshold_duration\":{\"type\":\"string\",\"format\":\"duration\",\"title\":\"Late Appointment Threshold Duration\",\"example\":\"P1DT23H30M4.000000S\"},\"first_appointment_start_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"First Appointment Start Time\"},\"last_appointment_end_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"Last Appointment End Time\"},\"exclude_dock_assignment_from_appointment_scheduling\":{\"type\":\"boolean\",\"title\":\"Exclude Dock Assignment From Appointment Scheduling\"},\"appointment_approval_required\":{\"type\":\"boolean\",\"title\":\"Appointment Approval Required\",\"description\":\"Whether appointments at this facility require approval before being scheduled\",\"default\":false},\"appointment_required_document_types\":{\"items\":{\"$ref\":\"#/components/schemas/AppointmentDocumentTypeEnum\"},\"type\":\"array\",\"description\":\"Document types an external (cross-tenant) scheduler must provide before an appointment at this facility can be booked. A type counts as provided when a matching document is attached to the appointment, its shipment or its orders. Empty means no requirement. OTHER is not allowed.\",\"default\":[]},\"enhanced_dock_rules\":{\"type\":\"boolean\",\"title\":\"Enhanced Dock Rules\",\"description\":\"Turn on Enhanced Dock Rules to enable more granular rules including for Product Categories and References.\",\"default\":false}},\"type\":\"object\",\"required\":[\"name\",\"location_type\",\"address\",\"facility_services\",\"appointment_lead_time_duration\",\"late_appointment_threshold_duration\",\"exclude_dock_assignment_from_appointment_scheduling\"],\"title\":\"UpdateFacility\"},\"UpdateFacilityDock\":{\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Name\"},\"color\":{\"type\":\"string\",\"pattern\":\"^#([A-Fa-f0-9]{6})$\",\"title\":\"Color\"},\"total_max_concurrent_appointments\":{\"type\":\"integer\",\"title\":\"Total Max Concurrent Appointments\",\"description\":\"Maximum number of appointments of all types that may be loading/unloading at this dock simultaneously\",\"default\":10000}},\"type\":\"object\",\"required\":[\"name\",\"color\"],\"title\":\"UpdateFacilityDock\"},\"UpdateFacilityDockAppointmentRule\":{\"properties\":{\"delivery_type\":{\"$ref\":\"#/components/schemas/DeliveryTypeEnum\"},\"mode\":{\"$ref\":\"#/components/schemas/DockSchedulingModeEnum\"},\"equipment_type\":{\"$ref\":\"#/components/schemas/DockSchedulingEquipmentTypeEnum\"},\"product_references\":{\"items\":{\"type\":\"string\",\"maxLength\":256},\"type\":\"array\",\"maxLength\":256,\"maxItems\":10,\"minItems\":1,\"title\":\"Product References\",\"description\":\"One or more product references this rule applies to. Canonical field.\"},\"product_reference\":{\"type\":\"string\",\"maxLength\":256,\"title\":\"Product Reference\",\"description\":\"DEPRECATED — use `product_references` instead. On input this single value is folded into `product_references` (and `product_references` wins if both are provided). On output it mirrors the first element of `product_references` for backwards compatibility with pre-array clients.\",\"deprecated\":true},\"product_category\":{\"items\":{\"type\":\"string\",\"maxLength\":256},\"type\":\"array\",\"maxLength\":256,\"maxItems\":10,\"minItems\":1,\"title\":\"Product Category\"},\"product_category_matching_mode\":{\"allOf\":[{\"$ref\":\"#/components/schemas/MatchingModeEnum\"}],\"description\":\"Whether every product category on the load must be on this rule's category list (`ALL`) or only one of them (`AT_LEAST_ONE`).\",\"default\":\"ALL\"},\"product_reference_matching_mode\":{\"allOf\":[{\"$ref\":\"#/components/schemas/MatchingModeEnum\"}],\"description\":\"Whether every line item on the load must be satisfied by an allowed product reference (`ALL`) or only one of them (`AT_LEAST_ONE`).\",\"default\":\"ALL\"},\"packaging_type\":{\"$ref\":\"#/components/schemas/PackagingTypes\"},\"stackable\":{\"type\":\"boolean\",\"title\":\"Stackable\"},\"is_hazmat\":{\"type\":\"boolean\",\"title\":\"Is Hazmat\"},\"load_type_id\":{\"type\":\"string\",\"title\":\"Load Type Id\",\"description\":\"ID of the LoadType whose fields should be used to determine if this rule matches a shipment\"},\"dock_accessorials\":{\"items\":{\"$ref\":\"#/components/schemas/DockSchedulingAccessorialTypeEnum\"},\"type\":\"array\"},\"temperature\":{\"$ref\":\"#/components/schemas/Temperature\"},\"appointment_type\":{\"allOf\":[{\"$ref\":\"#/components/schemas/FacilityAppointmentType\"}],\"default\":\"BY_APPOINTMENT_ONLY\"},\"first_appointment_start_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"First Appointment Start Time\"},\"last_appointment_end_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"Last Appointment End Time\"},\"max_concurrent_appointments\":{\"type\":\"integer\",\"minimum\":1,\"title\":\"Max Concurrent Appointments\",\"default\":1},\"is_public\":{\"type\":\"boolean\",\"title\":\"Is Public\"}},\"type\":\"object\",\"required\":[\"dock_accessorials\",\"is_public\"],\"title\":\"UpdateFacilityDockAppointmentRule\"},\"UpdateFacilityHoliday\":{\"properties\":{\"standard_holiday_name\":{\"allOf\":[{\"$ref\":\"#/components/schemas/StandardHolidays\"}],\"description\":\"StandardHoliday enum member to which this holiday refers. If this is not-null, the `custom_holiday_*` fields must all be null.\",\"example\":null},\"custom_holiday_name\":{\"type\":\"string\",\"title\":\"Custom Holiday Name\",\"description\":\"Human-readable name for a custom holiday. If not-null, then `custom_holiday_date` must also be provided and `standard_holiday_name` must be null.\",\"example\":\"National Puppy Day\"},\"custom_holiday_date\":{\"type\":\"string\",\"format\":\"date\",\"title\":\"Custom Holiday Date\",\"description\":\"Date for a custom holiday. If not-null, then `custom_holiday_name` must also be provided and `standard_holiday_name` must be null.\",\"example\":\"2023-03-23\"},\"first_appointment_start_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"First Appointment Start Time\",\"example\":null},\"last_appointment_end_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"Last Appointment End Time\",\"example\":null},\"closed_all_day\":{\"type\":\"boolean\",\"title\":\"Closed All Day\",\"description\":\"If true, indicates that the Facility is closed for the entire day of the holiday. If this value is true, then `first_appointment_start_time` and `last_appointment_end_time` must both be null.\",\"example\":true}},\"type\":\"object\",\"required\":[\"closed_all_day\"],\"title\":\"UpdateFacilityHoliday\"},\"UpdateFacilityHoursOfOperation\":{\"properties\":{\"day\":{\"$ref\":\"#/components/schemas/DaysOfWeek\"},\"is_facility_open\":{\"type\":\"boolean\",\"title\":\"Is Facility Open\"},\"open_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"Open Time\"},\"close_time\":{\"type\":\"string\",\"format\":\"time\",\"title\":\"Close Time\"},\"daily_max_capacity\":{\"type\":\"integer\",\"title\":\"Daily Max Capacity\"}},\"type\":\"object\",\"required\":[\"day\",\"is_facility_open\"],\"title\":\"UpdateFacilityHoursOfOperation\"},\"UpdateFacilityPointOfContact\":{\"properties\":{\"person_name\":{\"type\":\"string\",\"title\":\"Person Name\"},\"facility_role\":{\"$ref\":\"#/components/schemas/FacilityPointOfContactRole\"},\"phone_number\":{\"type\":\"string\",\"title\":\"Phone Number\"},\"is_default_for_facility\":{\"type\":\"boolean\",\"title\":\"Is Default For Facility\",\"default\":false}},\"type\":\"object\",\"required\":[\"person_name\",\"facility_role\"],\"title\":\"UpdateFacilityPointOfContact\"},\"UpdateLoadType\":{\"properties\":{\"delivery_type\":{\"$ref\":\"#/components/schemas/DeliveryTypeEnum\"},\"mode\":{\"$ref\":\"#/components/schemas/DockSchedulingModeEnum\"},\"equipment_type\":{\"$ref\":\"#/components/schemas/DockSchedulingEquipmentTypeEnum\"},\"product_references\":{\"items\":{\"type\":\"string\",\"maxLength\":256},\"type\":\"array\",\"maxLength\":256,\"maxItems\":10,\"minItems\":1,\"title\":\"Product References\",\"description\":\"One or more product references this rule applies to. Canonical field.\"},\"product_reference\":{\"type\":\"string\",\"maxLength\":256,\"title\":\"Product Reference\",\"description\":\"DEPRECATED — use `product_references` instead. On input this single value is folded into `product_references` (and `product_references` wins if both are provided). On output it mirrors the first element of `product_references` for backwards compatibility with pre-array clients.\",\"deprecated\":true},\"product_category\":{\"items\":{\"type\":\"string\",\"maxLength\":256},\"type\":\"array\",\"maxLength\":256,\"maxItems\":10,\"minItems\":1,\"title\":\"Product Category\"},\"product_category_matching_mode\":{\"allOf\":[{\"$ref\":\"#/components/schemas/MatchingModeEnum\"}],\"description\":\"Whether every product category on the load must be on this rule's category list (`ALL`) or only one of them (`AT_LEAST_ONE`).\",\"default\":\"ALL\"},\"product_reference_matching_mode\":{\"allOf\":[{\"$ref\":\"#/components/schemas/MatchingModeEnum\"}],\"description\":\"Whether every line item on the load must be satisfied by an allowed product reference (`ALL`) or only one of them (`AT_LEAST_ONE`).\",\"default\":\"ALL\"},\"packaging_type\":{\"$ref\":\"#/components/schemas/PackagingTypes\"},\"stackable\":{\"type\":\"boolean\",\"title\":\"Stackable\"},\"is_hazmat\":{\"type\":\"boolean\",\"title\":\"Is Hazmat\"},\"name\":{\"type\":\"string\",\"title\":\"Name\"},\"load_unload_duration\":{\"type\":\"string\",\"format\":\"duration\",\"title\":\"Load Unload Duration\",\"example\":\"P1DT23H30M4.000000S\"},\"appointment_duration\":{\"type\":\"string\",\"format\":\"duration\",\"title\":\"Appointment Duration\",\"example\":\"P1DT23H30M4.000000S\"},\"all_day_appointment\":{\"type\":\"boolean\",\"title\":\"All Day Appointment\",\"description\":\"If true, indicates that the Appointment is placed for the entire day. If this value is true, then `load_unload_duration` and `appointment_duration` must both be null.\",\"default\":false}},\"type\":\"object\",\"required\":[\"delivery_type\",\"name\"],\"title\":\"UpdateLoadType\"},\"ShipwellApiErrorSource\":{\"title\":\"ShipwellApiErrorSource\",\"description\":\"The source of the error in the request, either in the request body or a query/form parameter.\\nIf both \\\"parameter\\\" and \\\"pointer\\\" are non-null, then there is an error inside the json-parsed value of the \\\"parameter\\\".\",\"type\":\"object\",\"properties\":{\"parameter\":{\"title\":\"Parameter\",\"description\":\"Which query parameter caused the issue, such as an invalid page size\",\"type\":\"string\"},\"pointer\":{\"title\":\"Pointer\",\"description\":\"Which part of the request body caused the error, expressed as a JSON Pointer([RFC6901](https://tools.ietf.org/html/rfc6901)) (examples - '/' for the primary data object or '/attributes/title' to indicate a problem with the 'title' field)\",\"type\":\"string\"}}},\"ShipwellApiError\":{\"title\":\"ShipwellApiError\",\"description\":\"Information about an error that occurred\",\"type\":\"object\",\"properties\":{\"title\":{\"title\":\"Title\",\"description\":\"Human readable description of what went wrong, can be localized (example: 'Validation Error')\",\"type\":\"string\"},\"status\":{\"title\":\"Status\",\"description\":\"HTTP Status code describing the problem (example: '503' or '400')\",\"type\":\"string\"},\"code\":{\"title\":\"Code\",\"description\":\"Similar to 'title' in describing the general error but in machine-readable form (example: 'validation_error')\",\"type\":\"string\"},\"detail\":{\"title\":\"Detail\",\"description\":\"Human readable description specific to this occurrence, can be localized (example: 'Start time cannot be after end time')\",\"type\":\"string\"},\"source\":{\"title\":\"Source\",\"description\":\"Which part of the request the error occurred\",\"allOf\":[{\"$ref\":\"#/components/schemas/ShipwellApiErrorSource\"}]},\"meta\":{\"title\":\"Meta\",\"description\":\"Contains non-standard meta-information about the error\"}},\"required\":[\"title\",\"status\"]},\"ShipwellApiErrorResponse\":{\"title\":\"ShipwellApiErrorResponse\",\"type\":\"object\",\"properties\":{\"errors\":{\"title\":\"Errors\",\"description\":\"What went wrong in the request\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ShipwellApiError\"}}},\"required\":[\"errors\"]}},\"securitySchemes\":{\"APIKeyHeader\":{\"type\":\"apiKey\",\"in\":\"header\",\"name\":\"Authorization\"}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"corsProxyUrl\":\"https://cors.redoc.ly\",\"expandResponses\":\"200,201\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"Node.js\"},{\"lang\":\"JavaScript\"},{\"lang\":\"Python\"},{\"lang\":\"Java\"}]},\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","redocHasSecurityDefinitions":false,"redocInfoPageLink":"/openapi_pages/dock-scheduling/overview/","redocItemId":"tag/references/operation/search_references_facilities__facility_id__references_search_get","redocHasInfoPage":false,"settings":{"corsProxyUrl":"https://cors.redoc.ly","pagination":"item","expandResponses":"200,201","generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"Node.js"},{"lang":"JavaScript"},{"lang":"Python"},{"lang":"Java"}]}},"requestLogin":false,"lastModified":"2023-10-03T19:42:20.000Z"},"seo":{"title":"Search References"}}},"pageContext":{"id":"89c0218a-75f0-52da-aa00-02b68c233039operation/search_references_facilities__facility_id__references_search_get__redocly content/openapi_pages/dock-scheduling/operation/search_references_facilities__facility_id__references_search_get/","seo":{"title":"Search References","description":"Search shipments and orders matching an exact reference value at a given facility.","image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"openapi_pages/dock-scheduling.page.yaml#operation/search_references_facilities__facility_id__references_search_get","pageBaseUrl":"/openapi_pages/dock-scheduling","type":"redoc-operation","toc":{"enable":true,"maxDepth":4,"headings":null},"data":{},"catalogInfo":null,"link":"/openapi_pages/dock-scheduling/operation/search_references_facilities__facility_id__references_search_get/","sidebarName":"developerPortal","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"dock-scheduling","id":"dock-scheduling","title":"dock-scheduling","isDefault":true,"apiId":null}],"apiVersionId":null,"isDefaultApiVersion":true}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}