YM REST Services

Products

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin	Requires any of the permissions:	/admin/store/, /admin/events/

The following routes are available for this service:
GET	/Ams/{ClientID}/Products	Get list of a products for client.
GET	/Ams/{ClientID}/Products/{id}	Get the details of a product.

**Products** Parameters:
Name	Parameter	Data Type	Required	Description
id	path	int	No

**BaseDto** Parameters:
Name	Parameter	Data Type	Required
UsingRedis	form	bool	No
AppInitTime	form	DateTime	No
ServerID	form	string	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**ProductResponse** Parameters:
Name	Parameter	Data Type	Required
weight	form	double	No
hasSpecialTaxRate	form	bool	No
PrimaryCategory	form	string	No
ProductActive	form	int	No
IsFeatured	form	bool	No
ListInStore	form	bool	No
BuyFromStore	form	bool?	No
TagLine	form	string	No
SizeType	form	string	No
ColorOptions	form	string	No
CustomFieldName	form	string	No
CustomFieldOptions	form	string	No
ProductDescription	form	string	No
SpecialInstructions	form	string	No
RequireResponse	form	bool	No
ProductGroup	form	string	No
IsAutoPromoCode	form	bool	No
AutoPromoCode	form	AutoPromoCode	No
Freestone	form	FreestoneProduct	No
PathLMSProductID	form	int	No

**InvoiceItem** Parameters:
Name	Parameter	Data Type	Required
itemTypeId	form	string	No
id	form	int	No
shippingCost	form	double	No
description	form	string	No
customDescription	form	string	No
taxRate	form	double	No
taxGLCode	form	string	No
quantity	form	double	No
amount	form	double	No
isProRated	form	bool	No
GLCode	form	string	No
isModifier	form	bool	No
isDuesRule	form	bool	No
taxQBClass	form	string	No
QBClass	form	string	No
sku	form	string	No
taxable	form	bool	No
autoPromoCodeAmount	form	double	No
autoPromoCodeTitle	form	string	No
salesDiscount	form	double	No
AutoPromoCode	form	AutoPromoCode	No

**AutoPromoCode** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Title	form	string	No
IsPercent	form	bool	No
Discount	form	double	No

**FreestoneProduct** Parameters:
Name	Parameter	Data Type	Required
IsFreestoneProduct	form	bool	No
ProductTypeId	form	int?	No
CourseTypeId	form	int?	No

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.

GET /Ams/{ClientID}/Products HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	weight: 0,
	hasSpecialTaxRate: False,
	PrimaryCategory: String,
	ProductActive: 0,
	IsFeatured: False,
	ListInStore: False,
	BuyFromStore: False,
	TagLine: String,
	SizeType: String,
	ColorOptions: String,
	CustomFieldName: String,
	CustomFieldOptions: String,
	ProductDescription: String,
	SpecialInstructions: String,
	RequireResponse: False,
	ProductGroup: String,
	IsAutoPromoCode: False,
	AutoPromoCode: 
	{
		Id: 0,
		Title: String,
		IsPercent: False,
		Discount: 0
	},
	Freestone: 
	{
		IsFreestoneProduct: False,
		ProductTypeId: 0,
		CourseTypeId: 0
	},
	PathLMSProductID: 0,
	itemTypeId: String,
	id: 0,
	shippingCost: 0,
	description: String,
	customDescription: String,
	taxRate: 0,
	taxGLCode: String,
	quantity: 0,
	amount: 0,
	isProRated: False,
	GLCode: String,
	isModifier: False,
	isDuesRule: False,
	taxQBClass: String,
	QBClass: String,
	sku: String,
	taxable: False,
	autoPromoCodeAmount: 0,
	autoPromoCodeTitle: String,
	salesDiscount: 0
}