Loadsmart

Loadsmart Load Types API

The Load Types API from Loadsmart — 4 operation(s) for load types.

GitHub OpenAPI

Operations 7

POST /loadtype Create a single LoadType #
GET /loadtype Retrieve multiple LoadTypes #
DELETE /loadtype/{id} Delete a single LoadType #
GET /loadtype/{id} Retrieve a single LoadType #
PATCH /loadtype/{id} Update a single LoadType #
POST /loadtype/{id}/get-availability Load type controller availability #
GET /loadtype/{id}/appointment-count Returns the appointment count grouped by warehouse #

Documentation

📖
Documentation
https://developer.loadsmart.com/docs/shipperguide/overview/getting-started
📖
APIReference
https://developer.loadsmart.com/docs/shipperguide/api-reference
📖
Authentication
https://developer.loadsmart.com/docs/shipperguide/overview/getting-started
📖
Documentation
https://developer.loadsmart.com/docs/opendock/overview/getting-started
📖
APIReference
https://developer.loadsmart.com/docs/opendock/category/overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/loadsmart/refs/heads/main/openapi/loadsmart-load-types-api-openapi.yml

Other Resources

🔗
OpenAPISource
https://developer.loadsmart.com/api/openapi.yaml
🔗
Webhooks
https://developer.loadsmart.com/docs/shipperguide/api-reference
🔗
Sandbox
https://api.sandbox.loadsmart.com
🔗
Postman
https://community.loadsmart.com/hc/en-us/articles/14945962355091-Importing-the-Postman-Collection
🔗
OpenAPISource
https://neutron.opendock.com/docs-json
🔗
SwaggerUI
https://neutron.opendock.com/docs
🔗
WebSockets
https://developer.loadsmart.com/docs/opendock/overview/websockets
🔗
Sandbox
https://neutron.staging.opendock.com
🔗
Postman
https://www.postman.com/opendock/workspace/public-nova-workspace/
🔗
Community
https://community.loadsmart.com/hc/en-us/sections/24987828169619-Opendock-Nova-Warehouse-API

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/loadsmart-load-types-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

loadsmart-load-types-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Opendock Nova API Documentation Load Types API
  description: '## Welcome to Opendock Nova!'
  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: Load Types
paths:
  /loadtype:
    post:
      operationId: createOneBaseLoadTypeControllerLoadType
      summary: Create a single LoadType
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLoadTypeDto'
      responses:
        '201':
          description: Get create one base response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadType'
      tags:
      - Load Types
      security:
      - bearer: []
    get:
      operationId: getManyBaseLoadTypeControllerLoadType
      summary: Retrieve multiple LoadTypes
      parameters:
      - name: warehouseId
        required: false
        in: query
        description: When set, returns Loadtypes that can be used at this Warehouse.
        schema:
          type: string
      - name: includeOrgLoadTypes
        required: false
        in: query
        schema: {}
      - name: showOnlyAssignedLoadTypes
        required: false
        in: query
        schema: {}
      - name: includeHierarchySettings
        required: false
        in: query
        schema: {}
      - 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: LoadType
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/LoadType'
      tags:
      - Load Types
      security:
      - bearer: []
  /loadtype/{id}:
    delete:
      operationId: deleteOneBaseLoadTypeControllerLoadType
      summary: Delete a single LoadType
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: Delete one base response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadType'
      tags:
      - Load Types
      security:
      - bearer: []
    get:
      operationId: getOneBaseLoadTypeControllerLoadType
      summary: Retrieve a single LoadType
      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:
                $ref: '#/components/schemas/LoadType'
      tags:
      - Load Types
      security:
      - bearer: []
    patch:
      operationId: updateOneBaseLoadTypeControllerLoadType
      summary: Update a single LoadType
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLoadTypeDto'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadType'
      tags:
      - Load Types
      security:
      - bearer: []
  /loadtype/{id}/get-availability:
    post:
      operationId: LoadTypeController_availability
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: forceAsCarrier
        required: false
        in: query
        description: When passing this argument as true, the availability will consider the availability for a carrier user, default = false
        schema:
          example: 'true'
          type: boolean
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AvailabilityFromLoadTypeDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AvailabilityResponseDto'
      tags:
      - Load Types
      security:
      - bearer: []
      summary: Load type controller availability
      x-summary-source: derived
  /loadtype/{id}/appointment-count:
    get:
      operationId: LoadTypeController_getAppointmentCount
      summary: Returns the appointment count grouped by warehouse
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AppointmentCountResponseDto'
      tags:
      - Load Types
      security:
      - bearer: []
