Needio.Services

<back to all web services

GetStoreDetailRequest

The following routes are available for this service:
All Verbs/Store/GetStoreDetail/{Storeid}
GetStoreDetailRequest Parameters:
NameParameterData TypeRequiredDescription
StoreIdpathintNo
UserIdqueryintNo
UrlquerystringNo
UserLocationqueryGeoLocationNo
IncludeSettingYnqueryboolNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetStoreDetailResponse Parameters:
NameParameterData TypeRequiredDescription
StoreDetailformStoreDetailDTONo
ViewSettingformStoreViewSettingsNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
StoreDetailDTO Parameters:
NameParameterData TypeRequiredDescription
DeliveryAddressformstringNo
DeliveryStateIdformint?No
DeliveryCityIdformint?No
DeliveryDistrictIdformint?No
UseSameAddressformboolNo
ReturnDeliveryAddressformstringNo
ReturnDeliveryStateIdformint?No
ReturnDeliveryCityIdformint?No
ReturnDeliveryDistrictIdformint?No
UseSameAddressForReturnformboolNo
StoreMediasformList<MediaDTO>No
StoreRegionsformList<StoreRegionDTO>No
DepartmentsformList<StoreDepartmentDTO>No
ReviewsformList<StoreReviewDTO>No
StoreAccoutingInfoformStoreAccoutingDTONo
PostCountformintNo
HasSalerAgreementApprovedformboolNo
HasIyzicoAgreementApprovedformboolNo
StoreDTO Parameters:
NameParameterData TypeRequiredDescription
StoreIdformintNo
StoreNameformstringNo
StoreHeaderformstringNo
SummaryformstringNo
DescriptionformstringNo
PostTypeIdformshortNo
LocationformGeoLocationNo
BadgesformList<ItemBadgeDTO>No
MainMediaformMediaDTONo
SocialInfoformItemSocialInfoDTONo
StoreStatusformItemStatusesNo
StoreStateformItemStatesNo
UserIdformintNo
OwnerformUserInfoNo
ActionformDBActionNo
SaleLocalYnformboolNo
SaleCountryYnformboolNo
DeliveryToAddressYnformboolNo
DeliveryInStoreYnformboolNo
DeliveryByCargoformboolNo
OpenYnformboolNo
ShippingPriceYnformboolNo
ShippingAmountformdecimal?No
ShippingUpperLimitformdecimal?No
ShippingUpperAmountformdecimal?No
MaxDistanceformshort?No
DistanceformdoubleNo
MapAvatarformstringNo
StartDateformDateTime?No
EndDateformDateTime?No
OpenHoursformWeekOpenHoursNo
AlwActformintNo
MinAmountForOrderformdecimal?No
AverageServiceTimeformshort?No
ClosedYnformboolNo
FriendlyURLformstringNo
CategoryIdformshortNo
CategoryKeyformstringNo
ChatMethodformChatMethodsNo
AllowPaymentOnAddresformboolNo
AllowedPaymentsformstringNo
AttributeDataformstringNo
AttributeMetaformstringNo
GeoAddressformstringNo
VersionStatusformVersionStatusNo
BlockedYnformboolNo
EmailformstringNo
PhoneformstringNo
StatusInfoHashTagformstringNo
StatusInfoTextformstringNo
TrustedYnformboolNo
StoreCustomformStoreCustomDtoNo
GeoLocation Parameters:
NameParameterData TypeRequiredDescription
LonformstringNo
LatformstringNo
GeoAddressformstringNo
IsDeletedformboolNo
ItemBadgeDTO Parameters:
NameParameterData TypeRequiredDescription
BadgeIdformintNo
ItemIdformintNo
BadgeTypeIdformshortNo
StartDateformDateTime?No
EndDateformDateTime?No
Priortyformshort?No
ActiveYnformboolNo
MediaDTO Parameters:
NameParameterData TypeRequiredDescription
PostIdformintNo
MediaIdformint?No
MediaTypeformMediaTypesNo
SourceformstringNo
MediaFileNameformstringNo
MediaMimeformstringNo
IsMainformboolNo
RefIdformint?No
OrderNumformintNo
ActionformDBActionNo
IsDeletedformboolNo
FriendlyURLformstringNo
PostVariantA1KeyformstringNo
SourceUrlformstringNo
ActiveYnformboolNo
MediaTypes Enum:
NameValue
icon0
Image1
Video2
Youtube3
Pdf8
File9
ThreeD10
Custom99
DBAction Enum:
NameValue
None0
Insert1
Update2
Delete3
ItemSocialInfoDTO Parameters:
NameParameterData TypeRequiredDescription
AvgRateformdecimalNo
RateCountformintNo
Rate1CountformintNo
Rate2CountformintNo
Rate3CountformintNo
Rate4CountformintNo
Rate5CountformintNo
LikeCountformintNo
FollowCountformintNo
ViewCountformintNo
DidUserLikeformboolNo
DidUserRateformboolNo
DidUserFollowformboolNo
CanBeSharedformboolNo
ScoreformshortNo
ApprovedDateformDateTime?No
ItemStatuses Enum:
NameValue
Draft0
Pending1
Rejected2
Published10
Archived11
Blocked12
Deleted99
ItemStates Enum:
NameValue
New0
Exist10
Archived11
Bloked12
Deleted99
UserInfo Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
UserNameformstringNo
FirstNameformstringNo
UserFullNameformstringNo
SurnameformstringNo
NickNameformstringNo
ProfileImageformMediaDTONo
UserSocialInfoformUserSocialInfoDTONo
AvatarformstringNo
UserSocialInfoDTO Parameters:
NameParameterData TypeRequiredDescription
AvgRateformdoubleNo
RateCountformintNo
LikeCountformintNo
BanCountformintNo
BannedCountformintNo
FollowCountformintNo
FollowedCountformintNo
ActivePostCountformintNo
ViewCountformintNo
DidUserLikeformboolNo
DidUserBanformboolNo
DidUserBannedformboolNo
DidUserRateformboolNo
DidUserFollowformboolNo
DidUserFollowedformboolNo
WeekOpenHours Parameters:
NameParameterData TypeRequiredDescription
OpenHoursIdformint?No
Open7x24formboolNo
OfflinePOYnformboolNo
Day1formDayOpenHoursNo
Day2formDayOpenHoursNo
Day3formDayOpenHoursNo
Day4formDayOpenHoursNo
Day5formDayOpenHoursNo
Day6formDayOpenHoursNo
Day7formDayOpenHoursNo
ActionformDBActionNo
DayOpenHours Parameters:
NameParameterData TypeRequiredDescription
OpenHourIdformintNo
WeekDayformintNo
IsOpenformboolNo
StartformTimeSpan?No
EndformTimeSpan?No
ChatMethods Enum:
NameValue
NoChat0
Platform1
External2
VersionStatus Enum:
NameValue
AddOrEdit1
Approved2
DeleteRequest3
Deleted4
StoreCustomDto Parameters:
NameParameterData TypeRequiredDescription
StoreIdformintNo
StoreCustomIdformintNo
ExternalYnformboolNo
ExtProviderIdformExternalProvidersNo
ExtProviderformstringNo
SecretKeyformstringNo
ApiKeyformstringNo
ChatMethodformChatMethodsNo
TransTrackMethodformTransactionTrackMethodsNo
NotificationMethodformNotificationMethodsNo
StockCodeControlYnformboolNo
PreferedShipmentTypeformShipmentTypesNo
PreferedShipmentMethodIdformShippingCompanies?No
PreferedReturnShipmentTypeformShipmentTypesNo
PreferedReturnShipmentMethodIdformShippingCompanies?No
PreferedReturnShipmentDescriptionformstringNo
ExtensionDataformstringNo
ExternalProviders Enum:
NameValue
Needion0
Ayensoft1
Entegra2
StockMount11
TransactionTrackMethods Enum:
NameValue
Platform1
External2
NotificationMethods Enum:
NameValue
None0
OnlyFCM1
All2
ShipmentTypes Enum:
NameValue
None0
Online1
Manual2
External3
ShippingCompanies Enum:
NameValue
YurticiKargo1
ArasKargo2
UPSKargo3
MNGKargo4
SuratKargo5
DHLKargo6
PTTKargo8
StoreRegionDTO Parameters:
NameParameterData TypeRequiredDescription
StoreRegionIdformint?No
StateIdformintNo
CityIdformintNo
StoreIdformintNo
ActionformDBActionNo
StoreDepartmentDTO Parameters:
NameParameterData TypeRequiredDescription
DepartmentIdformint?No
DepartmentNameformstringNo
DepartmentCodeformstringNo
ActionformDBActionNo
StoreReviewDTO Parameters:
NameParameterData TypeRequiredDescription
ReviewIdformintNo
UserformUserInfoNo
ReviewTextformstringNo
RateformdoubleNo
ReviewDateformDateTimeNo
HideUserformboolNo
LikeCntformintNo
UnLikeCntformintNo
StoreAccoutingDTO Parameters:
NameParameterData TypeRequiredDescription
StoreIdformintNo
StoreTypeformStoreTypesNo
OfficalNameformstringNo
TaxOfficeformstringNo
TaxNumberformstringNo
TaxNumberVerifiedformboolNo
PaymentBankIdformshort?No
PaymentIBANformstringNo
PaymentIBANVerifiedformboolNo
PaymentIBANFirstNameformstringNo
PaymentIBANSurNameformstringNo
Address1formstringNo
DistrictIdformint?No
CityIdformint?No
StateIdformint?No
CountryIdformint?No
ApplyDefaultCommisionRateYnformboolNo
CommisionRateformdecimalNo
StoreTypes Enum:
NameValue
Personel1
PrivateCompany2
LimitedCompany3
StoreViewSettings Parameters:
NameParameterData TypeRequiredDescription
BreadCrumbformList<SmCategoryMetaDTO>No
StoreSettingformStoreSettingsNo
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
StoreSettings Parameters:
NameParameterData TypeRequiredDescription
UseMapInStoreformUseTypesNo
UseStoreDescformUseTypesNo
UseStoreSummaryformUseTypesNo
AllowActiveLocationformboolNo
AllowRouteMessageformboolNo
MaxMediaCountformintNo
UseDepartmentYnformboolNo
UseMinAmountForOrderformboolNo
AllowEmptyOrCustomBasketformboolNo
UseDeliveryMethodsformboolNo
AllowDeliveryToAddressformboolNo
AllowDeliveryInStoreformboolNo
AllowDeliveryByCargoformboolNo
ShippingPriceYnformboolNo
UseAmountPerDistanceformboolNo
UseAmountPerMinuteformboolNo
UseOpenHoursformboolNo
DefaultMinAmountForOrderformintNo
UseAverageServiceTimeformboolNo
DefaultAverageServiceTimeformintNo
UseMaxDeliveryDistanceformboolNo
DefaultMaxDistanceformintNo
PaymentWithNeedionformboolNo
PaymentOnAddresYnformboolNo
DefaultCommissionRateformdecimalNo
UseTypes Enum:
NameValue
None0
Optional1
Required2
GetStoreDetailResponse Parameters:
NameParameterData TypeRequiredDescription
StoreDetailformStoreDetailDTONo
ViewSettingformStoreViewSettingsNo

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

