MEmentium
v2
tms
Load Offers

Book a carrier for this offer

Book a carrier for this offer.

1. Find CarrierOffer by offer_id + carrier_id
2. Update status to BOOKED in TMS
3. Close all other CarrierOffers for same offer

For some TMS (like TAI), the API doesn't support updating carrier assignment
on existing shipments. In these cases, the booking is recorded in Mentium
and a `tms_link` is returned for manual carrier assignment in the TMS web UI.
post/v2/tms/offers/{offer_id}/carriers/{carrier_id}/book

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
carrier_idstring required

Headers

mentium-workspace-idstring nullable

Request body

accepted_carrier_rate_amountnumber nullable

Carrier rate to book. If omitted, books at the current carrier rate.

Response

Successful Response

successboolean required

Whether the booking was successful

offer_idstring required

The load offer ID

carrier_idstring required

The carrier's external reference ID

carrier_offer_idstring nullable

The carrier offer ID

statusstring required

BOOKED when the carrier was written to the TMS, ACCEPTED when they are not in the TMS yet and the acceptance was kept for a person to finish.

booked_atstring date-time required

Timestamp when the booking was made

closed_offers_countinteger required

Number of other carrier offers that were closed

tms_linkstring nullable

Link to TMS web UI for manual actions (e.g., TAI carrier assignment). When present, indicates the TMS requires manual completion.

Changes

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