Needio.Services

<back to all web services

SearchItemsRequest

The following routes are available for this service:
All Verbs/Items/SearchItems/
SearchItemsRequest Parameters:
NameParameterData TypeRequiredDescription
ItemTypequeryItemTypes[]No
SearchTextquerystringNo
PostTypeIdqueryshortNo
CategoryKeyquerystringNo
LocationqueryGeoLocationNo
LocDistancequeryintNo
LocTopLeftqueryGeoLocationNo
LocBottomRightqueryGeoLocationNo
SearchAttrDatasqueryList<SearchAttrData>No
ItemIdsqueryList<int>No
ListOrderqueryListOrdersNo
CountqueryintNo
PagequeryintNo
IncludeGtmYnqueryboolNo
IncludeSettingsYnqueryboolNo
IncludeAnalysisYnqueryboolNo
IncludeOnlyCategoriesqueryboolNo
IncludePostsqueryboolNo
MinPricequerydouble?No
MaxPricequerydouble?No
StoreIdqueryint?No
UserIdqueryint?No
IncludeUnPublishedqueryboolNo
IncludeCategoryContentqueryboolNo
CampaignCodequerystringNo
CityIdqueryint?No
IncludeMediasYnquerybool?No
IncludeMainMediaYnquerybool?No
IncludeVariantsYnquerybool?No
IncludeSocialInfoYnquerybool?No
IncludeStoreInfoYnquerybool?No
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
SearchItemsResponse Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<SItemDto>No
FacetsformList<FacetDTO>No
HitCountformlongNo
HitInSecondsformdoubleNo
SettingsformSearchSettingsNo
AnalysisformSearchAnalysisNo
CategoryContentformSmCategoryContentDTONo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
SItemDto Parameters:
NameParameterData TypeRequiredDescription
ItemTypeformItemTypesNo
ItemIdformintNo
ItemKeyformstringNo
ItemNameformstringNo
ItemHeaderformstringNo
DescriptionformstringNo
CategoryKeyformstringNo
ConditionIdformintNo
ParentItemTypeformItemTypesNo
ParentItemIdformintNo
ParentItemHeaderformstringNo
ParentFriendlyURLformstringNo
ParentMainMediaIdformstringNo
ParentMainMediaFriendlyURLformstringNo
PostTypeIdformshortNo
LocationformGeoLocationNo
MainMediaIdformstringNo
MainMediaFriendlyURLformstringNo
ListPriceformdecimal?No
SalePriceformdecimal?No
DiscountRateformdecimal?No
AddCommisionYnformboolNo
PublishYnformboolNo
MapAvatarformstringNo
FriendlyURLformstringNo
AvgRateformdecimalNo
RateCountformintNo
FollowCountformintNo
ViewCountformintNo
DidUserFollowformboolNo
ScoreformshortNo
DistanceformdoubleNo
StockTypeformshort?No
PriceTypeformshort?No
InStockYnformbool?No
InStockformint?No
AllowSaleYnformboolNo
CampaingnformItemCampaignDtoNo
PropertiesformList<PropertyDto>No
ItemTypes Enum:
NameValue
Post1
Store2
Category3
Product4
Campaign11
Banner21
GeoLocation Parameters:
NameParameterData TypeRequiredDescription
LonformstringNo
LatformstringNo
GeoAddressformstringNo
IsDeletedformboolNo
ItemCampaignDto Parameters:
NameParameterData TypeRequiredDescription
CampaignIdformintNo
CampaignCodeformstringNo
DescriptionformstringNo
MessageformstringNo
CampaignMessageformstringNo
ItemIdformintNo
ItemTypeformItemTypesNo
SaleQtyformintNo
MinimumQtyformintNo
InputSalePriceformdecimalNo
CSalePriceformdecimalNo
CTotalPriceformdecimalNo
CampaignTypeformCampaignTypesNo
CDiscountTypeformCampaignDiscountTypesNo
CDiscountQtyformintNo
CDiscountRateformdecimalNo
CDiscountAmtformdecimalNo
BeginDateformDateTimeNo
EndDateformDateTimeNo
LogoUrlformstringNo
ShowPriceYnformboolNo
CampaignAppliedformboolNo
CampaignTypes Enum:
NameValue
OnlyList0
SameProduct1
DifferentProduct2
AnyProduct3
Custom4
BasketDiscount11
StoreDiscount12
CampaignDiscountTypes Enum:
NameValue
Percent1
Amount2
Quantity3
PropertyDto Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
ValueformstringNo
FacetDTO Parameters:
NameParameterData TypeRequiredDescription
LabelformstringNo
ItemsCountformintNo
KeyformstringNo
HasMoreItemsformboolNo
ItemsformList<FacetItemDTO>No
FacetItemDTO Parameters:
NameParameterData TypeRequiredDescription
LabelformstringNo
KeyformstringNo
CodeformstringNo
CountformintNo
SearchSettings Parameters:
NameParameterData TypeRequiredDescription
BreadCrumbformList<SmCategoryMetaDTO>No
AttibuteDefsformList<SmAttributeDefDTO>No
VariantDefsformList<SmAttributeDefDTO>No
BrandsformList<BrandDto>No
PtSettingformPtSettingsNo
SuggestAttributeDefIdListformstringNo
SuggestTargetCatKeyformstringNo
SmCategoryMetaDTO Parameters:
NameParameterData TypeRequiredDescription
CTypeformSmCategoryTypeNo
SearchYnformboolNo
OrderformintNo
NTypeformSmCategoryTypeNo
FriendlyURLformstringNo
SelectedformboolNo
SubCatsformList<SmCategoryMetaDTO>No
LevelformbyteNo
DeepestYnformbool?No
CountformintNo
SearchWeightformdecimal?No
SmCategoryInfoDTO Parameters:
NameParameterData TypeRequiredDescription
CategoryIdformintNo
NameformstringNo
CodeformstringNo
PIdformshort?No
ActiveYnformboolNo
TagsformstringNo
TitleformstringNo
KeywordsformstringNo
MetadataformstringNo
CategoryLabelformstringNo
SmCategoryType Enum:
NameValue
None0
PostType1
StoreCategory2
PostCategory3
Department11
Brand21
Model23
SmAttributeDefDTO Parameters:
NameParameterData TypeRequiredDescription
ATypeformSmAttributeTypesNo
STypeformSmAttributeSearchTypesNo
AnyTextformstringNo
AllTextformstringNo
CodeformstringNo
ITypeformSmInputTypesNo
AttributeDatasformList<SmAttributeDataDTO>No
DefaultValueformstringNo
MinValueformint?No
MaxValueformint?No
ParentAttributeDefIdformshort?No
SmAttributeInfoDTO Parameters:
NameParameterData TypeRequiredDescription
AttributeDefIdformshortNo
NameformstringNo
LabelTextformstringNo
RequiredformboolNo
SmAttributeTypes Enum:
NameValue
Text1
Number2
Combo11
MultiSelect12
State13
Brand21
SmAttributeSearchTypes Enum:
NameValue
None0
NumberBetween2
SingleSelect11
MultiSelect12
SmInputTypes Enum:
NameValue
Text1
Number2
Tel3
SmAttributeDataDTO Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
ValueformstringNo
CountformintNo
OrderformintNo
BrandDto Parameters:
NameParameterData TypeRequiredDescription
BrandIdformintNo
BrandKeyformstringNo
BrandNameformstringNo
CountformintNo
PtSettings Parameters:
NameParameterData TypeRequiredDescription
SearchMapOnlyUsedConditionformboolNo
SearchMapDefaultScaleformintNo
SearchPostYnformboolNo
SearchStoreYnformboolNo
SearchPostOnMapYnformboolNo
SearchStoreOnMapYnformboolNo
SearchConditionYnformboolNo
SearchSaleTypeYnformboolNo
SearchDeliveryTypeYnformboolNo
SearchOpportunityProductsYnformboolNo
PtAllowSaleYnformboolNo
SearchDefaultformItemTypesNo
SearchMapMethodformItemTypesNo
DefaultCommissionRateformdecimalNo
VirtualDepartmentSourceformstringNo
FriendlyUrlSourceformstringNo
SearchAddressLevelformAddressLevelsNo
PostTypeDTO Parameters:
NameParameterData TypeRequiredDescription
PostTypeIdformintNo
NameformstringNo
DesciptionformstringNo
FriendlyUrlformstringNo
ActiveYnformboolNo
AddressLevels Enum:
NameValue
None0
State2
City3
District4
SearchAnalysis Parameters:
NameParameterData TypeRequiredDescription
BreadCrumbformList<SmCategoryMetaDTO>No
AttibuteDefsformList<SmAttributeDefDTO>No
ConditionsformSmAttributeDefDTONo
SaleTypesformSmAttributeDefDTONo
BrandsformList<BrandDto>No
BreadCrumb2formList<SmCategoryMetaDTO>No
CategorySuggestionformList<SmCategoryMetaDTO>No
MaxPriceformdecimalNo
MinPriceformdecimalNo
SmCategoryContentDTO Parameters:
NameParameterData TypeRequiredDescription
CategoryIdformintNo
CodeformstringNo
NameformstringNo
TitleformstringNo
KeywordsformstringNo
MetadataformstringNo
CategoryContentformstringNo
SearchAttrData Parameters:
NameParameterData TypeRequiredDescription
TypeformstringNo
KeyformstringNo
ListOrders Enum:
NameValue
Default0
AvgRateDesc1
FollowersCountDesc2
Newest3
PriceDesc4
PriceAsc5
SearchItemsResponse Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<SItemDto>No
FacetsformList<FacetDTO>No
HitCountformlongNo
HitInSecondsformdoubleNo
SettingsformSearchSettingsNo
AnalysisformSearchAnalysisNo
CategoryContentformSmCategoryContentDTONo

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.

