All Verbs | /service/QueryProductRecommendations |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BrandId | query | string | No | |
ProductCategory1In | query | string[] | No | |
ProductCategory2In | query | string[] | No | |
ProductCategory3In | query | string[] | No | |
RetailerCategory1In | query | string[] | No | |
RetailerCategory2In | query | string[] | No | |
RetailerCategory3In | query | 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 |
---|---|---|---|---|
Id | form | Guid | No | |
ProductId | form | string | No | |
BrandId | form | string | No | |
ProductCategory1 | form | string | No | |
ProductCategory2 | form | string | No | |
ProductCategory3 | form | string | No | |
RetailerCategory1 | form | string | No | |
RetailerCategory2 | form | string | No | |
RetailerCategory3 | form | string | No | |
TotalSales | form | double | No | |
TotalQty | form | int | No | |
TotalOrders | form | int | No | |
Product | form | Product | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | K | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
ProductLineId | form | string | No | |
ManufacturerNumber | form | string | No | |
ShortDescription | form | string | No | |
LongDescription | form | string | No | |
AltDescription | form | string | No | |
UpcCode | form | string | No | |
Status | form | string | No | |
Pricing | form | IDictionary<int, double> | No | |
ListPrice | form | decimal | No | |
WholesalePrice | form | decimal | No | |
RetailPrice | form | decimal? | No | |
RetailListPrice | form | decimal | No | |
UnitsInStock | form | int | No | |
UnitsAllocated | form | int | No | |
Price | form | decimal? | No | |
Unlisted | form | bool | No | |
CategoryId | form | string | No | |
Category | form | ProductCategory | No | |
MinimumOrderQty | form | double | No | |
AvailableQty | form | double | No | |
CaseQty | form | double | No | |
CasePrice | form | decimal | No | |
AvailableOn | form | DateTime? | No | |
IncomingQty | form | double | No | |
PurchaseIncrement | form | double | No | |
OptionGroup | form | string | No | |
OptionGroupList | form | string | No | |
VendorId | form | string | No | |
Vendor | form | Vendor | No | |
IsB2B | form | bool | No | |
IsB2C | form | bool | No | |
IsSellable | form | bool | No | |
IsNonDiscountable | form | bool | No | |
ItemType | form | string | No | |
ImageUrl | form | string | No | |
OnDemandProductEuid | form | string | No | |
Keywords | form | string | No | |
SuperCategory | form | string | No | |
Tags | form | Dictionary<string, HashSet<String>> | No | |
AsShownValues | form | FieldValue[] | No | |
GenericTags | form | List<Tag> | No | |
IsNew | form | bool | No | |
IsRestricted | form | bool | No | |
IsAsShown | form | bool | No | |
IsKit | form | bool | No | |
IsKitExplode | form | bool | No | |
IsKitEditable | form | bool | No | |
Meta | form | Dictionary<string, string> | No | |
IsOnDemand | form | bool | No | |
CreatedOn | form | DateTime | No | |
Weight | form | double | No | |
Height | form | decimal | No | |
Width | form | double | No | |
Length | form | decimal | No | |
CubicVolume | form | double | No | |
MaxNumLines | form | int | No | |
Cost | form | decimal | No | |
UOM | form | string | No | |
SubCategory | form | string | No | |
ShipOn | form | DateTime? | No | |
MainFeatured | form | int | No | |
Featured | form | int | No | |
Likes | form | long | No | |
HasLiked | form | bool | No | |
EnforceMinimum | form | bool | No | |
Points | form | decimal | No | |
Custom9 | form | string | No | |
Warehouse | form | string | No | |
ProductImages | form | List<ProductImage> | No | |
IsDealerVisible | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Label | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Label | form | string | No | |
VendorName | form | string | No | |
Abbreviation | form | string | No | |
OrderMinimum | form | decimal | No | |
ReOrderMinimum | form | decimal | No | |
MinimumBalance | form | decimal | No | |
Active | form | bool | No | |
IsInvoiceOnly | form | bool | No | |
AllowPriceOverride | form | bool | No | |
DefaultShipDatePrevious | form | bool | No | |
EnforceMinimums | form | bool | No | |
EnforcePurchaseIncrement | form | bool | No | |
AllowDiscounts | form | bool | No | |
EmailOrders | form | bool | No | |
AllowBackorders | form | bool | No | |
UseVendorCustId | form | bool | No | |
UseVendorShipId | form | bool | No | |
UseVendorTerms | form | bool | No | |
ExportReviewOrders | form | bool | No | |
EmailUrlToExport | form | bool | No | |
IncludeInBatch | form | bool | No | |
DecryptCCOnExport | form | bool | No | |
CustomerNumber | form | string | No | |
ExportOrders | form | bool | No | |
SplitByProductLine | form | bool | No | |
IsShowroomVendor | form | bool | No | |
AllowManualItemEntry | form | bool | No | |
RequireCreditSheet | form | bool | No | |
Address | form | string | No | |
City | form | string | No | |
State | form | string | No | |
Zip | form | string | No | |
Phone | form | string | No | |
Fax | form | string | No | |
form | string | No | ||
Website | form | string | No | |
Note | form | string | No | |
CommissionPercent | form | decimal | No | |
OrderTagLine | form | string | No | |
ProductTags | form | List<VendorProductTag> | No | |
Settings | form | List<VendorSetting> | No | |
LastLoginAttempt | form | DateTime | No | |
LastOrderedOn | form | DateTime | No | |
Meta | form | Dictionary<string, string> | No | |
Tags | form | Dictionary<string, HashSet<String>> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Tag | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
VendorId | form | string | No | |
Key | form | string | No | |
Value | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FieldId | form | string | No | |
ValueId | form | string | No | |
CustomText | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | double | No | |
Shard | form | string | No | |
PrincipalId | form | string | No | |
TagKind | form | string | No | |
TagLabel | form | string | No | |
ParentTagKind | form | string | No | |
ParentTagLabel | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CreatedBy | form | string | No | |
CreatedOn | form | DateTime | No | |
LastModifiedOn | form | DateTime | No | |
LastModifiedBy | form | string | No | |
Generated | form | bool | No | |
Exported | form | bool | No | |
Position | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ProductId | form | string | No | |
Position | form | int | No | |
CreatedOn | form | DateTime | 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/QueryProductRecommendations HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
brandId: String,
productCategory1In:
[
String
],
productCategory2In:
[
String
],
productCategory3In:
[
String
],
retailerCategory1In:
[
String
],
retailerCategory2In:
[
String
],
retailerCategory3In:
[
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: [ { productId: String, brandId: String, productCategory1: String, productCategory2: String, productCategory3: String, retailerCategory1: String, retailerCategory2: String, retailerCategory3: String, totalSales: 0, totalQty: 0, totalOrders: 0, product: { 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 } } }