Needio.Services

<back to all web services

GetStoreRequest

The following routes are available for this service:
All Verbs/Store/GetStore/{Storeid}
GetStoreRequest Parameters:
NameParameterData TypeRequiredDescription
StoreIdpathintNo
UrlquerystringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetStoreResponse Parameters:
NameParameterData TypeRequiredDescription
StoreformStoreDTONo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
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
UsageTypeformUsageTypesNo
MediaTypeformMediaTypesNo
SourceformstringNo
MediaFileNameformstringNo
MediaMimeformstringNo
IsMainformboolNo
RefIdformint?No
OrderNumformintNo
ActionformDBActionNo
IsDeletedformboolNo
FriendlyURLformstringNo
PostVariantA1KeyformstringNo
SourceUrlformstringNo
ActiveYnformboolNo
UsageTypes Enum:
NameValue
StoreMedias1
StoreFiles2
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
ExtApiKeyformstringNo
ExtSecretKeyformstringNo
ExtStoreCodeformstringNo
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
GetStoreResponse Parameters:
NameParameterData TypeRequiredDescription
StoreformStoreDTONo

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 /Store/GetStore/{Storeid} HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"StoreId":0,"Url":"String","start":"\/Date(1638924904735+0300)\/","DeviceUUID":"String","APIKey":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Store":{"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":"\/Date(-62135596800000-0000)\/","EndDate":"\/Date(-62135596800000-0000)\/","Priorty":0,"ActiveYn":false}],"MainMedia":{"PostId":0,"MediaId":0,"UsageType":1,"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":"\/Date(-62135596800000-0000)\/"},"StoreStatus":0,"StoreState":0,"UserId":0,"Owner":{"UserId":0,"UserName":"String","FirstName":"String","UserFullName":"String","Surname":"String","NickName":"String","ProfileImage":{"PostId":0,"MediaId":0,"UsageType":1,"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":"\/Date(-62135596800000-0000)\/","EndDate":"\/Date(-62135596800000-0000)\/","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","ExtApiKey":"String","ExtSecretKey":"String","ExtStoreCode":"String"}},"Result":false,"ResMessage":"String","Error":{"ErrorYn":false,"ErrorCode":"String","ErrorDescription":"String"},"PageInfo":{"TotalRecordCount":0,"TotalPageCount":0,"CurrentPage":0}}