/api/p/v{version}/loads/{loadNumber}/notes

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Create a new note associated with a specific load.

Notes can be used to store operational comments, updates, or other annotations related to the load.

Path Parameters

NameTypeRequiredDescription
loadNumberstringYesThe unique number identifying the load.
versionstringYesAPI version (e.g., 2.0). Default value: 2.0.

Request Body

{
  "Id": "string",
  "Description": "string",
  "NoteType": "string",
  "CreatedAt": "2026-03-16T12:53:22.902Z",
  "CreatedBy": "string"
}

Request Body Parameters

NameTypeDescription
CreatedAtdatetimeThe timestamp when the note was created.
CreatedBystringThe user or system creating the note.
DescriptionstringThe text content of the note.
IdstringUnique identifier of the note.
NoteTypestringThe category or type of the note.

Responses

200 OK

Returned when the note is successfully processed.

{
  "CreatedAt": "2026-03-16T12:54:26.202Z",
  "CreatedBy": "string",
  "Description": "string",
  "Id": "string",
  "NoteType": "string"
}

201 Created

Returned when a new note is successfully created.

{
  "CreatedAt": "2026-03-16T12:54:26.203Z",
  "CreatedBy": "string",
  "Description": "string",
  "Id": "string",
  "NoteType": "string"
}
Path Params
string
required
string
required
Defaults to 2.0
Body Params
string
required
string
required
string
required
Headers
string
enum
Defaults to application/json
Allowed:
string
enum
Defaults to application/json-patch+json
Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json