All Verbs | /Items/SearchItems3/ |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ItemType | query | ItemTypes[] | No | |
SearchText | query | string | No | |
PostTypeId | query | short | No | |
CategoryKey | query | string | No | |
Location | query | GeoLocation | No | |
LocDistance | query | int | No | |
LocTopLeft | query | GeoLocation | No | |
LocBottomRight | query | GeoLocation | No | |
SearchAttrDatas | query | List<SearchAttrData> | No | |
ItemIds | query | List<int> | No | |
ListOrder | query | ListOrders | No | |
Count | query | int | No | |
Page | query | int | No | |
IncludeGtmYn | query | bool | No | |
IncludeSettingsYn | query | bool | No | |
IncludeAnalysisYn | query | bool | No | |
IncludeOnlyCategories | query | bool | No | |
IncludePosts | query | bool | No | |
MinPrice | query | double? | No | |
MaxPrice | query | double? | No | |
StoreId | query | int? | No | |
UserId | query | int? | No | |
IncludeUnPublished | query | bool | No | |
IncludeCategoryContent | query | bool | No | |
CampaignCode | query | string | No | |
ShowAllStock | query | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
start | form | DateTime | No | |
DeviceUUID | form | string | No | |
APIKey | form | string | No | |
isAdmin | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Items | form | List<SItemDto> | No | |
Facets | form | List<FacetDTO> | No | |
HitCount | form | long | No | |
HitInSeconds | form | double | No | |
Settings | form | SearchSettings | No | |
Analysis | form | SearchAnalysis | No | |
CategoryContent | form | SmCategoryContentDTO | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Result | form | bool | No | |
ResMessage | form | string | No | |
Error | form | Error | No | |
PageInfo | form | BasePageInfo | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ErrorYn | form | bool | No | |
ErrorCode | form | string | No | |
ErrorDescription | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TotalRecordCount | form | int | No | |
TotalPageCount | form | int | No | |
CurrentPage | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ItemType | form | ItemTypes | No | |
ItemId | form | int | No | |
ItemKey | form | string | No | |
ItemName | form | string | No | |
ItemHeader | form | string | No | |
Description | form | string | No | |
CategoryKey | form | string | No | |
ConditionId | form | int | No | |
ParentItemType | form | ItemTypes | No | |
ParentItemId | form | int | No | |
ParentItemHeader | form | string | No | |
ParentFriendlyURL | form | string | No | |
ParentMainMediaId | form | string | No | |
ParentMainMediaFriendlyURL | form | string | No | |
PostTypeId | form | short | No | |
Location | form | GeoLocation | No | |
MainMediaId | form | string | No | |
MainMediaFriendlyURL | form | string | No | |
ListPrice | form | decimal? | No | |
SalePrice | form | decimal? | No | |
DiscountRate | form | decimal? | No | |
AddCommisionYn | form | bool | No | |
PublishYn | form | bool | No | |
MapAvatar | form | string | No | |
FriendlyURL | form | string | No | |
AvgRate | form | decimal | No | |
RateCount | form | int | No | |
FollowCount | form | int | No | |
ViewCount | form | int | No | |
DidUserFollow | form | bool | No | |
Score | form | short | No | |
Distance | form | double | No | |
StockType | form | short? | No | |
PriceType | form | short? | No | |
InStockYn | form | bool? | No | |
InStock | form | int? | No | |
AllowSaleYn | form | bool | No | |
Campaingn | form | ItemCampaignDto | No | |
Properties | form | List<PropertyDto> | No | |
CargoPrice | form | decimal | No | |
VariantColorCount | form | int | No | |
ListPrice2 | form | decimal? | No | |
Summary | form | string | No |
Name | Value |
---|---|
Post | 1 |
Store | 2 |
Category | 3 |
Product | 4 |
Campaign | 11 |
Banner | 21 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Lon | form | string | No | |
Lat | form | string | No | |
GeoAddress | form | string | No | |
IsDeleted | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CampaignId | form | int | No | |
CampaignCode | form | string | No | |
Description | form | string | No | |
Message | form | string | No | |
CampaignMessage | form | string | No | |
ItemId | form | int | No | |
ItemType | form | ItemTypes | No | |
SaleQty | form | int | No | |
MinimumQty | form | int | No | |
InputSalePrice | form | decimal | No | |
CSalePrice | form | decimal | No | |
CTotalPrice | form | decimal | No | |
CampaignType | form | CampaignTypes | No | |
CDiscountType | form | CampaignDiscountTypes | No | |
CDiscountQty | form | int | No | |
CDiscountRate | form | decimal | No | |
CDiscountAmt | form | decimal | No | |
BeginDate | form | DateTime | No | |
EndDate | form | DateTime | No | |
LogoUrl | form | string | No | |
ShowPriceYn | form | bool | No | |
CampaignApplied | form | bool | No | |
NeedionRate | form | decimal | No |
Name | Value |
---|---|
OnlyList | 0 |
SameProduct | 1 |
DifferentProduct | 2 |
AnyProduct | 3 |
Custom | 4 |
BasketDiscount | 11 |
StoreDiscount | 12 |
Name | Value |
---|---|
Percent | 1 |
Amount | 2 |
Quantity | 3 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Key | form | string | No | |
Value | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Label | form | string | No | |
ItemsCount | form | int | No | |
Key | form | string | No | |
HasMoreItems | form | bool | No | |
Items | form | List<FacetItemDTO> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Label | form | string | No | |
Key | form | string | No | |
Code | form | string | No | |
Count | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BreadCrumb | form | List<SmCategoryMetaDTO> | No | |
AttibuteDefs | form | List<SmAttributeDefDTO> | No | |
VariantDefs | form | List<SmAttributeDefDTO> | No | |
Brands | form | List<BrandDto> | No | |
PtSetting | form | PtSettings | No | |
SuggestAttributeDefIdList | form | string | No | |
SuggestTargetCatKey | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CType | form | SmCategoryType | No | |
SearchYn | form | bool | No | |
Order | form | int | No | |
NType | form | SmCategoryType | No | |
FriendlyURL | form | string | No | |
Selected | form | bool | No | |
SubCats | form | List<SmCategoryMetaDTO> | No | |
Level | form | byte | No | |
DeepestYn | form | bool? | No | |
Count | form | int | No | |
SearchWeight | form | decimal? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CategoryId | form | int | No | |
Name | form | string | No | |
Code | form | string | No | |
PId | form | short? | No | |
ActiveYn | form | bool | No | |
Tags | form | string | No | |
Title | form | string | No | |
Keywords | form | string | No | |
Metadata | form | string | No | |
CategoryLabel | form | string | No |
Name | Value |
---|---|
None | 0 |
PostType | 1 |
StoreCategory | 2 |
PostCategory | 3 |
Department | 11 |
Brand | 21 |
Model | 23 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SType | form | SmAttributeSearchTypes | No | |
AnyText | form | string | No | |
AllText | form | string | No | |
Code | form | string | No | |
IType | form | SmInputTypes | No | |
AttributeDatas | form | List<SmAttributeDataDTO> | No | |
ParentAttributeDefId | form | short? | No | |
HeaderText | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AttributeDefId | form | short | No | |
Name | form | string | No | |
LabelText | form | string | No | |
Required | form | bool | No | |
AType | form | SmAttributeTypes | No | |
DefaultKey | form | string | No | |
DefaultValue | form | string | No | |
MinValue | form | int? | No | |
MaxValue | form | int? | No |
Name | Value |
---|---|
Text | 1 |
Number | 2 |
Combo | 11 |
MultiSelect | 12 |
State | 13 |
Brand | 21 |
Name | Value |
---|---|
None | 0 |
NumberBetween | 2 |
SingleSelect | 11 |
MultiSelect | 12 |
Name | Value |
---|---|
Text | 1 |
Number | 2 |
Tel | 3 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Key | form | string | No | |
Value | form | string | No | |
Count | form | int | No | |
Order | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BrandId | form | int | No | |
BrandKey | form | string | No | |
BrandName | form | string | No | |
Count | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SearchMapOnlyUsedCondition | form | bool | No | |
SearchMapDefaultScale | form | int | No | |
SearchPostYn | form | bool | No | |
SearchStoreYn | form | bool | No | |
SearchPostOnMapYn | form | bool | No | |
SearchStoreOnMapYn | form | bool | No | |
SearchConditionYn | form | bool | No | |
SearchSaleTypeYn | form | bool | No | |
SearchDeliveryTypeYn | form | bool | No | |
SearchOpportunityProductsYn | form | bool | No | |
PtAllowSaleYn | form | bool | No | |
SearchDefault | form | ItemTypes | No | |
SearchMapMethod | form | ItemTypes | No | |
DefaultCommissionRate | form | decimal | No | |
VirtualDepartmentSource | form | string | No | |
FriendlyUrlSource | form | string | No | |
SearchAddressLevel | form | AddressLevels | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PostTypeId | form | int | No | |
Name | form | string | No | |
Desciption | form | string | No | |
FriendlyUrl | form | string | No | |
ActiveYn | form | bool | No |
Name | Value |
---|---|
None | 0 |
State | 2 |
City | 3 |
District | 4 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BreadCrumb | form | List<SmCategoryMetaDTO> | No | |
AttibuteDefs | form | List<SmAttributeDefDTO> | No | |
Conditions | form | SmAttributeDefDTO | No | |
SaleTypes | form | SmAttributeDefDTO | No | |
Brands | form | List<BrandDto> | No | |
BreadCrumb2 | form | List<SmCategoryMetaDTO> | No | |
CategorySuggestion | form | List<SmCategoryMetaDTO> | No | |
MaxPrice | form | decimal | No | |
MinPrice | form | decimal | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CategoryId | form | int | No | |
Code | form | string | No | |
Name | form | string | No | |
Title | form | string | No | |
Keywords | form | string | No | |
Metadata | form | string | No | |
CategoryContent | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Type | form | string | No | |
Key | form | string | No |
Name | Value |
---|---|
Default | 0 |
AvgRateDesc | 1 |
FollowersCountDesc | 2 |
Newest | 3 |
PriceDesc | 4 |
PriceAsc | 5 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Items | form | List<SItemDto> | No | |
Facets | form | List<FacetDTO> | No | |
HitCount | form | long | No | |
HitInSeconds | form | double | No | |
Settings | form | SearchSettings | No | |
Analysis | form | SearchAnalysis | No | |
CategoryContent | form | SmCategoryContentDTO | 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Items/SearchItems3/ 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","ShowAllStock":false,"start":"\/Date(-62135596800000-0000)\/","DeviceUUID":"String","APIKey":"String","isAdmin":false}
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,"NeedionRate":0},"Properties":[{"Key":"String","Value":"String"}],"CargoPrice":0,"VariantColorCount":0,"ListPrice2":0,"Summary":"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":[{"SType":0,"AnyText":"String","AllText":"String","Code":"String","IType":1,"AttributeDatas":[{"Key":"String","Value":"String","Count":0,"Order":0}],"ParentAttributeDefId":0,"HeaderText":"String","AttributeDefId":0,"Name":"String","LabelText":"String","Required":false,"AType":1,"DefaultKey":"String","DefaultValue":"String","MinValue":0,"MaxValue":0}],"VariantDefs":[{"SType":0,"AnyText":"String","AllText":"String","Code":"String","IType":1,"AttributeDatas":[{"Key":"String","Value":"String","Count":0,"Order":0}],"ParentAttributeDefId":0,"HeaderText":"String","AttributeDefId":0,"Name":"String","LabelText":"String","Required":false,"AType":1,"DefaultKey":"String","DefaultValue":"String","MinValue":0,"MaxValue":0}],"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":[{"SType":0,"AnyText":"String","AllText":"String","Code":"String","IType":1,"AttributeDatas":[{"Key":"String","Value":"String","Count":0,"Order":0}],"ParentAttributeDefId":0,"HeaderText":"String","AttributeDefId":0,"Name":"String","LabelText":"String","Required":false,"AType":1,"DefaultKey":"String","DefaultValue":"String","MinValue":0,"MaxValue":0}],"Conditions":{"SType":0,"AnyText":"String","AllText":"String","Code":"String","IType":1,"AttributeDatas":[{"Key":"String","Value":"String","Count":0,"Order":0}],"ParentAttributeDefId":0,"HeaderText":"String","AttributeDefId":0,"Name":"String","LabelText":"String","Required":false,"AType":1,"DefaultKey":"String","DefaultValue":"String","MinValue":0,"MaxValue":0},"SaleTypes":{"SType":0,"AnyText":"String","AllText":"String","Code":"String","IType":1,"AttributeDatas":[{"Key":"String","Value":"String","Count":0,"Order":0}],"ParentAttributeDefId":0,"HeaderText":"String","AttributeDefId":0,"Name":"String","LabelText":"String","Required":false,"AType":1,"DefaultKey":"String","DefaultValue":"String","MinValue":0,"MaxValue":0},"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}}