HTTP + JSV

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

POST /Store/GetStoreDetail/{Storeid} HTTP/1.1 
Host: baseservices.needion.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	StoreId: 0,
	UserId: 0,
	Url: String,
	UserLocation: 
	{
		Lon: String,
		Lat: String,
		GeoAddress: String,
		IsDeleted: False
	},
	IncludeSettingYn: False,
	start: 2021-10-27T07:56:12.3935570+03:00,
	DeviceUUID: String,
	APIKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	StoreDetail: 
	{
		DeliveryAddress: String,
		DeliveryStateId: 0,
		DeliveryCityId: 0,
		DeliveryDistrictId: 0,
		UseSameAddress: False,
		ReturnDeliveryAddress: String,
		ReturnDeliveryStateId: 0,
		ReturnDeliveryCityId: 0,
		ReturnDeliveryDistrictId: 0,
		UseSameAddressForReturn: False,
		StoreMedias: 
		[
			{
				PostId: 0,
				MediaId: 0,
				MediaType: 0,
				Source: String,
				MediaFileName: String,
				MediaMime: String,
				IsMain: False,
				RefId: 0,
				OrderNum: 0,
				Action: 0,
				IsDeleted: False,
				FriendlyURL: String,
				PostVariantA1Key: String,
				SourceUrl: String,
				ActiveYn: False
			}
		],
		StoreRegions: 
		[
			{
				StoreRegionId: 0,
				StateId: 0,
				CityId: 0,
				StoreId: 0,
				Action: 0
			}
		],
		Departments: 
		[
			{
				DepartmentId: 0,
				DepartmentName: String,
				DepartmentCode: String,
				Action: 0
			}
		],
		Reviews: 
		[
			{
				ReviewId: 0,
				User: 
				{
					UserId: 0,
					UserName: String,
					FirstName: String,
					UserFullName: String,
					Surname: String,
					NickName: String,
					ProfileImage: 
					{
						PostId: 0,
						MediaId: 0,
						MediaType: 0,
						Source: String,
						MediaFileName: String,
						MediaMime: String,
						IsMain: False,
						RefId: 0,
						OrderNum: 0,
						Action: 0,
						IsDeleted: False,
						FriendlyURL: String,
						PostVariantA1Key: String,
						SourceUrl: String,
						ActiveYn: False
					},
					UserSocialInfo: 
					{
						AvgRate: 0,
						RateCount: 0,
						LikeCount: 0,
						BanCount: 0,
						BannedCount: 0,
						FollowCount: 0,
						FollowedCount: 0,
						ActivePostCount: 0,
						ViewCount: 0,
						DidUserLike: False,
						DidUserBan: False,
						DidUserBanned: False,
						DidUserRate: False,
						DidUserFollow: False,
						DidUserFollowed: False
					},
					Avatar: String
				},
				ReviewText: String,
				Rate: 0,
				ReviewDate: 0001-01-01,
				HideUser: False,
				LikeCnt: 0,
				UnLikeCnt: 0
			}
		],
		StoreAccoutingInfo: 
		{
			StoreId: 0,
			StoreType: 1,
			OfficalName: String,
			TaxOffice: String,
			TaxNumber: String,
			TaxNumberVerified: False,
			PaymentBankId: 0,
			PaymentIBAN: String,
			PaymentIBANVerified: False,
			PaymentIBANFirstName: String,
			PaymentIBANSurName: String,
			Address1: String,
			DistrictId: 0,
			CityId: 0,
			StateId: 0,
			CountryId: 0,
			ApplyDefaultCommisionRateYn: False,
			CommisionRate: 0
		},
		PostCount: 0,
		HasSalerAgreementApproved: False,
		HasIyzicoAgreementApproved: False,
		StoreId: 0,
		StoreName: String,
		StoreHeader: String,
		Summary: String,
		Description: String,
		PostTypeId: 0,
		Location: 
		{
			Lon: String,
			Lat: String,
			GeoAddress: String,
			IsDeleted: False
		},
		Badges: 
		[
			{
				BadgeId: 0,
				ItemId: 0,
				BadgeTypeId: 0,
				StartDate: 0001-01-01,
				EndDate: 0001-01-01,
				Priorty: 0,
				ActiveYn: False
			}
		],
		MainMedia: 
		{
			PostId: 0,
			MediaId: 0,
			MediaType: 0,
			Source: String,
			MediaFileName: String,
			MediaMime: String,
			IsMain: False,
			RefId: 0,
			OrderNum: 0,
			Action: 0,
			IsDeleted: False,
			FriendlyURL: String,
			PostVariantA1Key: String,
			SourceUrl: String,
			ActiveYn: False
		},
		SocialInfo: 
		{
			AvgRate: 0,
			RateCount: 0,
			Rate1Count: 0,
			Rate2Count: 0,
			Rate3Count: 0,
			Rate4Count: 0,
			Rate5Count: 0,
			LikeCount: 0,
			FollowCount: 0,
			ViewCount: 0,
			DidUserLike: False,
			DidUserRate: False,
			DidUserFollow: False,
			CanBeShared: False,
			Score: 0,
			ApprovedDate: 0001-01-01
		},
		StoreStatus: 0,
		StoreState: 0,
		UserId: 0,
		Owner: 
		{
			UserId: 0,
			UserName: String,
			FirstName: String,
			UserFullName: String,
			Surname: String,
			NickName: String,
			ProfileImage: 
			{
				PostId: 0,
				MediaId: 0,
				MediaType: 0,
				Source: String,
				MediaFileName: String,
				MediaMime: String,
				IsMain: False,
				RefId: 0,
				OrderNum: 0,
				Action: 0,
				IsDeleted: False,
				FriendlyURL: String,
				PostVariantA1Key: String,
				SourceUrl: String,
				ActiveYn: False
			},
			UserSocialInfo: 
			{
				AvgRate: 0,
				RateCount: 0,
				LikeCount: 0,
				BanCount: 0,
				BannedCount: 0,
				FollowCount: 0,
				FollowedCount: 0,
				ActivePostCount: 0,
				ViewCount: 0,
				DidUserLike: False,
				DidUserBan: False,
				DidUserBanned: False,
				DidUserRate: False,
				DidUserFollow: False,
				DidUserFollowed: False
			},
			Avatar: String
		},
		Action: 0,
		SaleLocalYn: False,
		SaleCountryYn: False,
		DeliveryToAddressYn: False,
		DeliveryInStoreYn: False,
		DeliveryByCargo: False,
		OpenYn: False,
		ShippingPriceYn: False,
		ShippingAmount: 0,
		ShippingUpperLimit: 0,
		ShippingUpperAmount: 0,
		MaxDistance: 0,
		Distance: 0,
		MapAvatar: String,
		StartDate: 0001-01-01,
		EndDate: 0001-01-01,
		OpenHours: 
		{
			OpenHoursId: 0,
			Open7x24: False,
			OfflinePOYn: False,
			Day1: 
			{
				OpenHourId: 0,
				WeekDay: 0,
				IsOpen: False,
				Start: PT0S,
				End: PT0S
			},
			Day2: 
			{
				OpenHourId: 0,
				WeekDay: 0,
				IsOpen: False,
				Start: PT0S,
				End: PT0S
			},
			Day3: 
			{
				OpenHourId: 0,
				WeekDay: 0,
				IsOpen: False,
				Start: PT0S,
				End: PT0S
			},
			Day4: 
			{
				OpenHourId: 0,
				WeekDay: 0,
				IsOpen: False,
				Start: PT0S,
				End: PT0S
			},
			Day5: 
			{
				OpenHourId: 0,
				WeekDay: 0,
				IsOpen: False,
				Start: PT0S,
				End: PT0S
			},
			Day6: 
			{
				OpenHourId: 0,
				WeekDay: 0,
				IsOpen: False,
				Start: PT0S,
				End: PT0S
			},
			Day7: 
			{
				OpenHourId: 0,
				WeekDay: 0,
				IsOpen: False,
				Start: PT0S,
				End: PT0S
			},
			Action: 0
		},
		AlwAct: 0,
		MinAmountForOrder: 0,
		AverageServiceTime: 0,
		ClosedYn: False,
		FriendlyURL: String,
		CategoryId: 0,
		CategoryKey: String,
		ChatMethod: 0,
		AllowPaymentOnAddres: False,
		AllowedPayments: String,
		AttributeData: String,
		AttributeMeta: String,
		GeoAddress: String,
		VersionStatus: 1,
		BlockedYn: False,
		Email: String,
		Phone: String,
		StatusInfoHashTag: String,
		StatusInfoText: String,
		TrustedYn: False,
		StoreCustom: 
		{
			StoreId: 0,
			StoreCustomId: 0,
			ExternalYn: False,
			ExtProviderId: 0,
			ExtProvider: String,
			SecretKey: String,
			ApiKey: String,
			ChatMethod: 0,
			TransTrackMethod: 1,
			NotificationMethod: 0,
			StockCodeControlYn: False,
			PreferedShipmentType: 0,
			PreferedShipmentMethodId: 0,
			PreferedReturnShipmentType: 0,
			PreferedReturnShipmentMethodId: 0,
			PreferedReturnShipmentDescription: String,
			ExtensionData: String
		}
	},
	ViewSetting: 
	{
		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
			}
		],
		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
		}
	},
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ErrorCode: String,
		ErrorDescription: String
	},
	PageInfo: 
	{
		TotalRecordCount: 0,
		TotalPageCount: 0,
		CurrentPage: 0
	}
}