tms.delivery¶
Carrying out deliveries. It owns dispatch, driver assignment, arrival and position pings, parking zones and status changes. Most of it is field input, so POST and PATCH dominate.
35 endpoints - system tms - module gate applies
What this module covers - Deliveries, delivery orders, bookings, companies, equipment, loads.
Endpoints¶
| Method | Path | What it does | Evidence |
|---|---|---|---|
| GET | /tms/carrier-master/by-phone |
Look up a carrier master record by phone number | handler carrier_master_by_phone_number() · tables T_CARRIER_MASTER |
| GET | /tms/companies/(?P<id>\d+)/terminal-status |
Read the terminal status per company | handler is_terminal() · tables T_COMPANY |
| GET | /tms/deliveries/driver-list |
List the drivers available for dispatch | handler delivery_list_by_username() · tables T_BOOKING, T_COMPANY, T_DELIVERY +6 more |
| POST/PATCH | /tms/deliveries/form |
Register or edit a delivery | handler tmsDeliveryApiFormMutation() · calls driver-operation.php, popup.core.js |
| GET | /tms/deliveries |
List deliveries | handler tmsDeliveryApiParseIds() |
| PATCH | /tms/deliveries/(?P<id>\d+)/arrival-action |
Record an arrival action on a delivery | handler tmsDeliveryWrite() |
| POST | /tms/deliveries/(?P<id>\d+)/arrival-signal |
Send an arrival signal for a delivery | handler tmsDeliveryWrite() |
| PATCH | /tms/deliveries/(?P<id>\d+)/driver-assignment |
Assign a driver to a delivery | handler tmsDeliveryWrite() |
| PATCH | /tms/deliveries/(?P<id>\d+)/field |
Edit a single field of a delivery | handler tmsDeliveryWrite() |
| POST | /tms/deliveries/(?P<id>\d+)/finish-yard-queue-after-clear |
Complete a delivery after the yard queue is cleared | handler tmsDeliveryWrite() |
| GET | /tms/deliveries/(?P<id>\d+) |
Read a delivery in detail | handler tmsDeliveryApiReadRows() · tables T_COMPANY, T_DELIVERY, T_USER |
| POST | /tms/deliveries/(?P<id>\d+)/location-ping |
Send a location ping for a delivery | handler tmsDeliveryWrite() |
| POST/PATCH | /tms/deliveries/(?P<id>\d+)/parking-assignment |
Assign a parking zone | handler tmsDeliveryWrite() |
| POST/PATCH | /tms/deliveries/(?P<id>\d+)/parking-confirm |
Confirm parking | handler tmsDeliveryWrite() |
| POST | /tms/deliveries/(?P<id>\d+)/parking-request |
Register a parking request | handler tmsDeliveryWrite() |
| POST | /tms/deliveries/(?P<id>\d+)/status |
Change the status of a delivery | handler tmsDeliveryWrite() |
| GET | /tms/delivery-orders |
List delivery orders | handler delivery_order_by_bol_id() · tables T_DELIVERY_ORDER |
| POST | /tms/dispatch/delivery |
Run a delivery dispatch | handler tmsDeliveryApiDispatchCreate() · calls popup.core.js, delivery-dispatch-modal.js |
| POST | /tms/dispatch/export-pickup |
Run an export pickup dispatch | handler tmsDeliveryApiDispatchCreate() · calls booking-editor.js, popup.core.js |
| POST | /tms/dispatch/import-return |
Run a return inbound dispatch | handler tmsDeliveryApiDispatchCreate() · calls popup.core.js |
| GET | /tms/driver-logs/current |
Read the work log of the current driver | handler driver_log() · tables T_DRIVER_LOG, T_USER |
| GET | /tms/driver-logs/(?P<id>\d+)/deliveries |
List the deliveries of a driver | handler delivery_list_by_driver_log_id() · tables T_BOOKING, T_COMPANY, T_DELIVERY +4 more |
| GET | /tms/driver-logs/(?P<id>\d+) |
Read a driver work log in detail | handler tmsDeliveryApiDriverLogRow() · tables T_DRIVER_LOG, T_USER |
| GET | /tms/drivers/identity |
Read the identity of the logged-in driver | handler user_id_by_wordpress_username() · tables T_USER · calls driver-operation.php |
| GET | /tms/drivers/search |
Search drivers | handler tmsDeliveryApiDriverSearch() · tables T_COMPANY, T_ROLE, T_USER · calls loading-planner-modal.js |
| PATCH | /tms/equipment/(?P<id>\d+)/field |
Edit a single field of a piece of equipment | handler tmsDeliveryWrite() |
| GET | /tms/equipment-loads/(?P<id>\d+)/deliveries |
List the deliveries of a load | handler delivery_list_by_equipment_load_id() · tables T_COMPANY, T_DELIVERY, T_DELIVERY_ORDER +2 more |
| GET | /tms/equipment-loads/(?P<id>\d+)/return-booking-options |
Read the bookings a load can be returned against | handler tmsDeliveryApiReturnBookingOptions() · tables T_BOOKING, T_COMPANY, T_EQUIPMENT +1 more |
| PATCH/POST | /tms/equipment-loads/(?P<id>\d+)/status |
Change the status of a load | handler tmsDeliveryApiUpdateEquipmentLoadStatus() · tables T_BOOKING, T_EQUIPMENT, T_EQUIPMENT_LOAD |
| GET | /tms/export-empty-plans |
List the empty container export plans | handler eep_list() · tables T_EXPORT_EMPTY_PLAN · calls truck-dispatch.js |
| PATCH | /tms/import-delivery-orders/container-destination |
Edit the destination of an imported delivery order | handler tmsDeliveryApiChangeImportDeliveryDestination() · calls import-dispatch.js |
| PATCH | /tms/import-delivery-orders/container-destinations |
Edit the destinations of several imported orders at once | handler tmsDeliveryApiChangeImportDeliveryDestinations() · calls import-dispatch.js |
| GET | /tms/loading-bookings |
List the bookings available for loading | handler loading_booking_number_list() · tables T_BOOKING, T_COMPANY, T_DELIVERY +2 more |
| GET | /tms/loading-equipment |
List the equipment available for loading | handler loading_equipment_list() · tables T_BOOKING, T_EQUIPMENT, T_EQUIPMENT_LOAD +3 more · calls inbound-loader.php, popup.core.js |
| GET | /tms/trucking-terminal-appointments |
List trucking terminal appointments | handler tta_terminal_options() · tables T_COMPANY · calls truck-dispatch.js |
Topics this module shares with other modules¶
- Carrier - this topic is spread across 2 modules and 5 endpoints.
- Equipment load - this topic is spread across 4 modules and 10 endpoints.
- Delivery order import - this topic is spread across 2 modules and 6 endpoints.
Tables this module reads¶
T_COMPANY (9x) · T_USER (8x) · T_EQUIPMENT_LOAD (7x) · T_BOOKING (6x) · T_EQUIPMENT (6x) · T_DELIVERY (5x) · T_DELIVERY_ORDER (3x) · T_DRIVER_LOG (3x) · T_YARD_LOCATION (2x) · T_CARRIER_MASTER · T_YARD_DISPATCH_QUEUE · T_ROLE · T_EXPORT_EMPTY_PLAN · T_LOADING_PLANNER · T_TRANSLOAD
The description is a summary read off the route path, the handler, the tables it reaches and the screens that call it. Nothing is guessed without evidence: where the handler has to be read, it says so. The full evidence is on each endpoint page.