added

New Endpoints for Company Location Details

What’s New?

We added a new Locations Controller to the Public API. This lets you fetch and search company location details (e.g., Terminals, Shippers/Consignees, Cold Warehouses, Dry Warehouses).

  • Lookup by ID or Company Number: Retrieve a single location by unique id or companyNumber.
  • Flexible search: Filter by Statuses, LocationIds, or CreatedDateRange.
  • Richer details: Get company name, type, address, contacts, and notes directly in the response.

What Changed?

  • New endpoints:

    • GET /api/p/v{version}/locations → Single location lookup by id or companyNumber.
    • POST /api/p/v{version}/locations/search → Search and paginate results.
  • Response body includes:

    • Core: Id, Name, CompanyNumber, Type, Status
    • Address: PhysicalAddress { Street, City, State, ZipCode }
    • Contacts: Email[], Phone[], Fax
    • Metadata: DateCreated, ExternalId
    • Notes: [ { Id, Description, NoteType, Time, User } ]
  • Backward compatibility: No changes to existing load/trip stop payloads. Stops continue to expose companyId, but now customers can resolve those IDs via the Locations Controller for more context.


New Endpoints

  • GET /api/p/v{version}/locations
  • POST /api/p/v{version}/locations/search

Why?

Stops in loads and trips previously only included a companyId, making it difficult to identify the company behind each stop. With this release, customers can resolve those IDs into names, addresses, and full details. This improves reporting precision, operational visibility, and overall usability — without breaking existing integrations.