POST api/article/style/parameter/match

Provides a list of articles, given list of style parameter key and values for matching.

Request Information

URI Parameters

None.

Body Parameters

Key/value list for style parameter matching. Key uses StyleParameters enum. Value uses string.

Collection of PublicAPI.Models.StyleMatchList
NameDescriptionTypeAdditional information
Key

Style parameter selector.

 PublicAPI.Models.StyleParameters

None.
Value

Style match value.

 string

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "Key": "StyleParameter1",
    "Value": "sample string 1"
  },
  {
    "Key": "StyleParameter1",
    "Value": "sample string 1"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfStyleMatchList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PublicAPI.Models">
  <StyleMatchList>
    <Key>StyleParameter1</Key>
    <Value>sample string 1</Value>
  </StyleMatchList>
  <StyleMatchList>
    <Key>StyleParameter1</Key>
    <Value>sample string 1</Value>
  </StyleMatchList>
</ArrayOfStyleMatchList>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

List of articles.

Collection of Article
NameDescriptionTypeAdditional information
GroupId

The Group that owns this Style

 integer

None.
StyleId

The perant id so to say, linking all variants of a certen style together

 integer

None.
SupplierId

the Id of the supplier providing this style

 integer

None.
ItemGroup

The ItemGroupId that this style operates in

 integer

None.
StyleParameter1

Contains Style information (Season, Brands etc.). See parameterconfig for more information.

 string

Max length: 30
StyleParameter2

Contains Style information (Season, Brands etc.). See parameterconfig for more information.

 string

Max length: 30
StyleParameter3

Contains Style information (Season, Brands etc.). See parameterconfig for more information.

 string

Max length: 30
StyleParameter4

Contains Style information (Season, Brands etc.). See parameterconfig for more information.

 string

Max length: 30
StyleParameter5

Contains Style information (Season, Brands etc.). See parameterconfig for more information.

 string

Max length: 30
VariantId

The Id of this specific variant, unque in the entire Group

 integer

None.
EAN

The EAN of the variant

 string

Max length: 13
VariantParameter1

Contains variant information(size, color etc.). See parameterconfig for more information.

 string

Max length: 30
VariantParameter2

Contains variant information(size, color etc.). See parameterconfig for more information.

 string

Max length: 30
VariantParameter3

Contains variant information(size, color etc.). See parameterconfig for more information.

 string

Max length: 30
VariantParameter4

Contains variant information(size, color etc.). See parameterconfig for more information.

 string

Max length: 30
VariantParameter5

Contains variant information(size, color etc.). See parameterconfig for more information.

 string

Max length: 30
DisplayOrderVariantParameter1

Value defining how VariantParameter1 is ordered compared to the rest of the VariantParameters

 integer

None.
DisplayOrderVariantParameter2

Value defining how VariantParameter2 is ordered compared to the rest of the VariantParameters

 integer

None.
DisplayOrderVariantParameter3

Value defining how VariantParameter3 is ordered compared to the rest of the VariantParameters

 integer

None.
DisplayOrderVariantParameter4

Value defining how VariantParameter4 is ordered compared to the rest of the VariantParameters

 integer

None.
DisplayOrderVariantParameter5

Value defining how VariantParameter is ordered compared to the rest of the VariantParameters

 integer

None.
SalesPrice

The sales price.

 decimal number

None.
CostPrice

The cost price.

 decimal number

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "GroupId": 1,
    "StyleId": 2,
    "SupplierId": 3,
    "ItemGroup": 4,
    "StyleParameter1": "sample string 5",
    "StyleParameter2": "sample string 6",
    "StyleParameter3": "sample string 7",
    "StyleParameter4": "sample string 8",
    "StyleParameter5": "sample string 9",
    "VariantId": 10,
    "EAN": "sample string 11",
    "VariantParameter1": "sample string 12",
    "VariantParameter2": "sample string 13",
    "VariantParameter3": "sample string 14",
    "VariantParameter4": "sample string 15",
    "VariantParameter5": "sample string 16",
    "DisplayOrderVariantParameter1": 17,
    "DisplayOrderVariantParameter2": 18,
    "DisplayOrderVariantParameter3": 19,
    "DisplayOrderVariantParameter4": 20,
    "DisplayOrderVariantParameter5": 21,
    "SalesPrice": 22.0,
    "CostPrice": 23.0
  },
  {
    "GroupId": 1,
    "StyleId": 2,
    "SupplierId": 3,
    "ItemGroup": 4,
    "StyleParameter1": "sample string 5",
    "StyleParameter2": "sample string 6",
    "StyleParameter3": "sample string 7",
    "StyleParameter4": "sample string 8",
    "StyleParameter5": "sample string 9",
    "VariantId": 10,
    "EAN": "sample string 11",
    "VariantParameter1": "sample string 12",
    "VariantParameter2": "sample string 13",
    "VariantParameter3": "sample string 14",
    "VariantParameter4": "sample string 15",
    "VariantParameter5": "sample string 16",
    "DisplayOrderVariantParameter1": 17,
    "DisplayOrderVariantParameter2": 18,
    "DisplayOrderVariantParameter3": 19,
    "DisplayOrderVariantParameter4": 20,
    "DisplayOrderVariantParameter5": 21,
    "SalesPrice": 22.0,
    "CostPrice": 23.0
  }
]

