GET OneStop/Groups/{GroupID}/Devices/{DeviceID}/Consumables/{ConsumableID}/Orders
Get orders for specified consumable
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| GroupID | integer |
Required |
|
| DeviceID |
ID of Device to Get |
integer |
Required |
| ConsumableID |
Consumable to get |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
ConsumableOrderDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ConsumableOrderID |
Order ID |
integer |
Read Only |
| ConsumableID |
Consumable ID |
integer |
Read Only |
| DateRaised |
Date order raised |
date |
Read Only |
| DateDispatched |
Option date order despatched |
date |
None. |
| DateReplaced |
Date consumable replaced. Orders are deemed to be open until consumable is replaced |
date |
None. |
| OrderLevel |
Consumable level when order was placed |
integer |
Read Only |
| OrderPageCount |
Device page count when order was placed |
integer |
Read Only |
| ReplacementPageCount |
Device page count when consumable was replaced |
integer |
Read Only |
| BeforeChangeLevel |
Consumable level before consumable was replaced |
integer |
None. |
| ConsumableLifePageCount |
Page count of consumable. Updated when next order complete |
integer |
Read Only |
| ConsumableLifeDaysCount |
Number of days consumable was in device. Updated when next order complete |
integer |
Read Only |
| OrderReason |
Reason order was raised. Currently 1=Days Between Change, 2=Pages Between Change, 3=Level Reached, 4=Days Before Empty, 5= Manual Order, 6=Consumable Status |
integer |
Read Only |
| ContactName |
Option contact for order |
string |
None. |
| Address1 |
Option address for order |
string |
None. |
| Address2 |
Option address for order |
string |
None. |
| Address3 |
Option address for order |
string |
None. |
| PostCode |
Option address for order |
string |
None. |
| ContactPhone |
Option contact number for order |
string |
None. |
| ContactEmail |
Option contact email address for order |
string |
None. |
| OrderStatus |
Status of order. Currently 1, Placed, 2= Dispatched, 3= Delivered, 4=Installed, 5=Placed in Evatic, 6=Bulk Order Processed |
integer |
None. |
| Quantity |
Quantity of items ordered |
integer |
None. |
| DateDelivered |
Optional date item delivered. |
date |
None. |
| SignedBy |
Optional signed by value |
string |
None. |
| TrackingNumber |
Optional third party tracking number |
string |
None. |
| Courier |
Optional courier company |
string |
None. |
| ExternalReference |
Optional third party reference |
string |
None. |
| Comments |
Any comments for this order |
string |
None. |
| PurchaseOrder |
Optional purchase order number |
string |
None. |
| OrderNumber |
Optional order number |
string |
None. |
| DateProcessed |
Date order processed |
date |
None. |
| DateRaisedInExternalSystem |
Date order raised in external system if using bulk order processing |
date |
None. |
| PartCode |
Part code as specified by manufacturer |
string |
Read Only |
| PartNumber |
Part number as specified by manufacturer |
string |
Read Only |
| ConsumableType |
Standardized consumable type, i.e. Toner, Ink, Waste Toner |
string |
Read Only |
| ConsumableColour |
Standardized consumable colour i.e. cyan, magenta |
string |
Read Only |
Response Formats
application/json, text/json
{
"ConsumableOrderID": 1,
"ConsumableID": 2,
"DateRaised": "2026-07-07T14:50:16.0703391+01:00",
"DateDispatched": "2026-07-07T14:50:16.0703391+01:00",
"DateReplaced": "2026-07-07T14:50:16.0703391+01:00",
"OrderLevel": 4,
"OrderPageCount": 5,
"ReplacementPageCount": 1,
"BeforeChangeLevel": 1,
"ConsumableLifePageCount": 1,
"ConsumableLifeDaysCount": 1,
"OrderReason": 1,
"ContactName": "sample string 6",
"Address1": "sample string 7",
"Address2": "sample string 8",
"Address3": "sample string 9",
"PostCode": "sample string 10",
"ContactPhone": "sample string 11",
"ContactEmail": "sample string 12",
"OrderStatus": 13,
"Quantity": 14,
"DateDelivered": "2026-07-07T14:50:16.0713405+01:00",
"SignedBy": "sample string 15",
"TrackingNumber": "sample string 16",
"Courier": "sample string 17",
"ExternalReference": "sample string 18",
"Comments": "sample string 19",
"PurchaseOrder": "sample string 20",
"OrderNumber": "sample string 21",
"DateProcessed": "2026-07-07T14:50:16.0713405+01:00",
"DateRaisedInExternalSystem": "2026-07-07T14:50:16.0713405+01:00",
"PartCode": "sample string 22",
"PartNumber": "sample string 23",
"ConsumableType": "sample string 24",
"ConsumableColour": "sample string 25"
}
application/xml, text/xml
<ConsumableOrderDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneStopWebAPI.DTO"> <Address1>sample string 7</Address1> <Address2>sample string 8</Address2> <Address3>sample string 9</Address3> <Comments>sample string 19</Comments> <ConsumableLifeDaysCount>1</ConsumableLifeDaysCount> <ConsumableLifePageCount>1</ConsumableLifePageCount> <ContactEmail>sample string 12</ContactEmail> <ContactName>sample string 6</ContactName> <ContactPhone>sample string 11</ContactPhone> <Courier>sample string 17</Courier> <DateDelivered>2026-07-07T14:50:16.0713405+01:00</DateDelivered> <DateDispatched>2026-07-07T14:50:16.0703391+01:00</DateDispatched> <DateProcessed>2026-07-07T14:50:16.0713405+01:00</DateProcessed> <DateRaisedInExternalSystem>2026-07-07T14:50:16.0713405+01:00</DateRaisedInExternalSystem> <DateReplaced>2026-07-07T14:50:16.0703391+01:00</DateReplaced> <ExternalReference>sample string 18</ExternalReference> <OrderNumber>sample string 21</OrderNumber> <PostCode>sample string 10</PostCode> <PurchaseOrder>sample string 20</PurchaseOrder> <ReplacementPageCount>1</ReplacementPageCount> <SignedBy>sample string 15</SignedBy> <TrackingNumber>sample string 16</TrackingNumber> </ConsumableOrderDTO>