openapi: 3.0.0 info: title: Opendock Nova API Documentation Appointments API description: "## Welcome to Opendock Nova!\n\n#### What is Opendock Nova?\n\nOpendock is an online dock appointment scheduling tool. Facilities such as warehouses, distribution centers, and\nmanufacturing plants use it to organize their docks and schedule appointments for outbound pickups and inbound\ndeliveries.\nYou can read all our knowledge base\narticles [here.](https://community.loadsmart.com/hc/en-us/sections/24987828169619-Opendock-Nova-Warehouse-API)\n\nWe now provide an SSO option for User Authentication. Read\nthe [docs here.](https://community.loadsmart.com/hc/en-us/articles/14944624317075-Single-Sign-On-SSO-SAML-2-0)\n\n---\n\n## Our APIs\n\nWe have 3 main APIs:\n\n- REST API called _Neutron_ for performing standard HTTP operations.\n- Real-time API called _Subspace_ for receiving streaming events whenever objects are Created/Updated/Deleted.\n- A **\"Reference Number Validation\"** aka \"PO Validation\" _protocol_ for validating PO numbers (or similar) before an\n appointment is scheduled. Detailed documentation for it can be found\n here: [PO/Ref Number Validation Implementation](https://community.loadsmart.com/hc/en-us/articles/14946368437907-PO-Ref-Number-Validation-Implementation)\n\n---\n\n## Neutron - REST API\n\nAll endpoints are listed below. Depending on your User Role, some may be forbidden. Almost all endpoints expect a simple\nJWT token to be set in the `Authorization: Bearer` HTTP header. Read more about Bearer\ntokens [here](https://swagger.io/docs/specification/authentication/bearer-authentication/).\n\n### Base URL\n\nThe base URL is the same as it is for this document (look at the current URL in your browser's address bar). For\nexample, our production Neutron Base URL is [https://neutron.opendock.com](https://neutron.opendock.com).\n\n### Authentication\n\nTo start, call the `POST /auth/login` endpoint to exchange your user credentials (email + password) for a simple JWT\ntoken. If you don't have an account yet, reach out to your account admin or contact us for further help.\n\nIf login is successful, the response will be a JWT token to use as your `Bearer` header as described above.\n\nThe JWT expiration time depends on your User Role as well as other factors. You may base64-decode your JWT token to view\nmore technical details about it.\n\n#### Test it:\n\nTo test that your auth headers are set correctly, call the `GET /auth/me` endpoint. It will return a JSON payload with\nyour User information.\n\n---\n\n## Subspace - Real-time Streaming API\n\nSubspace is a _read-only_ API that allows your system to recieve streaming real-time information about changes to your\nAppointments, Warehouses, Docks, etc.\n\nUsing Subspace you can implement a \"push\"-based approach to your integration instead of relying only on \"poll\"-ing\nmethods (which can be inefficient).\n\nSubpsace is based on the famous [`socket.io`](https://socket.io/) library.\n\n### Choosing a socket.io Client\n\nThe socket.io project provides a JavaScript client library that works in the browser as well as NodeJS. However there\nare also client implementations in many other languages including C#, Java, Python, and Go, so you should select the\nappropriate client for your project. A good overview of socket.io and a list of client implementations can be found\nhere: [Socket.IO Introduction](https://socket.io/docs/v4/)\n\n**NOTE:** Currently Opendock uses socket.io server **v4.x** so please make sure to select an appropriate socket.io\nclient version that is protocol compatible.\n\n### Connecting and Authentication\n\nThe base connection URL is the same as the base URL for Neutron above, except with the word \"subspace\" instead of \"\nneutron\". For example, our production Subspace connection URL\nis [wss://subspace.opendock.com](wss://subspace.opendock.com).\n\nFor convenience, the same JWT token obtained from the Neutron `/auth/login` endpoint above is used for Subspace\nauthentication.\n\nConnecting and Authenticating are done in a single operation: simply connect to the following `wss` URL:\n\n```\n?token=\n```\n\nThat can be a little confusing to parse. Here's a real-life example connection string:\n\n```\nwss://subspace.opendock.com?token=eyJhbGciOiJIUzI1Ni...(full token continues)\n```\n\n**NOTE:** Currently Opendock only supports the `websocket` transport, so you must specify this in your connection\nsettings.\n\nHere's an example of connecting to Subspace using the JavaScript client:\n\n```JavaScript\n// NOTE: we assume \"accessToken\" was already obtained earlier via a call to '/auth/login'.\nconst baseSubspaceUrl = 'wss://subspace.opendock.com';\nconst url = `${baseSubspaceUrl}?token=${accessToken}`;\nconst socket = io(url, { transports: ['websocket'] }); // Enforce 'websocket' transport only.\n```\n\n### Listening to events\n\nSubspace emits Create/Update/Delete events for each entity in your Org (Appointment, Warehouse, Dock, etc). Your event\nhandler for these events will receive a JSON object containing the details about the given entity.\n\nOnce your socket.io client instance is connected, you can listen for any of these events by constructing the appropriate\nevent string:\n\nEvent strings follow this pattern:\n\n```\n\"{EventType}-{EntityName}\"\n```\n\n`EventType` can be one of: `create`, `update`, or `delete`.\n\n`EntityName` can be any entity in our REST API, such as: `Appointment`, `Warehouse`, `Dock`, etc.\n\nSo for example, to listen to `create` events for `Appointment` entities you would use:\n\n```\n\"create-Appointment\"\n```\n\nOr to listen to `update` events for `Warehouse` entities you would use:\n\n```\n\"update-Warehouse\"\n```\n\n**NOTE:** The event types are lowercase, but the entity names are capitalized (event strings are case-sensitive).\n\nThere is also a `\"heartbeat\"` event that you can listen to, which will emit every 5 seconds with a timestamp and the\nNeutron API version. This can be helpful for ensuring that your connection to Subspace is working correctly.\n\n### Caveats and Limitations\n\nSubspace does not do any sort of \"catch-up\" or \"replay\" of events, you will only get the events that occur after you\nconnect to the socket.io server.\n\nIf your client loses connection for some time, the event messages will not be queued and delivered when you next\nconnect, you will simply start receiving new messages after the point in time that you connected.\n\nFor this reason, even when using Subspace, you may need to occasionally supplement with calls to our REST API (ie.\ngetAll) to fetch entities and keep in sync with the data in Opendock, depending on your needs.\n\n### Example: Listening for Heartbeat\n\nThis event handler will get called periodically with the \"heartbeat\" information:\n\n```JavaScript\nsocket.on('heartbeat', (data) => {\n console.log(data);\n});\n```\n\nThis will output something like:\n\n```JSON\n{\n now: '2022-09-15T20:02:20.015Z',\n version: {\n major: '2',\n minor: '5',\n patch: '16',\n commit: '4a443fb\\n'\n }\n}\n```\n\n### Example: Listening for Appointment Creation and Update\n\nIn this example, your event handler will get called whenever an Appointment\nis created in your Org:\n\n```JavaScript\nsocket.on('create-Appointment', (data) => {\n console.log('appt create:', data);\n});\n```\n\nThe `data` your event handler recieves will be a JSON object containing\nthe Appointment details, like this:\n\n```JSON\n{\n \"id\": \"9cd63603-a7ff-43c7-8183-befc19a7a81b\",\n \"createDateTime\": \"2022-07-29T06:49:20Z\",\n \"lastChangedDateTime\": \"2022-07-29T06:49:20Z\",\n \"isActive\": true,\n \"tags\": [],\n \"type\": \"Standard\",\n \"status\": \"Scheduled\",\n \"start\": \"2022-07-29T00:00:00+00:00\",\n \"end\": \"2022-07-29T01:30:00+00:00\",\n ...\n ...\n ...\n}\n```\n\nIf you also wanted to listen for any changes to existing Appointments\nyou could add another listener:\n\n```JavaScript\nsocket.on('create-Appointment', (data) => {\n console.log('appt create:', data);\n});\n\nsocket.on('update-Appointment', (data) => {\n console.log('appt update:', data);\n});\n```\n\nThe `update-Appointment` event handler will receive a similar JSON object\ncontaining the most up-to-date details of the Appointment that was\njust updated.\n\n---\n\n## Nestjsx/Crud\n\n[NestJSX/Crud](https://github.com/nestjsx/crud/wiki/Requests#search) is a robust library designed for creating\nhigh-performance and scalable APIs. With NestJSX/Crud, API\nconsumers can take advantage of a flexible and intuitive approach to querying data.\n\nThis library streamlines the process of searching, sorting, and paginating data to cater to the exact requirements of\nthe API consumer. This feature saves valuable time by allowing the API consumer to bypass irrelevant data, ensuring only\nthe necessary data is obtained.\n\nNote: We encourage use of the `search` parameter (`s=...`), and do not allow use of the deprecated `filter` parameter.\n\n#### Search Examples\n\nFind all active Appointments created or updated since March 15th, 2023 at 8am MST (since created appts also have updated lastChangeDateTime)\n\n```\ns={\"lastChangedDateTime\":{\"$gt\":\"2023-03-15T08:00:00.000-07:00\"}}\n```\n\nFind all soft-deleted (inActive) appointments updated since a date/time (isActive:false indicates soft-deleted)\n\n```\ns={\"$and\":[{\"lastChangedDateTime\": {\"$gt\":\"2023-07-7T00:00:00.000Z\"}},{\"isActive\":false}]}\n```\n\nFind all appointments changed since a date time (both active and inactive).\nThis is useful for integration partners with recurring series who need to know future appointments in the series have been removed\n\n```\ns={\"$and\":[{\"lastChangedDateTime\": {\"$gt\":\"2023-07-7T00:00:00.000Z\"}},{\"$or\":[{\"isActive\":true},{\"isActive\":false}]}]}\n```\n\nFind all Appointment where the `tags` are empty\n\n```\ns={\"tags\": {\"$or\": {\"$isnull\": true, \"$eq\": \"{}\"}}}\n```\n\nFind all Appointments where it includes a tag of `Late`\n\n```\ns={\"tags\":{\"$contL\":\"Late\"}}\n```\n\nFind all appointments in `Scheduled` status set to start after March 15th, 2023 at 8am MST\n\n```\ns={\"$and\":[{\"status\":\"Scheduled\"},{\"start\":{\"$gt\":\"2023-03-15T08:00:00.000-07:00\"}}]}\n```\n\n#### Join examples (with Fields)\n\nTo return data from other tables without the need to make a secondary query, the API consumer can join specific tables\ntogether and request only the fields necessary.\n\nGet the appointment with the carrier and company. This will return a nested `User` with a nested `Company` in the result for\neach appointment.\nOrder matters here. You must first include `user` to get to `user.company`.\n\n```\njoin=user&join=user.company\n```\n\nTo get just the user's email and company's name, you can use the `||` operator.\nBecause `user.companyId = company.id` you must at least include `companyId` on `user`\n\n```\njoin=user||email,companyId&join=user.company||name\n```\n\n#### Other Examples\n\nTo get an appointment's refNumber (PO), start, lastChangedDateTime, and carrier company name\n\n```\ns={\"start\": {\"$gt\":\"2023-03-15T00:00:00.000Z\"}}&join=user||companyId&join=user.company||name&fields=refNumber,lastChangedDateTime,start\n```\n\n---\n" version: v4.144.0 - 39b4253 contact: {} servers: - url: https://neutron.opendock.com description: Production Server - url: https://neutron.staging.opendock.com description: Staging Server tags: - name: Appointments paths: /appointment: get: operationId: getManyBaseAppointmentControllerAppointment summary: Retrieve multiple Appointments parameters: - name: fields description: Selects resource fields. Docs required: false in: query schema: type: array items: type: string style: form explode: false - name: s description: Adds search condition. Docs required: false in: query schema: type: string - name: filter description: Adds filter condition. Docs required: false in: query schema: type: array items: type: string style: form explode: true - name: or description: Adds OR condition. Docs required: false in: query schema: type: array items: type: string style: form explode: true - name: sort description: Adds sort by field. Docs required: false in: query schema: type: array items: type: string style: form explode: true - name: join description: Adds relational resources. Docs required: false in: query schema: type: array items: type: string style: form explode: true - name: limit description: Limit amount of resources. Docs required: false in: query schema: type: integer - name: offset description: Offset amount of resources. Docs required: false in: query schema: type: integer - name: page description: Page portion of resources. Docs required: false in: query schema: type: integer - name: cache description: Reset cache (if was enabled). Docs required: false in: query schema: type: integer minimum: 0 maximum: 1 responses: '200': description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/PaginatedDto' - properties: entity: type: string example: AppointmentListItemDto data: type: array items: $ref: '#/components/schemas/AppointmentListItemDto' tags: - Appointments security: - bearer: [] post: operationId: createOneBaseAppointmentControllerAppointment summary: Create a single Appointment parameters: - name: bypassCustomFieldsValidation required: true in: query schema: type: boolean requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAppointmentDto' responses: '201': description: '' content: application/json: schema: properties: data: $ref: '#/components/schemas/AppointmentListItemDto' entity: type: string example: Appointment action: type: string example: create tags: - Appointments security: - bearer: [] /appointment/requirements: get: operationId: AppointmentController_getAppointmentRequirements parameters: - name: loadTypeId required: true in: query description: Identifies a LoadType. schema: type: string - name: warehouseId required: true in: query description: Identifies a Warehouse. schema: type: string - name: start required: true in: query description: The start date of appointment creations. schema: format: date-time type: string - name: end required: true in: query description: The end date of appointment creations. schema: format: date-time type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AppointmentRequirementsSuccessResponseDto' tags: - Appointments security: - bearer: [] /appointment/{id}: get: operationId: getOneBaseAppointmentControllerAppointment summary: Retrieve a single Appointment parameters: - name: id required: true in: path schema: type: string - name: fields description: Selects resource fields. Docs required: false in: query schema: type: array items: type: string style: form explode: false - name: join description: Adds relational resources. Docs required: false in: query schema: type: array items: type: string style: form explode: true - name: cache description: Reset cache (if was enabled). Docs required: false in: query schema: type: integer minimum: 0 maximum: 1 responses: '200': description: '' content: application/json: schema: properties: data: $ref: '#/components/schemas/AppointmentListItemDto' entity: type: string example: Appointment action: type: string example: read tags: - Appointments security: - bearer: [] delete: operationId: deleteOneBaseAppointmentControllerAppointment summary: Delete a single Appointment parameters: - name: id required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteAppointmentDto' responses: '200': description: '' content: application/json: schema: properties: data: $ref: '#/components/schemas/AppointmentListItemDto' entity: type: string example: Appointment action: type: string example: delete tags: - Appointments security: - bearer: [] patch: operationId: updateOneBaseAppointmentControllerAppointment summary: Update a single Appointment parameters: - name: id required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAppointmentDto' responses: '200': description: '' content: application/json: schema: properties: data: $ref: '#/components/schemas/AppointmentListItemDto' entity: type: string example: Appointment action: type: string example: update tags: - Appointments security: - bearer: [] /appointment/public/{id}: get: operationId: AppointmentController_getPublicAppointmentDetails parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AppointmentListItemDto' tags: - Appointments /appointment/{id}/set-eta: patch: operationId: AppointmentController_setEta parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EtaDto' responses: '200': description: '' content: application/json: schema: properties: data: $ref: '#/components/schemas/AppointmentListItemDto' entity: type: string example: Appointment action: type: string example: update tags: - Appointments security: - bearer: [] /appointment/{id}/undo-latest-status: patch: operationId: AppointmentController_undoLatestStatus parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: properties: data: $ref: '#/components/schemas/AppointmentListItemDto' entity: type: string example: Appointment action: type: string example: update tags: - Appointments security: - bearer: [] /appointment/reserve: post: operationId: AppointmentController_createReserve parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateReserveDto' responses: '200': description: '' content: application/json: schema: properties: data: $ref: '#/components/schemas/AppointmentListItemDto' entity: type: string example: Appointment action: type: string example: create tags: - Appointments security: - bearer: [] /appointment/{id}/recurring: post: operationId: AppointmentController_createRecurringAppointments summary: Creates a Recurring Appointment Series based on this appointment parameters: - name: id required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateRecurringAppointmentsDto' responses: '201': description: '' content: application/json: schema: properties: data: $ref: '#/components/schemas/RecurringAppointmentCreateResponse' entity: type: string example: Appointment action: type: string example: create tags: - Appointments security: - bearer: [] delete: operationId: AppointmentController_deleteRecurringAppointments summary: Deletes this appointment and all following appointments in the recurring series, except the original appointment used to create this series. parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: properties: data: $ref: '#/components/schemas/AppointmentListItemDto' entity: type: string example: Appointment action: type: string example: delete tags: - Appointments security: - bearer: [] /appointment/email-notification-html/{emailKey}: get: operationId: AppointmentController_getAppointmentNotificationEmailHtml parameters: - name: emailKey required: true in: path schema: type: string - name: warehouseId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AppointmentNotificationEmailHtmlResponseDto' tags: - Appointments security: - bearer: [] /appointment/{id}/tag: post: operationId: AppointmentController_addAppointmentTag parameters: - name: id required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddAppointmentTagDto' responses: '200': description: '' content: application/json: schema: properties: data: $ref: '#/components/schemas/AppointmentListItemDto' entity: type: string example: Appointment action: type: string example: update tags: - Appointments security: - bearer: [] delete: operationId: AppointmentController_removeAppointmentTag parameters: - name: id required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddAppointmentTagDto' responses: '200': description: '' content: application/json: schema: properties: data: $ref: '#/components/schemas/AppointmentListItemDto' entity: type: string example: Appointment action: type: string example: update tags: - Appointments security: - bearer: [] components: schemas: DeleteAppointmentDto: type: object properties: hardDelete: type: boolean AppointmentRequirementsFieldSchemaDto: type: object properties: type: type: string description: Human-readable field type label (e.g. uuid, timestamp, string). required: type: boolean description: Whether this field is required when creating an appointment. example: type: object description: Example value for this field; shape depends on warehouse, load type, and field type. acceptedValues: type: object description: Allowed or described values (e.g. UUID lists, maps of dock id to slot times, free-text rules). description: type: string description: How to supply this field on appointment creation. required: - type - required - example - description RecurringAppointmentCreateResponse: type: object properties: successes: type: array items: $ref: '#/components/schemas/RecurringAppointmentCreateSuccess' failures: type: array items: $ref: '#/components/schemas/RecurringAppointmentCreateFailure' required: - successes - failures PaginatedDto: type: object properties: count: type: number example: 2 total: type: number example: 2 page: type: number example: 1 pageCount: type: number example: 1 action: type: string example: read entity: type: string example: Appointment data: type: array items: type: string required: - count - total - page - pageCount - action - entity - data RecurringAppointmentCreateFailure: type: object properties: start: format: date-time type: string example: '2026-04-20T05:30:00.000Z' reason: type: string example: Appointment does not fit into combined Dock and Warehouse availability required: - start - reason AppointmentNotificationEmailHtmlResponseDto: type: object properties: bodyHtml: type: string example: Html Block Example subject: type: string example: Appointment details have changed required: - bodyHtml - subject CustomFieldDto: type: object properties: name: type: string example: emailDispatcher type: type: string example: email label: type: string example: Dispatcher description: type: string example: Dispatcher's email address placeholder: type: string example: xpto@example.com dropDownValues: example: [] type: array items: type: string hiddenFromCarrier: type: boolean example: false requiredForCarrier: type: boolean example: false requiredForWarehouse: type: boolean example: false value: type: object description: Field value — type depends on the custom field type required: - name - type - label AppointmentRequirementsSuccessResponseDto: type: object properties: notes: type: string description: Integrator-facing hints (e.g. external ref validation). Not the same as `fields.notes` on the appointment create payload. fields: $ref: '#/components/schemas/AppointmentRequirementsFieldsDto' example: $ref: '#/components/schemas/AppointmentRequirementsExamplePayloadDto' required: - fields - example AppointmentRequirementsFieldsDto: type: object properties: customFields: $ref: '#/components/schemas/AppointmentRequirementsFieldSchemaDto' customFormsData: $ref: '#/components/schemas/AppointmentRequirementsCustomFormsDataSchemaDto' units: $ref: '#/components/schemas/AppointmentRequirementsFieldSchemaDto' loadTypeId: $ref: '#/components/schemas/AppointmentRequirementsFieldSchemaDto' dockId: $ref: '#/components/schemas/AppointmentRequirementsFieldSchemaDto' start: $ref: '#/components/schemas/AppointmentRequirementsFieldSchemaDto' notes: $ref: '#/components/schemas/AppointmentRequirementsFieldSchemaDto' userId: $ref: '#/components/schemas/AppointmentRequirementsFieldSchemaDto' refNumbers: $ref: '#/components/schemas/AppointmentRequirementsFieldSchemaDto' ccEmails: $ref: '#/components/schemas/AppointmentRequirementsFieldSchemaDto' required: - loadTypeId - dockId - start - notes - userId - refNumbers - ccEmails AppointmentRequirementsSemanticLabelDto: type: object properties: slug: type: string name: type: string description: type: string required: - slug - name - description AppointmentRequirementsCustomFormFieldFieldDto: type: object properties: formFieldId: type: string triggerId: type: string value: type: string required: - formFieldId - triggerId - value RecurringCustomFormDataItemDto: type: object properties: {} CreateAppointmentDto: type: object properties: tags: type: object status: type: string enum: - NoShow - Cancelled - Requested - Scheduled - Arrived - InProgress - Completed userId: type: object loadTypeId: type: string dockId: type: string start: format: date-time type: string end: format: date-time type: string refNumbers: type: array items: type: string refNumber: type: string customFields: type: array items: type: string notes: type: string ccEmails: type: array items: type: string muteNotifications: type: boolean metadata: type: object units: type: object required: - loadTypeId - dockId - start CreateRecurringAppointmentsDto: type: object properties: numWeeks: type: number example: 3 description: Number of weeks to repeat pattern weekDays: type: array example: - Monday items: type: string enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday copyFields: type: array example: - customFields description: Copy appointment fields to the series. Copying refNumber will not work if unique ref number setting is on items: type: string enum: - refNumber - customFields - notes - tags customFormsDataToCopy: description: Load-type custom form data rows from the parent appointment to copy into each child. Pass the full row objects returned by the customformdata API (formFieldId, triggerId, label, type, value). Array-valued fields (multidoc, dropdownmultiselect) are serialised correctly for each child. type: array items: $ref: '#/components/schemas/RecurringCustomFormDataItemDto' startingStatus: type: string enum: - Scheduled - Requested example: Requested default: Scheduled description: Starting status for recurring children. Defaults to Scheduled required: - numWeeks - weekDays AppointmentRequirementsExamplePayloadDto: type: object properties: customFields: type: array items: type: object description: Present when the warehouse exposes custom appointment fields to carriers. customFormsData: type: array items: type: object description: Present when custom form fields apply to this load type. units: type: number description: Handling units count when that field is enabled. loadTypeId: type: string dockId: type: string start: type: object nullable: true description: First available slot as ISO string when slots exist; otherwise null. notes: type: string userId: type: string refNumbers: description: One or more reference numbers; elements are strings or integers depending on warehouse ref mode. type: array items: type: array ccEmails: type: array items: type: string required: - loadTypeId - dockId - start - notes - userId - refNumbers - ccEmails CreateReserveDto: type: object properties: dockId: type: string format: uuid example: c9fbc7d2-f9c3-483c-84b4-1215682af6a3 start: format: date-time type: string example: '2026-03-23T05:00:00.000Z' notes: type: string example: Reserved duration_min: type: number example: 30 description: 'Duration in minutes (default: 30)' required: - dockId - start UpdateAppointmentDto: type: object properties: tags: type: object status: type: string enum: - NoShow - Cancelled - Requested - Scheduled - Arrived - InProgress - Completed userId: type: object loadTypeId: type: string dockId: type: string start: format: date-time type: string end: format: date-time type: string refNumbers: type: array items: type: string refNumber: type: string customFields: type: array items: type: string notes: type: string ccEmails: type: array items: type: string muteNotifications: type: boolean metadata: type: object units: type: object type: type: string enum: - Standard - Reserve statusTimeline: type: object isCheckedInByCarrier: type: boolean StatusTimelineDto: type: object properties: NoShow: type: object format: date-time nullable: true example: null Arrived: type: object format: date-time nullable: true example: null Cancelled: type: object format: date-time nullable: true example: null Completed: type: object format: date-time nullable: true example: null Requested: type: object format: date-time nullable: true example: '2026-03-18T18:14:00.000Z' Scheduled: type: object format: date-time nullable: true example: null InProgress: type: object format: date-time nullable: true example: null AddAppointmentTagDto: type: object properties: tag: type: string example: Damaged required: - tag AppointmentMetadataDto: type: object properties: unitLimitBreached: type: boolean example: false externalValidationFailed: type: boolean example: false externalValidationErrorMessage: type: object nullable: true example: null unitLimitOverrideReason: type: object example: null nullable: true clonedFromId: type: object format: uuid nullable: true example: null EtaDto: type: object properties: eta: format: date-time type: string example: '2026-03-19T18:30:00.000Z' description: Estimated time of arrival reason: type: string example: on time description: Reason for the ETA update (required for carriers) required: - eta RecurringAppointmentCreateSuccess: type: object properties: appointmentId: type: string format: uuid example: 3ca0e68f-8fc4-4e5d-b08a-b5ffefe2ebce start: format: date-time type: string example: '2026-03-30T05:30:00.000Z' required: - appointmentId - start AppointmentListItemDto: type: object properties: id: type: string format: uuid example: 25523508-e358-4161-8907-5bfba673ce94 createDateTime: type: string format: date-time example: '2026-03-18T18:14:51.766Z' createdBy: type: string format: uuid example: c798fcb0-e072-46af-92cf-dec899b68973 lastChangedDateTime: type: string format: date-time example: '2026-03-18T18:14:59.545Z' lastChangedBy: type: string format: uuid example: c798fcb0-e072-46af-92cf-dec899b68973 isActive: type: boolean example: true tags: nullable: true example: [] type: array items: type: string type: type: string enum: - Standard - Reserve example: Standard status: type: string enum: - NoShow - Cancelled - Requested - Scheduled - Arrived - InProgress - Completed example: Requested statusTimeline: $ref: '#/components/schemas/StatusTimelineDto' userId: type: object format: uuid nullable: true example: c798fcb0-e072-46af-92cf-dec899b68973 loadTypeId: type: string format: uuid example: e4fbeabd-a501-4f3b-bc11-7f034110e925 dockId: type: string format: uuid example: c9fbc7d2-f9c3-483c-84b4-1215682af6a3 orgId: type: string format: uuid example: 7e77fbe1-9517-44ce-b08b-5a18b478b79f start: type: string format: date-time example: '2026-03-19T18:30:00.000Z' end: type: string format: date-time example: '2026-03-19T19:30:00.000Z' eta: type: object format: date-time nullable: true example: null refNumber: type: string example: APT-41313 refNumbers: example: - APT-41313 type: array items: type: string customFields: type: array items: $ref: '#/components/schemas/CustomFieldDto' notes: type: object nullable: true example: '' ccEmails: example: [] type: array items: type: string recurringParentId: type: object format: uuid nullable: true example: null recurringPattern: type: object nullable: true example: null reschedules: type: object nullable: true example: null confirmationNumber: type: string example: '137510' muteNotifications: type: boolean example: false isCheckedInByCarrier: type: boolean example: false metadata: $ref: '#/components/schemas/AppointmentMetadataDto' units: type: object nullable: true example: 12 searchableCustomFields: type: object nullable: true example: null recurringParent: type: object nullable: true example: null recurringChildren: nullable: true description: Child appointments in a recurring series (only present when relation is loaded) type: array items: type: object required: - id - createDateTime - createdBy - lastChangedDateTime - isActive - type - status - loadTypeId - dockId - orgId - start - end - confirmationNumber - muteNotifications - isCheckedInByCarrier AppointmentRequirementsCustomFormFieldRowDto: type: object properties: field: $ref: '#/components/schemas/AppointmentRequirementsCustomFormFieldFieldDto' type: type: string enum: - str - bigstr - date - bool - doc - multidoc - int - email - phone - dropdown - dropdownmultiselect - combobox - timestamp - action required: type: boolean description: Whether this field is required when scheduling. minLengthOrValue: type: number description: Minimum length or value for field types `str`, `bigstr`, and `int`. maxLengthOrValue: type: number description: Maximum length or value for field types `str`, `bigstr`, and `int`. dropDownValues: description: Discrete option strings when the field type is dropdown, dropdownmultiselect, or combobox and the warehouse configured choices. type: array items: type: string formName: type: string label: type: string description: type: object nullable: true description: Warehouse-defined form field description; always serialized. Use null or empty string as stored. semanticLabel: nullable: true allOf: - $ref: '#/components/schemas/AppointmentRequirementsSemanticLabelDto' required: - field - type - required - formName - label - description - semanticLabel AppointmentRequirementsCustomFormsDataSchemaDto: type: object properties: type: type: string required: type: boolean children: description: Rows describing each custom form field for this load type (`field` holds formFieldId, triggerId, value placeholder). type: array items: $ref: '#/components/schemas/AppointmentRequirementsCustomFormFieldRowDto' description: type: string required: - type - required - children - description securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http