POST api/Order/PlaceOrder
Places rep order
Request Information
URI Parameters
None.
Body Parameters
The Order object to store
OrderName | Description | Type | Additional information |
---|---|---|---|
orderid | integer |
None. |
|
customer_id | string |
None. |
|
customer_name | string |
None. |
|
ordernumber | string |
None. |
|
pickupnotenumber | string |
None. |
|
shiptolocation | string |
None. |
|
orderdate | string |
None. |
|
requireddeliverydate | string |
None. |
|
comments | string |
None. |
|
orderedby_repcode | string |
None. |
|
orderedby_rep | string |
None. |
|
orderedby_userid | integer |
None. |
|
assignuserid | integer |
None. |
|
assigngroupid | integer |
None. |
|
datecreated | date |
None. |
|
sTranNo_RMS | string |
None. |
|
AppGuid | globally unique identifier |
None. |
|
orderItems | Collection of OrderItem |
None. |
Request Formats
application/json, text/json
Sample:
{ "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-17T03:42:56.6682822+00:00", "sTranNo_RMS": "sample string 12", "AppGuid": "6074c4ca-7167-4acf-ab2b-818938f90d2b", "orderItems": [ { "itemid": 1, "orderid": 1, "itemorder_code": "sample string 2", "itemorder_description": "sample string 3", "bags": "sample string 4", "price": 1.0, "AppGuid": "148311e8-aaca-4c41-8f70-a486de798941" }, { "itemid": 1, "orderid": 1, "itemorder_code": "sample string 2", "itemorder_description": "sample string 3", "bags": "sample string 4", "price": 1.0, "AppGuid": "148311e8-aaca-4c41-8f70-a486de798941" } ] }
application/xml, text/xml
Sample:
<Order xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Core.Models.Orders"> <AppGuid>6074c4ca-7167-4acf-ab2b-818938f90d2b</AppGuid> <assigngroupid>1</assigngroupid> <assignuserid>1</assignuserid> <comments>sample string 9</comments> <customer_id>sample string 2</customer_id> <customer_name>sample string 3</customer_name> <datecreated>2024-05-17T03:42:56.6682822+00:00</datecreated> <orderItems> <OrderItem> <AppGuid>148311e8-aaca-4c41-8f70-a486de798941</AppGuid> <bags>sample string 4</bags> <itemid>1</itemid> <itemorder_code>sample string 2</itemorder_code> <itemorder_description>sample string 3</itemorder_description> <orderid>1</orderid> <price>1</price> </OrderItem> <OrderItem> <AppGuid>148311e8-aaca-4c41-8f70-a486de798941</AppGuid> <bags>sample string 4</bags> <itemid>1</itemid> <itemorder_code>sample string 2</itemorder_code> <itemorder_description>sample string 3</itemorder_description> <orderid>1</orderid> <price>1</price> </OrderItem> </orderItems> <orderdate>sample string 7</orderdate> <orderedby_rep>sample string 11</orderedby_rep> <orderedby_repcode>sample string 10</orderedby_repcode> <orderedby_userid>1</orderedby_userid> <orderid>1</orderid> <ordernumber>sample string 4</ordernumber> <pickupnotenumber>sample string 5</pickupnotenumber> <requireddeliverydate>sample string 8</requireddeliverydate> <sTranNo_RMS>sample string 12</sTranNo_RMS> <shiptolocation>sample string 6</shiptolocation> </Order>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Returns the updated Order object containing the orderId and the sTranNo_RMS reference to RMS
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-17T03:42:56.6996252+00:00", "sTranNo_RMS": "sample string 12", "AppGuid": "2b60a9ea-06c6-42fb-a101-6dc9e4771a65", "orderItems": [ { "itemid": 1, "orderid": 1, "itemorder_code": "sample string 2", "itemorder_description": "sample string 3", "bags": "sample string 4", "price": 1.0, "AppGuid": "8ec56209-6c61-411b-88ad-c05ff335aff6" }, { "itemid": 1, "orderid": 1, "itemorder_code": "sample string 2", "itemorder_description": "sample string 3", "bags": "sample string 4", "price": 1.0, "AppGuid": "8ec56209-6c61-411b-88ad-c05ff335aff6" } ] }, "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>2b60a9ea-06c6-42fb-a101-6dc9e4771a65</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-17T03:42:56.6996252+00:00</d2p1:datecreated> <d2p1:orderItems> <d2p1:OrderItem> <d2p1:AppGuid>8ec56209-6c61-411b-88ad-c05ff335aff6</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>8ec56209-6c61-411b-88ad-c05ff335aff6</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>