GET api/order/{ID}
This API method returns details for a quote or order including the services and costs associated with each service. Notes
Error Messages
- 500/Internal Server Error - Error retrieving order with ID.
- 404/Not found - No order found with id - The ID specified is not linked to an order.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
ID | Filter by Order ID | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Populated QuoteDetails object
Collection of OrderDetailViewName | Description | Type | Additional information |
---|---|---|---|
ID | OrderID | integer |
None. |
Company | Company Name | string |
None. |
DefaultSite | Default Site Name | string |
None. |
DefaultSiteID | Default Site ID | integer |
None. |
ContactName | Contact Name | string |
None. |
ContactID | Contact ID | integer |
None. |
Name | Order or Quote referrence | string |
None. |
CreatedDate | Created Date | date |
None. |
QuoteExpiryDate | Date a quote will expire on - blank if its an order | date |
None. |
Status | Order Status | string |
None. |
Owner | Order Owner | string |
None. |
Services | List of services on Order | Collection of OrderDetailService |
None. |
LastUpdated | The date/time that the order was last updated | date |
None. |