POST api/goods/CatalogEntitySearch
Поиск товаров/брендов/папок каталога по части заданного наименования
Request Information
URI Parameters
None.
Body Parameters
CatalogEntitySearchRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| CatalogId |
Идентификатор каталога, по сущностям которого идёт запрос |
integer |
None. |
| Name |
Наименование сущности для поиска |
string |
None. |
| Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
| Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
| SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"CatalogId": 1,
"Name": "sample string 1",
"Operator": 1,
"Token": 1,
"SiteCode": "sample string 2"
}
application/xml, text/xml
Sample:
<CatalogEntitySearchRequest 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 2</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <CatalogId>1</CatalogId> <Name>sample string 1</Name> </CatalogEntitySearchRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CatalogEntitySearchResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Goods |
Массив товаров |
Collection of CatalogEntitySearchGoodRow |
None. |
| Positions |
Массив позиций |
Collection of CatalogEntitySearchPositionRow |
None. |
| Brands |
Массив брендов |
Collection of CatalogEntitySearchBrandRow |
None. |
| ErrorCode |
Код ошибки |
integer |
None. |
| Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Goods": [
{
"Id": 1,
"GoodId": 1,
"Name": "sample string 1",
"LongName": "sample string 2"
},
{
"Id": 1,
"GoodId": 1,
"Name": "sample string 1",
"LongName": "sample string 2"
}
],
"Positions": [
{
"Id": 1,
"PositionId": 1,
"Name": "sample string 1",
"Logo": "sample string 2",
"IconLogo": "sample string 3",
"PreviewLogo": "sample string 4"
},
{
"Id": 1,
"PositionId": 1,
"Name": "sample string 1",
"Logo": "sample string 2",
"IconLogo": "sample string 3",
"PreviewLogo": "sample string 4"
}
],
"Brands": [
{
"Id": 1,
"BrandId": 1,
"Name": "sample string 1",
"Logo": "sample string 2",
"IconLogo": "sample string 3",
"PreviewLogo": "sample string 4"
},
{
"Id": 1,
"BrandId": 1,
"Name": "sample string 1",
"Logo": "sample string 2",
"IconLogo": "sample string 3",
"PreviewLogo": "sample string 4"
}
],
"ErrorCode": 1,
"Message": "sample string 2"
}
application/xml, text/xml
Sample:
<CatalogEntitySearchResponse 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>
<Brands>
<CatalogEntitySearchResponse.CatalogEntitySearchBrandRow>
<BrandId>1</BrandId>
<IconLogo>sample string 3</IconLogo>
<Id>1</Id>
<Logo>sample string 2</Logo>
<Name>sample string 1</Name>
<PreviewLogo>sample string 4</PreviewLogo>
</CatalogEntitySearchResponse.CatalogEntitySearchBrandRow>
<CatalogEntitySearchResponse.CatalogEntitySearchBrandRow>
<BrandId>1</BrandId>
<IconLogo>sample string 3</IconLogo>
<Id>1</Id>
<Logo>sample string 2</Logo>
<Name>sample string 1</Name>
<PreviewLogo>sample string 4</PreviewLogo>
</CatalogEntitySearchResponse.CatalogEntitySearchBrandRow>
</Brands>
<Goods>
<CatalogEntitySearchResponse.CatalogEntitySearchGoodRow>
<GoodId>1</GoodId>
<Id>1</Id>
<LongName>sample string 2</LongName>
<Name>sample string 1</Name>
</CatalogEntitySearchResponse.CatalogEntitySearchGoodRow>
<CatalogEntitySearchResponse.CatalogEntitySearchGoodRow>
<GoodId>1</GoodId>
<Id>1</Id>
<LongName>sample string 2</LongName>
<Name>sample string 1</Name>
</CatalogEntitySearchResponse.CatalogEntitySearchGoodRow>
</Goods>
<Positions>
<CatalogEntitySearchResponse.CatalogEntitySearchPositionRow>
<IconLogo>sample string 3</IconLogo>
<Id>1</Id>
<Logo>sample string 2</Logo>
<Name>sample string 1</Name>
<PositionId>1</PositionId>
<PreviewLogo>sample string 4</PreviewLogo>
</CatalogEntitySearchResponse.CatalogEntitySearchPositionRow>
<CatalogEntitySearchResponse.CatalogEntitySearchPositionRow>
<IconLogo>sample string 3</IconLogo>
<Id>1</Id>
<Logo>sample string 2</Logo>
<Name>sample string 1</Name>
<PositionId>1</PositionId>
<PreviewLogo>sample string 4</PreviewLogo>
</CatalogEntitySearchResponse.CatalogEntitySearchPositionRow>
</Positions>
</CatalogEntitySearchResponse>