ApexERPHost

<back to all web services

GetECommerceMainPageProductGroups

Requires Authentication
The following routes are available for this service:
GET/eCommerce/Pages/Main/ProductGroups
GetECommerceMainPageProductGroups Parameters:
NameParameterData TypeRequiredDescription
ClientIdqueryint?No
BranchIdqueryint?No
UserquerystringNo
LangquerystringNo
GetECommerceMainPageProductGroupsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<ECommercePageProductGroup>No
TrendingProductsformList<ECommerceProduct>No
FilterGroupsformList<ECommerceFilterGroup>No
ECommercePageProductGroup Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
TitleformstringNo
ProductsformList<ECommerceProduct>No
ECommerceProduct Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
BCodeformstringNo
NameformstringNo
PriceformdecimalNo
Pointsformdecimal?No
InStockformboolNo
PromoformboolNo
Discountformdecimal?No
ImgLinkformstringNo
DiscountedPriceformdecimal?No
IsNewformbool?No
NettoformdecimalNo
UnitformstringNo
AnnotationHtmlformstringNo
NeedPrepareformint?No
QuantityStepformdecimal?No
ByWeightformbyte?No
SlugformstringNo
PPCatIdformstringNo
mdtradeformdecimalNo
mdretailformdecimalNo
rcountformdecimalNo
QualityIdformint?No
QualityformstringNo
HCategoryIdformint?No
IncodeformstringNo
HCategoryNameformstringNo
HCategoryHcodeformstringNo
BrandIdformint?No
BrandNameformstringNo
BrandAbbreviationformstringNo
BrandImageLinkformstringNo
AnnotationHtmlEnformstringNo
ECommerceFilterGroup Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
LocationformstringNo
FiltersformList<ECommerceFilter>No
ECommerceFilter Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TypeformintNo
NameformstringNo
QueryParamformstringNo
ValuesformList<ECommerceFilterValue>No
DefaultValueformECommerceFilterValueNo
ECommerceFilterValue Parameters:
NameParameterData TypeRequiredDescription
ValueformstringNo
NameformstringNo
MinValueformdecimal?No
MaxValueformdecimal?No
ParentValueformstringNo
ImgLinkformstringNo
SortformstringNo
SlugformstringNo
ShortDescriptionformstringNo
DescriptionformstringNo
ShortDescription2formstringNo
Description2formstringNo
VideoLinkformstringNo
ImageLinksformList<string>No
MinCountformdecimal?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /eCommerce/Pages/Main/ProductGroups HTTP/1.1 
Host: 10.10.0.107 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Result":[{"Id":"String","Title":"String","Products":[{"Id":"String","BCode":"String","Name":"String","Price":0,"Points":0,"InStock":false,"Promo":false,"Discount":0,"ImgLink":"String","DiscountedPrice":0,"IsNew":false,"Netto":0,"Unit":"String","AnnotationHtml":"String","NeedPrepare":0,"QuantityStep":0,"ByWeight":0,"Slug":"String","PPCatId":"String","mdtrade":0,"mdretail":0,"rcount":0,"QualityId":0,"Quality":"String","HCategoryId":0,"Incode":"String","HCategoryName":"String","HCategoryHcode":"String","BrandId":0,"BrandName":"String","BrandAbbreviation":"String","BrandImageLink":"String","AnnotationHtmlEn":"String"}]}],"TrendingProducts":[{"Id":"String","BCode":"String","Name":"String","Price":0,"Points":0,"InStock":false,"Promo":false,"Discount":0,"ImgLink":"String","DiscountedPrice":0,"IsNew":false,"Netto":0,"Unit":"String","AnnotationHtml":"String","NeedPrepare":0,"QuantityStep":0,"ByWeight":0,"Slug":"String","PPCatId":"String","mdtrade":0,"mdretail":0,"rcount":0,"QualityId":0,"Quality":"String","HCategoryId":0,"Incode":"String","HCategoryName":"String","HCategoryHcode":"String","BrandId":0,"BrandName":"String","BrandAbbreviation":"String","BrandImageLink":"String","AnnotationHtmlEn":"String"}],"FilterGroups":[{"Id":0,"Name":"String","Location":"String","Filters":[{"Id":0,"Type":0,"Name":"String","QueryParam":"String","Values":[{"Value":"String","Name":"String","MinValue":0,"MaxValue":0,"ParentValue":"String","ImgLink":"String","Sort":"String","Slug":"String","ShortDescription":"String","Description":"String","ShortDescription2":"String","Description2":"String","VideoLink":"String","ImageLinks":["String"],"MinCount":0}],"DefaultValue":{"Value":"String","Name":"String","MinValue":0,"MaxValue":0,"ParentValue":"String","ImgLink":"String","Sort":"String","Slug":"String","ShortDescription":"String","Description":"String","ShortDescription2":"String","Description2":"String","VideoLink":"String","ImageLinks":["String"],"MinCount":0}}]}]}