POST /Items/SearchItems/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ItemType":[1],"SearchText":"String","PostTypeId":0,"CategoryKey":"String","Location":{"Lon":"String","Lat":"String","GeoAddress":"String","IsDeleted":false},"LocDistance":0,"LocTopLeft":{"Lon":"String","Lat":"String","GeoAddress":"String","IsDeleted":false},"LocBottomRight":{"Lon":"String","Lat":"String","GeoAddress":"String","IsDeleted":false},"SearchAttrDatas":[{"Type":"String","Key":"String"}],"ItemIds":[0],"ListOrder":0,"Count":0,"Page":0,"IncludeGtmYn":false,"IncludeSettingsYn":false,"IncludeAnalysisYn":false,"IncludeOnlyCategories":false,"IncludePosts":false,"MinPrice":0,"MaxPrice":0,"StoreId":0,"UserId":0,"IncludeUnPublished":false,"IncludeCategoryContent":false,"CampaignCode":"String","CityId":0,"IncludeMediasYn":false,"IncludeMainMediaYn":false,"IncludeVariantsYn":false,"IncludeSocialInfoYn":false,"IncludeStoreInfoYn":false,"start":"\/Date(1634658372686+0300)\/","DeviceUUID":"String","APIKey":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Items":[{"ItemType":1,"ItemId":0,"ItemKey":"String","ItemName":"String","ItemHeader":"String","Description":"String","CategoryKey":"String","ConditionId":0,"ParentItemType":1,"ParentItemId":0,"ParentItemHeader":"String","ParentFriendlyURL":"String","ParentMainMediaId":"String","ParentMainMediaFriendlyURL":"String","PostTypeId":0,"Location":{"Lon":"String","Lat":"String","GeoAddress":"String","IsDeleted":false},"MainMediaId":"String","MainMediaFriendlyURL":"String","ListPrice":0,"SalePrice":0,"DiscountRate":0,"AddCommisionYn":false,"PublishYn":false,"MapAvatar":"String","FriendlyURL":"String","AvgRate":0,"RateCount":0,"FollowCount":0,"ViewCount":0,"DidUserFollow":false,"Score":0,"Distance":0,"StockType":0,"PriceType":0,"InStockYn":false,"InStock":0,"AllowSaleYn":false,"Campaingn":{"CampaignId":0,"CampaignCode":"String","Description":"String","Message":"String","CampaignMessage":"String","ItemId":0,"ItemType":1,"SaleQty":0,"MinimumQty":0,"InputSalePrice":0,"CSalePrice":0,"CTotalPrice":0,"CampaignType":0,"CDiscountType":1,"CDiscountQty":0,"CDiscountRate":0,"CDiscountAmt":0,"BeginDate":"\/Date(-62135596800000-0000)\/","EndDate":"\/Date(-62135596800000-0000)\/","LogoUrl":"String","ShowPriceYn":false,"CampaignApplied":false},"Properties":[{"Key":"String","Value":"String"}]}],"Facets":[{"Label":"String","ItemsCount":0,"Key":"String","HasMoreItems":false,"Items":[{"Label":"String","Key":"String","Code":"String","Count":0}]}],"HitCount":0,"HitInSeconds":0,"Settings":{"BreadCrumb":[{"CType":0,"SearchYn":false,"Order":0,"NType":0,"FriendlyURL":"String","Selected":false,"SubCats":[{"CType":0,"SearchYn":false,"Order":0,"NType":0,"FriendlyURL":"String","Selected":false,"SubCats":[{"CType":0,"SearchYn":false,"Order":0,"NType":0,"FriendlyURL":"String","Selected":false,"Level":0,"DeepestYn":false,"Count":0,"SearchWeight":0,"CategoryId":0,"Name":"String","Code":"String","PId":0,"ActiveYn":false,"Tags":"String","Title":"String","Keywords":"String","Metadata":"String","CategoryLabel":"String"}],"Level":0,"DeepestYn":false,"Count":0,"SearchWeight":0,"CategoryId":0,"Name":"String","Code":"String","PId":0,"ActiveYn":false,"Tags":"String","Title":"String","Keywords":"String","Metadata":"String","CategoryLabel":"String"}],"Level":0,"DeepestYn":false,"Count":0,"SearchWeight":0,"CategoryId":0,"Name":"String","Code":"String","PId":0,"ActiveYn":false,"Tags":"String","Title":"String","Keywords":"String","Metadata":"String","CategoryLabel":"String"}],"AttibuteDefs":[{"AType":1,"SType":0,"AnyText":"String","AllText":"String","Code":"String","IType":1,"AttributeDatas":[{"Key":"String","Value":"String","Count":0,"Order":0}],"DefaultValue":"String","MinValue":0,"MaxValue":0,"ParentAttributeDefId":0,"AttributeDefId":0,"Name":"String","LabelText":"String","Required":false}],"VariantDefs":[{"AType":1,"SType":0,"AnyText":"String","AllText":"String","Code":"String","IType":1,"AttributeDatas":[{"Key":"String","Value":"String","Count":0,"Order":0}],"DefaultValue":"String","MinValue":0,"MaxValue":0,"ParentAttributeDefId":0,"AttributeDefId":0,"Name":"String","LabelText":"String","Required":false}],"Brands":[{"BrandId":0,"BrandKey":"String","BrandName":"String","Count":0}],"PtSetting":{"SearchMapOnlyUsedCondition":false,"SearchMapDefaultScale":0,"SearchPostYn":false,"SearchStoreYn":false,"SearchPostOnMapYn":false,"SearchStoreOnMapYn":false,"SearchConditionYn":false,"SearchSaleTypeYn":false,"SearchDeliveryTypeYn":false,"SearchOpportunityProductsYn":false,"PtAllowSaleYn":false,"SearchDefault":1,"SearchMapMethod":1,"DefaultCommissionRate":0,"VirtualDepartmentSource":"String","FriendlyUrlSource":"String","SearchAddressLevel":0,"PostTypeId":0,"Name":"String","Desciption":"String","FriendlyUrl":"String","ActiveYn":false},"SuggestAttributeDefIdList":"String","SuggestTargetCatKey":"String"},"Analysis":{"BreadCrumb":[{"CType":0,"SearchYn":false,"Order":0,"NType":0,"FriendlyURL":"String","Selected":false,"SubCats":[{"CType":0,"SearchYn":false,"Order":0,"NType":0,"FriendlyURL":"String","Selected":false,"SubCats":[{"CType":0,"SearchYn":false,"Order":0,"NType":0,"FriendlyURL":"String","Selected":false,"Level":0,"DeepestYn":false,"Count":0,"SearchWeight":0,"CategoryId":0,"Name":"String","Code":"String","PId":0,"ActiveYn":false,"Tags":"String","Title":"String","Keywords":"String","Metadata":"String","CategoryLabel":"String"}],"Level":0,"DeepestYn":false,"Count":0,"SearchWeight":0,"CategoryId":0,"Name":"String","Code":"String","PId":0,"ActiveYn":false,"Tags":"String","Title":"String","Keywords":"String","Metadata":"String","CategoryLabel":"String"}],"Level":0,"DeepestYn":false,"Count":0,"SearchWeight":0,"CategoryId":0,"Name":"String","Code":"String","PId":0,"ActiveYn":false,"Tags":"String","Title":"String","Keywords":"String","Metadata":"String","CategoryLabel":"String"}],"AttibuteDefs":[{"AType":1,"SType":0,"AnyText":"String","AllText":"String","Code":"String","IType":1,"AttributeDatas":[{"Key":"String","Value":"String","Count":0,"Order":0}],"DefaultValue":"String","MinValue":0,"MaxValue":0,"ParentAttributeDefId":0,"AttributeDefId":0,"Name":"String","LabelText":"String","Required":false}],"Conditions":{"AType":1,"SType":0,"AnyText":"String","AllText":"String","Code":"String","IType":1,"AttributeDatas":[{"Key":"String","Value":"String","Count":0,"Order":0}],"DefaultValue":"String","MinValue":0,"MaxValue":0,"ParentAttributeDefId":0,"AttributeDefId":0,"Name":"String","LabelText":"String","Required":false},"SaleTypes":{"AType":1,"SType":0,"AnyText":"String","AllText":"String","Code":"String","IType":1,"AttributeDatas":[{"Key":"String","Value":"String","Count":0,"Order":0}],"DefaultValue":"String","MinValue":0,"MaxValue":0,"ParentAttributeDefId":0,"AttributeDefId":0,"Name":"String","LabelText":"String","Required":false},"Brands":[{"BrandId":0,"BrandKey":"String","BrandName":"String","Count":0}],"BreadCrumb2":[{"CType":0,"SearchYn":false,"Order":0,"NType":0,"FriendlyURL":"String","Selected":false,"SubCats":[{"CType":0,"SearchYn":false,"Order":0,"NType":0,"FriendlyURL":"String","Selected":false,"SubCats":[{"CType":0,"SearchYn":false,"Order":0,"NType":0,"FriendlyURL":"String","Selected":false,"Level":0,"DeepestYn":false,"Count":0,"SearchWeight":0,"CategoryId":0,"Name":"String","Code":"String","PId":0,"ActiveYn":false,"Tags":"String","Title":"String","Keywords":"String","Metadata":"String","CategoryLabel":"String"}],"Level":0,"DeepestYn":false,"Count":0,"SearchWeight":0,"CategoryId":0,"Name":"String","Code":"String","PId":0,"ActiveYn":false,"Tags":"String","Title":"String","Keywords":"String","Metadata":"String","CategoryLabel":"String"}],"Level":0,"DeepestYn":false,"Count":0,"SearchWeight":0,"CategoryId":0,"Name":"String","Code":"String","PId":0,"ActiveYn":false,"Tags":"String","Title":"String","Keywords":"String","Metadata":"String","CategoryLabel":"String"}],"CategorySuggestion":[{"CType":0,"SearchYn":false,"Order":0,"NType":0,"FriendlyURL":"String","Selected":false,"SubCats":[{"CType":0,"SearchYn":false,"Order":0,"NType":0,"FriendlyURL":"String","Selected":false,"SubCats":[{"CType":0,"SearchYn":false,"Order":0,"NType":0,"FriendlyURL":"String","Selected":false,"Level":0,"DeepestYn":false,"Count":0,"SearchWeight":0,"CategoryId":0,"Name":"String","Code":"String","PId":0,"ActiveYn":false,"Tags":"String","Title":"String","Keywords":"String","Metadata":"String","CategoryLabel":"String"}],"Level":0,"DeepestYn":false,"Count":0,"SearchWeight":0,"CategoryId":0,"Name":"String","Code":"String","PId":0,"ActiveYn":false,"Tags":"String","Title":"String","Keywords":"String","Metadata":"String","CategoryLabel":"String"}],"Level":0,"DeepestYn":false,"Count":0,"SearchWeight":0,"CategoryId":0,"Name":"String","Code":"String","PId":0,"ActiveYn":false,"Tags":"String","Title":"String","Keywords":"String","Metadata":"String","CategoryLabel":"String"}],"MaxPrice":0,"MinPrice":0},"CategoryContent":{"CategoryId":0,"Code":"String","Name":"String","Title":"String","Keywords":"String","Metadata":"String","CategoryContent":"String"},"Result":false,"ResMessage":"String","Error":{"ErrorYn":false,"ErrorCode":"String","ErrorDescription":"String"},"PageInfo":{"TotalRecordCount":0,"TotalPageCount":0,"CurrentPage":0}}