MEmentium
TMS API
TMS API - Loads

Create Load

Create a new load.

post/v2/tms-api/loads

Request

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

Headers

X-API-Keystring nullable

API key for authentication

Request body

external_reference_idstring required

Unique identifier from your system

tms_statusstring nullable

Raw TMS status from your system (e.g., 'Dispatched', 'At Shipper')

mentium_status'PLANNED' | 'ACTIVE' | 'COVERED' | 'IN_TRANSIT' | 'DELIVERED' | 'COMPLETED' | 'TERMINATED' | 'ARCHIVED' | 'TEMP' | 'MENTIUM_UNKNOWN_VALUE' required
equipment_type'DRY_VAN' | 'REEFER' | 'FLATBED' | 'FLATBED_CONESTOGA' | 'STEPDECK' | 'STEPDECK_CONESTOGA' | 'LOWBOY' | 'REMOVABLE_GOOSENECK' | 'BULK_DRY_HOPPER' | 'BULK_DRY_PNEUMATIC' | 'BULK_DRY_DUMP' | 'TANKER' | 'INTERMODAL' | 'STRAIGHT' | 'SPRINTER' | 'HOTSHOT' | 'POWER_ONLY' | 'MENTIUM_UNKNOWN_VALUE' required
transport_mode'FTL' | 'PTL' | 'LTL' | 'MENTIUM_UNKNOWN_VALUE' required
customer_external_reference_idstring required

Customer external reference ID - REQUIRED

descriptionstring nullable

Load description

mode_typestring nullable

Business mode (e.g., Brokerage, Asset)

service_typestring nullable

Service type

weightnumber nullable

Total weight

weight_uom'lbs' | 'kg'

Valid weight units of measure for the public TMS API.

piecesinteger nullable

Number of pieces

pallet_countinteger nullable

Number of pallets

lengthnumber nullable

Length

widthnumber nullable

Width

heightnumber nullable

Height

pickup_datetimestring date-time nullable

[Deprecated] Pickup date/time. Use stops[].target_arrival_earliest_at on the PICKUP stop.

delivery_datetimestring date-time nullable

[Deprecated] Delivery date/time. Use stops[].target_arrival_earliest_at on the DELIVERY stop.

earliest_pickupstring date-time nullable

[Deprecated] Earliest pickup. Use stops[].target_arrival_earliest_at on the PICKUP stop.

latest_pickupstring date-time nullable

Exclusive upper bound (half-open). Emitted verbatim from the canonical *_latest_at column; integrators that previously interpreted this as inclusive must adjust. Deprecated — see Sunset header.

earliest_deliverystring date-time nullable

[Deprecated] Earliest delivery. Use stops[].target_arrival_earliest_at on the DELIVERY stop.

latest_deliverystring date-time nullable

Exclusive upper bound (half-open). Emitted verbatim from the canonical *_latest_at column; integrators that previously interpreted this as inclusive must adjust. Deprecated — see Sunset header.

carrier_external_reference_idstring nullable

Carrier external reference ID (for historical/covered loads)

total_distancenumber nullable

Total distance

carrier_milesnumber nullable

Carrier miles

customer_milesnumber nullable

Customer miles

beginning_buy_ratenumber nullable

Beginning buy rate

max_buy_ratenumber nullable

Maximum buy rate

is_hotboolean nullable

Hot/priority load

is_trackingboolean nullable

Tracking enabled

actual_dispatcherstring nullable

Actual dispatcher name or email

operation_userstring nullable

Operations user name or email

account_managerstring nullable

Account manager name or email

mentium_booked_atstring date-time nullable

When the load was booked (carrier secured). Timezone-aware. If omitted, inferred from mentium_status: COVERED -> now; IN_TRANSIT/DELIVERED/COMPLETED -> first PICKUP stop arrival; PLANNED/ACTIVE -> null.

mentium_assigned_atstring date-time nullable

When a dispatcher was assigned. Timezone-aware. If omitted, set to now when dispatcher_rep is provided.

Response

Successful Response

idstring required

Internal Mentium ID

external_reference_idstring required

External reference ID from your system

tms_statusstring nullable

Raw TMS status from your system (e.g., 'Dispatched', 'At Shipper')

mentium_statusstring required

Mentium normalized load status (PLANNED, ACTIVE, COVERED, IN_TRANSIT, DELIVERED, COMPLETED, TERMINATED, or the read-only ARCHIVED set by Mentium's Load auto clean, or the read-only TEMP for a load Mentium created for quoting before it exists in the TMS) - Always present

equipment_typestring nullable

Equipment type (DRY_VAN, REEFER, etc.)

descriptionstring nullable

Load description

mode_typestring nullable

Mode type

transport_modestring nullable

Transport mode

service_typestring nullable

Service type

weightnumber nullable

Total weight

weight_uomstring nullable

Weight unit

piecesinteger nullable

Number of pieces

pallet_countinteger nullable

Number of pallets

lengthnumber nullable

Length

widthnumber nullable

Width

heightnumber nullable

Height

pickup_datetimestring date-time nullable

[Deprecated] Pickup arrival time. Use first PICKUP stop.actual_arrival_at / expected_arrival_at.

delivery_datetimestring date-time nullable

[Deprecated] Delivery arrival time. Use last DELIVERY stop.actual_arrival_at / expected_arrival_at.

earliest_pickupstring date-time nullable

[Deprecated] Earliest pickup (inclusive). Use first_pickup_stop_target_arrival_earliest_at.

latest_pickupstring date-time nullable

Exclusive upper bound (half-open). Emitted verbatim from the canonical *_latest_at column; integrators that previously interpreted this as inclusive must adjust. Deprecated — see Sunset header.

earliest_deliverystring date-time nullable

[Deprecated] Earliest delivery (inclusive). Use last_delivery_stop_target_arrival_earliest_at.

latest_deliverystring date-time nullable

Exclusive upper bound (half-open). Emitted verbatim from the canonical *_latest_at column; integrators that previously interpreted this as inclusive must adjust. Deprecated — see Sunset header.

first_pickup_stop_target_arrival_earliest_atstring date-time nullable

First-pickup stop target window start (inclusive)

first_pickup_stop_target_arrival_latest_atstring date-time nullable

First-pickup stop target window end (exclusive)

last_delivery_stop_target_arrival_earliest_atstring date-time nullable

Last-delivery stop target window start (inclusive)

last_delivery_stop_target_arrival_latest_atstring date-time nullable

Last-delivery stop target window end (exclusive)

customer_idstring nullable

Customer ID

customer_external_reference_idstring nullable

Customer external reference ID

customer_namestring nullable

Customer name

carrier_idstring nullable

Carrier ID

carrier_external_reference_idstring nullable

Carrier external reference ID

carrier_namestring nullable

Carrier name

total_distancenumber nullable

Total distance

carrier_milesnumber nullable

Carrier miles

customer_milesnumber nullable

Customer miles

beginning_buy_ratenumber nullable

Beginning buy rate

max_buy_ratenumber nullable

Maximum buy rate

is_hotboolean nullable

Hot/priority load

is_trackingboolean nullable

Tracking enabled

actual_dispatcherstring nullable

Actual dispatcher name or email

operation_userstring nullable

Operations user name or email

account_managerstring nullable

Account manager name or email

mentium_booked_atstring date-time nullable

When the load was booked (carrier secured)

mentium_assigned_atstring date-time nullable

When a dispatcher was assigned

created_atstring date-time required

Creation timestamp

updated_atstring date-time required

Last update timestamp

Changes

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