POST api/order/Order/{orderID}/OrderDetail/Kit
Creates a new order detail record for the Parent SKU and creates the Child items records in the order detail for the Child items list. The Group Owner Detail ID of the Child SKU would have the order detailID of the Parent Item.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| orderID |
The identifier of order to create the new product line. |
integer |
Required |
Body Parameters
OrderDetailKitViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ParentItem | OrderDetailRegularViewModel |
None. |
|
| ChildItems |
Child items associated to the order. |
Collection of OrderDetailRegularViewModel |
None. |
Request Formats
application/xml, text/xml
Sample:
<OrderDetailKitViewModel>
<ParentItem>
<OrderDetailID>1</OrderDetailID>
<ProductID>sample string 2</ProductID>
<Description>sample string 3</Description>
<Quantity>4</Quantity>
<PriceTaxFields>
<Price>1</Price>
<TaxableAmount>2</TaxableAmount>
<Tax>1</Tax>
</PriceTaxFields>
<VolumeFields>
<Volume>1</Volume>
<Volume2>2</Volume2>
<Volume3>3</Volume3>
<Volume4>4</Volume4>
</VolumeFields>
<OtherPriceFields>
<OtherPrice>1</OtherPrice>
<OtherPrice2>2</OtherPrice2>
<OtherPrice3>3</OtherPrice3>
<OtherPrice4>4</OtherPrice4>
</OtherPriceFields>
<Misc>
<OrderDetailMiscFieldsViewModel>
<OrderDetailID>1</OrderDetailID>
<MiscFields>
<KeyValuePairOfStringObject>
<Key>sample string 1</Key>
<Value />
</KeyValuePairOfStringObject>
<KeyValuePairOfStringObject>
<Key>sample string 3</Key>
<Value />
</KeyValuePairOfStringObject>
</MiscFields>
</OrderDetailMiscFieldsViewModel>
<OrderDetailMiscFieldsViewModel>
<OrderDetailID>1</OrderDetailID>
<MiscFields>
<KeyValuePairOfStringObject>
<Key>sample string 1</Key>
<Value />
</KeyValuePairOfStringObject>
<KeyValuePairOfStringObject>
<Key>sample string 3</Key>
<Value />
</KeyValuePairOfStringObject>
</MiscFields>
</OrderDetailMiscFieldsViewModel>
</Misc>
<ShouldCalculateTax>True</ShouldCalculateTax>
<Timer>6</Timer>
</ParentItem>
<ChildItems>
<OrderDetailRegularViewModel>
<OrderDetailID>1</OrderDetailID>
<ProductID>sample string 2</ProductID>
<Description>sample string 3</Description>
<Quantity>4</Quantity>
<PriceTaxFields>
<Price>1</Price>
<TaxableAmount>2</TaxableAmount>
<Tax>1</Tax>
</PriceTaxFields>
<VolumeFields>
<Volume>1</Volume>
<Volume2>2</Volume2>
<Volume3>3</Volume3>
<Volume4>4</Volume4>
</VolumeFields>
<OtherPriceFields>
<OtherPrice>1</OtherPrice>
<OtherPrice2>2</OtherPrice2>
<OtherPrice3>3</OtherPrice3>
<OtherPrice4>4</OtherPrice4>
</OtherPriceFields>
<Misc>
<OrderDetailMiscFieldsViewModel>
<OrderDetailID>1</OrderDetailID>
<MiscFields>
<KeyValuePairOfStringObject>
<Key>sample string 1</Key>
<Value />
</KeyValuePairOfStringObject>
<KeyValuePairOfStringObject>
<Key>sample string 3</Key>
<Value />
</KeyValuePairOfStringObject>
</MiscFields>
</OrderDetailMiscFieldsViewModel>
<OrderDetailMiscFieldsViewModel>
<OrderDetailID>1</OrderDetailID>
<MiscFields>
<KeyValuePairOfStringObject>
<Key>sample string 1</Key>
<Value />
</KeyValuePairOfStringObject>
<KeyValuePairOfStringObject>
<Key>sample string 3</Key>
<Value />
</KeyValuePairOfStringObject>
</MiscFields>
</OrderDetailMiscFieldsViewModel>
</Misc>
<ShouldCalculateTax>True</ShouldCalculateTax>
<Timer>6</Timer>
</OrderDetailRegularViewModel>
<OrderDetailRegularViewModel>
<OrderDetailID>1</OrderDetailID>
<ProductID>sample string 2</ProductID>
<Description>sample string 3</Description>
<Quantity>4</Quantity>
<PriceTaxFields>
<Price>1</Price>
<TaxableAmount>2</TaxableAmount>
<Tax>1</Tax>
</PriceTaxFields>
<VolumeFields>
<Volume>1</Volume>
<Volume2>2</Volume2>
<Volume3>3</Volume3>
<Volume4>4</Volume4>
</VolumeFields>
<OtherPriceFields>
<OtherPrice>1</OtherPrice>
<OtherPrice2>2</OtherPrice2>
<OtherPrice3>3</OtherPrice3>
<OtherPrice4>4</OtherPrice4>
</OtherPriceFields>
<Misc>
<OrderDetailMiscFieldsViewModel>
<OrderDetailID>1</OrderDetailID>
<MiscFields>
<KeyValuePairOfStringObject>
<Key>sample string 1</Key>
<Value />
</KeyValuePairOfStringObject>
<KeyValuePairOfStringObject>
<Key>sample string 3</Key>
<Value />
</KeyValuePairOfStringObject>
</MiscFields>
</OrderDetailMiscFieldsViewModel>
<OrderDetailMiscFieldsViewModel>
<OrderDetailID>1</OrderDetailID>
<MiscFields>
<KeyValuePairOfStringObject>
<Key>sample string 1</Key>
<Value />
</KeyValuePairOfStringObject>
<KeyValuePairOfStringObject>
<Key>sample string 3</Key>
<Value />
</KeyValuePairOfStringObject>
</MiscFields>
</OrderDetailMiscFieldsViewModel>
</Misc>
<ShouldCalculateTax>True</ShouldCalculateTax>
<Timer>6</Timer>
</OrderDetailRegularViewModel>
</ChildItems>
</OrderDetailKitViewModel>
application/json, text/json
Sample:
{
"ParentItem": {
"OrderDetailID": 1,
"ProductID": "sample string 2",
"Description": "sample string 3",
"Quantity": 4,
"PriceTaxFields": {
"Price": 1.0,
"TaxableAmount": 2.0,
"Tax": 1.0
},
"VolumeFields": {
"Volume": 1.0,
"Volume2": 2.0,
"Volume3": 3.0,
"Volume4": 4.0
},
"OtherPriceFields": {
"OtherPrice": 1.0,
"OtherPrice2": 2.0,
"OtherPrice3": 3.0,
"OtherPrice4": 4.0
},
"Misc": [
{
"OrderDetailID": 1,
"MiscFields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"OrderDetailID": 1,
"MiscFields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Timer": 6
},
"ChildItems": [
{
"OrderDetailID": 1,
"ProductID": "sample string 2",
"Description": "sample string 3",
"Quantity": 4,
"PriceTaxFields": {
"Price": 1.0,
"TaxableAmount": 2.0,
"Tax": 1.0
},
"VolumeFields": {
"Volume": 1.0,
"Volume2": 2.0,
"Volume3": 3.0,
"Volume4": 4.0
},
"OtherPriceFields": {
"OtherPrice": 1.0,
"OtherPrice2": 2.0,
"OtherPrice3": 3.0,
"OtherPrice4": 4.0
},
"Misc": [
{
"OrderDetailID": 1,
"MiscFields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"OrderDetailID": 1,
"MiscFields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Timer": 6
},
{
"OrderDetailID": 1,
"ProductID": "sample string 2",
"Description": "sample string 3",
"Quantity": 4,
"PriceTaxFields": {
"Price": 1.0,
"TaxableAmount": 2.0,
"Tax": 1.0
},
"VolumeFields": {
"Volume": 1.0,
"Volume2": 2.0,
"Volume3": 3.0,
"Volume4": 4.0
},
"OtherPriceFields": {
"OtherPrice": 1.0,
"OtherPrice2": 2.0,
"OtherPrice3": 3.0,
"OtherPrice4": 4.0
},
"Misc": [
{
"OrderDetailID": 1,
"MiscFields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"OrderDetailID": 1,
"MiscFields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Timer": 6
}
]
}
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
ApiResultOfOrderDetailViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | OrderDetailViewModel |
None. |
|
| IsSuccessful | boolean |
None. |
|
| MessageTranslationKey | string |
None. |
|
| Message | string |
None. |
|
| Messages | Collection of ApiResultMessage |
None. |
Response Formats
application/xml, text/xml, application/json, text/json
Sample:
Sample not available.