go back Home

OrderService

This service provides operations for retrieving and managing order records.

Operations

name role description
GET /orders Users Retrieves a List of RowOrders with a full or partial match to the given value.
GET /orders/new Users, Customers Creates an order object with all configured defaults set. This doesn't create a record in the database. Instead, callers of this method can edit the returned object and then pass it back to the create method to actually insert the record in the database. If a recurring order ID is supplied, then we fill the order object (and its children) with data from the recurring order record.
GET /orders/search Users, Customers Searches the database for orders matching the given request parameters.
GET /orders/tracking Users, Customers 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.
GET /orders/userSavedSearch Users Retrieves a List of RowOrders objects based on an existing saved search.
GET /orders/{id} Users, Drivers, Customers, Carriers Retrieves the Order specified by the ID.
GET /orders/{id}/deliveryReceipt Users, Drivers Retrieves a delivery receipt, in PDF format, for the specified orderId.
GET /orders/{id}/positions Users, Customers Retrieves mobile communication positions for a given order
POST /orders/autorate/{id} Users Performs autorate operation on provided order id.
POST /orders/autorateDetailReport/{id} Users Returns detail report of autorate for a given order.
POST /orders/getBillOfLadingReport/{id} Users Retrieves the bill of lading report for a specified order id.
POST /orders/{id}/convertSubjectOrder Users, Customers Converts a subject order to an order.
POST /orders/{id}/copy Users Creates a copy of the original order in the target company.
POST /orders/{id}/duplicate Users, Customers Creates duplicate copies of the original order, based on supplied parameters.
PUT /orders/create Users, Customers Creates a RowOrders record for the given order data.
PUT /orders/createSubjectOrder Users, Customers Creates a RowOrders record for the given order data.
PUT /orders/orderPostHist/create Users, Drivers, Carriers, Carrier Drivers Creates a new order history record.
PUT /orders/update Users, Customers Updates a RowOrders record for the given order data.
PUT /orders/updateRow Users Updates a RowOrders record for the given order data. This strictly updates the order row without some validation and without updating corresponding stop and movement data. Care should be given when using this service.