All Verbs | /Sm/GetSmCategorySettings |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | query | int | No | |
Code | query | string | No | |
PostTypesYn | query | bool | No | |
CatChainYn | query | bool | No | |
CatListYn | query | bool | No | |
AttListYn | query | bool | No | |
StoreSettingYn | query | bool | No | |
PostSettingYn | query | bool | No | |
PtSettingYn | query | bool | No | |
BrandYn | query | bool | No | |
VAttDefYn | query | bool | No | |
VAttDataYn | query | bool | No | |
MinLevel | query | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
start | form | DateTime | No | |
DeviceUUID | form | string | No | |
APIKey | form | string | No | |
isAdmin | form | bool | No | |
Cmd | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CategoryChain | form | SmCategoryMetaDTO | No | |
CategoryList | form | List<SmCategoryMetaDTO> | No | |
PostType | form | SmCategoryMetaDTO | No | |
PostTypes | form | List<SmCategoryMetaDTO> | No | |
AttributesList | form | List<SmAttributeDefDTO> | No | |
Brands | form | List<BrandDto> | No | |
PostSetting | form | PostSettings | No | |
StoreSetting | form | StoreSettings | No | |
PtSetting | form | PtSettings | 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 | |
ExYn | 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 |
---|---|---|---|---|
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 |
---|---|---|---|---|
UseMapInPost | form | UseTypes | No | |
UseStartEndDate | form | bool | No | |
UseBrandYn | form | UseTypes | No | |
AddBrand2HeaderYn | form | bool | No | |
MaxMediaCount | form | int | No | |
UseStock | form | UseTypes | No | |
UseCondition | form | UseTypes | No | |
UseSaleType | form | UseTypes | No | |
UsePostDesc | form | UseTypes | No | |
UsePostSummary | form | UseTypes | No | |
AddressLevel | form | AddressLevels | No | |
LabelDescription | form | string | No | |
LabelHeader | form | string | No | |
LabelAddToBasket | form | string | No | |
LabelChat | form | string | No | |
LabelPrice | form | string | No | |
UseNoPrice | form | bool | No | |
UseSinglePrice | form | bool | No | |
UseVariant | form | bool | No | |
UseRangePrice | form | bool | No | |
AllowCustomVariant | form | bool | No | |
TimeBasedVariantYn | form | bool | No | |
VariantAtt1Def | form | int | No | |
VariantAtt2Def | form | int | No | |
VariantAtt3Def | form | int | No | |
VariantAtt4Def | form | int | No | |
AllowSale | form | bool | No | |
AllowReturn | form | bool | No | |
AllowSerialNumber | form | bool | No | |
MaxReturnDays | form | int | No | |
AllowStopInSalerApprove | form | bool | No | |
AllowAddingToBasket | form | bool | No | |
ServiceRegionYn | form | bool | No | |
UseCatalogProduct | form | UseTypes | No | |
MaxInstallmentNumber | form | int | No | |
MaxInstallmentNumber2 | form | int | No | |
MaxInstallmentComNumber | form | int | No | |
MaxInstallmentLimit | form | decimal | No | |
MaxInstallmentLimit2 | form | decimal | No | |
MaxInstallmentComLimit | form | decimal | No | |
CommissionRate | form | decimal | No | |
Plus18 | form | bool | No | |
CategoryListStyle | form | int | No | |
AllowPersonalizedYn | form | bool | No |
Name | Value |
---|---|
None | 0 |
Optional | 1 |
Required | 2 |
Name | Value |
---|---|
None | 0 |
State | 2 |
City | 3 |
District | 4 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UseMapInStore | form | UseTypes | No | |
UseStoreDesc | form | UseTypes | No | |
UseStoreSummary | form | UseTypes | No | |
AllowActiveLocation | form | bool | No | |
AllowRouteMessage | form | bool | No | |
MaxMediaCount | form | int | No | |
UseDepartmentYn | form | bool | No | |
UseMinAmountForOrder | form | bool | No | |
AllowEmptyOrCustomBasket | form | bool | No | |
UseDeliveryMethods | form | bool | No | |
AllowDeliveryToAddress | form | bool | No | |
AllowDeliveryInStore | form | bool | No | |
AllowDeliveryByCargo | form | bool | No | |
ShippingPriceYn | form | bool | No | |
UseAmountPerDistance | form | bool | No | |
UseAmountPerMinute | form | bool | No | |
UseOpenHours | form | bool | No | |
DefaultMinAmountForOrder | form | int | No | |
UseAverageServiceTime | form | bool | No | |
DefaultAverageServiceTime | form | int | No | |
UseMaxDeliveryDistance | form | bool | No | |
DefaultMaxDistance | form | int | No | |
PaymentWithNeedion | form | bool | No | |
PaymentOnAddresYn | form | bool | No | |
DefaultCommissionRate | form | decimal | 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 |
---|---|
Post | 1 |
Store | 2 |
Category | 3 |
Product | 4 |
Campaign | 5 |
Banner | 21 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CategoryChain | form | SmCategoryMetaDTO | No | |
CategoryList | form | List<SmCategoryMetaDTO> | No | |
PostType | form | SmCategoryMetaDTO | No | |
PostTypes | form | List<SmCategoryMetaDTO> | No | |
AttributesList | form | List<SmAttributeDefDTO> | No | |
Brands | form | List<BrandDto> | No | |
PostSetting | form | PostSettings | No | |
StoreSetting | form | StoreSettings | No | |
PtSetting | form | PtSettings | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Sm/GetSmCategorySettings HTTP/1.1
Host: baseservices.needion.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
Code: String,
PostTypesYn: False,
CatChainYn: False,
CatListYn: False,
AttListYn: False,
StoreSettingYn: False,
PostSettingYn: False,
PtSettingYn: False,
BrandYn: False,
VAttDefYn: False,
VAttDataYn: False,
MinLevel: 0,
start: 0001-01-01,
DeviceUUID: String,
APIKey: String,
isAdmin: False,
Cmd: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { CategoryChain: { 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, SubCats: [ { } ], 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 }, CategoryList: [ { 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 } ], PostType: { 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, SubCats: [ { } ], 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 }, PostTypes: [ { 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 } ], AttributesList: [ { 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 } ], PostSetting: { UseMapInPost: 0, UseStartEndDate: False, UseBrandYn: 0, AddBrand2HeaderYn: False, MaxMediaCount: 0, UseStock: 0, UseCondition: 0, UseSaleType: 0, UsePostDesc: 0, UsePostSummary: 0, AddressLevel: 0, LabelDescription: String, LabelHeader: String, LabelAddToBasket: String, LabelChat: String, LabelPrice: String, UseNoPrice: False, UseSinglePrice: False, UseVariant: False, UseRangePrice: False, AllowCustomVariant: False, TimeBasedVariantYn: False, VariantAtt1Def: 0, VariantAtt2Def: 0, VariantAtt3Def: 0, VariantAtt4Def: 0, AllowSale: False, AllowReturn: False, AllowSerialNumber: False, MaxReturnDays: 0, AllowStopInSalerApprove: False, AllowAddingToBasket: False, ServiceRegionYn: False, UseCatalogProduct: 0, MaxInstallmentNumber: 0, MaxInstallmentNumber2: 0, MaxInstallmentComNumber: 0, MaxInstallmentLimit: 0, MaxInstallmentLimit2: 0, MaxInstallmentComLimit: 0, CommissionRate: 0, Plus18: False, CategoryListStyle: 0, AllowPersonalizedYn: False }, StoreSetting: { UseMapInStore: 0, UseStoreDesc: 0, UseStoreSummary: 0, AllowActiveLocation: False, AllowRouteMessage: False, MaxMediaCount: 0, UseDepartmentYn: False, UseMinAmountForOrder: False, AllowEmptyOrCustomBasket: False, UseDeliveryMethods: False, AllowDeliveryToAddress: False, AllowDeliveryInStore: False, AllowDeliveryByCargo: False, ShippingPriceYn: False, UseAmountPerDistance: False, UseAmountPerMinute: False, UseOpenHours: False, DefaultMinAmountForOrder: 0, UseAverageServiceTime: False, DefaultAverageServiceTime: 0, UseMaxDeliveryDistance: False, DefaultMaxDistance: 0, PaymentWithNeedion: False, PaymentOnAddresYn: False, DefaultCommissionRate: 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 }, Result: False, ResMessage: String, Error: { ErrorYn: False, ExYn: False, ErrorCode: String, ErrorDescription: String }, PageInfo: { TotalRecordCount: 0, TotalPageCount: 0, CurrentPage: 0 } }