GET api/Order/GetOrder/{orderId}
Gets the order details
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
orderId |
The orderId (primary key) column in keystone_mobi_orders |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns the Order object
OrderViewModelName | Description | Type | Additional information |
---|---|---|---|
order | Order |
None. |
|
apiResponse | APIResponseMessage |
None. |
Response Formats
application/json, text/json
Sample:
{ "order": { "orderid": 1, "customer_id": "sample string 2", "customer_name": "sample string 3", "ordernumber": "sample string 4", "pickupnotenumber": "sample string 5", "shiptolocation": "sample string 6", "orderdate": "sample string 7", "requireddeliverydate": "sample string 8", "comments": "sample string 9", "orderedby_repcode": "sample string 10", "orderedby_rep": "sample string 11", "orderedby_userid": 1, "assignuserid": 1, "assigngroupid": 1, "datecreated": "2024-05-17T05:02:53.8456143+00:00", "sTranNo_RMS": "sample string 12", "AppGuid": "54645d12-edf7-4c93-9a64-066414eef628", "orderItems": [ { "itemid": 1, "orderid": 1, "itemorder_code": "sample string 2", "itemorder_description": "sample string 3", "bags": "sample string 4", "price": 1.0, "AppGuid": "b7fda2ab-2450-4897-af03-1978bfe72698" }, { "itemid": 1, "orderid": 1, "itemorder_code": "sample string 2", "itemorder_description": "sample string 3", "bags": "sample string 4", "price": 1.0, "AppGuid": "b7fda2ab-2450-4897-af03-1978bfe72698" } ] }, "apiResponse": { "HttpStatusCode": "sample string 1", "ReasonPhrase": "sample string 2", "ExceptionMessage": "sample string 3", "GeneralMessage": "sample string 4" } }
application/xml, text/xml
Sample:
<OrderViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.Orders"> <apiResponse xmlns:d2p1="http://schemas.datacontract.org/2004/07/API.Core.Models"> <d2p1:ExceptionMessage>sample string 3</d2p1:ExceptionMessage> <d2p1:GeneralMessage>sample string 4</d2p1:GeneralMessage> <d2p1:HttpStatusCode>sample string 1</d2p1:HttpStatusCode> <d2p1:ReasonPhrase>sample string 2</d2p1:ReasonPhrase> </apiResponse> <order xmlns:d2p1="http://schemas.datacontract.org/2004/07/API.Core.Models.Orders"> <d2p1:AppGuid>54645d12-edf7-4c93-9a64-066414eef628</d2p1:AppGuid> <d2p1:assigngroupid>1</d2p1:assigngroupid> <d2p1:assignuserid>1</d2p1:assignuserid> <d2p1:comments>sample string 9</d2p1:comments> <d2p1:customer_id>sample string 2</d2p1:customer_id> <d2p1:customer_name>sample string 3</d2p1:customer_name> <d2p1:datecreated>2024-05-17T05:02:53.8456143+00:00</d2p1:datecreated> <d2p1:orderItems> <d2p1:OrderItem> <d2p1:AppGuid>b7fda2ab-2450-4897-af03-1978bfe72698</d2p1:AppGuid> <d2p1:bags>sample string 4</d2p1:bags> <d2p1:itemid>1</d2p1:itemid> <d2p1:itemorder_code>sample string 2</d2p1:itemorder_code> <d2p1:itemorder_description>sample string 3</d2p1:itemorder_description> <d2p1:orderid>1</d2p1:orderid> <d2p1:price>1</d2p1:price> </d2p1:OrderItem> <d2p1:OrderItem> <d2p1:AppGuid>b7fda2ab-2450-4897-af03-1978bfe72698</d2p1:AppGuid> <d2p1:bags>sample string 4</d2p1:bags> <d2p1:itemid>1</d2p1:itemid> <d2p1:itemorder_code>sample string 2</d2p1:itemorder_code> <d2p1:itemorder_description>sample string 3</d2p1:itemorder_description> <d2p1:orderid>1</d2p1:orderid> <d2p1:price>1</d2p1:price> </d2p1:OrderItem> </d2p1:orderItems> <d2p1:orderdate>sample string 7</d2p1:orderdate> <d2p1:orderedby_rep>sample string 11</d2p1:orderedby_rep> <d2p1:orderedby_repcode>sample string 10</d2p1:orderedby_repcode> <d2p1:orderedby_userid>1</d2p1:orderedby_userid> <d2p1:orderid>1</d2p1:orderid> <d2p1:ordernumber>sample string 4</d2p1:ordernumber> <d2p1:pickupnotenumber>sample string 5</d2p1:pickupnotenumber> <d2p1:requireddeliverydate>sample string 8</d2p1:requireddeliverydate> <d2p1:sTranNo_RMS>sample string 12</d2p1:sTranNo_RMS> <d2p1:shiptolocation>sample string 6</d2p1:shiptolocation> </order> </OrderViewModel>