tms.booking¶
Registering and editing bookings, plus the functions around one: packing list, out ref assignment, billing readiness and empty container plans. A booking is the starting point for later transload, delivery and billing work, so a wrong state here puts the modules below it wrong as well.
28 endpoints - system tms - module gate applies
What this module covers - Bookings, companies, loads, sales orders, equipment. The packing list additionally reads equipment and loads.
Endpoints¶
| Method | Path | What it does | Evidence |
|---|---|---|---|
| POST | /tms/bookings/booking-instruction/ai-extract |
Extract items from a booking instruction with AI | handler ctcAiApiExtract() · calls api_catalog.php |
| GET/PATCH | /tms/bookings/booking-instruction/ai-prompt |
Read or edit the booking instruction AI prompt | handler ctcAiApiPrompt() · calls api_catalog.php |
| GET | /tms/bookings/drayage-empty-options |
Read the options for a drayage empty container | handler tmsBookingApiDrayageEmptyOptions() · tables T_BOOKING, T_COMPANY |
| POST | /tms/bookings/duplicate-reference |
Handle a duplicate link on a transload reference | handler duplicate_reference_number() · tables T_TRANSLOAD · calls popup.core.js |
| POST/PATCH | /tms/bookings/form |
Register or edit a booking | handler tmsBookingApiFormMutation() · calls popup.core.js |
| GET | /tms/bookings |
List bookings | handler booking_list() · tables T_BOOKING, T_COMPANY · calls api_catalog.php, mk-booking-list.php |
| GET | /tms/bookings/loading-options |
Read the loading options | handler loading_booking_number_list() · tables T_BOOKING, T_COMPANY, T_DELIVERY +2 more |
| GET | /tms/bookings/options |
Read the booking input options (company, load) | handler booking_editor_options() · tables T_COMPANY, T_LOAD, T_MASTER · calls booking-editor.js, mk-booking-editor.js |
| POST | /tms/bookings |
Register a booking | handler tmsBookingWriteWithOutRefs() · calls api_catalog.php, mk-booking-list.php |
| GET | /tms/bookings/sales-orders |
List the sales orders of a booking | handler booking_sales_order_options() · tables T_LOAD · calls booking-editor.js, mk-booking-editor.js |
| GET | /tms/bookings/search |
Search bookings | handler tmsBookingApiSearch() · tables T_BOOKING, T_COMPANY · calls container-edit-modal.js, mk-outbound-order-editor.js |
| GET | /tms/bookings/weight-requirement |
Read the weight requirement of a booking | handler weight_requirement_by_booking_number() · tables T_BOOKING |
| POST | /tms/bookings/(?P<id>\d+)/append-po |
Add a PO to a booking | handler tmsBookingWrite() |
| POST | /tms/bookings/(?P<id>\d+)/assign-out-refs |
Assign out refs to a booking | handler tmsBookingApiAssignOutRefs() · tables T_BOOKING |
| GET | /tms/bookings/{id}/billing-readiness |
Check whether a booking can be billed | handler booking_billing_readiness_projection() |
| POST | /tms/bookings/(?P<id>\d+)/clone |
Clone a booking | handler tmsBookingWrite() |
| GET | /tms/bookings/(?P<id>\d+)/containers |
List the containers of a booking | handler container_list_by_booking_id() · tables T_BOOKING, T_COMPANY, T_EQUIPMENT +4 more |
| GET | /tms/bookings/(?P<id>\d+) |
Read a booking in detail | handler booking_detail() · tables T_BOOKING, T_COMPANY, T_CUSTOMER_PO +1 more |
| POST | /tms/bookings/(?P<id>\d+)/packing-list/email |
Send the packing list by email | handler tmsBookingApiSendPackingListEmail() |
| PATCH | /tms/bookings/(?P<id>\d+)/packing-list/equipment-loads |
Edit the loading items on a packing list | handler tmsBookingWrite() |
| GET | /tms/bookings/(?P<id>\d+)/packing-list/files |
List the files attached to a packing list | handler packing_list_url() · tables T_BOOKING, T_DELIVERY, T_EQUIPMENT +2 more |
| GET | /tms/bookings/(?P<id>\d+)/packing-list |
Read a packing list | handler packing_list() · tables T_EQUIPMENT, T_EQUIPMENT_LOAD, T_LOAD |
| PATCH | /tms/bookings/(?P<id>\d+)/packing-list/rates |
Edit the rates on a packing list | handler tmsBookingWrite() |
| PATCH | /tms/bookings/(?P<id>\d+) |
Edit a booking | handler tmsBookingWriteWithOutRefs() |
| POST | /tms/empty-plan/booking-inquiry-email |
Send the booking inquiry email for an empty plan | handler tmsBookingApiSendEmptyPlanBookingInquiryEmail() · tables T_COMPANY_EMAIL, T_MASTER · calls api_catalog.php, empty-schedule.php |
| POST | /tms/empty-plan/create |
Create an empty container plan | handler tmsBookingWrite() · calls empty-schedule.php |
| GET | /tms/empty-plan/summary |
Read the summary of an empty container plan | handler empty_plan_summary() · tables T_COMPANY, T_TRANSLOAD · calls api_catalog.php |
| POST | /tms/export-containers/revert |
Reverse the processing of an exported container | handler tmsBookingWrite() · calls container-edit-modal.js, popup.core.js |
Topics this module shares with other modules¶
- Equipment load - this topic is spread across 4 modules and 10 endpoints.
- AI item extraction - this topic is spread across 7 modules and 8 endpoints.
- Rate - this topic is spread across 3 modules and 6 endpoints.
Tables this module reads¶
T_BOOKING (9x) · T_COMPANY (8x) · T_EQUIPMENT (4x) · T_EQUIPMENT_LOAD (4x) · T_LOAD (4x) · T_TRANSLOAD (2x) · T_DELIVERY (2x) · T_MASTER (2x) · T_EQUIPMENT_COMMODITY · T_YARD_LOCATION · T_CUSTOMER_PO · T_CUSTOMER_PO_ITEM · T_FILE · T_COMPANY_EMAIL
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.