Items
Content was last updated in 06.23.05-00
Revision History
API Version | R2 Version | Reference No. | Changes |
2.0 | 06.23.05-00 | R2-20661 | Introducing PUT function. |
2.0 | 06.23.03-00 | R2-19961 | Container flag support through "iscontainer": true tag. |
2.0 | 06.01.06-00 | NA | Introduction to Items resource |
This resource provides a set of operations to search for items and GET a specific item by ID.
GET
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
[
{
"productid": "string",
"description": "string",
"itemtype": "Items",
"misctype": "Misc",
"serial": true,
"rent": true,
"sell": true,
"stock": 0,
"availablequantity": 0,
"siteid": "string",
"manufacturer": "string",
"model": "string",
"upc": "string",
"departmentid": "string",
"availablegroupid": "string",
"exchangegroupid": "string",
"commissiongroupid": "string",
"reportgroupid": "string",
"attributegroupid": "string",
"taxgroupid": "string",
"shelflocation": "string",
"binnumber": "string",
"nswithassets": true,
"partnumber": "string",
"categoryid": "string",
"subcategoryid": "string",
"alloweddiscount": 0,
"allowsubrent": true,
"checkavailability": true,
"childitems": [
null
]
}
"iscontainer": true
]GET by ID
You can retrieve all information of a specific item for a specific site in R2 using this service.
This service also provides pricing information of a specific item.
Sample response payload
CODE
{
"productid": "string",
"description": "string",
"active": true,
"serial": true,
"misctype": "Misc",
"iscapitalizedcost": true,
"nswithassets": true,
"pricingmethod": "Package",
"ismiscitem": true,
"isaccessory": true,
"isconsigned": true,
"keywords": "string",
"subcategoryid": "string",
"upc": "string",
"turnaroundtime": "string",
"dateadded": "MM/dd/yyyy HH:mm",
"sortpriority": "string",
"warrantyperiodinmonths": 0,
"manufacturer": "string",
"partno": "string",
"model": "string",
"madein": "string",
"url": "string",
"stock": 0,
"canrent": true,
"cansell": true,
"qconreturn": true,
"cansubrent": true,
"checkavail": true,
"servicecharge": true,
"damagewaiver": true,
"ismaintainstatistics": true,
"discountpercent": 0,
"consumable": true,
"printonorder": true,
"issearchable": true,
"retailprice": 0,
"lowestretailprice": 0,
"msrp": 0,
"nbv": 0,
"nbvason": "MM/dd/yyyy HH:mm",
"sitereplacementcost": 0,
"basereplacementcost": 0,
"siteaveragecost": 0,
"baseaveragecost": 0,
"sitepurchaseprice": 0,
"purchaseprice": 0,
"isdepreciable": true,
"depreciationtype": "Fixed",
"depreciationpercent": 0,
"depreciationlife": 0,
"depreciationsalvagepercent": 0,
"availgroupid": "string",
"exchangegroupid": "string",
"commissiongroupid": "string",
"metergroupid": "string",
"reportgroupid": "string",
"departmentgroupid": "string",
"attributegroupid": "string",
"taxgroupid": "string",
"maintenancegroupid": "string",
"pricinggroupid": "string",
"depreciationgroupid": "string",
"matrixpricegroupid": "string",
"accountgroupid": "string",
"rentglaccountid": "string",
"salesglaccountid": "string",
"subrentglaccountid": "string",
"expensesaccountglaccountid": "string",
"cogsglaccountid": "string",
"depreciationglaccountid": "string",
"inventoryglaccountid": "string",
"accountdepreciationglaccountid": "string",
"writeoffglaccountid": "string",
"discountglaccountid": "string",
"length": 0,
"width": 0,
"height": 0,
"weight": 0,
"pricing": [
{
"groupid": "string",
"date": "MM/dd/yyyy HH:mm",
"unit": "Weekly",
"price": 0,
"minprice": 0,
"cost": 0,
"overheadcost": 0
}
]
"iscontainer": true
}PUT by ID
You can modify the details of an existing item.
After a successful update, you will see the entire object in the response.
Sample response payload
CODE
{
"recordid" "string"
"productid": "string",
"description": "string",
"longdescription" "string"
"active" "boolean": true,
"pricingmethod" "string"
"ismiscitem" "boolean": true ,
"keywords": "string",
"upc": "string",
"turnaroundtime": "string",
"sortpriority": "string",
"warrantyperiodinmonths": 0,
"manufacturer": "string",
"partno": "string",
"model": "string",
"madein": "string",
"url": "string",
"damagewaiver": true,
"ismaintainstatistics": true,
"discountpercent": 0,
"consumable": true,
"printonorder": true,
"issearchable": true,
"msrp": 0,
"sitereplacementcost": 0,
"siteaveragecost": 0,
"availgroupid": "string",
"exchangegroupid": "string",
"commissiongroupid": "string",
"metergroupid": "string",
"reportgroupid": "string",
"departmentgroupid": "string",
"attributegroupid": "string",
"taxgroupid": "string",
"pricinggroupid": "string",
"depreciationgroupid": "string",
"matrixpricegroupid": "string",
"accountgroupid": "string",
"rentglaccountid": "string",
"salesglaccountid": "string",
"subrentglaccountid": "string",
"expensesaccountglaccountid": "string",
"cogsglaccountid": "string",
"depreciationglaccountid": "string",
"inventoryglaccountid": "string",
"accountdepreciationglaccountid": "string",
"writeoffglaccountid": "string",
"discountglaccountid": "string",
"length": 0,
"width": 0,
"height": 0,
"weight": 0,
}