MEmentium
v2
tms
Load Offers

Get offer or calculated defaults (no auto-create)

Returns existing offer or calculated defaults WITHOUT auto-creating.

Use this endpoint to display offer values without persisting them until
the user explicitly saves. This allows TMS changes (like Beginning Buy Rate
updates) to be reflected until user saves.

**Response includes `is_saved` flag:**
- `is_saved=true`: Offer exists in DB, showing saved values
- `is_saved=false`: No offer exists, showing calculated defaults from TMS
get/v2/tms/offers/by-load/{external_reference_load_id}

Request

  • Base URL
    https://api.mentium.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

external_reference_load_idstring required

Query parameters

integration_connection_idstring required

TMS integration connection UUID

Headers

mentium-workspace-idstring nullable

Response

Successful Response

idstring nullable
organization_idstring required
workspace_idstring required
integration_connection_idstring required
external_reference_load_idstring required
customer_rate_amountnumber nullable
min_load_offer_carrier_rate_amountnumber nullable required
min_load_offer_carrier_rate_sourcestring nullable
max_load_offer_carrier_rate_amountnumber nullable
max_load_offer_carrier_rate_sourcestring nullable
load_board_posted_carrier_rate_amountnumber nullable

What the TMS has the load posted at on the load boards; no quote is below it (ENG-2550).

created_atstring date-time nullable
updated_atstring date-time nullable
is_savedboolean required

True if offer exists in DB, False if showing calculated defaults

customer_currencystring nullable

Customer billing currency from Vortex.

org_currencystring nullable

Currency amounts are stored in Nexus

negotiation_currency_basisstring nullable

Negotiation currency basis setting (organization|customer|carrier).

display_currencystring nullable

Currency amounts are displayed in (org's current base currency)

was_convertedboolean

True if amounts were converted from org_currency to display_currency

Changes

No recorded changes to this operation across all 2 revisions of this API.