The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
offset: 0,
total: 0,
results:
[
{
id: String,
createdOn: 0001-01-01,
createdBy: String,
productId: String,
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,
categoryId: String,
minimumOrderQty: 0,
availableQty: 0,
availableOn: 0001-01-01,
incomingQty: 0,
purchaseIncrement: 0,
optionGroup: String,
optionGroupList: String,
vendorId: String,
itemType: String,
imageUrl: String,
onDemandProductEuid: String,
keywords: String,
superCategory: String,
isNew: False,
isRestricted: False,
createdOn: 0001-01-01,
weight: 0,
height: 0,
length: 0,
cubicVolume: 0,
cost: 0,
uom: String,
subCategory: String,
shipOn: 0001-01-01,
featured: 0
},
status: String,
comments: String,
poNumber: String,
tagFor: String,
contactName: String,
acknowledgement: String,
invoiceId: String,
shipToOverride: String,
customerServiceEmail: String,
meta:
{
String: String
},
shippingLocation:
{
retailerId: String,
id: String,
name: String,
companyName: String,
address: String,
address2: String,
city: String,
state: String,
zip: String,
country: String,
phone: String,
storeLocator: False,
retailer:
{
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: 2025-02-20T19:02:50.7006060+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
},
email: String,
createdOn: 2025-02-20T19:02:50.7006060+00:00,
salesReps:
[
String
],
paymentTerms: String,
shippingMethod: String,
paymentTerm:
{
id: String,
name: String,
isCredit: False,
isStandard: False
},
shipMethod:
{
id: String,
name: String
},
meta:
{
String: String
},
storeCategory: String,
storeClass: String,
storeClasses:
{
id: String,
name: String
},
storeType: String,
status: String,
defaultShipOn: 0001-01-01,
custom2: String,
storeSize: String,
storeStatus: String,
reason: String,
defaultWarehouseID: String,
contactName: String,
isNewLocation: False,
doNotUse: False,
tags:
{
String:
[
String
]
}
},
retailer:
{
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: 2025-02-20T19:02:50.7162325+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
},
lines:
[
{
id: String,
position: 0,
productId: String,
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
},
reason: String,
comment: String,
quantity: 0,
qtyPurchased: 0,
extendedTotal: 0
}
],
itemCount: 1,
qtyPurchased: 0,
weight: 0,
cubicVolume: 0,
freight: 0,
refund: 0,
giftCardDiscount: 0,
grandTotal: 0
}
],
meta:
{
String: String
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}