POST api/Orders
Request Information
URI Parameters
None.
Body Parameters
OrderModel| Name | Description | Type | Additional information |
|---|---|---|---|
| order_id | string |
None. |
|
| order_year | integer |
None. |
|
| order_number | integer |
None. |
|
| description | string |
None. |
|
| request_date | decimal number |
None. |
|
| eta | decimal number |
None. |
|
| received_date | decimal number |
None. |
|
| order_stage | string |
None. |
|
| complete_percent | integer |
None. |
|
| currency | string |
None. |
|
| shipping_method | ShippingMethodModel |
None. |
|
| payment_method | PaymentMethodModel |
None. |
|
| delivery_address | string |
None. |
|
| discount | decimal number |
None. |
|
| cif | boolean |
None. |
|
| packing_cost | decimal number |
None. |
|
| subtotal | decimal number |
None. |
|
| total | decimal number |
None. |
|
| comment | string |
None. |
|
| order_item | Collection of OrderItemModel |
None. |
|
| app_name | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"order_id": "sample string 1",
"order_year": 2,
"order_number": 3,
"description": "sample string 4",
"request_date": 5.1,
"eta": 6.1,
"received_date": 7.1,
"order_stage": "sample string 8",
"complete_percent": 9,
"currency": "sample string 10",
"shipping_method": {
"method_id": 1,
"method_name": "sample string 2",
"shipping_cost": 3.1,
"container_cost": 4.1,
"container_size": 5,
"estimated_time": 6
},
"payment_method": {
"payment_id": 1,
"payment_due_date": "sample string 2",
"payment_status": "sample string 3"
},
"delivery_address": "sample string 11",
"discount": 12.1,
"cif": true,
"packing_cost": 13.1,
"subtotal": 14.1,
"total": 15.1,
"comment": "sample string 16",
"order_item": [
{
"sample": {
"sample_id": "sample string 1",
"sample_reference": "sample string 2",
"sample_name": "sample string 3",
"sample_type": "sample string 4",
"ol_factory": "sample string 5",
"sample_rating": 6,
"delivery_date": "sample string 7",
"top_note": "sample string 8",
"middle_note": "sample string 9",
"base_note": "sample string 10",
"sample_image": "sample string 11",
"price": 12.1,
"project_id": 13,
"inspiration": "sample string 14",
"brand": "sample string 15",
"application": "sample string 16",
"version": 17,
"stock": 18.1,
"out_of_stock": true
},
"sample_label": "sample string 1",
"quantity": 2.1,
"packing_order": [
{
"package_number": 1,
"packing_method": {
"packing_id": 1,
"packing_type": "sample string 2",
"packing_price": 3.1,
"packing_image": "sample string 4"
}
},
{
"package_number": 1,
"packing_method": {
"packing_id": 1,
"packing_type": "sample string 2",
"packing_price": 3.1,
"packing_image": "sample string 4"
}
}
]
},
{
"sample": {
"sample_id": "sample string 1",
"sample_reference": "sample string 2",
"sample_name": "sample string 3",
"sample_type": "sample string 4",
"ol_factory": "sample string 5",
"sample_rating": 6,
"delivery_date": "sample string 7",
"top_note": "sample string 8",
"middle_note": "sample string 9",
"base_note": "sample string 10",
"sample_image": "sample string 11",
"price": 12.1,
"project_id": 13,
"inspiration": "sample string 14",
"brand": "sample string 15",
"application": "sample string 16",
"version": 17,
"stock": 18.1,
"out_of_stock": true
},
"sample_label": "sample string 1",
"quantity": 2.1,
"packing_order": [
{
"package_number": 1,
"packing_method": {
"packing_id": 1,
"packing_type": "sample string 2",
"packing_price": 3.1,
"packing_image": "sample string 4"
}
},
{
"package_number": 1,
"packing_method": {
"packing_id": 1,
"packing_type": "sample string 2",
"packing_price": 3.1,
"packing_image": "sample string 4"
}
}
]
}
],
"app_name": "sample string 17"
}
application/xml, text/xml
Sample:
<OrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApi.Models">
<app_name>sample string 17</app_name>
<cif>true</cif>
<comment>sample string 16</comment>
<complete_percent>9</complete_percent>
<currency>sample string 10</currency>
<delivery_address>sample string 11</delivery_address>
<description>sample string 4</description>
<discount>12.1</discount>
<eta>6.1</eta>
<order_id>sample string 1</order_id>
<order_item>
<OrderItemModel>
<packing_order>
<PackingOrderModel>
<package_number>1</package_number>
<packing_method>
<packing_id>1</packing_id>
<packing_image>sample string 4</packing_image>
<packing_price>3.1</packing_price>
<packing_type>sample string 2</packing_type>
</packing_method>
</PackingOrderModel>
<PackingOrderModel>
<package_number>1</package_number>
<packing_method>
<packing_id>1</packing_id>
<packing_image>sample string 4</packing_image>
<packing_price>3.1</packing_price>
<packing_type>sample string 2</packing_type>
</packing_method>
</PackingOrderModel>
</packing_order>
<quantity>2.1</quantity>
<sample>
<application>sample string 16</application>
<base_note>sample string 10</base_note>
<brand>sample string 15</brand>
<delivery_date>sample string 7</delivery_date>
<inspiration>sample string 14</inspiration>
<middle_note>sample string 9</middle_note>
<ol_factory>sample string 5</ol_factory>
<out_of_stock>true</out_of_stock>
<price>12.1</price>
<project_id>13</project_id>
<sample_id>sample string 1</sample_id>
<sample_image>sample string 11</sample_image>
<sample_name>sample string 3</sample_name>
<sample_rating>6</sample_rating>
<sample_reference>sample string 2</sample_reference>
<sample_type>sample string 4</sample_type>
<stock>18.1</stock>
<top_note>sample string 8</top_note>
<version>17</version>
</sample>
<sample_label>sample string 1</sample_label>
</OrderItemModel>
<OrderItemModel>
<packing_order>
<PackingOrderModel>
<package_number>1</package_number>
<packing_method>
<packing_id>1</packing_id>
<packing_image>sample string 4</packing_image>
<packing_price>3.1</packing_price>
<packing_type>sample string 2</packing_type>
</packing_method>
</PackingOrderModel>
<PackingOrderModel>
<package_number>1</package_number>
<packing_method>
<packing_id>1</packing_id>
<packing_image>sample string 4</packing_image>
<packing_price>3.1</packing_price>
<packing_type>sample string 2</packing_type>
</packing_method>
</PackingOrderModel>
</packing_order>
<quantity>2.1</quantity>
<sample>
<application>sample string 16</application>
<base_note>sample string 10</base_note>
<brand>sample string 15</brand>
<delivery_date>sample string 7</delivery_date>
<inspiration>sample string 14</inspiration>
<middle_note>sample string 9</middle_note>
<ol_factory>sample string 5</ol_factory>
<out_of_stock>true</out_of_stock>
<price>12.1</price>
<project_id>13</project_id>
<sample_id>sample string 1</sample_id>
<sample_image>sample string 11</sample_image>
<sample_name>sample string 3</sample_name>
<sample_rating>6</sample_rating>
<sample_reference>sample string 2</sample_reference>
<sample_type>sample string 4</sample_type>
<stock>18.1</stock>
<top_note>sample string 8</top_note>
<version>17</version>
</sample>
<sample_label>sample string 1</sample_label>
</OrderItemModel>
</order_item>
<order_number>3</order_number>
<order_stage>sample string 8</order_stage>
<order_year>2</order_year>
<packing_cost>13.1</packing_cost>
<payment_method>
<payment_due_date>sample string 2</payment_due_date>
<payment_id>1</payment_id>
<payment_status>sample string 3</payment_status>
</payment_method>
<received_date>7.1</received_date>
<request_date>5.1</request_date>
<shipping_method>
<container_cost>4.1</container_cost>
<container_size>5</container_size>
<estimated_time>6</estimated_time>
<method_id>1</method_id>
<method_name>sample string 2</method_name>
<shipping_cost>3.1</shipping_cost>
</shipping_method>
<subtotal>14.1</subtotal>
<total>15.1</total>
</OrderModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
OrderModel| Name | Description | Type | Additional information |
|---|---|---|---|
| order_id | string |
None. |
|
| order_year | integer |
None. |
|
| order_number | integer |
None. |
|
| description | string |
None. |
|
| request_date | decimal number |
None. |
|
| eta | decimal number |
None. |
|
| received_date | decimal number |
None. |
|
| order_stage | string |
None. |
|
| complete_percent | integer |
None. |
|
| currency | string |
None. |
|
| shipping_method | ShippingMethodModel |
None. |
|
| payment_method | PaymentMethodModel |
None. |
|
| delivery_address | string |
None. |
|
| discount | decimal number |
None. |
|
| cif | boolean |
None. |
|
| packing_cost | decimal number |
None. |
|
| subtotal | decimal number |
None. |
|
| total | decimal number |
None. |
|
| comment | string |
None. |
|
| order_item | Collection of OrderItemModel |
None. |
|
| app_name | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"order_id": "sample string 1",
"order_year": 2,
"order_number": 3,
"description": "sample string 4",
"request_date": 5.1,
"eta": 6.1,
"received_date": 7.1,
"order_stage": "sample string 8",
"complete_percent": 9,
"currency": "sample string 10",
"shipping_method": {
"method_id": 1,
"method_name": "sample string 2",
"shipping_cost": 3.1,
"container_cost": 4.1,
"container_size": 5,
"estimated_time": 6
},
"payment_method": {
"payment_id": 1,
"payment_due_date": "sample string 2",
"payment_status": "sample string 3"
},
"delivery_address": "sample string 11",
"discount": 12.1,
"cif": true,
"packing_cost": 13.1,
"subtotal": 14.1,
"total": 15.1,
"comment": "sample string 16",
"order_item": [
{
"sample": {
"sample_id": "sample string 1",
"sample_reference": "sample string 2",
"sample_name": "sample string 3",
"sample_type": "sample string 4",
"ol_factory": "sample string 5",
"sample_rating": 6,
"delivery_date": "sample string 7",
"top_note": "sample string 8",
"middle_note": "sample string 9",
"base_note": "sample string 10",
"sample_image": "sample string 11",
"price": 12.1,
"project_id": 13,
"inspiration": "sample string 14",
"brand": "sample string 15",
"application": "sample string 16",
"version": 17,
"stock": 18.1,
"out_of_stock": true
},
"sample_label": "sample string 1",
"quantity": 2.1,
"packing_order": [
{
"package_number": 1,
"packing_method": {
"packing_id": 1,
"packing_type": "sample string 2",
"packing_price": 3.1,
"packing_image": "sample string 4"
}
},
{
"package_number": 1,
"packing_method": {
"packing_id": 1,
"packing_type": "sample string 2",
"packing_price": 3.1,
"packing_image": "sample string 4"
}
}
]
},
{
"sample": {
"sample_id": "sample string 1",
"sample_reference": "sample string 2",
"sample_name": "sample string 3",
"sample_type": "sample string 4",
"ol_factory": "sample string 5",
"sample_rating": 6,
"delivery_date": "sample string 7",
"top_note": "sample string 8",
"middle_note": "sample string 9",
"base_note": "sample string 10",
"sample_image": "sample string 11",
"price": 12.1,
"project_id": 13,
"inspiration": "sample string 14",
"brand": "sample string 15",
"application": "sample string 16",
"version": 17,
"stock": 18.1,
"out_of_stock": true
},
"sample_label": "sample string 1",
"quantity": 2.1,
"packing_order": [
{
"package_number": 1,
"packing_method": {
"packing_id": 1,
"packing_type": "sample string 2",
"packing_price": 3.1,
"packing_image": "sample string 4"
}
},
{
"package_number": 1,
"packing_method": {
"packing_id": 1,
"packing_type": "sample string 2",
"packing_price": 3.1,
"packing_image": "sample string 4"
}
}
]
}
],
"app_name": "sample string 17"
}
application/xml, text/xml
Sample:
<OrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApi.Models">
<app_name>sample string 17</app_name>
<cif>true</cif>
<comment>sample string 16</comment>
<complete_percent>9</complete_percent>
<currency>sample string 10</currency>
<delivery_address>sample string 11</delivery_address>
<description>sample string 4</description>
<discount>12.1</discount>
<eta>6.1</eta>
<order_id>sample string 1</order_id>
<order_item>
<OrderItemModel>
<packing_order>
<PackingOrderModel>
<package_number>1</package_number>
<packing_method>
<packing_id>1</packing_id>
<packing_image>sample string 4</packing_image>
<packing_price>3.1</packing_price>
<packing_type>sample string 2</packing_type>
</packing_method>
</PackingOrderModel>
<PackingOrderModel>
<package_number>1</package_number>
<packing_method>
<packing_id>1</packing_id>
<packing_image>sample string 4</packing_image>
<packing_price>3.1</packing_price>
<packing_type>sample string 2</packing_type>
</packing_method>
</PackingOrderModel>
</packing_order>
<quantity>2.1</quantity>
<sample>
<application>sample string 16</application>
<base_note>sample string 10</base_note>
<brand>sample string 15</brand>
<delivery_date>sample string 7</delivery_date>
<inspiration>sample string 14</inspiration>
<middle_note>sample string 9</middle_note>
<ol_factory>sample string 5</ol_factory>
<out_of_stock>true</out_of_stock>
<price>12.1</price>
<project_id>13</project_id>
<sample_id>sample string 1</sample_id>
<sample_image>sample string 11</sample_image>
<sample_name>sample string 3</sample_name>
<sample_rating>6</sample_rating>
<sample_reference>sample string 2</sample_reference>
<sample_type>sample string 4</sample_type>
<stock>18.1</stock>
<top_note>sample string 8</top_note>
<version>17</version>
</sample>
<sample_label>sample string 1</sample_label>
</OrderItemModel>
<OrderItemModel>
<packing_order>
<PackingOrderModel>
<package_number>1</package_number>
<packing_method>
<packing_id>1</packing_id>
<packing_image>sample string 4</packing_image>
<packing_price>3.1</packing_price>
<packing_type>sample string 2</packing_type>
</packing_method>
</PackingOrderModel>
<PackingOrderModel>
<package_number>1</package_number>
<packing_method>
<packing_id>1</packing_id>
<packing_image>sample string 4</packing_image>
<packing_price>3.1</packing_price>
<packing_type>sample string 2</packing_type>
</packing_method>
</PackingOrderModel>
</packing_order>
<quantity>2.1</quantity>
<sample>
<application>sample string 16</application>
<base_note>sample string 10</base_note>
<brand>sample string 15</brand>
<delivery_date>sample string 7</delivery_date>
<inspiration>sample string 14</inspiration>
<middle_note>sample string 9</middle_note>
<ol_factory>sample string 5</ol_factory>
<out_of_stock>true</out_of_stock>
<price>12.1</price>
<project_id>13</project_id>
<sample_id>sample string 1</sample_id>
<sample_image>sample string 11</sample_image>
<sample_name>sample string 3</sample_name>
<sample_rating>6</sample_rating>
<sample_reference>sample string 2</sample_reference>
<sample_type>sample string 4</sample_type>
<stock>18.1</stock>
<top_note>sample string 8</top_note>
<version>17</version>
</sample>
<sample_label>sample string 1</sample_label>
</OrderItemModel>
</order_item>
<order_number>3</order_number>
<order_stage>sample string 8</order_stage>
<order_year>2</order_year>
<packing_cost>13.1</packing_cost>
<payment_method>
<payment_due_date>sample string 2</payment_due_date>
<payment_id>1</payment_id>
<payment_status>sample string 3</payment_status>
</payment_method>
<received_date>7.1</received_date>
<request_date>5.1</request_date>
<shipping_method>
<container_cost>4.1</container_cost>
<container_size>5</container_size>
<estimated_time>6</estimated_time>
<method_id>1</method_id>
<method_name>sample string 2</method_name>
<shipping_cost>3.1</shipping_cost>
</shipping_method>
<subtotal>14.1</subtotal>
<total>15.1</total>
</OrderModel>