go back to OrderService

GET /orders/tracking

Searches the database for orders matching the given request parameters. Additional options included to allow searching into equipment and reference numbers. This matches the parameters allowed in Internet Module load tracking (OrderSearchServlet.process()). Parameters reference the field name listed. Date parameters are used for a between clause.

Roles that can access this endpoint are Users, Customers.

Parameters

name description type default type
orderId orders.id query String
proNbr freight_group.pro_nbr query String
status orders.status query String
blnum orders.blnum query String
consigneeRefno orders.consignee_refno query String
referenceNumber reference_number.reference_number (subselected on all stops for the order) query String
tractorId tractor.id (joined on final move) query String
trailerId trailer.id (joined on final move) query String
driverId driver.id (joined on final move) query String
shipperLocationId stop.location_id (joined on orders.shipper_stop_id) query String
shipperCity stop.city_name (joined on orders.shipper_stop_id) query String
shipperState stop.state (joined on orders.shipper_stop_id) query String
shipperZip stop.zip_code (joined on orders.shipper_stop_id) query String
shipperStartDate stop.sched_arrive_early (joined on orders.shipper_stop_id) query Date
shipperEndDate stop.sched_arrive_early (joined on orders.shipper_stop_id) query Date
consigneeLocationId stop.location_id (joined on orders.consignee_stop_id) query String
consigneeCity stop.city_name (joined on orders.consignee_stop_id) query String
consigneeState stop.state (joined on orders.consignee_stop_id) query String
consigneeZip stop.zip (joined on orders.consignee_stop_id) query String
consigneeStartDate stop.sched_arrive_early (joined on orders.consignee_stop_id) query Date
consigneeEndDate stop.sched_arrive_early (joined on orders.consignee_stop_id) query Date

Result

List < RowOrders > of type: application/xml application/json

a list of RowOrders objects

Try It Out

Request

- Authentication Help
- String
- String
- String
- String
- String
- String
- String
- String
- String
- String
- String
- String
- String
- Date
- Date
- String
- String
- String
- String
- Date
- Date