Entities
Reference and master data scoped to your account: offices, salespersons, counter parties, commodities, accessorials, locations, and load update statuses. Dispatch and Opportunity records reference these by id, so this is usually the first API partners call.
The pattern
Every entity type below follows the same two operations: a POST .../list for a paginated, filterable list (pageNumber/pageSize, plus a filterSet for narrowing results), and a GET .../{id} for a single record by identifier.
Example: list your offices
curl -X POST https://dev-openapi-apim.azure-api.net/public/entities/v2/offices/list \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{"pageNumber": 1, "pageSize": 10}'
{"totalCount": 19, "result": [ { "...": "..." } ]}
Available entity types
Offices
List or retrieve the offices available to the calling customer.
Salespersons
List or retrieve the salespersons available to the calling customer.
Counter parties
List or retrieve counter parties, plus two supporting lookups: all available counter party types, and all contacts for a specific counter party.
Commodities
List or retrieve the commodities available to the calling customer.
Accessorials
List or retrieve the accessorials available to the calling customer.
Locations
List or retrieve locations, plus an address-suggestion search (post-locations-addresses-search) backed by the HERE Maps autocomplete service -- useful for validating or auto-completing an address before creating a location.
Load update statuses
List or retrieve the load update statuses available to the calling customer -- the status values referenced when posting check calls against a load (see the Dispatch API).
[PLACEHOLDER — needs real content from someone with product knowledge of this API: what the specific filterSet fields and values mean for each entity type, and any write/create operations planned for this API beyond the read-only list/get operations documented above.]