YM REST Services

StoreProductPromoCodes

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin	Requires the permission:	CanAdminMembers

The following routes are available for this service:
PUT	/Ams/{ClientID}/StoreProductPromoCodes/validate-list	Get list of valid Store Product Promo Codes.
PUT	/Ams/{ClientID}/StoreProductPromoCodes/validate	Validates a Store Product Promo Code.

**StoreProductPromoCodes** Parameters:
Name	Parameter	Data Type	Required
PromoCode	body	string	No
ValidationMode	body	ValidationModes	No
Invoice	body	Invoice	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

**Invoice** Parameters:
Name	Parameter	Data Type	Required
date	form	DateTime	No
shippingMethodId	form	int	No
shippingMethodName	form	string	No
shippingTax	form	double	No
shippingTotal	form	double	No
taxRate	form	double	No
taxTotal	form	double	No
totalAmount	form	double	No
comment	form	string	No
person	form	Person	No
shippingAddress	form	Address	No
invoiceItems	form	List<InvoiceItem>	No
isNewMember	form	bool	No
taxGLCode	form	string	No
taxQBClass	form	string	No
shippingGLCode	form	string	No
shippingQBClass	form	string	No

**Person** Parameters:
Name	Parameter	Data Type	Required
id	form	int	No
organization	form	string	No
firstName	form	string	No
lastName	form	string	No
middleName	form	string	No
nameSuffix	form	string	No
emailAddress	form	string	No
primaryAddress	form	Address	No
username	form	string	No
password	form	string	No
isMember	form	bool	No
expirationDate	form	string	No
currentMembershipAllowsMultipleOpenInvoices	form	bool	No
currentMembershipInvoiceIsOpen	form	bool	No
currentMembershipInvoiceAwaitingAutoBill	form	bool	No

**Address** Parameters:
Name	Parameter	Data Type	Required
firstName	form	string	No
lastName	form	string	No
organization	form	string	No
address1	form	string	No
address2	form	string	No
city	form	string	No
location	form	string	No
postalCode	form	string	No
countryCode	form	string	No
countryName	form	string	No
areaCode	form	string	No
phone	form	string	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

**StoreProductPromoCodesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
StoreProductPromoCodesList	form	List<StoreProductPromoCode>	No
ValidationDescription	form	string	No

**StoreProductPromoCode** Parameters:
Name	Parameter	Data Type	Required	Description
ProductsList	form	List<int>	No

**PromoCode** Parameters:
Name	Parameter	Data Type	Required
PromoCodeID	form	int	No
AppliesToWholeCart	form	int	No
IsAutoPromoCode	form	bool	No
IsPercentDiscountProduct	form	bool	No
IsPercentDiscountShipping	form	bool	No
Expires	form	DateTime	No
Start	form	DateTime	No
DiscountProduct	form	double	No
DiscountShipping	form	double	No
DiscountThreshold	form	double	No
SchoolID	form	int	No
GLCode	form	string	No
QBClass	form	string	No
PromoCodeName	form	string	No
Private	form	int	No
UsageLimit	form	int	No
UsageOnePerUser	form	bool	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.

PUT /Ams/{ClientID}/StoreProductPromoCodes/validate-list HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	PromoCode: String,
	ValidationMode: Single,
	Invoice: 
	{
		date: 0001-01-01,
		shippingMethodId: 0,
		shippingMethodName: String,
		shippingTax: 0,
		shippingTotal: 0,
		taxRate: 0,
		taxTotal: 0,
		totalAmount: 0,
		comment: String,
		person: 
		{
			id: 0,
			organization: String,
			firstName: String,
			lastName: String,
			middleName: String,
			nameSuffix: String,
			emailAddress: String,
			primaryAddress: 
			{
				firstName: String,
				lastName: String,
				organization: String,
				address1: String,
				address2: String,
				city: String,
				location: String,
				postalCode: String,
				countryCode: String,
				countryName: String,
				areaCode: String,
				phone: String
			},
			username: String,
			password: String,
			isMember: False,
			expirationDate: String,
			currentMembershipAllowsMultipleOpenInvoices: False,
			currentMembershipInvoiceIsOpen: False,
			currentMembershipInvoiceAwaitingAutoBill: False,
			UsingRedis: True,
			AppInitTime: 2025-01-15T06:19:47.4297411-05:00,
			ServerID: WS-6-56-398,
			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: 2025-01-15T09:00:26.9303749-05:00,
			Device: Desktop
		},
		shippingAddress: 
		{
			firstName: String,
			lastName: String,
			organization: String,
			address1: String,
			address2: String,
			city: String,
			location: String,
			postalCode: String,
			countryCode: String,
			countryName: String,
			areaCode: String,
			phone: String
		},
		invoiceItems: 
		[
			{
				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,
				AutoPromoCode: 
				{
					Id: 0,
					Title: String,
					IsPercent: False,
					Discount: 0
				}
			}
		],
		isNewMember: False,
		taxGLCode: String,
		taxQBClass: String,
		shippingGLCode: String,
		shippingQBClass: String
	},
	UsingRedis: True,
	AppInitTime: 2025-01-15T06:19:47.4297411-05:00,
	ServerID: WS-6-56-398,
	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: 2025-01-15T09:00:26.9303749-05:00,
	Device: Desktop
}

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

{
	StoreProductPromoCodesList: 
	[
		{
			
		}
	],
	ValidationDescription: String,
	PromoCode: String,
	ValidationMode: Single,
	Invoice: 
	{
		date: 0001-01-01,
		shippingMethodId: 0,
		shippingMethodName: String,
		shippingTax: 0,
		shippingTotal: 0,
		taxRate: 0,
		taxTotal: 0,
		totalAmount: 0,
		comment: String,
		person: 
		{
			id: 0,
			organization: String,
			firstName: String,
			lastName: String,
			middleName: String,
			nameSuffix: String,
			emailAddress: String,
			primaryAddress: 
			{
				firstName: String,
				lastName: String,
				organization: String,
				address1: String,
				address2: String,
				city: String,
				location: String,
				postalCode: String,
				countryCode: String,
				countryName: String,
				areaCode: String,
				phone: String
			},
			username: String,
			password: String,
			isMember: False,
			expirationDate: String,
			currentMembershipAllowsMultipleOpenInvoices: False,
			currentMembershipInvoiceIsOpen: False,
			currentMembershipInvoiceAwaitingAutoBill: False,
			UsingRedis: True,
			AppInitTime: 2025-01-15T06:19:47.4297411-05:00,
			ServerID: WS-6-56-398,
			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: 2025-01-15T09:00:26.9461076-05:00,
			Device: Desktop
		},
		shippingAddress: 
		{
			firstName: String,
			lastName: String,
			organization: String,
			address1: String,
			address2: String,
			city: String,
			location: String,
			postalCode: String,
			countryCode: String,
			countryName: String,
			areaCode: String,
			phone: String
		},
		invoiceItems: 
		[
			{
				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,
				AutoPromoCode: 
				{
					Id: 0,
					Title: String,
					IsPercent: False,
					Discount: 0
				}
			}
		],
		isNewMember: False,
		taxGLCode: String,
		taxQBClass: String,
		shippingGLCode: String,
		shippingQBClass: String
	},
	UsingRedis: True,
	AppInitTime: 2025-01-15T06:19:47.4297411-05:00,
	ServerID: WS-6-56-398,
	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: 2025-01-15T09:00:26.9461076-05:00,
	Device: Desktop
}