POST api/order/SubmitApiOrder
Submit an sales order
Request Information
URI Parameters
None.
Body Parameters
ApiOrderRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Warehouse | string |
None. |
|
| PONo | string |
None. |
|
| ShipInstruction | string |
None. |
|
| PromoCode | string |
None. |
|
| ShipTo | string |
None. |
|
| ShipVia | string |
None. |
|
| RequestShipDate | date |
None. |
|
| OrderItems | Collection of ApiOrderItem |
None. |
|
| ShippingAddress | ShippingAddress |
None. |
Request Formats
application/json, text/json
Sample:
{
"Warehouse": "sample string 1",
"PONo": "sample string 2",
"ShipInstruction": "sample string 3",
"PromoCode": "sample string 4",
"ShipTo": "sample string 5",
"ShipVia": "sample string 6",
"RequestShipDate": "2025-11-16T18:43:05.5318552-08:00",
"OrderItems": [
{
"ItemNo": "sample string 1",
"Qty": 2,
"Price": 3.0
},
{
"ItemNo": "sample string 1",
"Qty": 2,
"Price": 3.0
}
],
"ShippingAddress": {
"Name": "sample string 1",
"Address1": "sample string 2",
"Address2": "sample string 3",
"City": "sample string 4",
"StateCode": "sample string 5",
"ZipCode": "sample string 6",
"Phone": "sample string 7",
"ShipToCode": "sample string 8",
"Reference": "sample string 9"
}
}
application/xml, text/xml
Sample:
<ApiOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DFS.WebAPI.Models">
<OrderItems>
<ApiOrderItem>
<ItemNo>sample string 1</ItemNo>
<Price>3</Price>
<Qty>2</Qty>
</ApiOrderItem>
<ApiOrderItem>
<ItemNo>sample string 1</ItemNo>
<Price>3</Price>
<Qty>2</Qty>
</ApiOrderItem>
</OrderItems>
<PONo>sample string 2</PONo>
<PromoCode>sample string 4</PromoCode>
<RequestShipDate>2025-11-16T18:43:05.5318552-08:00</RequestShipDate>
<ShipInstruction>sample string 3</ShipInstruction>
<ShipTo>sample string 5</ShipTo>
<ShipVia>sample string 6</ShipVia>
<ShippingAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/App.WebAPI.Models">
<d2p1:Address1>sample string 2</d2p1:Address1>
<d2p1:Address2>sample string 3</d2p1:Address2>
<d2p1:City>sample string 4</d2p1:City>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Phone>sample string 7</d2p1:Phone>
<d2p1:Reference>sample string 9</d2p1:Reference>
<d2p1:ShipToCode>sample string 8</d2p1:ShipToCode>
<d2p1:StateCode>sample string 5</d2p1:StateCode>
<d2p1:ZipCode>sample string 6</d2p1:ZipCode>
</ShippingAddress>
<Warehouse>sample string 1</Warehouse>
</ApiOrderRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |
Item Type Definitions
Items - These are standalone products packaged in a single box.
- Examples include a dining chair, a complete nightstand, or even a dining set where all components are packaged together in one box.
- The contents may represent a single product or multiple pieces bundled as a complete set.
Kit Items - Products requiring multiple boxes for complete assembly or functionality.
- Examples include a dining table where the tabletop and legs are boxed separately.
- While the complete product is sold as one SKU, its components are shipped in multiple packages.
Supplement Items - Products that depend on a primary item to function, often enhancing or complementing another product.
- Examples: A dresser mirror (requires a dresser for use) or a trundle (designed to pair with a daybed).
- While sellable individually, they lack standalone utility without the corresponding main product.
Components - Single-box parts of a larger Kit Item, typically not sold or listed independently.
- Examples include the tabletop or legs of a Kit Item dining table.
- Unlike Supplement Items, Components are integral parts of a single product, not optional add-ons.
Combo Sets - Bundles of individually sellable Items curated for convenience or a cohesive design.
- Examples: A dining set combining a Kit Item table with four matching dining chairs (each chair being an Item).
- These sets simplify purchasing and ensure compatibility among the pieces.
Sellable Components - Functionally part of a larger Kit Item but capable of being sold or used on their own.
- Examples: A headboard from a multi-box bed or a standalone glass tabletop for a dining table.
- Unlike Components, Sellable Components retain functional value independently and are offered individually.