MEmentium
v2
tms
Load Offers

Update offer with automatic margin recalculation

Update persisted offer fields.

Notes:
- `customer_rate_amount` is not stored in Nexus; Vortex is its source of truth.
- margins are computed at read-time for display

**Validation:**
- max_load_offer_carrier_rate_amount: >= min_load_offer_carrier_rate_amount
patch/v2/tms/offers/{offer_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

offer_idstring required

Headers

mentium-workspace-idstring nullable

Request body

Example request

{
  "min_load_offer_carrier_rate_amount": 2500
}

Response

Successful Response

idstring required
organization_idstring required
workspace_idstring required
integration_connection_idstring required
external_reference_load_idstring required
customer_rate_amountstring nullable

What customer pays broker (revenue) from Vortex, converted to display_currency using today's rate

min_load_offer_carrier_rate_amountstring nullable

Minimum carrier-rate bound for the load offer (in display_currency)

min_load_offer_carrier_rate_source'RELATIVE_TO_TMS_MIN_CARRIER_RATE' | 'RELATIVE_TO_TMS_MAX_CARRIER_RATE' | 'RELATIVE_TO_TMS_CUSTOMER_RATE' | 'RELATIVE_TO_DAT_MARKET_RATE' | 'RELATIVE_TO_GREENSCREENS_MARKET_RATE' | 'RELATIVE_TO_MIN_LOAD_OFFER_CARRIER_RATE' | 'RELATIVE_TO_MAX_LOAD_OFFER_CARRIER_RATE' | 'RELATIVE_TO_HISTORICAL_CARRIER_RATE' | 'RELATIVE_TO_LOAD_BOARD_POSTED_CARRIER_RATE' | 'MANUAL_OVERRIDE' | 'MENTIUM_UNKNOWN_VALUE'
min_load_offer_carrier_rate_source_raw_amountstring nullable
max_load_offer_carrier_rate_amountstring nullable

Maximum carrier-rate bound for the load offer

max_load_offer_carrier_rate_source'RELATIVE_TO_TMS_MIN_CARRIER_RATE' | 'RELATIVE_TO_TMS_MAX_CARRIER_RATE' | 'RELATIVE_TO_TMS_CUSTOMER_RATE' | 'RELATIVE_TO_DAT_MARKET_RATE' | 'RELATIVE_TO_GREENSCREENS_MARKET_RATE' | 'RELATIVE_TO_MIN_LOAD_OFFER_CARRIER_RATE' | 'RELATIVE_TO_MAX_LOAD_OFFER_CARRIER_RATE' | 'RELATIVE_TO_HISTORICAL_CARRIER_RATE' | 'RELATIVE_TO_LOAD_BOARD_POSTED_CARRIER_RATE' | 'MANUAL_OVERRIDE' | 'MENTIUM_UNKNOWN_VALUE'
max_load_offer_carrier_rate_source_raw_amountstring nullable
customer_currencystring nullable

Customer billing currency from Vortex.

org_currencystring nullable

Currency the load-offer carrier-rate bounds are stored in

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 due to org currency change

created_by_user_idstring nullable

User who created the offer (null for automated workflows)

created_atstring date-time required
updated_atstring date-time required

Changes

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