Loadsmart Appointments API

The Appointments API from Loadsmart — 10 operation(s) for appointments.

Documentation

Specifications

Other Resources

OpenAPI Specification

loadsmart-appointments-api-openapi.yml Raw ↑
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<Connection URL>?token=<JWT 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. <a href="https://github.com/nestjsx/crud/wiki/Requests#select" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
      - name: s
        description: Adds search condition. <a href="https://github.com/nestjsx/crud/wiki/Requests#search" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: string
      - name: filter
        description: Adds filter condition. <a href="https://github.com/nestjsx/crud/wiki/Requests#filter" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: or
        description: Adds OR condition. <a href="https://github.com/nestjsx/crud/wiki/Requests#or" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: sort
        description: Adds sort by field. <a href="https://github.com/nestjsx/crud/wiki/Requests#sort" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: join
        description: Adds relational resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#join" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: limit
        description: Limit amount of resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#limit" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
      - name: offset
        description: Offset amount of resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#offset" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
      - name: page
        description: Page portion of resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#page" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
      - name: cache
        description: Reset cache (if was enabled). <a href="https://github.com/nestjsx/crud/wiki/Requests#cache" target="_blank">Docs</a>
        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. <a href="https://github.com/nestjsx/crud/wiki/Requests#select" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
      - name: join
        description: Adds relational resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#join" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: cache
        description: Reset cache (if was enabled). <a href="https://github.com/nestjsx/crud/wiki/Requests#cache" target="_blank">Docs</a>
        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 lang="en-US"><body>Html Block Example</body></html>
        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/AppointmentRequirem

# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/loadsmart/refs/heads/main/openapi/loadsmart-appointments-api-openapi.yml