HTTP + JSV
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /service/ApproveRetailer HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: String,
originalId: String,
companyName: String,
address: String,
address2: String,
address3: String,
city: String,
state: String,
zip: String,
country: String,
billingLocation:
{
companyName: String,
personName:
{
full: ""
},
address: String,
address1: String,
address2: String,
city: String,
state: String,
zip: String,
country: String,
meta: {}
},
phone: String,
fax: String,
contact: String,
paymentTerms: String,
shippingMethod: String,
notes: String,
accountType: String,
source: String,
customerType: String,
status: String,
isKeyAccount: False,
doNotUse: False,
isNewAccount: False,
isModified: False,
isCreditHold: False,
isSendSetupForm: False,
residential: False,
email: String,
website: String,
federalTaxID: String,
stateTaxID: String,
stateTaxExpiration: 0001-01-01,
defaultShipOn: 0001-01-01,
apiKey: String,
priceList: String,
containerPriceList: String,
discount: 0,
meta:
{
String: String
},
createdOn: 2024-11-10T03:33:16.3668693+00:00,
lastOrderedOn: 0001-01-01,
lastContactedOn: 0001-01-01,
lastLoginAttempt: 0001-01-01,
salesReps:
[
String
],
storeTypes:
[
String
],
paymentTerm:
{
id: String,
name: String,
isCredit: False,
isStandard: False
},
salesRep:
{
id: String,
name: String,
fullName: String,
userName: String,
address: String,
city: String,
state: String,
zip: String,
country: String,
phone: String,
fax: String,
email: String,
notes: String,
repGroupId: String,
territoryId: String,
regionId: String,
divisionId: String,
bio: String,
startedOn: 0001-01-01,
terminatedOn: 0001-01-01,
bornOn: 0001-01-01,
active: False,
totalSales: 0,
region:
{
id: String,
name: String,
houseAccount: String
},
division:
{
id: String,
name: String,
repGroup: String,
keyAccountGroup: String,
isKeyAccount: False,
salesRepId: String,
salesRep:
{
id: String,
name: String,
fullName: String,
userName: String,
address: String,
city: String,
state: String,
zip: String,
country: String,
phone: String,
fax: String,
email: String,
notes: String,
repGroupId: String,
territoryId: String,
regionId: String,
divisionId: String,
bio: String,
startedOn: 0001-01-01,
terminatedOn: 0001-01-01,
bornOn: 0001-01-01,
active: False,
totalSales: 0,
region:
{
id: String,
name: String,
houseAccount: String
},
division:
{
id: String,
name: String,
repGroup: String,
keyAccountGroup: String,
isKeyAccount: False,
salesRepId: String,
salesRep:
{
id: String,
name: String,
fullName: String,
userName: String,
address: String,
city: String,
state: String,
zip: String,
country: String,
phone: String,
fax: String,
email: String,
notes: String,
repGroupId: String,
territoryId: String,
regionId: String,
divisionId: String,
bio: String,
startedOn: 0001-01-01,
terminatedOn: 0001-01-01,
bornOn: 0001-01-01,
active: False,
totalSales: 0,
region:
{
id: String,
name: String,
houseAccount: String
},
division:
{
id: String,
name: String,
repGroup: String,
keyAccountGroup: String,
isKeyAccount: False,
salesRepId: String
},
territory:
{
id: String,
name: String,
regionId: String,
region:
{
id: String,
name: String,
houseAccount: String
},
zipcodeCount: 0,
customerCount: 0
},
legacyUser:
{
id: String,
userName: String,
fullName: String,
shortName: String,
email: String,
type: String,
priceList: String
},
user:
{
contactId: String,
retailerId: String,
salesRepId: String,
meta:
{
String: String,
Tags: "{
String:
[
String
]
}"
},
tags:
{
String:
[
String
]
},
shard: String,
email: String,
userName: String,
id: 0,
primaryEmail: String,
phoneNumber: String,
firstName: String,
lastName: String,
displayName: String,
company: String,
birthDate: 0001-01-01,
birthDateRaw: String,
address: String,
address2: String,
city: String,
state: String,
country: String,
culture: String,
fullName: String,
gender: String,
language: String,
mailAddress: String,
nickname: String,
postalCode: String,
timeZone: String,
salt: String,
passwordHash: String,
digestHa1Hash: String,
roles:
[
String
],
permissions:
[
String
],
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
invalidLoginAttempts: 0,
lastLoginAttempt: 0001-01-01,
lockedDate: 0001-01-01,
recoveryToken: String,
refId: 0,
refIdStr: String
},
customerServiceEmailAddress: String
}
},
territory:
{
id: String,
name: String,
regionId: String,
region:
{
id: String,
name: String,
houseAccount: String
},
zipcodeCount: 0,
customerCount: 0
},
legacyUser:
{
id: String,
userName: String,
fullName: String,
shortName: String,
email: String,
type: String,
priceList: String
},
user:
{
contactId: String,
retailerId: String,
salesRepId: String,
meta:
{
String: String,
Tags: "{
String:
[
String
]
}"
},
tags:
{
String:
[
String
]
},
shard: String,
email: String,
userName: String,
id: 0,
primaryEmail: String,
phoneNumber: String,
firstName: String,
lastName: String,
displayName: String,
company: String,
birthDate: 0001-01-01,
birthDateRaw: String,
address: String,
address2: String,
city: String,
state: String,
country: String,
culture: String,
fullName: String,
gender: String,
language: String,
mailAddress: String,
nickname: String,
postalCode: String,
timeZone: String,
salt: String,
passwordHash: String,
digestHa1Hash: String,
roles:
[
String
],
permissions:
[
String
],
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
invalidLoginAttempts: 0,
lastLoginAttempt: 0001-01-01,
lockedDate: 0001-01-01,
recoveryToken: String,
refId: 0,
refIdStr: String
},
customerServiceEmailAddress: String
}
},
territory:
{
id: String,
name: String,
regionId: String,
region:
{
id: String,
name: String,
houseAccount: String
},
zipcodeCount: 0,
customerCount: 0
},
legacyUser:
{
id: String,
userName: String,
fullName: String,
shortName: String,
email: String,
type: String,
priceList: String
},
user:
{
contactId: String,
retailerId: String,
salesRepId: String,
meta:
{
String: String,
Tags: "{
String:
[
String
]
}"
},
tags:
{
String:
[
String
]
},
shard: String,
email: String,
userName: String,
id: 0,
primaryEmail: String,
phoneNumber: String,
firstName: String,
lastName: String,
displayName: String,
company: String,
birthDate: 0001-01-01,
birthDateRaw: String,
address: String,
address2: String,
city: String,
state: String,
country: String,
culture: String,
fullName: String,
gender: String,
language: String,
mailAddress: String,
nickname: String,
postalCode: String,
timeZone: String,
salt: String,
passwordHash: String,
digestHa1Hash: String,
roles:
[
String
],
permissions:
[
String
],
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
invalidLoginAttempts: 0,
lastLoginAttempt: 0001-01-01,
lockedDate: 0001-01-01,
recoveryToken: String,
refId: 0,
refIdStr: String
},
customerServiceEmailAddress: String
},
shipMethod:
{
id: String,
name: String
},
openOrders: 0,
openOrdersTotal: 0,
totalSales: 0,
totalSalesYTD: 0,
totalSalesLY: 0,
totalOrders: 0,
lastOrderTotal: 0,
lastOrderId: String,
territoryId: String,
regionId: String,
region:
{
id: String,
name: String,
houseAccount: String
},
territory:
{
id: String,
name: String,
regionId: String,
region:
{
id: String,
name: String,
houseAccount: String
},
zipcodeCount: 0,
customerCount: 0
},
keywords: String,
tags:
{
String:
[
String
]
},
poRequired: False,
balance: 0,
totalBalance: 0,
futureBalance: 0,
past1Days: 0,
past30Days: 0,
past60Days: 0,
past90Days: 0,
erpCustId: String,
restrictionGroup: String,
creditLimit: 0,
creditAvailable: 0,
locationType: String,
reference1: String,
totalShipTos: 0,
thisYearInvoiced: 0,
lastYearInvoiced: 0,
totalOpenOrders: 0,
validateAddress: False,
hash: String,
setupCompleted: False,
infoReviewed: False,
ranking: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
id: String,
originalId: String,
companyName: String,
address: String,
address2: String,
address3: String,
city: String,
state: String,
zip: String,
country: String,
billingLocation:
{
companyName: String,
personName:
{
full: ""
},
address: String,
address1: String,
address2: String,
city: String,
state: String,
zip: String,
country: String,
meta: {}
},
phone: String,
fax: String,
contact: String,
paymentTerms: String,
shippingMethod: String,
notes: String,
accountType: String,
source: String,
customerType: String,
status: String,
isKeyAccount: False,
doNotUse: False,
isNewAccount: False,
isModified: False,
isCreditHold: False,
isSendSetupForm: False,
residential: False,
email: String,
website: String,
federalTaxID: String,
stateTaxID: String,
stateTaxExpiration: 0001-01-01,
defaultShipOn: 0001-01-01,
apiKey: String,
priceList: String,
containerPriceList: String,
discount: 0,
meta:
{
String: String
},
createdOn: 2024-11-10T03:33:16.3857471+00:00,
lastOrderedOn: 0001-01-01,
lastContactedOn: 0001-01-01,
lastLoginAttempt: 0001-01-01,
salesReps:
[
String
],
storeTypes:
[
String
],
paymentTerm:
{
id: String,
name: String,
isCredit: False,
isStandard: False
},
salesRep:
{
id: String,
name: String,
fullName: String,
userName: String,
address: String,
city: String,
state: String,
zip: String,
country: String,
phone: String,
fax: String,
email: String,
notes: String,
repGroupId: String,
territoryId: String,
regionId: String,
divisionId: String,
bio: String,
startedOn: 0001-01-01,
terminatedOn: 0001-01-01,
bornOn: 0001-01-01,
active: False,
totalSales: 0,
region:
{
id: String,
name: String,
houseAccount: String
},
division:
{
id: String,
name: String,
repGroup: String,
keyAccountGroup: String,
isKeyAccount: False,
salesRepId: String,
salesRep:
{
id: String,
name: String,
fullName: String,
userName: String,
address: String,
city: String,
state: String,
zip: String,
country: String,
phone: String,
fax: String,
email: String,
notes: String,
repGroupId: String,
territoryId: String,
regionId: String,
divisionId: String,
bio: String,
startedOn: 0001-01-01,
terminatedOn: 0001-01-01,
bornOn: 0001-01-01,
active: False,
totalSales: 0,
region:
{
id: String,
name: String,
houseAccount: String
},
division:
{
id: String,
name: String,
repGroup: String,
keyAccountGroup: String,
isKeyAccount: False,
salesRepId: String,
salesRep:
{
id: String,
name: String,
fullName: String,
userName: String,
address: String,
city: String,
state: String,
zip: String,
country: String,
phone: String,
fax: String,
email: String,
notes: String,
repGroupId: String,
territoryId: String,
regionId: String,
divisionId: String,
bio: String,
startedOn: 0001-01-01,
terminatedOn: 0001-01-01,
bornOn: 0001-01-01,
active: False,
totalSales: 0,
region:
{
id: String,
name: String,
houseAccount: String
},
division:
{
id: String,
name: String,
repGroup: String,
keyAccountGroup: String,
isKeyAccount: False,
salesRepId: String
},
territory:
{
id: String,
name: String,
regionId: String,
region:
{
id: String,
name: String,
houseAccount: String
},
zipcodeCount: 0,
customerCount: 0
},
legacyUser:
{
id: String,
userName: String,
fullName: String,
shortName: String,
email: String,
type: String,
priceList: String
},
user:
{
contactId: String,
retailerId: String,
salesRepId: String,
meta:
{
String: String,
Tags: "{
String:
[
String
]
}"
},
tags:
{
String:
[
String
]
},
shard: String,
email: String,
userName: String,
id: 0,
primaryEmail: String,
phoneNumber: String,
firstName: String,
lastName: String,
displayName: String,
company: String,
birthDate: 0001-01-01,
birthDateRaw: String,
address: String,
address2: String,
city: String,
state: String,
country: String,
culture: String,
fullName: String,
gender: String,
language: String,
mailAddress: String,
nickname: String,
postalCode: String,
timeZone: String,
salt: String,
passwordHash: String,
digestHa1Hash: String,
roles:
[
String
],
permissions:
[
String
],
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
invalidLoginAttempts: 0,
lastLoginAttempt: 0001-01-01,
lockedDate: 0001-01-01,
recoveryToken: String,
refId: 0,
refIdStr: String
},
customerServiceEmailAddress: String
}
},
territory:
{
id: String,
name: String,
regionId: String,
region:
{
id: String,
name: String,
houseAccount: String
},
zipcodeCount: 0,
customerCount: 0
},
legacyUser:
{
id: String,
userName: String,
fullName: String,
shortName: String,
email: String,
type: String,
priceList: String
},
user:
{
contactId: String,
retailerId: String,
salesRepId: String,
meta:
{
String: String,
Tags: "{
String:
[
String
]
}"
},
tags:
{
String:
[
String
]
},
shard: String,
email: String,
userName: String,
id: 0,
primaryEmail: String,
phoneNumber: String,
firstName: String,
lastName: String,
displayName: String,
company: String,
birthDate: 0001-01-01,
birthDateRaw: String,
address: String,
address2: String,
city: String,
state: String,
country: String,
culture: String,
fullName: String,
gender: String,
language: String,
mailAddress: String,
nickname: String,
postalCode: String,
timeZone: String,
salt: String,
passwordHash: String,
digestHa1Hash: String,
roles:
[
String
],
permissions:
[
String
],
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
invalidLoginAttempts: 0,
lastLoginAttempt: 0001-01-01,
lockedDate: 0001-01-01,
recoveryToken: String,
refId: 0,
refIdStr: String
},
customerServiceEmailAddress: String
}
},
territory:
{
id: String,
name: String,
regionId: String,
region:
{
id: String,
name: String,
houseAccount: String
},
zipcodeCount: 0,
customerCount: 0
},
legacyUser:
{
id: String,
userName: String,
fullName: String,
shortName: String,
email: String,
type: String,
priceList: String
},
user:
{
contactId: String,
retailerId: String,
salesRepId: String,
meta:
{
String: String,
Tags: "{
String:
[
String
]
}"
},
tags:
{
String:
[
String
]
},
shard: String,
email: String,
userName: String,
id: 0,
primaryEmail: String,
phoneNumber: String,
firstName: String,
lastName: String,
displayName: String,
company: String,
birthDate: 0001-01-01,
birthDateRaw: String,
address: String,
address2: String,
city: String,
state: String,
country: String,
culture: String,
fullName: String,
gender: String,
language: String,
mailAddress: String,
nickname: String,
postalCode: String,
timeZone: String,
salt: String,
passwordHash: String,
digestHa1Hash: String,
roles:
[
String
],
permissions:
[
String
],
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
invalidLoginAttempts: 0,
lastLoginAttempt: 0001-01-01,
lockedDate: 0001-01-01,
recoveryToken: String,
refId: 0,
refIdStr: String
},
customerServiceEmailAddress: String
},
shipMethod:
{
id: String,
name: String
},
openOrders: 0,
openOrdersTotal: 0,
totalSales: 0,
totalSalesYTD: 0,
totalSalesLY: 0,
totalOrders: 0,
lastOrderTotal: 0,
lastOrderId: String,
territoryId: String,
regionId: String,
region:
{
id: String,
name: String,
houseAccount: String
},
territory:
{
id: String,
name: String,
regionId: String,
region:
{
id: String,
name: String,
houseAccount: String
},
zipcodeCount: 0,
customerCount: 0
},
keywords: String,
tags:
{
String:
[
String
]
},
poRequired: False,
balance: 0,
totalBalance: 0,
futureBalance: 0,
past1Days: 0,
past30Days: 0,
past60Days: 0,
past90Days: 0,
erpCustId: String,
restrictionGroup: String,
creditLimit: 0,
creditAvailable: 0,
locationType: String,
reference1: String,
totalShipTos: 0,
thisYearInvoiced: 0,
lastYearInvoiced: 0,
totalOpenOrders: 0,
validateAddress: False,
hash: String,
setupCompleted: False,
infoReviewed: False,
ranking: String
}