GET /orders/new
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.
Roles that can access this endpoint are Users, Customers.
Parameters
| name |
description |
type |
default |
type |
| recurringOrderId |
the ID of the recurring order that we'll use to fill the order object (optional) |
query
|
|
String
|
Result
RowOrders
of type:
application/xml
application/json
an order record with all appropriate defaults set
Additional attributes:
__statusDescr This value represents the description of the order status, found in the orders.status field.__collectionMethodDescr This value represents the description of the collection method, found in the orders.collection_method field.__rateTypeDescr This value represents the description of the rate type, found in the orders.rate_type field.__revenueTypeDescr This value represents the description of the revenue code, found in the orders.revenue_code_id field.__equipmentTypeDescr This value represents the description of the equipment type, found in the orders.equipment_type_id field.__tractorTypeDescr This value represents the description of the tractor type, found in the orders.tractor_type field.
Child Elements:
RowCustomer This element represent the customer associated with the order, by the order.customer_id field.
The element contains a __name attribute with the value customer.RowUsers This element represent the entered user associated with the order, by the order.entered_user_id field.
The element contains a __name attribute with the value enteredUser.RowStop These elements represent the stops associated with the order.
Each element contains a __name attribute with the value stops.RowOtherCharge These elements represent the other charges associated with the order.
Each element contains a __name attribute with the value otherCharges.RowMovement These elements represent the other charges associated with the order.
Each element contains a __name attribute with the value movements.
Try It Out
Request