components:
  schemas:
    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
    AvailabilityFromLoadTypeDto:
      type: object
      properties:
        start:
          format: date-time
          type: string
          example: '2026-05-24T19:16:46.221Z'
        end:
          format: date-time
          type: string
          example: '2026-05-24T19:16:46.221Z'
      required:
      - start
      - end
    TimeInterval:
      type: object
      properties:
        end:
          format: date-time
          type: string
        start:
          format: date-time
          type: string
      required:
      - end
      - start
    ClockSpan:
      type: object
      properties:
        end:
          type: string
          example: '18:00'
        start:
          type: string
          example: 06:00
      required:
      - end
      - start
    AppointmentCountResponseDto:
      type: object
      properties: {}
    LoadType:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the record
          example: a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5
          readOnly: true
        createDateTime:
          format: date-time
          type: string
          description: The date and time when the record was created
          example: '2023-10-01T12:00:00Z'
          readOnly: true
        createdBy:
          type: object
          description: The ID of the user who created the record
          example: a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5
          readOnly: true
        lastChangedDateTime:
          format: date-time
          type: string
          description: The date and time when the record was last changed
          example: '2023-10-01T12:00:00Z'
          readOnly: true
        org:
          $ref: '#/components/schemas/LoadType'
        orgId:
          type: string
        direction:
          type: string
          enum:
          - Inbound
          - Outbound
          - Inbound/Outbound
        operation:
          type: string
          enum:
          - Live
          - Drop
          - Other
        equipmentType:
          type: string
          enum:
          - Dry Van
          - Flatbed
          - Reefer
          - Other
        transportationMode:
          type: string
          enum:
          - FTL
          - PTL
          - Other
        allowCarrierScheduling:
          type: boolean
        description:
          type: string
        settings:
          type: object
        schedule:
          $ref: '#/components/schemas/ScheduleDto'
      required:
      - id
      - createDateTime
      - createdBy
      - lastChangedDateTime
    UpdateLoadTypeDto:
      type: object
      properties:
        tags:
          type: object
        orgId:
          type: string
        warehouseId:
          type: string
        direction:
          type: string
          enum:
          - Inbound
          - Outbound
          - Inbound/Outbound
        operation:
          type: string
          enum:
          - Live
          - Drop
          - Other
        equipmentType:
          type: string
          enum:
          - Dry Van
          - Flatbed
          - Reefer
          - Other
        transportationMode:
          type: string
          enum:
          - FTL
          - PTL
          - Other
        allowCarrierScheduling:
          type: boolean
        description:
          type: object
        settings:
          type: object
        schedule:
          $ref: '#/components/schemas/ScheduleDto'
        name:
          type: string
        duration_min:
          type: number
    AvailabilityResponseDto:
      type: object
      properties: {}
    CreateLoadTypeDto:
      type: object
      properties:
        tags:
          type: object
        orgId:
          type: string
        warehouseId:
          type: string
        direction:
          type: string
          enum:
          - Inbound
          - Outbound
          - Inbound/Outbound
        operation:
          type: string
          enum:
          - Live
          - Drop
          - Other
        equipmentType:
          type: string
          enum:
          - Dry Van
          - Flatbed
          - Reefer
          - Other
        transportationMode:
          type: string
          enum:
          - FTL
          - PTL
          - Other
        allowCarrierScheduling:
          type: boolean
        description:
          type: object
        settings:
          type: object
        schedule:
          $ref: '#/components/schemas/ScheduleDto'
      required:
      - direction
    ScheduleDto:
      type: object
      properties:
        sunday:
          type: array
          items:
            $ref: '#/components/schemas/ClockSpan'
        monday:
          type: array
          items:
            $ref: '#/components/schemas/ClockSpan'
        tuesday:
          type: array
          items:
            $ref: '#/components/schemas/ClockSpan'
        wednesday:
          type: array
          items:
            $ref: '#/components/schemas/ClockSpan'
        thursday:
          type: array
          items:
            $ref: '#/components/schemas/ClockSpan'
        friday:
          type: array
          items:
            $ref: '#/components/schemas/ClockSpan'
        saturday:
          type: array
          items:
            $ref: '#/components/schemas/ClockSpan'
        version:
          type: number
          example: 1
        closedIntervals:
          type: array
          items:
            $ref: '#/components/schemas/TimeInterval'
      required:
      - sunday
      - monday
      - tuesday
      - wednesday
      - thursday
      - friday
      - saturday
      - version
      - closedIntervals
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http