All Verbs | /service/QueryVendors |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Search | query | string | No | |
Id | query | string | No | |
RepId | query | string | No | |
DivisionId | query | string | No | |
TermId | query | string | No | |
VendorGroup | query | string | No | |
includeInactive | query | bool | No | |
RepGroupName | query | string | No | |
LimitVendorByRepGroup | query | bool | 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 | |
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 | K | 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 |
---|---|---|---|---|
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/QueryVendors HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
search: String,
id: String,
repId: String,
divisionId: String,
termId: String,
vendorGroup: String,
includeInactive: False,
repGroupName: String,
limitVendorByRepGroup: False,
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, 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 ] } } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }