| All Verbs | /service/QueryPromotionProductsQualify/{PromoCode} |
|---|
| 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/QueryPromotionProductsQualify/{PromoCode} HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
promoCode: 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:
[
{
id: String,
productLineId: String,
manufacturerNumber: String,
shortDescription: String,
longDescription: String,
altDescription: String,
upcCode: String,
status: String,
listPrice: 0,
wholesalePrice: 0,
retailPrice: 0,
retailListPrice: 0,
unitsInStock: 0,
unitsAllocated: 0,
unlisted: False,
categoryId: String,
category:
{
id: String,
label: String
},
minimumOrderQty: 0,
availableQty: 0,
caseQty: 0,
casePrice: 0,
availableOn: 0001-01-01,
incomingQty: 0,
purchaseIncrement: 0,
optionGroup: String,
optionGroupList: String,
vendorId: String,
vendor:
{
id: String,
label: String,
vendorName: String,
abbreviation: String,
orderMinimum: 0,
reOrderMinimum: 0,
minimumBalance: 0,
active: False,
isInvoiceOnly: False,
allowPriceOverride: False,
defaultShipDatePrevious: False,
enforceMinimums: False,
enforcePurchaseIncrement: False,
allowDiscounts: False,
emailOrders: False,
allowBackorders: False,
useVendorCustId: False,
useVendorShipId: False,
useVendorTerms: False,
exportReviewOrders: False,
emailUrlToExport: False,
includeInBatch: False,
decryptCCOnExport: False,
customerNumber: String,
exportOrders: False,
splitByProductLine: False,
isShowroomVendor: False,
allowManualItemEntry: False,
requireCreditSheet: False,
address: String,
city: String,
state: String,
zip: String,
phone: String,
fax: String,
email: String,
website: String,
note: String,
commissionPercent: 0,
orderTagLine: String,
productTags:
[
{
id: String,
tag: String
}
],
settings:
[
{
vendorId: String,
key: String,
value: String
}
],
lastLoginAttempt: 0001-01-01,
lastOrderedOn: 0001-01-01,
meta:
{
String: String
},
tags:
{
String:
[
String
]
}
},
isB2B: False,
isB2C: False,
isSellable: False,
isNonDiscountable: False,
itemType: String,
imageUrl: String,
onDemandProductEuid: String,
keywords: String,
superCategory: String,
tags:
{
String:
[
String
]
},
asShownValues:
[
{
fieldId: String,
valueId: String,
customText: String
}
],
genericTags:
[
{
id: 1312561414.13126,
shard: String,
principalId: String,
tagKind: String,
tagLabel: String,
parentTagKind: String,
parentTagLabel: String,
createdBy: String,
createdOn: 0001-01-01,
lastModifiedOn: 0001-01-01,
lastModifiedBy: String,
generated: False,
exported: False,
position: 0
}
],
isNew: False,
isRestricted: False,
isAsShown: False,
isKit: False,
isKitExplode: False,
isKitEditable: False,
meta:
{
String: String
},
isOnDemand: False,
createdOn: 0001-01-01,
weight: 0,
height: 0,
width: 0,
length: 0,
cubicVolume: 0,
maxNumLines: 0,
cost: 0,
uom: String,
subCategory: String,
shipOn: 0001-01-01,
mainFeatured: 0,
featured: 0,
likes: 1,
hasLiked: False,
enforceMinimum: False,
points: 0,
custom9: String,
warehouse: String,
productImages:
[
{
productId: String,
position: 0,
createdOn: 0001-01-01
}
],
isDealerVisible: False
}
],
meta:
{
String: String
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}