Guides
Changelog
Back to All
Added

Load Notes Endpoints Added to the Public API

5 months ago

Release Date: March 2, 2026 (endpoints), April 30, 2026 (CreatedById)

What's New?

You can now list, create, and delete load notes through the Public API — keeping operational commentary in sync between Alvys and your external systems.

What Changed?

Previously, load notes were only accessible inside the Alvys platform.

Now, the Public API (v2) includes:

GET    /api/p/v2.0/loads/{loadNumber}/notes
POST   /api/p/v2.0/loads/{loadNumber}/notes
DELETE /api/p/v2.0/loads/{loadNumber}/notes/{noteId}
  • List load notes — returns all notes on the load.
  • Create load note — body takes description, noteType, and an optional client-supplied id; returns 201 with the created note.
  • Delete load note — returns 204 on success.

Response Body Includes

  • Id, Description, NoteType
  • CreatedAt, CreatedBy
  • CreatedById — the unique identifier of the user who created the note (added April 2026), so integrations can attribute notes to a user by id instead of parsing display names.

Notes on orphaned or inaccessible loads return 404.

Why?

Notes carry dispatch context — special instructions, exception history, customer commitments. Exposing them via the API lets integrations read that context and write their own, without double entry in two systems.