application/xml, text/xml

Sample: 
<ArrayOfArticleViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PublicAPI.Models">
  <ArticleViewModel>
    <CostPrice>23</CostPrice>
    <DisplayOrderVariantParameter1>17</DisplayOrderVariantParameter1>
    <DisplayOrderVariantParameter2>18</DisplayOrderVariantParameter2>
    <DisplayOrderVariantParameter3>19</DisplayOrderVariantParameter3>
    <DisplayOrderVariantParameter4>20</DisplayOrderVariantParameter4>
    <DisplayOrderVariantParameter5>21</DisplayOrderVariantParameter5>
    <EAN>sample string 11</EAN>
    <GroupId>1</GroupId>
    <ItemGroup>4</ItemGroup>
    <SalesPrice>22</SalesPrice>
    <StyleId>2</StyleId>
    <StyleParameter1>sample string 5</StyleParameter1>
    <StyleParameter2>sample string 6</StyleParameter2>
    <StyleParameter3>sample string 7</StyleParameter3>
    <StyleParameter4>sample string 8</StyleParameter4>
    <StyleParameter5>sample string 9</StyleParameter5>
    <SupplierId>3</SupplierId>
    <VariantId>10</VariantId>
    <VariantParameter1>sample string 12</VariantParameter1>
    <VariantParameter2>sample string 13</VariantParameter2>
    <VariantParameter3>sample string 14</VariantParameter3>
    <VariantParameter4>sample string 15</VariantParameter4>
    <VariantParameter5>sample string 16</VariantParameter5>
  </ArticleViewModel>
  <ArticleViewModel>
    <CostPrice>23</CostPrice>
    <DisplayOrderVariantParameter1>17</DisplayOrderVariantParameter1>
    <DisplayOrderVariantParameter2>18</DisplayOrderVariantParameter2>
    <DisplayOrderVariantParameter3>19</DisplayOrderVariantParameter3>
    <DisplayOrderVariantParameter4>20</DisplayOrderVariantParameter4>
    <DisplayOrderVariantParameter5>21</DisplayOrderVariantParameter5>
    <EAN>sample string 11</EAN>
    <GroupId>1</GroupId>
    <ItemGroup>4</ItemGroup>
    <SalesPrice>22</SalesPrice>
    <StyleId>2</StyleId>
    <StyleParameter1>sample string 5</StyleParameter1>
    <StyleParameter2>sample string 6</StyleParameter2>
    <StyleParameter3>sample string 7</StyleParameter3>
    <StyleParameter4>sample string 8</StyleParameter4>
    <StyleParameter5>sample string 9</StyleParameter5>
    <SupplierId>3</SupplierId>
    <VariantId>10</VariantId>
    <VariantParameter1>sample string 12</VariantParameter1>
    <VariantParameter2>sample string 13</VariantParameter2>
    <VariantParameter3>sample string 14</VariantParameter3>
    <VariantParameter4>sample string 15</VariantParameter4>
    <VariantParameter5>sample string 16</VariantParameter5>
  </ArticleViewModel>
</ArrayOfArticleViewModel>