POST api/goods/GoodsPagingInfo
Получение информации о товарах в зависимости от заданных фильтров
Request Information
URI Parameters
None.
Body Parameters
GoodsPagingInfoRequestName | Description | Type | Additional information |
---|---|---|---|
CatalogId |
Идентификатор каталога, по которому идёт запрос |
integer |
None. |
Client |
Идентификатор клиента, который запрашивает информацию о товарах |
integer |
None. |
Favorite |
Признак, что запрашиваются товары с пометкой для механики "любимые товары" |
boolean |
None. |
FavoriteClient |
Признак, что запрашиваются товары, которые помечены как "любимые товары" у клиента |
boolean |
None. |
SelectedClient |
Признак, что запрашиваются товары, которые отложены/выбраны как "избранное" |
boolean |
None. |
MainPage |
Признак, что запрашиваюттся товары для главной страницы/экрана |
boolean |
None. |
Recommended |
Признак, что запрашиваются рекомендованные товары ( вместе с client) |
boolean |
None. |
New |
Признак, что запрашиваются товары-новинки |
boolean |
None. |
Popular |
Признак, что запрашиваются популярные товарый |
boolean |
None. |
IsMobile |
Признак, что запрос идёт из мобильного приложения |
boolean |
None. |
IsCrm |
Признак, что запрос идёт из ЛК (crm.loycon.ru) |
boolean |
None. |
CatalogPositionName |
Фильтр: товары по наименованию папки номенклатуры |
string |
None. |
CatalogPositionId |
Фильтр: товары по идентификатору папки номенклатуры |
integer |
None. |
BrandName |
Фильтр: товара по бренду |
string |
None. |
BrandId |
Фильтр: товары по идентификатору бренда |
integer |
None. |
MinSum |
Фильтр: минимальная стоимость товаров |
decimal number |
None. |
MaxSum |
Фильтр: максимальная стоимость товаров |
decimal number |
None. |
Start |
Фильтр: с какой позиции вернуть товары |
integer |
None. |
Length |
Фильтр: какое количество товаров вернуть |
integer |
None. |
Guid |
Гуид товара, который необходимо найти |
string |
None. |
QrCode |
Признак, что запрашивается информация о товаре с qr-кода |
boolean |
None. |
GoodName |
Фильтр: часть наименования товара для поиска |
string |
None. |
GoodId |
Идентификатор товара |
integer |
None. |
PropsData |
Массив свойств |
Collection of GoodsPagingInfoPropsData |
None. |
TagsData |
Массив тегов |
Collection of GoodsPagingInfoTagsData |
None. |
FilterData |
Массив фильтров |
Collection of GoodsPagingInfoFilterData |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{ "CatalogId": 1, "Client": 1, "Favorite": true, "FavoriteClient": true, "SelectedClient": true, "MainPage": true, "Recommended": true, "New": true, "Popular": true, "IsMobile": true, "IsCrm": true, "CatalogPositionName": "sample string 1", "CatalogPositionId": 1, "BrandName": "sample string 2", "BrandId": 1, "MinSum": 1.0, "MaxSum": 1.0, "Start": 1, "Length": 1, "Guid": "sample string 3", "QrCode": true, "GoodName": "sample string 4", "GoodId": 1, "PropsData": [ { "Id": 1, "Type": "sample string 1", "Code": "sample string 2", "Name": "sample string 3", "Value": "sample string 4" }, { "Id": 1, "Type": "sample string 1", "Code": "sample string 2", "Name": "sample string 3", "Value": "sample string 4" } ], "TagsData": [ { "Id": 1, "GoodTagsId": 1, "Name": "sample string 1" }, { "Id": 1, "GoodTagsId": 1, "Name": "sample string 1" } ], "FilterData": [ { "Id": 1, "FilterId": 1, "Name": "sample string 1", "NameId": 1 }, { "Id": 1, "FilterId": 1, "Name": "sample string 1", "NameId": 1 } ], "Operator": 1, "Token": 1, "SiteCode": "sample string 5" }
application/xml, text/xml
<GoodsPagingInfoRequest 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 5</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <BrandId>1</BrandId> <BrandName>sample string 2</BrandName> <CatalogId>1</CatalogId> <CatalogPositionId>1</CatalogPositionId> <CatalogPositionName>sample string 1</CatalogPositionName> <Client>1</Client> <Favorite>true</Favorite> <FavoriteClient>true</FavoriteClient> <FilterData> <GoodsPagingInfoRequest.GoodsPagingInfoFilterData> <FilterId>1</FilterId> <Id>1</Id> <Name>sample string 1</Name> <NameId>1</NameId> </GoodsPagingInfoRequest.GoodsPagingInfoFilterData> <GoodsPagingInfoRequest.GoodsPagingInfoFilterData> <FilterId>1</FilterId> <Id>1</Id> <Name>sample string 1</Name> <NameId>1</NameId> </GoodsPagingInfoRequest.GoodsPagingInfoFilterData> </FilterData> <GoodId>1</GoodId> <GoodName>sample string 4</GoodName> <Guid>sample string 3</Guid> <IsCrm>true</IsCrm> <IsMobile>true</IsMobile> <Length>1</Length> <MainPage>true</MainPage> <MaxSum>1</MaxSum> <MinSum>1</MinSum> <New>true</New> <Popular>true</Popular> <PropsData> <GoodsPagingInfoRequest.GoodsPagingInfoPropsData> <Code>sample string 2</Code> <Id>1</Id> <Name>sample string 3</Name> <Type>sample string 1</Type> <Value>sample string 4</Value> </GoodsPagingInfoRequest.GoodsPagingInfoPropsData> <GoodsPagingInfoRequest.GoodsPagingInfoPropsData> <Code>sample string 2</Code> <Id>1</Id> <Name>sample string 3</Name> <Type>sample string 1</Type> <Value>sample string 4</Value> </GoodsPagingInfoRequest.GoodsPagingInfoPropsData> </PropsData> <QrCode>true</QrCode> <Recommended>true</Recommended> <SelectedClient>true</SelectedClient> <Start>1</Start> <TagsData> <GoodsPagingInfoRequest.GoodsPagingInfoTagsData> <GoodTagsId>1</GoodTagsId> <Id>1</Id> <Name>sample string 1</Name> </GoodsPagingInfoRequest.GoodsPagingInfoTagsData> <GoodsPagingInfoRequest.GoodsPagingInfoTagsData> <GoodTagsId>1</GoodTagsId> <Id>1</Id> <Name>sample string 1</Name> </GoodsPagingInfoRequest.GoodsPagingInfoTagsData> </TagsData> </GoodsPagingInfoRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
GoodsPagingInfoResponseName | Description | Type | Additional information |
---|---|---|---|
TotalRows |
Общее количество товаров, которые можно вернуть после применения всех фильтров |
integer |
None. |
MinSumCatalog |
Минимальная цена товара в итоговой выборке |
decimal number |
None. |
MaxSumCatalog |
Максимальная цена товара в итоговой выборке |
decimal number |
None. |
Goods |
Массив товаров |
Collection of GoodsPagingInfoGood |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "TotalRows": 1, "MinSumCatalog": 1.0, "MaxSumCatalog": 1.0, "Goods": [ { "Id": 1, "GoodId": 1, "Guid": "sample string 1", "ShortName": "sample string 2", "LongName": "sample string 3", "Price": 1.0, "OldPrice": 1.0, "Remain": 1, "StorageName": "sample string 4", "ItemArticle": "sample string 5", "ItemCode": "sample string 6", "BrandName": "sample string 7", "BrandLogo": "sample string 8", "Description": "sample string 9", "InBasket": true, "Favorite": true, "FavoriteClient": true, "SelectedClient": true, "NoShownMobile": true, "GoodProps": [ { "Id": 1, "Type": "sample string 1", "Code": "sample string 2", "Name": "sample string 3", "Value": "sample string 4", "PropsId": 1 }, { "Id": 1, "Type": "sample string 1", "Code": "sample string 2", "Name": "sample string 3", "Value": "sample string 4", "PropsId": 1 } ], "GoodTags": [ { "Id": 1, "Name": "sample string 1", "Code": "sample string 2", "Color": "sample string 3", "GoodTagsId": 1 }, { "Id": 1, "Name": "sample string 1", "Code": "sample string 2", "Color": "sample string 3", "GoodTagsId": 1 } ], "GoodImages": [ { "Id": 1, "Name": "sample string 1", "Url": "sample string 2", "Main": true }, { "Id": 1, "Name": "sample string 1", "Url": "sample string 2", "Main": true } ] }, { "Id": 1, "GoodId": 1, "Guid": "sample string 1", "ShortName": "sample string 2", "LongName": "sample string 3", "Price": 1.0, "OldPrice": 1.0, "Remain": 1, "StorageName": "sample string 4", "ItemArticle": "sample string 5", "ItemCode": "sample string 6", "BrandName": "sample string 7", "BrandLogo": "sample string 8", "Description": "sample string 9", "InBasket": true, "Favorite": true, "FavoriteClient": true, "SelectedClient": true, "NoShownMobile": true, "GoodProps": [ { "Id": 1, "Type": "sample string 1", "Code": "sample string 2", "Name": "sample string 3", "Value": "sample string 4", "PropsId": 1 }, { "Id": 1, "Type": "sample string 1", "Code": "sample string 2", "Name": "sample string 3", "Value": "sample string 4", "PropsId": 1 } ], "GoodTags": [ { "Id": 1, "Name": "sample string 1", "Code": "sample string 2", "Color": "sample string 3", "GoodTagsId": 1 }, { "Id": 1, "Name": "sample string 1", "Code": "sample string 2", "Color": "sample string 3", "GoodTagsId": 1 } ], "GoodImages": [ { "Id": 1, "Name": "sample string 1", "Url": "sample string 2", "Main": true }, { "Id": 1, "Name": "sample string 1", "Url": "sample string 2", "Main": true } ] } ], "ErrorCode": 1, "Message": "sample string 2" }
application/xml, text/xml
<GoodsPagingInfoResponse 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> <Goods> <GoodsPagingInfoResponse.GoodsPagingInfoGood> <BrandLogo>sample string 8</BrandLogo> <BrandName>sample string 7</BrandName> <Description>sample string 9</Description> <Favorite>true</Favorite> <FavoriteClient>true</FavoriteClient> <GoodId>1</GoodId> <GoodImages> <GoodSystemDataImageResponse> <Id>1</Id> <Main>true</Main> <Name>sample string 1</Name> <Url>sample string 2</Url> </GoodSystemDataImageResponse> <GoodSystemDataImageResponse> <Id>1</Id> <Main>true</Main> <Name>sample string 1</Name> <Url>sample string 2</Url> </GoodSystemDataImageResponse> </GoodImages> <GoodProps> <GoodSystemDataPropResponse> <Code>sample string 2</Code> <Id>1</Id> <Name>sample string 3</Name> <PropsId>1</PropsId> <Type>sample string 1</Type> <Value>sample string 4</Value> </GoodSystemDataPropResponse> <GoodSystemDataPropResponse> <Code>sample string 2</Code> <Id>1</Id> <Name>sample string 3</Name> <PropsId>1</PropsId> <Type>sample string 1</Type> <Value>sample string 4</Value> </GoodSystemDataPropResponse> </GoodProps> <GoodTags> <GoodSystemDataTagResponse> <Code>sample string 2</Code> <Color>sample string 3</Color> <GoodTagsId>1</GoodTagsId> <Id>1</Id> <Name>sample string 1</Name> </GoodSystemDataTagResponse> <GoodSystemDataTagResponse> <Code>sample string 2</Code> <Color>sample string 3</Color> <GoodTagsId>1</GoodTagsId> <Id>1</Id> <Name>sample string 1</Name> </GoodSystemDataTagResponse> </GoodTags> <Guid>sample string 1</Guid> <Id>1</Id> <InBasket>true</InBasket> <ItemArticle>sample string 5</ItemArticle> <ItemCode>sample string 6</ItemCode> <LongName>sample string 3</LongName> <NoShownMobile>true</NoShownMobile> <OldPrice>1</OldPrice> <Price>1</Price> <Remain>1</Remain> <SelectedClient>true</SelectedClient> <ShortName>sample string 2</ShortName> <StorageName>sample string 4</StorageName> </GoodsPagingInfoResponse.GoodsPagingInfoGood> <GoodsPagingInfoResponse.GoodsPagingInfoGood> <BrandLogo>sample string 8</BrandLogo> <BrandName>sample string 7</BrandName> <Description>sample string 9</Description> <Favorite>true</Favorite> <FavoriteClient>true</FavoriteClient> <GoodId>1</GoodId> <GoodImages> <GoodSystemDataImageResponse> <Id>1</Id> <Main>true</Main> <Name>sample string 1</Name> <Url>sample string 2</Url> </GoodSystemDataImageResponse> <GoodSystemDataImageResponse> <Id>1</Id> <Main>true</Main> <Name>sample string 1</Name> <Url>sample string 2</Url> </GoodSystemDataImageResponse> </GoodImages> <GoodProps> <GoodSystemDataPropResponse> <Code>sample string 2</Code> <Id>1</Id> <Name>sample string 3</Name> <PropsId>1</PropsId> <Type>sample string 1</Type> <Value>sample string 4</Value> </GoodSystemDataPropResponse> <GoodSystemDataPropResponse> <Code>sample string 2</Code> <Id>1</Id> <Name>sample string 3</Name> <PropsId>1</PropsId> <Type>sample string 1</Type> <Value>sample string 4</Value> </GoodSystemDataPropResponse> </GoodProps> <GoodTags> <GoodSystemDataTagResponse> <Code>sample string 2</Code> <Color>sample string 3</Color> <GoodTagsId>1</GoodTagsId> <Id>1</Id> <Name>sample string 1</Name> </GoodSystemDataTagResponse> <GoodSystemDataTagResponse> <Code>sample string 2</Code> <Color>sample string 3</Color> <GoodTagsId>1</GoodTagsId> <Id>1</Id> <Name>sample string 1</Name> </GoodSystemDataTagResponse> </GoodTags> <Guid>sample string 1</Guid> <Id>1</Id> <InBasket>true</InBasket> <ItemArticle>sample string 5</ItemArticle> <ItemCode>sample string 6</ItemCode> <LongName>sample string 3</LongName> <NoShownMobile>true</NoShownMobile> <OldPrice>1</OldPrice> <Price>1</Price> <Remain>1</Remain> <SelectedClient>true</SelectedClient> <ShortName>sample string 2</ShortName> <StorageName>sample string 4</StorageName> </GoodsPagingInfoResponse.GoodsPagingInfoGood> </Goods> <MaxSumCatalog>1</MaxSumCatalog> <MinSumCatalog>1</MinSumCatalog> <TotalRows>1</TotalRows> </GoodsPagingInfoResponse>