Create load note

POST

api

{version}

loads

{loadNumber}

notes

Create load note

curl --request POST \
  --url https://integrations.alvys.com/api/p/v{version}/loads/{loadNumber}/notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "Id": "<string>",
  "Description": "<string>",
  "NoteType": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({Id: '<string>', Description: '<string>', NoteType: '<string>'})
};

fetch('https://integrations.alvys.com/api/p/v{version}/loads/{loadNumber}/notes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://integrations.alvys.com/api/p/v{version}/loads/{loadNumber}/notes"

payload = {
    "Id": "<string>",
    "Description": "<string>",
    "NoteType": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/loads/{loadNumber}/notes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Id' => '<string>',
    'Description' => '<string>',
    'NoteType' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json-patch+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://integrations.alvys.com/api/p/v{version}/loads/{loadNumber}/notes"

	payload := strings.NewReader("{\n  \"Id\": \"<string>\",\n  \"Description\": \"<string>\",\n  \"NoteType\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://integrations.alvys.com/api/p/v{version}/loads/{loadNumber}/notes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Id\": \"<string>\",\n  \"Description\": \"<string>\",\n  \"NoteType\": \"<string>\"\n}")
  .asString();

{
  "Id": "<string>",
  "Description": "<string>",
  "NoteType": "<string>",
  "CreatedBy": "<string>",
  "CreatedAt": "2023-11-07T05:31:56Z",
  "CreatedById": "<string>"
}

{
  "Id": "<string>",
  "Description": "<string>",
  "NoteType": "<string>",
  "CreatedBy": "<string>",
  "CreatedAt": "2023-11-07T05:31:56Z",
  "CreatedById": "<string>"
}

{
  "Errors": {},
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

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

Name	Type	Required	Description
loadNumber	string	Yes	The unique number identifying the load.
version	string	Yes	API version (e.g., `1.0`). Default value: `1.0`.

Request Body

{
  "Id": "string",
  "Description": "string",
  "NoteType": "string"
}

Request Body Parameters

Name	Type	Required	Description
Id	string	Yes	Unique identifier of the note.
Description	string	Yes	The text content of the note. Maximum 4000 characters.
NoteType	string	Yes	The category or type of the note. Maximum 50 characters. Must be one of: `System`, `General`, `Assignment`, `Safety`.

Responses

201 Created

Returned when a new note is successfully created.

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

Authorizations

Authorization

string

header

required

OAuth 2.0 client-credentials access token. Obtain one from https://auth.alvys.com/oauth/token (grant_type=client_credentials, audience=https://api.alvys.com/public/), then paste it here. The playground sends it as Authorization: Bearer <token>.

Path Parameters

loadNumber

string

required

version

string

default:1.0

required

API version (e.g., 1.0)

Example:

"1.0"

Body

string

required

Description

string

required

NoteType

string

required

Response

string

required

Description

string

required

NoteType

string

required

CreatedBy

string

required

CreatedAt

string<date-time> | null

CreatedById

string | null

⌘I

Create load note

curl --request POST \
  --url https://integrations.alvys.com/api/p/v{version}/loads/{loadNumber}/notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "Id": "<string>",
  "Description": "<string>",
  "NoteType": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({Id: '<string>', Description: '<string>', NoteType: '<string>'})
};

fetch('https://integrations.alvys.com/api/p/v{version}/loads/{loadNumber}/notes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://integrations.alvys.com/api/p/v{version}/loads/{loadNumber}/notes"

payload = {
    "Id": "<string>",
    "Description": "<string>",
    "NoteType": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/loads/{loadNumber}/notes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Id' => '<string>',
    'Description' => '<string>',
    'NoteType' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json-patch+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://integrations.alvys.com/api/p/v{version}/loads/{loadNumber}/notes"

	payload := strings.NewReader("{\n  \"Id\": \"<string>\",\n  \"Description\": \"<string>\",\n  \"NoteType\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://integrations.alvys.com/api/p/v{version}/loads/{loadNumber}/notes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Id\": \"<string>\",\n  \"Description\": \"<string>\",\n  \"NoteType\": \"<string>\"\n}")
  .asString();

{
  "Id": "<string>",
  "Description": "<string>",
  "NoteType": "<string>",
  "CreatedBy": "<string>",
  "CreatedAt": "2023-11-07T05:31:56Z",
  "CreatedById": "<string>"
}

{
  "Id": "<string>",
  "Description": "<string>",
  "NoteType": "<string>",
  "CreatedBy": "<string>",
  "CreatedAt": "2023-11-07T05:31:56Z",
  "CreatedById": "<string>"
}

{
  "Errors": {},
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

​Path Parameters

​Request Body

​Request Body Parameters

​Responses

​201 Created

Authorizations

Path Parameters

Body

Response

Path Parameters

Request Body

Request Body Parameters

Responses

201 Created