GET api/Product/PropertiesForProduct?ProductID={ProductID}
Properties for product.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ProductID |
The product identifier. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of ProductProperty| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
ProductProperty System ID. |
integer |
None. |
| Name |
Product property name |
string |
None. |
| Type |
Product property type. Text, Select, Number, Check |
string |
None. |
| ExtraCost |
Product property extra cost, add to total cost of line. |
decimal number |
None. |
| ExtraCostPercentage |
Product property percentage extra cost, used to work out extra cost from base product price. |
decimal number |
None. |
| ExtraCostPerMetre |
If true, extra cost and extra cost percentage should be added per 1000 width. |
boolean |
None. |
| Options |
Product property options. Only when Type is Select |
Collection of Option |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"ID": 1,
"Name": "sample string 2",
"Type": "sample string 3",
"ExtraCost": 1.0,
"ExtraCostPercentage": 1.0,
"ExtraCostPerMetre": true,
"Options": [
{
"ID": 1,
"Value": "sample string 2"
},
{
"ID": 1,
"Value": "sample string 2"
}
]
},
{
"ID": 1,
"Name": "sample string 2",
"Type": "sample string 3",
"ExtraCost": 1.0,
"ExtraCostPercentage": 1.0,
"ExtraCostPerMetre": true,
"Options": [
{
"ID": 1,
"Value": "sample string 2"
},
{
"ID": 1,
"Value": "sample string 2"
}
]
}
]
application/xml, text/xml
Sample:
<ArrayOfProductProperty xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DecorDepot.API.Models">
<ProductProperty>
<ExtraCost>1</ExtraCost>
<ExtraCostPerMetre>true</ExtraCostPerMetre>
<ExtraCostPercentage>1</ExtraCostPercentage>
<ID>1</ID>
<Name>sample string 2</Name>
<Options>
<ProductPropertyOption>
<ID>1</ID>
<Value>sample string 2</Value>
</ProductPropertyOption>
<ProductPropertyOption>
<ID>1</ID>
<Value>sample string 2</Value>
</ProductPropertyOption>
</Options>
<Type>sample string 3</Type>
</ProductProperty>
<ProductProperty>
<ExtraCost>1</ExtraCost>
<ExtraCostPerMetre>true</ExtraCostPerMetre>
<ExtraCostPercentage>1</ExtraCostPercentage>
<ID>1</ID>
<Name>sample string 2</Name>
<Options>
<ProductPropertyOption>
<ID>1</ID>
<Value>sample string 2</Value>
</ProductPropertyOption>
<ProductPropertyOption>
<ID>1</ID>
<Value>sample string 2</Value>
</ProductPropertyOption>
</Options>
<Type>sample string 3</Type>
</ProductProperty>
</ArrayOfProductProperty>