POST api/goods/GoodsFilterProps
Получение информации о фильтрах товарах и их значениях в зависимости от входных параметров
Request Information
URI Parameters
None.
Body Parameters
GoodsFilterPropsRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| IsMobile |
Признак, что запрос идёт из мобильного приложения |
boolean |
None. |
| CatalogPositionName |
Фильтр товары по наименованию папки номенклатуры |
string |
None. |
| CatalogPositionId |
Фильтр: товары по идентификатору папки номенклатуры |
integer |
None. |
| GoodList |
Фильтр: товары из списка товаров |
integer |
None. |
| FilterName |
Фильтр: часть наименования фильтра |
string |
None. |
| CategoryName |
Фильтр: наименование категории товара |
string |
None. |
| SeasonName |
Фильтр: cезон, к которому относится товар |
string |
None. |
| CollectionName |
Фильтр:коллекция, к которой относится товар |
string |
None. |
| NomenclatureType |
Фильтр: тип номенклатуры (товар, услуга, набор, сертификаты) |
string |
None. |
| NomenclatureSpecies |
Фильтр: вид номенклатуры (ручки, шапки, доски и т.д.) |
string |
None. |
| NomenclatureTypeId |
Фильтр: идентификатор типа номенклатуры (товар, услуга, набор, сертификаты) |
integer |
None. |
| NomenclatureSpeciesId |
Фильтр: идентификатор вида номенклатуры (ручки, шапки, доски и т.д.) |
integer |
None. |
| BrandName |
Фильтр: товара по бренду |
string |
None. |
| BrandId |
Фильтр: идентификатор бренда |
integer |
None. |
| GoodName |
Фильтр: наименование товара |
string |
None. |
| MainPage |
Фильтр: для товаров, которые отображаются на гл. экране |
boolean |
None. |
| Popular |
Фильтр: для товаров, которые помечены как популярные |
boolean |
None. |
| Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
| Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
| SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{
"IsMobile": true,
"CatalogPositionName": "sample string 1",
"CatalogPositionId": 1,
"GoodList": 1,
"FilterName": "sample string 2",
"CategoryName": "sample string 3",
"SeasonName": "sample string 4",
"CollectionName": "sample string 5",
"NomenclatureType": "sample string 6",
"NomenclatureSpecies": "sample string 7",
"NomenclatureTypeId": 1,
"NomenclatureSpeciesId": 1,
"BrandName": "sample string 8",
"BrandId": 1,
"GoodName": "sample string 9",
"MainPage": true,
"Popular": true,
"Operator": 1,
"Token": 1,
"SiteCode": "sample string 10"
}
application/xml, text/xml
<GoodsFilterPropsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.GoodsRequest"> <Operator xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Operator> <SiteCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 10</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <BrandId>1</BrandId> <BrandName>sample string 8</BrandName> <CatalogPositionId>1</CatalogPositionId> <CatalogPositionName>sample string 1</CatalogPositionName> <CategoryName>sample string 3</CategoryName> <CollectionName>sample string 5</CollectionName> <FilterName>sample string 2</FilterName> <GoodList>1</GoodList> <GoodName>sample string 9</GoodName> <IsMobile>true</IsMobile> <MainPage>true</MainPage> <NomenclatureSpecies>sample string 7</NomenclatureSpecies> <NomenclatureSpeciesId>1</NomenclatureSpeciesId> <NomenclatureType>sample string 6</NomenclatureType> <NomenclatureTypeId>1</NomenclatureTypeId> <Popular>true</Popular> <SeasonName>sample string 4</SeasonName> </GoodsFilterPropsRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
GoodsFilterPropsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Filters |
Массив фильтров |
Collection of GoodsFilterPropsFilter |
None. |
| ErrorCode |
Код ошибки |
integer |
None. |
| Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{
"Filters": [
{
"Id": 1,
"FilterId": 1,
"Name": "sample string 1",
"GoodFilterValues": [
{
"Id": 1,
"Name": "sample string 1",
"NameId": 1,
"FilterId": 1
},
{
"Id": 1,
"Name": "sample string 1",
"NameId": 1,
"FilterId": 1
}
]
},
{
"Id": 1,
"FilterId": 1,
"Name": "sample string 1",
"GoodFilterValues": [
{
"Id": 1,
"Name": "sample string 1",
"NameId": 1,
"FilterId": 1
},
{
"Id": 1,
"Name": "sample string 1",
"NameId": 1,
"FilterId": 1
}
]
}
],
"ErrorCode": 1,
"Message": "sample string 2"
}
application/xml, text/xml
<GoodsFilterPropsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.GoodsResponse">
<ErrorCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</ErrorCode>
<Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 2</Message>
<Filters>
<GoodsFilterPropsResponse.GoodsFilterPropsFilter>
<FilterId>1</FilterId>
<GoodFilterValues>
<GoodSystemDataFilterValueResponse>
<FilterId>1</FilterId>
<Id>1</Id>
<Name>sample string 1</Name>
<NameId>1</NameId>
</GoodSystemDataFilterValueResponse>
<GoodSystemDataFilterValueResponse>
<FilterId>1</FilterId>
<Id>1</Id>
<Name>sample string 1</Name>
<NameId>1</NameId>
</GoodSystemDataFilterValueResponse>
</GoodFilterValues>
<Id>1</Id>
<Name>sample string 1</Name>
</GoodsFilterPropsResponse.GoodsFilterPropsFilter>
<GoodsFilterPropsResponse.GoodsFilterPropsFilter>
<FilterId>1</FilterId>
<GoodFilterValues>
<GoodSystemDataFilterValueResponse>
<FilterId>1</FilterId>
<Id>1</Id>
<Name>sample string 1</Name>
<NameId>1</NameId>
</GoodSystemDataFilterValueResponse>
<GoodSystemDataFilterValueResponse>
<FilterId>1</FilterId>
<Id>1</Id>
<Name>sample string 1</Name>
<NameId>1</NameId>
</GoodSystemDataFilterValueResponse>
</GoodFilterValues>
<Id>1</Id>
<Name>sample string 1</Name>
</GoodsFilterPropsResponse.GoodsFilterPropsFilter>
</Filters>
</GoodsFilterPropsResponse>