POST api/goods/CatalogDataActionPagingInfo
Получение информации о сущностях таблицах товарного каталога, с входными фильтрами, с пагинацией
Request Information
URI Parameters
None.
Body Parameters
CatalogDataActionPagingInfoRequestName | Description | Type | Additional information |
---|---|---|---|
CatalogId |
Идентификатор каталога, по сущностям которого идёт запрос |
integer |
None. |
Report |
Признак, что идёт запрос для скачивания отчёта |
boolean |
None. |
TypeInfo |
Сущность, по которой идёт запрос (Brands, Catalogpositions, Storages, Props, GoodsPriceRemain) |
string |
None. |
BrandId |
Идентификатор сущности для действия: бренд |
integer |
None. |
StoragesId |
Идентификатор сущности для действия: склад |
integer |
None. |
StoragesPos |
Фильтр: идентификатор точки продаж, которой принадлежит склад |
integer |
None. |
StoragesName |
Фильтр: наименование склада |
string |
None. |
PropsId |
Идентификатор сущности для действия: свойство |
integer |
None. |
PriceRemainId |
Идентификатор сущности для действия: запись остатка и цены |
integer |
None. |
CatalogPositionId |
Идентификатор сущности для действия: папка каталога |
integer |
None. |
ShownMobile |
Фильтр: отображающие запись в моб. приложении |
boolean |
None. |
NoShownMobile |
Фильтр: не отображать запись в моб. приложении |
boolean |
None. |
NoActive |
Фильтр: деактивированные записи |
boolean |
None. |
Active |
Фильтр: активированные записи |
boolean |
None. |
GoodId |
Фильтр: идентификатор товара |
integer |
None. |
LevelShown |
Порядковый номер сущности в списке для отображения пользователю (слева направо) |
byte |
None. |
MainPageMobile |
Признак отображения сущности на гл. экране моб. приложения |
boolean |
None. |
Code |
Фильтр для свойства: код сущности (например, size или color) |
string |
None. |
Type |
Фильтр для свойства: тип сущности |
string |
None. |
Start |
Пагинация: номер записи, от которой показывать записи, включая указанную |
integer |
None. |
Length |
Пагинация: позиция от которой показывать записи, включая указанную |
integer |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{ "CatalogId": 1, "Report": true, "TypeInfo": "sample string 1", "BrandId": 1, "StoragesId": 1, "StoragesPos": 1, "StoragesName": "sample string 2", "PropsId": 1, "PriceRemainId": 1, "CatalogPositionId": 1, "ShownMobile": true, "NoShownMobile": true, "NoActive": true, "Active": true, "GoodId": 1, "LevelShown": 64, "MainPageMobile": true, "Code": "sample string 3", "Type": "sample string 4", "Start": 1, "Length": 1, "Operator": 1, "Token": 1, "SiteCode": "sample string 5" }
application/xml, text/xml
<CatalogDataActionPagingInfoRequest 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> <Active>true</Active> <BrandId>1</BrandId> <CatalogId>1</CatalogId> <CatalogPositionId>1</CatalogPositionId> <Code>sample string 3</Code> <GoodId>1</GoodId> <Length>1</Length> <LevelShown>64</LevelShown> <MainPageMobile>true</MainPageMobile> <NoActive>true</NoActive> <NoShownMobile>true</NoShownMobile> <PriceRemainId>1</PriceRemainId> <PropsId>1</PropsId> <Report>true</Report> <ShownMobile>true</ShownMobile> <Start>1</Start> <StoragesId>1</StoragesId> <StoragesName>sample string 2</StoragesName> <StoragesPos>1</StoragesPos> <Type>sample string 4</Type> <TypeInfo>sample string 1</TypeInfo> </CatalogDataActionPagingInfoRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
CatalogDataActionPagingInfoResponseName | Description | Type | Additional information |
---|---|---|---|
TotalRows |
Количество записей всего |
integer |
None. |
TotalRowsSelect |
Количество записей в запросе |
integer |
None. |
Properties |
Массив свойств товаров |
Collection of CatalogDataActionPagingInfoProperty |
None. |
Storages |
Массив складов в каталоге |
Collection of CatalogDataActionPagingInfoStorage |
None. |
Positions |
Массив папок каталога товаров |
Collection of CatalogDataActionPagingInfoPosition |
None. |
Brands |
Массив брендов товаров |
Collection of CatalogDataActionPagingInfoBrand |
None. |
Prices |
Массив остатков и цен |
Collection of CatalogDataActionPagingInfoPrice |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "TotalRows": 1, "TotalRowsSelect": 1, "Properties": [ { "Id": 1, "PropertyId": 1, "Name": "sample string 1", "Code": "sample string 2", "Type": "sample string 3", "NoShownMobile": true, "NoActive": true, "LevelShown": 64 }, { "Id": 1, "PropertyId": 1, "Name": "sample string 1", "Code": "sample string 2", "Type": "sample string 3", "NoShownMobile": true, "NoActive": true, "LevelShown": 64 } ], "Storages": [ { "Id": 1, "StoragesId": 1, "Name": "sample string 1", "Pos": 1, "PosName": "sample string 2", "Partner": 1, "NoActive": true }, { "Id": 1, "StoragesId": 1, "Name": "sample string 1", "Pos": 1, "PosName": "sample string 2", "Partner": 1, "NoActive": true } ], "Positions": [ { "Id": 1, "PositionId": 1, "Name": "sample string 1", "NoShownMobile": true, "NoActive": true, "BigLogo": "sample string 2", "Logo": "sample string 3", "IconLogo": "sample string 4", "PreviewLogo": "sample string 5", "MainPageMobile": true, "LevelShown": 64 }, { "Id": 1, "PositionId": 1, "Name": "sample string 1", "NoShownMobile": true, "NoActive": true, "BigLogo": "sample string 2", "Logo": "sample string 3", "IconLogo": "sample string 4", "PreviewLogo": "sample string 5", "MainPageMobile": true, "LevelShown": 64 } ], "Brands": [ { "Id": 1, "BrandId": 1, "Name": "sample string 1", "NoShownMobile": true, "NoActive": true, "BigLogo": "sample string 2", "Logo": "sample string 3", "IconLogo": "sample string 4", "PreviewLogo": "sample string 5", "MainPageMobile": true, "LevelShown": 64 }, { "Id": 1, "BrandId": 1, "Name": "sample string 1", "NoShownMobile": true, "NoActive": true, "BigLogo": "sample string 2", "Logo": "sample string 3", "IconLogo": "sample string 4", "PreviewLogo": "sample string 5", "MainPageMobile": true, "LevelShown": 64 } ], "Prices": [ { "Id": 1, "StoragesId": 1, "StoragesName": "sample string 1", "PosId": 1, "PosName": "sample string 2", "Goods": 1, "Price": 1.0, "MinPrice": 1.0, "OldPrice": 1.0, "MarkupPrice": 1.0, "Remain": 1.0, "PriceRemainId": 1, "GoodsName": "sample string 3" }, { "Id": 1, "StoragesId": 1, "StoragesName": "sample string 1", "PosId": 1, "PosName": "sample string 2", "Goods": 1, "Price": 1.0, "MinPrice": 1.0, "OldPrice": 1.0, "MarkupPrice": 1.0, "Remain": 1.0, "PriceRemainId": 1, "GoodsName": "sample string 3" } ], "ErrorCode": 1, "Message": "sample string 2" }
application/xml, text/xml
<CatalogDataActionPagingInfoResponse 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> <CatalogDataActionPagingInfoResponse.CatalogDataActionPagingInfoBrand> <BigLogo>sample string 2</BigLogo> <BrandId>1</BrandId> <IconLogo>sample string 4</IconLogo> <Id>1</Id> <LevelShown>64</LevelShown> <Logo>sample string 3</Logo> <MainPageMobile>true</MainPageMobile> <Name>sample string 1</Name> <NoActive>true</NoActive> <NoShownMobile>true</NoShownMobile> <PreviewLogo>sample string 5</PreviewLogo> </CatalogDataActionPagingInfoResponse.CatalogDataActionPagingInfoBrand> <CatalogDataActionPagingInfoResponse.CatalogDataActionPagingInfoBrand> <BigLogo>sample string 2</BigLogo> <BrandId>1</BrandId> <IconLogo>sample string 4</IconLogo> <Id>1</Id> <LevelShown>64</LevelShown> <Logo>sample string 3</Logo> <MainPageMobile>true</MainPageMobile> <Name>sample string 1</Name> <NoActive>true</NoActive> <NoShownMobile>true</NoShownMobile> <PreviewLogo>sample string 5</PreviewLogo> </CatalogDataActionPagingInfoResponse.CatalogDataActionPagingInfoBrand> </Brands> <Positions> <CatalogDataActionPagingInfoResponse.CatalogDataActionPagingInfoPosition> <BigLogo>sample string 2</BigLogo> <IconLogo>sample string 4</IconLogo> <Id>1</Id> <LevelShown>64</LevelShown> <Logo>sample string 3</Logo> <MainPageMobile>true</MainPageMobile> <Name>sample string 1</Name> <NoActive>true</NoActive> <NoShownMobile>true</NoShownMobile> <PositionId>1</PositionId> <PreviewLogo>sample string 5</PreviewLogo> </CatalogDataActionPagingInfoResponse.CatalogDataActionPagingInfoPosition> <CatalogDataActionPagingInfoResponse.CatalogDataActionPagingInfoPosition> <BigLogo>sample string 2</BigLogo> <IconLogo>sample string 4</IconLogo> <Id>1</Id> <LevelShown>64</LevelShown> <Logo>sample string 3</Logo> <MainPageMobile>true</MainPageMobile> <Name>sample string 1</Name> <NoActive>true</NoActive> <NoShownMobile>true</NoShownMobile> <PositionId>1</PositionId> <PreviewLogo>sample string 5</PreviewLogo> </CatalogDataActionPagingInfoResponse.CatalogDataActionPagingInfoPosition> </Positions> <Prices> <CatalogDataActionPagingInfoResponse.CatalogDataActionPagingInfoPrice> <Goods>1</Goods> <GoodsName>sample string 3</GoodsName> <Id>1</Id> <MarkupPrice>1</MarkupPrice> <MinPrice>1</MinPrice> <OldPrice>1</OldPrice> <PosId>1</PosId> <PosName>sample string 2</PosName> <Price>1</Price> <PriceRemainId>1</PriceRemainId> <Remain>1</Remain> <StoragesId>1</StoragesId> <StoragesName>sample string 1</StoragesName> </CatalogDataActionPagingInfoResponse.CatalogDataActionPagingInfoPrice> <CatalogDataActionPagingInfoResponse.CatalogDataActionPagingInfoPrice> <Goods>1</Goods> <GoodsName>sample string 3</GoodsName> <Id>1</Id> <MarkupPrice>1</MarkupPrice> <MinPrice>1</MinPrice> <OldPrice>1</OldPrice> <PosId>1</PosId> <PosName>sample string 2</PosName> <Price>1</Price> <PriceRemainId>1</PriceRemainId> <Remain>1</Remain> <StoragesId>1</StoragesId> <StoragesName>sample string 1</StoragesName> </CatalogDataActionPagingInfoResponse.CatalogDataActionPagingInfoPrice> </Prices> <Properties> <CatalogDataActionPagingInfoResponse.CatalogDataActionPagingInfoProperty> <Code>sample string 2</Code> <Id>1</Id> <LevelShown>64</LevelShown> <Name>sample string 1</Name> <NoActive>true</NoActive> <NoShownMobile>true</NoShownMobile> <PropertyId>1</PropertyId> <Type>sample string 3</Type> </CatalogDataActionPagingInfoResponse.CatalogDataActionPagingInfoProperty> <CatalogDataActionPagingInfoResponse.CatalogDataActionPagingInfoProperty> <Code>sample string 2</Code> <Id>1</Id> <LevelShown>64</LevelShown> <Name>sample string 1</Name> <NoActive>true</NoActive> <NoShownMobile>true</NoShownMobile> <PropertyId>1</PropertyId> <Type>sample string 3</Type> </CatalogDataActionPagingInfoResponse.CatalogDataActionPagingInfoProperty> </Properties> <Storages> <CatalogDataActionPagingInfoResponse.CatalogDataActionPagingInfoStorage> <Id>1</Id> <Name>sample string 1</Name> <NoActive>true</NoActive> <Partner>1</Partner> <Pos>1</Pos> <PosName>sample string 2</PosName> <StoragesId>1</StoragesId> </CatalogDataActionPagingInfoResponse.CatalogDataActionPagingInfoStorage> <CatalogDataActionPagingInfoResponse.CatalogDataActionPagingInfoStorage> <Id>1</Id> <Name>sample string 1</Name> <NoActive>true</NoActive> <Partner>1</Partner> <Pos>1</Pos> <PosName>sample string 2</PosName> <StoragesId>1</StoragesId> </CatalogDataActionPagingInfoResponse.CatalogDataActionPagingInfoStorage> </Storages> <TotalRows>1</TotalRows> <TotalRowsSelect>1</TotalRowsSelect> </CatalogDataActionPagingInfoResponse>