openapi: 3.0.0
info:
title: Opendock Nova API Documentation Appointments Capacity 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: Capacity
description: 'Manages new capacity. A capacity is a truck that is
empty and it''s location.
'
paths:
/api/v2/capacity:
post:
summary: Create capacity
description: 'Inform us about a list of available trucks.
The available trucks must have at least a point of pickup, the
delivery is not mandatory but will increase the chances of best
matching for our loads.
The capacity represents an empty truck position. For different
empty positions for the same truck, the available trucks and
their ids must be different. We suggest that you use an uuid to
represent the `ref_number` attribute on your side, because this
identifier will be reused across other endpoints.
'
tags:
- Capacity
security:
- User-JWT:
- capacity_write
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- type: array
title: capacity:spot
items:
type: object
required:
- carrier_identification
- ref_number
- equipment_type
- available_at
- pickup
properties:
available_at:
type: string
description: The date and time the truck is going to be available. You must not provide timezone info.
format: date-time
pattern: YYYY-MM-DDThh:mm:ss
delivery_deadhead:
type: number
description: The distance between the truck and the delivery
pickup_deadhead:
type: number
description: The distance between the truck and the pickup
expires_at:
type: string
format: date-time
carrier_identification:
description: 'An identifier for the carrier.
There are two ways to identify a carrier, by Loadsmart Carrier ID or by MC+DOT combination.
If you provide carrier ID, you must not provide any information for MC and DOT.
If you provide MC and DOT, you must not provide carrier ID information.
'
oneOf:
- title: Carrier identified by Carrier ID
type: object
properties:
carrier_id:
type: string
format: uuid
description: Carrier UUID (provided by Loadsmart)
mc:
type: string
description: Carrier MC Number (Motor Carrier Number)
dot:
type: string
description: Carrier DOT Number
required:
- carrier_id
- title: Carrier identified by MC and DOT
type: object
properties:
carrier_id:
type: string
format: uuid
description: Carrier UUID (provided by Loadsmart)
mc:
type: string
description: Carrier MC Number (Motor Carrier Number)
dot:
type: string
description: Carrier DOT Number
required:
- mc
- dot
ref_number:
type: string
description: 'Unique id for the given capacity, this must represent the id for this capacity on your side.
This represents the empty truck location identifier. You must use different ids for different
empty locations or dates, even if its the same capacity/truck.
We suggest that you use an uuid to create this identifier.
'
fleet_id:
type: string
description: Fleet identifier for this capacity.
equipment_type:
type: string
enum:
- DRV
- FBE
- RFR
- CON
- CUR
- DDP
- IMC
- SDK
- STK
description: 'Truck''s type. Must be one of the following:
`DRV` for Dry Van
`FBE` for Flatbed
`RFR` for Reefer
`CON` for Conestoga
`CUR` for Curtainside
`DDP` for Double Drop
`IMC` for Intermodal
`SDK` for Step Deck
`STK` for Straight Truck
'
rate:
type: number
description: The all in rate for the lane.
rate_per_mile:
type: number
description: Indicates the value per miles
is_backhaul:
type: boolean
description: Indicates whether the capacity is backhaul or not.
contacts:
type: array
description: A list of who should be contacted by us for this capacity.
items:
type: object
properties:
name:
type: string
phone_number:
type: string
pattern: \+\d{4,15}
maxLength: 16
description: Phone number following the format [E.164](https://www.itu.int/rec/T-REC-E.164/)
email:
type: string
pickup:
description: 'The desired location for pickup.
Certain parameters are required for this request.
You must include either zipcode, state or coords.
If you provide coords, you must not provide any other address information.
If you include a City, then a State should also be provided to avoid
ambiguous information.
Missing geographical data will be automatically filled by the API.
'
oneOf:
- title: Place with State
type: object
properties:
city:
type: string
description: Name of city
state:
type: string
description: Two letter state or equivalent administrative boundary
zipcode:
type: string
description: zipcode (first five digits)
country:
type: string
pattern: ^[A-Z]{3}$
description: '3-letter country code, uppercase (ISO 3166-1 alpha-3)
If no country is provided, ''USA'' is inferred.
'
coords:
type: object
required:
- latitude
- longitude
properties:
latitude:
type: number
description: Approximate latitude for the place
longitude:
type: number
description: Approximate longitude for the place
required:
- state
- title: Place with Zipcode
type: object
properties:
city:
type: string
description: Name of city
state:
type: string
description: Two letter state or equivalent administrative boundary
zipcode:
type: string
description: zipcode (first five digits)
country:
type: string
pattern: ^[A-Z]{3}$
description: '3-letter country code, uppercase (ISO 3166-1 alpha-3)
If no country is provided, ''USA'' is inferred.
'
coords:
type: object
required:
- latitude
- longitude
properties:
latitude:
type: number
description: Approximate latitude for the place
longitude:
type: number
description: Approximate longitude for the place
required:
- zipcode
- title: Place with City must have State
type: object
properties:
city:
type: string
description: Name of city
state:
type: string
description: Two letter state or equivalent administrative boundary
zipcode:
type: string
description: zipcode (first five digits)
country:
type: string
pattern: ^[A-Z]{3}$
description: '3-letter country code, uppercase (ISO 3166-1 alpha-3)
If no country is provided, ''USA'' is inferred.
'
coords:
type: object
required:
- latitude
- longitude
properties:
latitude:
type: number
description: Approximate latitude for the place
longitude:
type: number
description: Approximate longitude for the place
required:
- city
- state
- title: Place with Coords
type: object
properties:
city:
type: string
description: Name of city
state:
type: string
description: Two letter state or equivalent administrative boundary
zipcode:
type: string
description: zipcode (first five digits)
country:
type: string
pattern: ^[A-Z]{3}$
description: '3-letter country code, uppercase (ISO 3166-1 alpha-3)
If no country is provided, ''USA'' is inferred.
'
coords:
type: object
required:
- latitude
- longitude
properties:
latitude:
type: number
description: Approximate latitude for the place
longitude:
type: number
description: Approximate longitude for the place
required:
- coords
delivery:
type: array
description: 'The desired location for delivery.
Certain parameters are required for this request.
You must include either zipcode, state or coords.
If you provide coords, you must not provide any other address information.
If you include a City, then a State should also be provided to avoid
ambiguous information.
Missing geographical data will be automatically filled by the API.
'
items:
oneOf:
- title: Place with State
type: object
properties:
city:
type: string
description: Name of city
state:
type: string
description: Two letter state or equivalent administrative boundary
zipcode:
type: string
description: zipcode (first five digits)
country:
type: string
pattern: ^[A-Z]{3}$
description: '3-letter country code, uppercase (ISO 3166-1 alpha-3)
If no country is provided, ''USA'' is inferred.
'
coords:
type: object
required:
- latitude
- longitude
properties:
latitude:
type: number
description: Approximate latitude for the place
longitude:
type: number
description: Approximate longitude for the place
required:
- state
- title: Place with Zipcode
type: object
properties:
city:
type: string
description: Name of city
state:
type: string
description: Two letter state or equivalent administrative boundary
zipcode:
type: string
description: zipcode (first five digits)
country:
type: string
pattern: ^[A-Z]{3}$
description: '3-letter country code, uppercase (ISO 3166-1 alpha-3)
If no country is provided, ''USA'' is inferred.
'
coords:
type: object
required:
- latitude
- longitude
properties:
latitude:
type: number
description: Approximate latitude for the place
longitude:
type: number
description: Approximate longitude for the place
required:
- zipcode
- title: Place with City must have State
type: object
properties:
city:
type: string
description: Name of city
state:
type: string
description: Two letter state or equivalent administrative boundary
zipcode:
type: string
description: zipcode (first five digits)
country:
type: string
pattern: ^[A-Z]{3}$
description: '3-letter country code, uppercase (ISO 3166-1 alpha-3)
If no country is provided, ''USA'' is inferred.
'
coords:
type: object
required:
- latitude
- longitude
properties:
latitude:
type: number
description: Approximate latitude for the place
longitude:
type: number
description: Approximate longitude for the place
required:
- city
- state
- title: Place with Coords
type: object
properties:
city:
type: string
description: Name of city
state:
type: string
description: Two letter state or equivalent administrative boundary
zipcode:
type: string
description: zipcode (first five digits)
country:
type: string
pattern: ^[A-Z]{3}$
description: '3-letter country code, uppercase (ISO 3166-1 alpha-3)
If no country is provided, ''USA'' is inferred.
'
coords:
type: object
required:
- latitude
- longitude
properties:
latitude:
type: number
description: Approximate latitude for the place
longitude:
type: number
description: Approximate longitude for the place
required:
- coords
- type: array
title: capacity:static
items:
type: object
required:
- carrier_identification
- ref_number
- equipment_type
- available_dow
- pickup
- contacts
properties:
available_dow:
type: array
description: A list of the capacity's available days of week.
items:
type: string
enum:
- Mon
- Tue
- Wed
- Thu
# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/loadsmart/refs/heads/main/openapi/loadsmart-capacity-api-openapi.yml