Orders
This resource provides a set of operations to search, retrieve, create, and update Orders.
You can create an order of type Quote and Reservation for a specific duration, add items, and labors to the order. The availability of added items will be blocked for the specified duration if it’s a reservation order.
You can modify any detail of an existing Order and/or its item and labor lines by specifying the action type.
Following verbs are supported by this resource.
GET
End Point: /orders
You can search for any existing R2 Orders using this service.
You can also apply filters as defined here.
Pagination is supported for this API. Click here to see the details of it.
Sample response payload
CODE
[
{
"orderid": "string",
"ordertype": "Quote",
"datecreated": "MM/dd/yyyy HH:mm",
"lastupdateddate": "MM/dd/yyyy HH:mm",
"startdate": "MM/dd/yyyy HH:mm",
"enddate": "MM/dd/yyyy HH:mm",
"amount": 0,
"siteamount": 0,
"baseamount": 0,
"salesperson": "string",
"probability": "0%",
"description": "string",
"saleorder": true,
"ordersubtype": "Order",
"status": "Open",
"ostatus": "Partly Filled",
"assignedto": "string",
"project": "string",
"sitename": "string",
"ponumber": "string",
"categoryid": "string",
"subcategoryid": "string",
"departmentid": "string",
"customerid": "string",
"companyname": "string",
"companystatus": "Active",
"contactname": "string",
"billingcompanyname": "string",
"billingcompanystatus": "Active",
"billingcontactname": "string",
"nextbilldate": "MM/dd/yyyy HH:mm",
"shippinglocationid": "string",
"shippinglocationname": "string",
"shippingaddress": "string",
"shippingstreet": "string",
"shippingcity": "string",
"shippingstate": "string",
"shippingzipcode": "string",
"shipdate": "MM/dd/yyyy HH:mm",
"isinvoiceexists": true,
"lastinvoiceposteddate": "MM/dd/yyyy HH:mm",
"eventid": "string",
"eventname": "string",
"shippingboothroomnumber": "string",
"returnboothroomnumber": "string"
}
]GET by ID
End Point: /orders/{id}
You can retrieve all information on a specific R2 Order using this service.
You can also retrieve the following Labor related details and Order Header details.
Labor Details
QTY
Tasks
Regular Rate
OT Rate
DT Rate
RT hours
OT hours
DT hours
Discount
Total Cost
Action- shows the section header and section total lines as well
Order Header Details
Primary Project Manager Full Name
Primary Labor Planner Full Name and ID
Primary Salesperson Full Name
Shipping Location Name
Payment Terms Name
Billing Terms Name
Site name
Items subtotal
Labor subtotal
Prepayment subtotal
Deposit
Net Due
Sample response payload
CODE
{
"orderid": "string",
"orderdescription": "string",
"ordertype": "Quote",
"versionno": 0,
"contactid": "string",
"contactname": "string",
"companyid": "string",
"companyname": "string",
"billingcontactid": "string",
"siteid": "string",
"sitename": "string",
"chargestartdateandtime": "MM/dd/yyyy HH:mm",
"chargeduration": "string",
"prepdateandtime": "MM/dd/yyyy HH:mm",
"deliverydateandtime": "MM/dd/yyyy HH:mm",
"loadindateandtime": "MM/dd/yyyy HH:mm",
"rehearsaldateandtime": "MM/dd/yyyy HH:mm",
"showstartdateandtime": "MM/dd/yyyy HH:mm",
"showenddateandtime": "MM/dd/yyyy HH:mm",
"strikedateandtime": "MM/dd/yyyy HH:mm",
"pickupdateandtime": "MM/dd/yyyy HH:mm",
"returndateandtime": "MM/dd/yyyy HH:mm",
"salespersonid": "string",
"salespersonname": "string",
"probability": "0%",
"projectmanagerid": "string",
"projectmanagername": "string",
"laborplannerid": "string",
"laborplannername": "string",
"projectid": "string",
"infocomments":
[
{
"recordid": "string",
"comment": "string"
}
],
"laborcomments":
[
{
"recordid": "string",
"comment": "string"
}
],
"eventid": "string",
"eventname": "string",
"eventstartdate": "MM/dd/yyyy HH:mm",
"eventenddate": "MM/dd/yyyy HH:mm",
"shippingcontactid": "string",
"shippingcomments":
[
{
"recordid": "string",
"comment": "string"
}
],
"shippinglocationid": "string",
"shippinglocationdescription": "string",
"shippingaddress":
{
"addressline": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"shipvia": "Ground Fr",
"shippingboothroomnumber": "string",
"shippingtrackingno": "string",
"taxregionid": "string",
"ponumber": "string",
"paymenttermid": "string",
"paymenttermdescription": "string",
"paymentmethod": "Visa",
"payat": "Rent",
"billingtermid": "string",
"billingtermdescription": "string",
"paytype": "Bill",
"secondinvoicedate": "MM/dd/yyyy HH:mm",
"resellcertificatenumber": "string",
"discounttype": "Fixed",
"discountpercent": 0,
"discountamount": 0,
"damagewaivertype": "Fixed",
"damagewaiverpercent": 0,
"damagewaiveramount": 0,
"consumabletype": "Fixed",
"consumableamount": 0,
"consumablepercent": 0,
"servicechargeondiscountedamount": true,
"servicechargeonsellitems": true,
"servicechargeonlabor": true,
"servicechargeonmisc": true,
"servicechargeondamagewaiver": true,
"servicechargeonconsumable": true,
"servicechargetype": "Fixed",
"servicechargeamount": 0,
"servicechargepercent": 0,
"taxapplicable": true,
"itemsubtotal": 0,
"laborsubtotal": 0,
"subtotal": 0,
"totaltaxamount": 0,
"net": 0,
"advance": 0,
"deposit": 0,
"netdue": 0,
"returncontactid": "string",
"returnlocationid": "string",
"returnaddress":
{
"addressline": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"returnvia": "Ground Fr",
"returnboothroomnumber": "string",
"returntrackingno": "string",
"profitcentreid": "string",
"discountgroupid": "string",
"departmentid": "string",
"accountid": "string",
"disclaimerid": "string",
"commissiongroupid": "string",
"categoryid": "string",
"validtilldateandtime": "MM/dd/yyyy HH:mm",
"defaultunit": "Week",
"udfs":
[
{
"caption": "string",
"value": "string"
}
],
"orderitems":
[
{
"recordid": "string",
"linenumber": 0,
"productid": "string",
"description": "string",
"invtype": "null",
"quantity": 0,
"status": "Hold",
"action": "Rent",
"daysinweek": 0,
"daysinmonth": 0,
"unit": "AMPM",
"unitprice": 0,
"discountpercent": 0,
"amount": 0,
"shelflocation": "string",
"binnumber": "string",
"chargestartdateandtime": "MM/dd/yyyy HH:mm",
"chargeduration": "string",
"prepdateandtime": "MM/dd/yyyy HH:mm",
"deliverydateandtime": "MM/dd/yyyy HH:mm",
"loadindateandtime": "MM/dd/yyyy HH:mm",
"rehearsaldateandtime": "MM/dd/yyyy HH:mm",
"showstartdateandtime": "MM/dd/yyyy HH:mm",
"showenddateandtime": "MM/dd/yyyy HH:mm",
"strikedateandtime": "MM/dd/yyyy HH:mm",
"pickupdateandtime": "MM/dd/yyyy HH:mm",
"returndateandtime": "MM/dd/yyyy HH:mm",
"comments":
[
{
"recordid": "string",
"comment": "string"
}
],
"childitems":
[
null
]
"iscontainer": true
}
],
"orderlabors":
[
{
"recordid": "string",
"linenumber": 0,
"laborid": "string",
"description": "string",
"quantity": 0,
"task": "string",
"action": "Rent",
"rtrate": 0,
"otrate": 0,
"dtrate": 0,
"rt": 0,
"ot": 0,
"dt": 0,
"startdate": "MM/dd/yyyy HH:mm",
"enddate": "MM/dd/yyyy HH:mm",
"discountpercent": 0,
"totalcost": 0,
"amount": 0
}
]
}POST
End Point: /orders
This action is used to create a Quote or a Reservation, with all header details like the main customer, dates, shipping location, return location, discounts, payments, Probability etc...
You can add items of type Rent, Sale, Misc. Charge, etc with line details like units, quantity, action, unit price. You can also add labor lines with dates on Order.
The Probability field is considered only when creating a Quote and ignored for other types of Order..
On successful creation, the service returns HTTPStatus 201 - Created success status response code.
On successful creation, you will see the entire object in the response body.
The ID of the new record will be returned in 'Location' attribute of the HTTP Header.
The 'Location' indicates the target of a redirection or the URL of a newly created resource. For example: /orders/{id}
Sample response payload
CODE
{
"orderdescription": "string",
"ordertype": "Quote",
"contactid": "string",
"billingcontactid": "string",
"siteid": "string",
"chargestartdateandtime": "MM/dd/yyyy HH:mm",
"chargeduration": "string",
"prepdateandtime": "MM/dd/yyyy HH:mm",
"deliverydateandtime": "MM/dd/yyyy HH:mm",
"loadindateandtime": "MM/dd/yyyy HH:mm",
"rehearsaldateandtime": "MM/dd/yyyy HH:mm",
"showstartdateandtime": "MM/dd/yyyy HH:mm",
"showenddateandtime": "MM/dd/yyyy HH:mm",
"strikedateandtime": "MM/dd/yyyy HH:mm",
"pickupdateandtime": "MM/dd/yyyy HH:mm",
"returndateandtime": "MM/dd/yyyy HH:mm",
"salespersonid": "string",
"probability": "0%",
"projectmanagerid": "string",
"laborplannerid": "string",
"projectid": "string",
"infocomments":
[
{
"recordid": "string",
"comment": "string"
}
],
"laborcomments":
[
{
"recordid": "string",
"comment": "string"
}
],
"eventid": "string",
"shippingcontactid": "string",
"shippingcomments":
[
{
"recordid": "string",
"comment": "string"
}
],
"shippinglocationid": "string",
"shippingaddress":
{
"addressline": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"shipvia": "Ground Fr",
"shippingboothroomnumber": "string",
"shippingtrackingno": "string",
"taxregionid": "string",
"ponumber": "string",
"paymenttermid": "string",
"paymentmethod": "Visa",
"payat": "Rent",
"billingtermid": "string",
"paytype": "Bill",
"secondinvoicedate": "MM/dd/yyyy HH:mm",
"resellcertificatenumber": "string",
"discounttype": "Fixed",
"discountpercent": 0,
"discountamount": 0,
"damagewaivertype": "Fixed",
"damagewaiverpercent": 0,
"damagewaiveramount": 0,
"consumabletype": "Fixed",
"consumableamount": 0,
"consumablepercent": 0,
"sevicechargeondiscountedamount": true,
"servicechargeonsellitems": true,
"servicechargeonlabor": true,
"servicechargeonmisc": true,
"servicechargeondamagewaiver": true,
"servicechargeonconsumable": true,
"servicechargetype": "Fixed",
"servicechargeamount": 0,
"servicechargepercent": 0,
"taxapplicable": true,
"returncontactid": "string",
"returnlocationid": "string",
"returnaddress":
{
"addressline": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"returnvia": "Ground Fr",
"returnboothroomnumber": "string",
"returntrackingno": "string",
"profitcentreid": "string",
"discountgroupid": "string",
"departmentid": "string",
"accountid": "string",
"disclaimerid": "string",
"commissiongroupid": "string",
"categoryid": "string",
"validtilldateandtime": "MM/dd/yyyy HH:mm",
"defaultunit": "Week",
"udfs":
[
{
"caption": "string",
"value": "string"
}
],
"orderitems":
[
{
"recordid": "string",
"productid": "string",
"description": "string",
"quantity": 0,
"action": "Rent",
"daysinweek": 0,
"daysinmonth": 0,
"unit": "AMPM",
"unitprice": 0,
"discountpercent": 0,
"amount": 0,
"shelflocation": "string",
"binnumber": "string",
"chargestartdateandtime": "MM/dd/yyyy HH:mm",
"chargeduration": "string",
"prepdateandtime": "MM/dd/yyyy HH:mm",
"deliverydateandtime": "MM/dd/yyyy HH:mm",
"loadindateandtime": "MM/dd/yyyy HH:mm",
"rehearsaldateandtime": "MM/dd/yyyy HH:mm",
"showstartdateandtime": "MM/dd/yyyy HH:mm",
"showenddateandtime": "MM/dd/yyyy HH:mm",
"strikedateandtime": "MM/dd/yyyy HH:mm",
"pickupdateandtime": "MM/dd/yyyy HH:mm",
"returndateandtime": "MM/dd/yyyy HH:mm",
"comments":
[
{
"recordid": "string",
"comment": "string"
}
],
"childitems":
[
null
]
}
],
"orderlabors":
[
{
"recordid": "string",
"laborid": "string",
"description": "string",
"startdate": "MM/dd/yyyy HH:mm",
"enddate": "MM/dd/yyyy HH:mm"
}
]
}
}POST: Convert Order
End Point: /orders/{id}/convert/{type}
You can convert an existing order to Quote/Reservation/Hold.
On successful conversion of an order, you will see the entire object in the response body.
PUT
End Point: /orders/{id}
You can modify the details of the existing R2 Order and update many header details like the main customer, dates, locations, discounts, payments, Probability etc... The Probability field is considered only when updating a Quote and ignored for other types of Order.
Using the PUT action you can perform the following changes on the Item/Labor lines — Add New , Modify or Delete Existing.
For deletion, there is a "lineaction": "Delete" code introduced in the given payload (It is same for both - Item and Labor.
The Probability field is considered only when updating a Quote and ignored for other types of Order.
After a successful update, you will see the entire object in the response body.
Sample response payload
CODE
{
"orderdescription": "string",
"ordertype": "Quote",
"contactid": "string",
"billingcontactid": "string",
"siteid": "string",
"chargestartdateandtime": "MM/dd/yyyy HH:mm",
"chargeduration": "string",
"prepdateandtime": "MM/dd/yyyy HH:mm",
"deliverydateandtime": "MM/dd/yyyy HH:mm",
"loadindateandtime": "MM/dd/yyyy HH:mm",
"rehearsaldateandtime": "MM/dd/yyyy HH:mm",
"showstartdateandtime": "MM/dd/yyyy HH:mm",
"showenddateandtime": "MM/dd/yyyy HH:mm",
"strikedateandtime": "MM/dd/yyyy HH:mm",
"pickupdateandtime": "MM/dd/yyyy HH:mm",
"returndateandtime": "MM/dd/yyyy HH:mm",
"salespersonid": "string",
"probability": "0%",
"projectmanagerid": "string",
"laborplannerid": "string",
"projectid": "string",
"infocomments":
[
{
"recordid": "string",
"comment": "string"
}
],
"laborcomments":
[
{
"recordid": "string",
"comment": "string"
}
],
"eventid": "string",
"shippingcontactid": "string",
"shippingcomments":
[
{
"recordid": "string",
"comment": "string"
}
],
"shippinglocationid": "string",
"shippingaddress":
{
"addressline": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"shipvia": "Ground Fr",
"shippingboothroomnumber": "string",
"shippingtrackingno": "string",
"taxregionid": "string",
"ponumber": "string",
"paymenttermid": "string",
"paymentmethod": "Visa",
"payat": "Rent",
"billingtermid": "string",
"paytype": "Bill",
"secondinvoicedate": "MM/dd/yyyy HH:mm",
"resellcertificatenumber": "string",
"discounttype": "Fixed",
"discountpercent": 0,
"discountamount": 0,
"damagewaivertype": "Fixed",
"damagewaiverpercent": 0,
"damagewaiveramount": 0,
"consumabletype": "Fixed",
"consumableamount": 0,
"consumablepercent": 0,
"servicechargeondiscountedamount": true,
"servicechargeonsellitems": true,
"servicechargeonlabor": true,
"servicechargeonmisc": true,
"servicechargeondamagewaiver": true,
"servicechargeonconsumable": true,
"servicechargetype": "Fixed",
"servicechargeamount": 0,
"servicechargepercent": 0,
"taxapplicable": true,
"returncontactid": "string",
"returnlocationid": "string",
"returnaddress":
{
"addressline": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"returnvia": "Ground Fr",
"returnboothroomnumber": "string",
"returntrackingno": "string",
"profitcentreid": "string",
"discountgroupid": "string",
"departmentid": "string",
"accountid": "string",
"disclaimerid": "string",
"commissiongroupid": "string",
"categoryid": "string",
"validtilldateandtime": "MM/dd/yyyy HH:mm",
"defaultunit": "Week",
"udfs":
[
{
"caption": "string",
"value": "string"
}
],
"orderitems":
[
{
"recordid": "string",
"lineaction": "Delete",
"productid": "string",
"description": "string",
"quantity": 0,
"action": "Rent",
"daysinweek": 0,
"daysinmonth": 0,
"unit": "AMPM",
"unitprice": 0,
"discountpercent": 0,
"amount": 0,
"shelflocation": "string",
"binnumber": "string",
"chargestartdateandtime": "MM/dd/yyyy HH:mm",
"chargeduration": "string",
"prepdateandtime": "MM/dd/yyyy HH:mm",
"deliverydateandtime": "MM/dd/yyyy HH:mm",
"loadindateandtime": "MM/dd/yyyy HH:mm",
"rehearsaldateandtime": "MM/dd/yyyy HH:mm",
"showstartdateandtime": "MM/dd/yyyy HH:mm",
"showenddateandtime": "MM/dd/yyyy HH:mm",
"strikedateandtime": "MM/dd/yyyy HH:mm",
"pickupdateandtime": "MM/dd/yyyy HH:mm",
"returndateandtime": "MM/dd/yyyy HH:mm",
"comments":
[
{
"recordid": "string",
"comment": "string"
}
],
"childitems":
[
null
]
}
],
"orderlabors":
[
{
"recordid": "string",
"lineaction": "Delete",
"laborid": "string",
"description": "string",
"startdate": "MM/dd/yyyy HH:mm",
"enddate": "MM/dd/yyyy HH:mm"
}
]
}