Needio.Services

<back to all web services

GetProductDetailRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/Product/GetProductDetail/{ProductId}
GetProductDetailRequest Parameters:
NameParameterData TypeRequiredDescription
ProductIdpathintNo
UrlquerystringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetProductDetailResponse Parameters:
NameParameterData TypeRequiredDescription
ProductDtoformProductDtoNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
ProductDto Parameters:
NameParameterData TypeRequiredDescription
PostIdformintNo
ProductIdformintNo
ProductNameformstringNo
ProductKeyformGuidNo
ProductHeaderformstringNo
SummaryformstringNo
DescriptionformstringNo
ProductTypeIdformshortNo
MainMediaformMediaDTONo
ListPriceformdecimal?No
SalePriceformdecimal?No
ProductStatusformItemStatusesNo
ProductStateformItemStatesNo
PriceTypeformPriceTypesNo
PublishYnformboolNo
ActiveYnformboolNo
ShippingAmountformdecimal?No
ShippingDeciformdecimal?No
StartDateformDateTime?No
EndDateformDateTime?No
CategoryIdformshortNo
CategoryKeyformstringNo
CategoryNameformstringNo
StockTypeformStockTypesNo
StockCodeformstringNo
EANCodeformstringNo
NSKUformstringNo
NeedionRateformdecimalNo
NeedionDescriptionformstringNo
VersionStatusformVersionStatusNo
VersionNoformintNo
BrandIdformint?No
BrandKeyformstringNo
BrandNameformstringNo
VAttr1IdformintNo
VAttr2IdformintNo
VAttr3IdformintNo
VAttr4IdformintNo
VAttr1MetaformstringNo
VAttr2MetaformstringNo
VAttr3MetaformstringNo
VAttr4MetaformstringNo
FriendlyUrlformstringNo
BannerContentformstringNo
SliderContentformstringNo
BackgroundMediaformstringNo
ProductMediasformList<MediaDTO>No
PositivePointsformList<ProductPointDto>No
NegativePointsformList<ProductPointDto>No
ProductVariantsformList<ProductVariantDto>No
AttributeDataformList<AttributeDto>No
ProductReviewsformList<ProductReviewDTO>No
ActionformDBActionNo
PublishReviewYnformboolNo
VAttr1DefformSmAttributeDefDTONo
VAttr2DefformSmAttributeDefDTONo
VAttr3DefformSmAttributeDefDTONo
VAttr4DefformSmAttributeDefDTONo
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
ItemStatuses Enum:
NameValue
Draft0
Pending1
Rejected2
Published10
Archived11
Blocked12
Deleted99
ItemStates Enum:
NameValue
New0
Exist10
Archived11
Bloked12
Deleted99
PriceTypes Enum:
NameValue
NoPrice0
SinglePrice1
MultiVariant2
PriceRange3
StockTypes Enum:
NameValue
Infinite0
QuantityStock1
VersionStatus Enum:
NameValue
AddOrEdit1
Approved2
DeleteRequest3
Deleted4
ProductPointDto Parameters:
NameParameterData TypeRequiredDescription
PointTextformstringNo
RateformdoubleNo
IsAdvformboolNo
OrderformintNo
ProductVariantDto Parameters:
NameParameterData TypeRequiredDescription
ProductVariantIdformintNo
ProductIdformintNo
VariantKeyformGuidNo
VariantNameformstringNo
VariantDescriptionformstringNo
StockCodeformstringNo
EANCodeformstringNo
NSKUformstringNo
ListPriceformdecimalNo
SalePriceformdecimalNo
A1KeyformstringNo
A1ValueformstringNo
A2KeyformstringNo
A2ValueformstringNo
A3KeyformstringNo
A3ValueformstringNo
A4KeyformstringNo
A4ValueformstringNo
ActionformDBActionNo
AttributeDto Parameters:
NameParameterData TypeRequiredDescription
AttributeDefIdformshortNo
LabelTextformstringNo
KeysformstringNo
ValuesformstringNo
ProductReviewDTO Parameters:
NameParameterData TypeRequiredDescription
ProductReviewIdformintNo
ParentIdformint?No
UserIdformintNo
ProductIdformintNo
RateformshortNo
ReviewTextformstringNo
ReviewDateformDateTimeNo
StatusformPostReviewStatusesNo
ApproveDateformDateTime?No
ApprovedByformint?No
OrgTextformstringNo
RejectReasonformstringNo
HideUserYnformbool?No
QProductExplanationformshort?No
ReviewCodeformstringNo
ProductReviewsformList<ProductReviewDTO>No
UserformUserInfoNo
PostReviewStatuses Enum:
NameValue
Unknown0
Approved1
Rejected2
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
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
GetProductDetailResponse Parameters:
NameParameterData TypeRequiredDescription
ProductDtoformProductDtoNo

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 /Product/GetProductDetail/{ProductId} HTTP/1.1 
Host: baseservices.needion.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ProductId: 0,
	Url: String,
	start: 2021-10-27T07:57:02.6601591+03:00,
	DeviceUUID: String,
	APIKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ProductDto: 
	{
		PostId: 0,
		ProductId: 0,
		ProductName: String,
		ProductKey: 00000000000000000000000000000000,
		ProductHeader: String,
		Summary: String,
		Description: String,
		ProductTypeId: 0,
		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
		},
		ListPrice: 0,
		SalePrice: 0,
		ProductStatus: 0,
		ProductState: 0,
		PriceType: 0,
		PublishYn: False,
		ActiveYn: False,
		ShippingAmount: 0,
		ShippingDeci: 0,
		StartDate: 0001-01-01,
		EndDate: 0001-01-01,
		CategoryId: 0,
		CategoryKey: String,
		CategoryName: String,
		StockType: 0,
		StockCode: String,
		EANCode: String,
		NSKU: String,
		NeedionRate: 0,
		NeedionDescription: String,
		VersionStatus: 1,
		VersionNo: 0,
		BrandId: 0,
		BrandKey: String,
		BrandName: String,
		VAttr1Id: 0,
		VAttr2Id: 0,
		VAttr3Id: 0,
		VAttr4Id: 0,
		VAttr1Meta: String,
		VAttr2Meta: String,
		VAttr3Meta: String,
		VAttr4Meta: String,
		FriendlyUrl: String,
		BannerContent: String,
		SliderContent: String,
		BackgroundMedia: String,
		ProductMedias: 
		[
			{
				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
			}
		],
		PositivePoints: 
		[
			{
				PointText: String,
				Rate: 0,
				IsAdv: False,
				Order: 0
			}
		],
		NegativePoints: 
		[
			{
				PointText: String,
				Rate: 0,
				IsAdv: False,
				Order: 0
			}
		],
		ProductVariants: 
		[
			{
				ProductVariantId: 0,
				ProductId: 0,
				VariantKey: 00000000000000000000000000000000,
				VariantName: String,
				VariantDescription: String,
				StockCode: String,
				EANCode: String,
				NSKU: String,
				ListPrice: 0,
				SalePrice: 0,
				A1Key: String,
				A1Value: String,
				A2Key: String,
				A2Value: String,
				A3Key: String,
				A3Value: String,
				A4Key: String,
				A4Value: String,
				Action: 0
			}
		],
		AttributeData: 
		[
			{
				AttributeDefId: 0,
				LabelText: String,
				Keys: String,
				Values: String
			}
		],
		ProductReviews: 
		[
			{
				ProductReviewId: 0,
				ParentId: 0,
				UserId: 0,
				ProductId: 0,
				Rate: 0,
				ReviewText: String,
				ReviewDate: 0001-01-01,
				Status: 0,
				ApproveDate: 0001-01-01,
				ApprovedBy: 0,
				OrgText: String,
				RejectReason: String,
				HideUserYn: False,
				QProductExplanation: 0,
				ReviewCode: String,
				ProductReviews: 
				[
					{
						ProductReviewId: 0,
						ParentId: 0,
						UserId: 0,
						ProductId: 0,
						Rate: 0,
						ReviewText: String,
						ReviewDate: 0001-01-01,
						Status: 0,
						ApproveDate: 0001-01-01,
						ApprovedBy: 0,
						OrgText: String,
						RejectReason: String,
						HideUserYn: False,
						QProductExplanation: 0,
						ReviewCode: String,
						ProductReviews: 
						[
							{
								ProductReviewId: 0,
								ParentId: 0,
								UserId: 0,
								ProductId: 0,
								Rate: 0,
								ReviewText: String,
								ReviewDate: 0001-01-01,
								Status: 0,
								ApproveDate: 0001-01-01,
								ApprovedBy: 0,
								OrgText: String,
								RejectReason: String,
								HideUserYn: False,
								QProductExplanation: 0,
								ReviewCode: String,
								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
								}
							}
						],
						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
						}
					}
				],
				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
				}
			}
		],
		Action: 0,
		PublishReviewYn: False,
		VAttr1Def: 
		{
			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
		},
		VAttr2Def: 
		{
			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
		},
		VAttr3Def: 
		{
			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
		},
		VAttr4Def: 
		{
			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
		}
	},
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ErrorCode: String,
		ErrorDescription: String
	},
	PageInfo: 
	{
		TotalRecordCount: 0,
		TotalPageCount: 0,
		CurrentPage: 0
	}
}