EMUN1 ASP.NET

<back to all web services

CheckPromotions

Requires Authentication
The following routes are available for this service:
All Verbs/service/CheckPromotions
All Verbs/service/CheckPromotions/{CartId}
CheckPromotions Parameters:
NameParameterData TypeRequiredDescription
CartIdpathstringNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Promotions Parameters:
NameParameterData TypeRequiredDescription
strPromotionCodeformstringNo
strPromotionDescformstringNo
dblQualifyAmountformdouble?No
strPromotionTypeformstringNo
strRewardTypeformstringNo
strDiscountFromformstringNo
strFreeProductformstringNo
dblDiscountPercentformdouble?No
dblDiscountDollarformdouble?No
strSpecialTermformstringNo
strNoteformstringNo
dtmStartDateformDateTime?No
dtmEndDateformDateTime?No
dtmShipBeforeformDateTime?No
strProductLineIDformstringNo
strCategoryformstringNo
strSubCategoryformstringNo
strProductIDformstringNo
ysnApplyWholeOrderformboolNo
strWarehouseformstringNo
dtmShipAfterformDateTime?No
intNumShipDaysformint?No
strBrandIDformstringNo
ysnMultipleOrdersformboolNo
ysnSameShipDateformboolNo
ysnExistingTermQualifiesformboolNo
ysnAllowCancelDateformboolNo
ysnIncludeInMultiOrderformboolNo
ysnAllowTermReplaceformboolNo
ysnAllowDiscountReplaceformboolNo
ysnReplaceDiscountformboolNo
ysnCombineDiscountformboolNo
ysnNotAllowDiscountOnPriceTierItemsformboolNo
curSalesPriceformdouble?No
ysnRequireEmailformboolNo
intPriorityformint?No
strOrderSourceformstringNo
strGeneratedFromformstringNo
strAdvancedCriteriaformstringNo
ysnDisplayOnCheckoutformboolNo
strPriceListformstringNo
ysnOneTimeUseformboolNo
intQualifyQuantityformint?No
dblMaxQualifyAmountformdouble?No
StatusformstringNo
CreatedByformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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 /service/CheckPromotions HTTP/1.1 
Host: www.bernhardthospitality.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	cartId: String,
	skip: 0,
	take: 0,
	orderBy: String,
	orderByDesc: String,
	include: String,
	fields: String,
	meta: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			strPromotionCode: String,
			strPromotionDesc: String,
			dblQualifyAmount: 0,
			strPromotionType: String,
			strRewardType: String,
			strDiscountFrom: String,
			strFreeProduct: String,
			dblDiscountPercent: 0,
			dblDiscountDollar: 0,
			strSpecialTerm: String,
			strNote: String,
			dtmStartDate: 0001-01-01,
			dtmEndDate: 0001-01-01,
			dtmShipBefore: 0001-01-01,
			strProductLineID: String,
			strCategory: String,
			strSubCategory: String,
			strProductID: String,
			ysnApplyWholeOrder: False,
			strWarehouse: String,
			dtmShipAfter: 0001-01-01,
			intNumShipDays: 0,
			strBrandID: String,
			ysnMultipleOrders: False,
			ysnSameShipDate: False,
			ysnExistingTermQualifies: False,
			ysnAllowCancelDate: False,
			ysnIncludeInMultiOrder: False,
			ysnAllowTermReplace: False,
			ysnAllowDiscountReplace: False,
			ysnReplaceDiscount: False,
			ysnCombineDiscount: False,
			ysnNotAllowDiscountOnPriceTierItems: False,
			curSalesPrice: 0,
			ysnRequireEmail: False,
			intPriority: 0,
			strOrderSource: String,
			strGeneratedFrom: String,
			strAdvancedCriteria: String,
			ysnDisplayOnCheckout: False,
			strPriceList: String,
			ysnOneTimeUse: False,
			intQualifyQuantity: 0,
			dblMaxQualifyAmount: 0,
			status: String,
			createdBy: String
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}