YM REST Services

ProductsDto

The following routes are available for this service:
POST	/Ams/{ClientID}/Products	Create Store Product.
PUT	/Ams/{ClientID}/Products	Update Store Product.

**ProductsDto** Parameters:
Name	Parameter	Data Type	Required
ProductID	body	int	No
Details	body	ProductDetails	No
DisplayOptions	body	ProductDisplayOptions	No
ItemOptions	body	ItemOptions	No
PricingOptions	body	Pricing	No
Financial	body	Financial	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

**ProductDetails** Parameters:
Name	Parameter	Data Type	Required
ProductName	form	string	No
ProductCode	form	string	No
ProductActive	form	bool	No
PrimaryCategory	form	string	No
ProductDescription	form	string	No
ProductType	form	int	No

**ProductDisplayOptions** Parameters:
Name	Parameter	Data Type	Required
IsFeatured	form	bool	No
ListInStore	form	bool	No
TagLine	form	string	No
ProductGroup	form	string	No

**ItemOptions** Parameters:
Name	Parameter	Data Type	Required
RequireCustomerResponse	form	bool	No
SpecialInstructions	form	string	No
SizeType	form	string	No
ColorOptions	form	string	No
CustomFieldName	form	string	No
CustomFieldOptions	form	string	No

**Pricing** Parameters:
Name	Parameter	Data Type	Required
ChargeTaxVAT	form	bool	No
ShippingWeight	form	double	No
ShippingSurcharge	form	decimal	No
NonMemberUnitPrice	form	decimal?	No
MemberPricing	form	List<MemberPricing>	No

**MemberPricing** Parameters:
Name	Parameter	Data Type	Required	Description
MemberTypeCode	form	string	No
UnitPrice	form	decimal?	No

**Financial** Parameters:
Name	Parameter	Data Type	Required	Description
GLCode	form	string	No
QuickBooksClass	form	string	No

**ProductsDto** Parameters:
Name	Parameter	Data Type	Required
ProductID	body	int	No
Details	body	ProductDetails	No
DisplayOptions	body	ProductDisplayOptions	No
ItemOptions	body	ItemOptions	No
PricingOptions	body	Pricing	No
Financial	body	Financial	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.

POST /Ams/{ClientID}/Products HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ProductID: 0,
	Details: 
	{
		ProductName: String,
		ProductCode: String,
		ProductActive: False,
		PrimaryCategory: String,
		ProductDescription: String,
		ProductType: 0
	},
	DisplayOptions: 
	{
		IsFeatured: False,
		ListInStore: False,
		TagLine: String,
		ProductGroup: String
	},
	ItemOptions: 
	{
		RequireCustomerResponse: False,
		SpecialInstructions: String,
		SizeType: String,
		ColorOptions: String,
		CustomFieldName: String,
		CustomFieldOptions: String
	},
	PricingOptions: 
	{
		ChargeTaxVAT: False,
		ShippingWeight: 0,
		ShippingSurcharge: 0,
		NonMemberUnitPrice: 0,
		MemberPricing: 
		[
			{
				MemberTypeCode: String,
				UnitPrice: 0
			}
		]
	},
	Financial: 
	{
		GLCode: String,
		QuickBooksClass: String
	},
	UsingRedis: True,
	AppInitTime: 2024-05-03T00:25:28.2378460-04:00,
	ServerID: WS-6-183-431,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2024-05-03T01:04:17.4133170-04:00,
	Device: Desktop
}

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

{
	ProductID: 0,
	Details: 
	{
		ProductName: String,
		ProductCode: String,
		ProductActive: False,
		PrimaryCategory: String,
		ProductDescription: String,
		ProductType: 0
	},
	DisplayOptions: 
	{
		IsFeatured: False,
		ListInStore: False,
		TagLine: String,
		ProductGroup: String
	},
	ItemOptions: 
	{
		RequireCustomerResponse: False,
		SpecialInstructions: String,
		SizeType: String,
		ColorOptions: String,
		CustomFieldName: String,
		CustomFieldOptions: String
	},
	PricingOptions: 
	{
		ChargeTaxVAT: False,
		ShippingWeight: 0,
		ShippingSurcharge: 0,
		NonMemberUnitPrice: 0,
		MemberPricing: 
		[
			{
				MemberTypeCode: String,
				UnitPrice: 0
			}
		]
	},
	Financial: 
	{
		GLCode: String,
		QuickBooksClass: String
	},
	UsingRedis: True,
	AppInitTime: 2024-05-03T00:25:28.2378460-04:00,
	ServerID: WS-6-183-431,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2024-05-03T01:04:17.4133170-04:00,
	Device: Desktop
}