cxt_track_shipments
Track shipments
Track orders and route stops by tracking number: matches a parcel reference, a parcel item barcode, or Reference1/Reference2 of an order or route stop. Returns shipment summaries with status events and proof of delivery as far as the caller's permissions allow: an INET login sees the most detail; with an Operations App login this endpoint is called without credentials (CXT lists only internet users and anonymous callers for it), which returns the limited public tracking view. Costs 1 API credit with the vendor. POST /v2/Shipments/Summaries.
Parametersend_datepage_numpage_sizebegin_datetracking_numbersrequiredinclude_partial_match
cxt_search_shipments
Search orders and route stops
Search orders and route stops by place, address, city, state, postal code, order template, or only by date range. tracking_type says which field search_criteria is matched against: Location (origin/destination or stop name), Address, City, State, Postal (zip or zip+4), Template (order template name), Tracking (references/barcodes) or DateOnly (no criteria: everything between begin_date and end_date). Returns shipment summaries, up to 1000 per page. An INET login sees the most detail; with an Operations App login this endpoint is called without credentials (CXT lists only internet users and anonymous callers for it), so the view is limited. Costs 1 API credit with the vendor. POST /v2/Shipments/Summaries.
Parametersend_datepage_numpage_sizebegin_datetracking_typerequiredsearch_criteriainclude_partial_match
cxt_list_recent_orders
List recent orders
The most recent orders of the signed-in INTERNET user (user type INET; the orders of their account). Costs 1 API credit with the vendor. POST /v2/Shipments/Summaries with numRecentOrders.
Parameterscount
cxt_get_order
Get order (internet user)
One on-demand order with its status, confirmation, pickup, delivery and proof-of-delivery details, as an INTERNET user sees it (sign in with user type INET). Optionally with the itemized charges. Operations App users should use cxt_get_dispatch_order. Costs 1 API credit with the vendor. GET /v2/Orders/{orderId}/{includeItemizedCharges}.
Parametersorder_idrequiredinclude_itemized_charges
cxt_get_dispatch_order
Get order (Operations App user)
One on-demand order with itemized charges, as an OPERATIONS APP (X Dispatch) user sees it (sign in with user type XDISPATCH): addresses, times, driver, status events, proof of delivery. Costs 1 API credit with the vendor. GET /v2/Dispatch/Orders/{onDemandOrderId}.
Parametersorder_idrequired
cxt_get_planning_limits
Get itinerary planning limits
The itinerary planning limits of this X Dispatch system: maxAllowedStops (shipments x 2), maxAllowedLocations and maxAllowedPlaceholders. Needs an Operations App user with the ITINERARY_PLANNING_ACCESS permission. GET /v3/ItineraryPlanning/Settings.
Takes no parameters.
cxt_validate_drivers
Validate drivers for planning
Check whether drivers are available to be planned: for each driver id, vehicle violations (for example an expired inspection) and HR violations (for example not scheduled), each with isBypassable. Changes nothing. Needs ITINERARY_PLANNING_ACCESS. POST /v3/ItineraryPlanning/Orders/Drivers/Validate.
Parametersdriver_idsrequired
cxt_validate_driver_for_orders
Validate a driver for orders
Check one driver against specific orders: vehicle violations, HR violations and capability violations (for example Hazmat or Lift Gate that the driver lacks). Changes nothing. Needs ITINERARY_PLANNING_ACCESS. POST /v3/ItineraryPlanning/Orders/Drivers/{driverId}/Validate.
Parametersdriver_idrequiredorder_idsrequired
cxt_plan_orders
Plan orders onto drivers
Generate a proposed itinerary that assigns on-demand orders to drivers (pickup and delivery stops in sequence, with times, distance and unassigned stops). This only PROPOSES a plan: nothing is dispatched until cxt_save_order_plan is called. Needs ITINERARY_PLANNING_ACCESS. Check the limits with cxt_get_planning_limits first. POST /v3/ItineraryPlanning/Orders.
Parametersgoalend_timerequiredorder_idsrequireddriver_idsrequiredstart_timerequiredenhanced_routingnum_placeholdersmax_orders_per_driver
cxt_optimize_order_plan
Re-optimize one driver's order plan
Re-optimize a single driver's plan after manual changes (proposal only: nothing is dispatched until cxt_save_order_plan). Needs ITINERARY_PLANNING_ACCESS. POST /v3/ItineraryPlanning/Orders/Optimize.
Parametersgoalend_timerequireddriver_idrequiredstart_timerequiredis_placeholderplan_order_idsrequiredenhanced_routingall_input_order_idsrequired
cxt_plan_routes
Plan route stops
Generate a proposed re-sequencing of the stops of existing routes for one route date (stops move between the output routes, with times, distance and unassigned stops). Proposal only: nothing changes until cxt_save_route_plan is called. Needs ITINERARY_PLANNING_ACCESS. POST /v3/ItineraryPlanning/Routes/{postDate}.
Parametersgoalend_timerequiredpost_daterequiredstart_timerequiredinput_route_idsrequiredenhanced_routingnum_placeholdersoutput_route_idsrequiredexcluded_stop_idsmax_stops_per_routegrace_period_per_stopservice_time_per_stop
cxt_optimize_route_plan
Re-optimize one route
Re-optimize a single route after manual changes (proposal only: nothing changes until cxt_save_route_plan). Needs ITINERARY_PLANNING_ACCESS. POST /v3/ItineraryPlanning/Routes/{postDate}/Optimize.
Parametersgoalend_timerequiredroute_idrequiredpost_daterequiredstart_timerequiredis_batch_callplan_stop_idsis_placeholderinput_route_idsenhanced_routingexcluded_stop_ids
cxt_save_order_plan
Save order plan (dispatch orders to drivers)
COMMIT an order plan: assigns the orders to the drivers and DISPATCHES them (drivers receive the work in the driver app; customers may be notified by the system's own status rules). Use only after the user has seen and approved the plan from cxt_plan_orders / cxt_optimize_order_plan. Pass each driver's stops from the plan reply: id, type (PICKUP or DELIVERY), sequence and from (the scheduled time). Response is empty on success (204). Needs ITINERARY_PLANNING_ACCESS. POST /v3/ItineraryPlanning/Orders/Save.
Parametersplansrequiredconfirmrequireddriver_pay_locked_status
cxt_save_route_plan
Save route plan (reassign route stops)
COMMIT a route plan for one route date: moves and re-sequences route stops as in the plan and DISPATCHES the changed routes to drivers. Use only after the user has seen and approved the plan from cxt_plan_routes / cxt_optimize_route_plan. Pass each route's stops from the plan reply: id, sequence and from (the scheduled time). Response is empty on success (204). Needs ITINERARY_PLANNING_ACCESS. POST /v3/ItineraryPlanning/Routes/{postDate}/Save.
Parametersplansrequiredconfirmrequiredpost_daterequireddriver_pay_locked_status
