Loads

Log a check call

Changed on

Log a check call on a load, as the TMS "Log check call" does.

What happens

  • The check call is recorded
  • A tracking event moves the load, its orders and its shipment along — for example DEPARTED_DELIVERY at the last stop delivers them — and records the stop's arrival or departure time when it is not set yet
  • The load's next check call is set (see nextCheckCall)
  • Shippers and tracking partners connected to the load are notified as for any check call (EDI 214, project44)

Dispatching

  • DISPATCHED copies the driver contact's phone and the pick-up ETA onto the carrier, as the TMS does
  • On a truckload, trackingEnabled (default: the load's tracking setting) turns tracking on or off; with it on, a driver phone is required and the carrier's tracking provider starts on its own. A load a provider already tracks keeps its setting.
  • LTL and forwarding loads are dispatched with tracking off

Prerequisites

  • The event must follow from the load's current status for its mode (see CheckCallStatus); any other returns 409
post/loads/{id}/check-calls

Request

  • Base URL: https://api.mvmnt.io/v1
  • URL: https://api.mvmnt.io/v1/loads/{id}/check-calls
  • Auth: HTTP bearer

Path parameters

idstring required

Resource ID (UUID) or client key

Query parameters

by'id' | 'key'

Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.

Request body

status'CHECK_CALL' | 'INTERNAL_NOTE' | 'EXTERNAL_NOTE' | 'INCIDENT' | 'DISPATCHED' | 'ARRIVED_AT_PICKUP' | 'DEPARTED_PICKUP' | 'ARRIVED_AT_DELIVERY' | 'DEPARTED_DELIVERY' | 'COMPLETED_FINAL_DELIVERY' | 'PICKED_UP' | 'IN_TRANSIT' | 'OUT_FOR_DELIVERY' required

Check-call events a caller can log. The TMS offers, and this API accepts, the notes and INCIDENT at any time, and a tracking event only when it follows from the load's current status for its mode:

  • DISPATCHED: load booked or selected
  • ARRIVED_AT_PICKUP, PICKED_UP: load dispatched (ARRIVED_AT_PICKUP also while in transit to a later pickup)
  • DEPARTED_PICKUP: load loading
  • IN_TRANSIT: load picked up
  • ARRIVED_AT_DELIVERY: load in transit
  • OUT_FOR_DELIVERY: load in transit or at the delivery terminal
  • DEPARTED_DELIVERY: load unloading
  • COMPLETED_FINAL_DELIVERY: load unloading, in transit, at the delivery terminal, out for delivery or recovered

Truckload uses the arrive/depart events; LTL and forwarding (ocean, air, expedited) use PICKED_UP, IN_TRANSIT and OUT_FOR_DELIVERY.

calledAtstring date-time

When the call happened. Defaults to now.

notesstring
locationstring

The driver's location. CHECK_CALL and INCIDENT only.

incidentType'ACCIDENT' | 'ACTUAL_CLAIM' | 'ATTEMPTED_DELIVERY' | 'BREAKDOWN' | 'DELAY' | 'DELIVERY_NOT_COMPLETED' | 'FRAUD' | 'GENERAL_EXCEPTION' | 'LOAD_LOCK_ALERT' | 'OVERAGE_SHORTAGE' | 'PICKUP_EXCEPTION' | 'POTENTIAL_CLAIM' | 'REFUSED_BY_CONSIGNEE' | 'REFUSED_BY_RECIPIENT' | 'REJECTION' | 'SHIPMENT_CANCELLED' | 'SHIPMENT_DAMAGED' | 'SHIPMENT_DELAYED' | 'SHIPMENT_HAS_BEEN_RECONSIGNED' | 'SHIPMENT_RETURNED_TO_SHIPPER' | 'STORAGE_IN_TRANSIT' | 'TONU'
stopIdstring uuid

The stop an arrive, depart or final-delivery event is for: a pickup for *_PICKUP, a delivery for *_DELIVERY, the load's last stop for COMPLETED_FINAL_DELIVERY. When omitted it is chosen as the TMS does — the first stop of that kind not yet arrived at (arrive) or arrived at but not departed (depart), else the only candidate.

arrivedAtDatestring date

Required for ARRIVED_AT_PICKUP and ARRIVED_AT_DELIVERY.

arrivedAtTimestring

Stop-local time, HH:mm. Required with arrivedAtDate.

departedAtDatestring date

Required for DEPARTED_PICKUP, DEPARTED_DELIVERY and COMPLETED_FINAL_DELIVERY.

departedAtTimestring

Stop-local time, HH:mm. Required with departedAtDate.

dispatchTimestring

DISPATCHED only.

trackingEnabledboolean

DISPATCHED on a truckload only: whether to track the load. When omitted it follows the load's tracking setting, as in the TMS. Tracking needs a driver phone, from the carrier's driver contact or its driver cell; the tracking provider then starts on its own. LTL and forwarding loads are not tracked this way.

nextCheckCallstring date-time nullable

When the next check call is due. As in the TMS, it defaults to three hours from now, and is cleared once the load is delivered. It can be set only while the load is not delivered, and not with INCIDENT, INTERNAL_NOTE or EXTERNAL_NOTE.

nextCheckCallNotestring

Response

Check call logged

idstring uuid required
loadIdstring uuid required
statusstring required

The event. Besides the values a caller can log (CheckCallStatus), tracking integrations record their own, such as TRACKING_SERVICE_UPDATE or DOCUMENT_UPLOADED.

incidentType'ACCIDENT' | 'ACTUAL_CLAIM' | 'ATTEMPTED_DELIVERY' | 'BREAKDOWN' | 'DELAY' | 'DELIVERY_NOT_COMPLETED' | 'FRAUD' | 'GENERAL_EXCEPTION' | 'LOAD_LOCK_ALERT' | 'OVERAGE_SHORTAGE' | 'PICKUP_EXCEPTION' | 'POTENTIAL_CLAIM' | 'REFUSED_BY_CONSIGNEE' | 'REFUSED_BY_RECIPIENT' | 'REJECTION' | 'SHIPMENT_CANCELLED' | 'SHIPMENT_DAMAGED' | 'SHIPMENT_DELAYED' | 'SHIPMENT_HAS_BEEN_RECONSIGNED' | 'SHIPMENT_RETURNED_TO_SHIPPER' | 'STORAGE_IN_TRANSIT' | 'TONU'
calledAtstring date-time nullable
locationstring nullable
notesstring nullable
stopIdstring uuid nullable
arrivedAtDatestring date nullable
arrivedAtTimestring nullable

Stop-local time, HH:mm

departedAtDatestring date nullable
departedAtTimestring nullable

Stop-local time, HH:mm

dispatchTimestring nullable
recordedBystring

Who logged it — a user, an integration, or Public API (<client>)

integrationstring nullable

The tracking integration that recorded it, if any

createdAtstring date-time required

Changes