All Verbs | /service/CheckPromotions | ||
---|---|---|---|
All Verbs | /service/CheckPromotions/{CartId} |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CartId | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
strPromotionCode | form | string | No | |
strPromotionDesc | form | string | No | |
dblQualifyAmount | form | double? | No | |
strPromotionType | form | string | No | |
strRewardType | form | string | No | |
strDiscountFrom | form | string | No | |
strFreeProduct | form | string | No | |
dblDiscountPercent | form | double? | No | |
dblDiscountDollar | form | double? | No | |
strSpecialTerm | form | string | No | |
strNote | form | string | No | |
dtmStartDate | form | DateTime? | No | |
dtmEndDate | form | DateTime? | No | |
dtmShipBefore | form | DateTime? | No | |
strProductLineID | form | string | No | |
strCategory | form | string | No | |
strSubCategory | form | string | No | |
strProductID | form | string | No | |
ysnApplyWholeOrder | form | bool | No | |
strWarehouse | form | string | No | |
dtmShipAfter | form | DateTime? | No | |
intNumShipDays | form | int? | No | |
strBrandID | form | string | No | |
ysnMultipleOrders | form | bool | No | |
ysnSameShipDate | form | bool | No | |
ysnExistingTermQualifies | form | bool | No | |
ysnAllowCancelDate | form | bool | No | |
ysnIncludeInMultiOrder | form | bool | No | |
ysnAllowTermReplace | form | bool | No | |
ysnAllowDiscountReplace | form | bool | No | |
ysnReplaceDiscount | form | bool | No | |
ysnCombineDiscount | form | bool | No | |
ysnNotAllowDiscountOnPriceTierItems | form | bool | No | |
curSalesPrice | form | double? | No | |
ysnRequireEmail | form | bool | No | |
intPriority | form | int? | No | |
strOrderSource | form | string | No | |
strGeneratedFrom | form | string | No | |
strAdvancedCriteria | form | string | No | |
ysnDisplayOnCheckout | form | bool | No | |
strPriceList | form | string | No | |
ysnOneTimeUse | form | bool | No | |
intQualifyQuantity | form | int? | No | |
dblMaxQualifyAmount | form | double? | No | |
Status | form | string | No | |
CreatedBy | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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 } } }