POST middleware/catalog/filter

Request Information

URI Parameters

None.

Body Parameters

CatalogFilterRequest
NameDescriptionTypeAdditional information
category_id

string

None.

customer_region

string

None.

search_query

string

None.

lotno_query

string

None.

language

string

None.

page

integer

None.

per_page

integer

None.

brands

Collection of string

None.

min_price

integer

None.

max_price

integer

None.

colors

Collection of string

None.

countries

Collection of string

None.

region

Collection of string

None.

grape_varieties

Collection of string

None.

min_vintage_year

integer

None.

max_vintage_year

integer

None.

bottle_sizes

Collection of string

None.

wine_categories

Collection of string

None.

oaks

Collection of string

None.

overlays

Collection of string

None.

aromas

Collection of string

None.

concentrations

Collection of string

None.

min_sugar_scale

decimal number

None.

max_sugar_scale

decimal number

None.

min_cellar_year

integer

None.

max_cellar_year

integer

None.

cellar_countries

Collection of string

None.

Request Formats

application/json, text/json

Sample:
{
  "category_id": "sample string 1",
  "customer_region": "sample string 2",
  "search_query": "sample string 3",
  "lotno_query": "sample string 4",
  "language": "sample string 5",
  "page": 6,
  "per_page": 7,
  "brands": [
    "sample string 1",
    "sample string 2"
  ],
  "min_price": 8,
  "max_price": 9,
  "colors": [
    "sample string 1",
    "sample string 2"
  ],
  "countries": [
    "sample string 1",
    "sample string 2"
  ],
  "region": [
    "sample string 1",
    "sample string 2"
  ],
  "grape_varieties": [
    "sample string 1",
    "sample string 2"
  ],
  "min_vintage_year": 10,
  "max_vintage_year": 11,
  "bottle_sizes": [
    "sample string 1",
    "sample string 2"
  ],
  "wine_categories": [
    "sample string 1",
    "sample string 2"
  ],
  "oaks": [
    "sample string 1",
    "sample string 2"
  ],
  "overlays": [
    "sample string 1",
    "sample string 2"
  ],
  "aromas": [
    "sample string 1",
    "sample string 2"
  ],
  "concentrations": [
    "sample string 1",
    "sample string 2"
  ],
  "min_sugar_scale": 12.0,
  "max_sugar_scale": 13.0,
  "min_cellar_year": 14,
  "max_cellar_year": 15,
  "cellar_countries": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<CatalogFilterRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Opimian.Wimps.CMS.API.Models">
  <Aromas xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Aromas>
  <BottleSizes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </BottleSizes>
  <Brands xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Brands>
  <CategoryId>sample string 1</CategoryId>
  <CellarCountries xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CellarCountries>
  <Colors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Colors>
  <Concentrations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Concentrations>
  <Countries xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Countries>
  <CustomerRegion>sample string 2</CustomerRegion>
  <GrapeVarieties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </GrapeVarieties>
  <Language>sample string 5</Language>
  <LotNoQuery>sample string 4</LotNoQuery>
  <MaxCellarYear>15</MaxCellarYear>
  <MaxPrice>9</MaxPrice>
  <MaxSugarScale>13</MaxSugarScale>
  <MaxVintageYear>11</MaxVintageYear>
  <MinCellarYear>14</MinCellarYear>
  <MinPrice>8</MinPrice>
  <MinSugarScale>12</MinSugarScale>
  <MinVintageYear>10</MinVintageYear>
  <Oaks xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Oaks>
  <Overlays xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Overlays>
  <Page>6</Page>
  <PerPage>7</PerPage>
  <Regions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Regions>
  <SearchQuery>sample string 3</SearchQuery>
  <WineCategories xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WineCategories>
</CatalogFilterRequest>

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 'CatalogFilterRequest'.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.