All Verbs | /service/QueryProductTagKinds | ||
---|---|---|---|
All Verbs | /service/QueryProductTagGroups |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Search | query | string | No | |
TagCriteria | query | Dictionary<string, HashSet<String>> | No | |
IncludePricing | query | bool | No | |
IncludeNonSellable | query | bool | No | |
IncludeInactive | query | bool | No | |
IncludeLabels | query | bool | No | |
IncludeMedia | query | bool | No | |
RetailerId | query | string | No | |
CartId | query | string | No | |
Id | query | string | No | |
ListId | query | string | No | |
PriceListId | query | string | No | |
KitId | query | string | No | |
Active | query | bool? | No | |
IsNew | query | bool? | No | |
Recent | query | double? | No | |
Status | query | string | No | |
Scan | query | string | No | |
IdIn | query | string[] | No | |
ManufacturerNumberIn | query | string[] | No | |
UpcCodeIn | query | string[] | No | |
StockListId | 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 | 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 | K | 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 |
---|---|---|---|---|
Status | form | string | No | |
Reason | form | string | No | |
InputId | form | string | No | |
InputIndex | form | int | No | |
CityStates | form | CityEntry[] | No | |
ZipCodes | form | ZipCodeEntry[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
City | form | string | No | |
MailableCity | form | bool | No | |
StateAbbreviation | form | string | No | |
State | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ZipCode | form | string | No | |
ZipCodeType | form | string | No | |
DefaultCity | form | string | No | |
CountyFips | form | string | No | |
CountyName | form | string | No | |
StateAbbreviation | form | string | No | |
State | form | string | No | |
Latitude | form | double | No | |
Longitude | form | double | No | |
Precision | form | string | No | |
AlternateCounties | form | AlternateCounty[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CountyFips | form | string | No | |
CountyName | form | string | No | |
StateAbbreviation | form | string | No | |
State | 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/QueryProductTagKinds HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
search: String,
tagCriteria:
{
String:
[
String
]
},
includePricing: False,
includeNonSellable: False,
includeInactive: False,
includeLabels: False,
includeMedia: False,
retailerId: String,
cartId: String,
id: String,
listId: String,
priceListId: String,
kitId: String,
active: False,
isNew: False,
recent: 0,
status: String,
scan: String,
idIn:
[
String
],
manufacturerNumberIn:
[
String
],
upcCodeIn:
[
String
],
stockListId: 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: [ { tagKind: String, tagLabel: String, count: 0 } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }