| Parameter | Length | Possible Values | Description |
|
partnerKey
|
32 Char |
String. Given by Westcon Account manager |
Reseller identifier. |
|
resellerId |
-- |
String. Given by Westcon Account manager or 0000000 if not known |
Reseller's internal identifier |
|
quoteId |
-- |
String |
Quote ID returned from the Event Listener with an event type of "QUOTE_CREATED" or "QUOTE_REVISED". Do not include the _Rev# |
|
version |
-- |
Number |
Version number. In case the version is empty, the latest version would be used. Example: 4 |
| Parameter | Length | Data type | Description |
|
message |
-- |
String |
Eg: Successfully Retrieved Quote with id - {QuoteId}, No quote available in 1view with id - {QuouteId} etc... |
|
QuoteData |
-- |
Quote Data |
|
|
success
|
-- |
Boolean |
True - Means success, False - Means failed |
| Parameter | Length | Data type | Description |
|
code |
-- |
String |
Unique Quote number |
|
deliveryAddress
|
-- |
Delivery address details |
|
|
deliveryCost
|
-- |
Freight charges of the quote |
|
|
deliveryMode
|
-- |
Shipping method eg: Economy,express |
|
|
entries
|
-- |
All product/prices details of the quote (line items) |
|
|
totalItems
|
-- |
Integer |
Total items in quote |
|
totalPriceWithTax
|
-- |
Total price of the quote items including tax |
|
|
totalTax
|
-- |
Total tax amount of the quote |
|
|
user
|
-- |
Quote created by |
|
|
accountData
|
-- |
Reseller and country details |
|
|
assignedToAM
|
-- |
String |
AM User details to whom this quote is assigned |
|
assignedToAMEmail
|
-- |
String |
AM email address details to whom this quote is assigned |
|
assignedToAMName
|
-- |
String |
Assigned AM first name and last name |
|
assignedToAMPhone
|
-- |
String |
AM User phone number details to whom this quote is assigned |
|
b2BSalesOrg
|
-- |
Reseller and sales org details |
|
|
billToAccount
|
-- |
Reseller billing account address details |
|
|
carrierAccountNumber
|
-- |
String |
Carrier Account Number |
|
certificateOriginCharges
|
-- |
double |
Certificate Origin Charges |
|
closedDate
|
-- |
String |
Quote expiration date |
|
createdBy
|
-- |
String |
Name of the user who created the quote |
|
createdDate
|
-- |
String |
Quote created date |
|
date
|
-- |
date |
Date |
|
deliveryCharges
|
-- |
String |
Delivery Charges |
|
docDeliveryCharges
|
-- |
double |
Document delivery Charges |
|
endUserAccount
|
-- |
End user account address details |
|
|
endUserAddress
|
-- |
End user address details |
|
|
importDuty
|
-- |
double |
Import duty |
|
isBlindShipment
|
-- |
Boolean |
Blind shipment flag |
|
FlatFreight
|
-- |
Flat freight charges |
|
|
legalCharges
|
-- |
double |
Legal Chargess |
|
note
|
-- |
String |
Quote header level notes provided by the user |
|
opportunityId
|
-- |
String |
Sales view opportunity ID |
|
opportunityName
|
-- |
String |
One of the field where user can provide Opportunity Name |
|
opportunityNotes
|
-- |
String |
One of the field where user can provide Opportunity Notes |
|
opportunityNumber
|
-- |
String |
One of the field where user can provide Opportunity Number |
|
projectNumber
|
-- |
String |
One of the field where user can provide Project Number |
|
quoteCode
|
-- |
String |
Quote number |
|
quoteCustomer
|
-- |
Reseller account details |
|
|
quoteInformation
|
-- |
Quote creator email address, currency, start and end date |
|
|
quoteRequester
|
-- |
String |
Quote requester name |
|
rebateUpliftText
|
-- |
String |
rebateUpliftText |
|
region
|
-- |
Region of which the sales org belongs |
|
|
requesterEmail
|
-- |
String |
Quote requester email address |
|
salesOrg
|
-- |
String |
Sales org which quote belongs |
|
salesOrgCountryName
|
-- |
Country name of the sales org |
|
|
salesOrgName
|
-- |
String |
Name of the sales org |
|
sasoOrCocCharges
|
-- |
double |
sasoOrCocCharges |
|
shipToAccount
|
-- |
ship to user account address details |
|
|
shippingInstruction
|
-- |
String |
Shipping instruction |
|
shippingMethodDisplay
|
-- |
String |
Shipping method name selected by the user |
|
soldToAccount
|
-- |
sold to user account address details |
|
|
soldToAccountLanguage
|
-- |
String |
sold to account language |
|
specialDiscount
|
-- |
double |
Special discount |
|
submittedBy
|
-- |
String |
Quote submitted user |
|
totalListPrice
|
-- |
Total list price of the items present in quote |
|
|
totalResellerPrice
|
-- |
Total reseller price of the items without tax |
|
|
totalVolume
|
-- |
String |
Total Volume of the items present in quote |
|
totalWeight
|
-- |
String |
Total weight of the items present in quote |
|
transactionFees
|
-- |
double |
Total transaction fees |
|
vendorName
|
-- |
String |
All vendor names of the items |
|
versionID
|
-- |
String |
Quote revision number |
|
comments |
-- |
Comment |
|
|
currency
|
-- |
String |
Quote quoted currency |
|
quoteCreatedBy
|
-- |
String |
Quote created name |
|
revisionRequestCCEmail
|
-- |
String |
Quote revision requester email address |
| Parameter | Length | Data type | Description |
|
companyName |
-- |
String |
Name of the company |
|
country |
-- |
String |
Country |
|
firstName |
-- |
String |
First name |
|
lastName |
-- |
String |
Last name |
|
formattedAddress |
-- |
String |
Complete address with comma separated values |
|
line1 |
-- |
String |
Address line 1 |
|
line2 |
-- |
String |
Address line 2 |
|
line3 |
-- |
String |
Address line 3 |
|
line4 |
-- |
String |
Address line 4 |
|
phone |
-- |
String |
Phone number |
|
postalCode |
-- |
String |
Postal code/Zip code number |
|
region |
-- |
String |
Region of the country |
|
town |
-- |
String |
Town/City |
| Parameter | Length | Data type | Description |
|
isocode |
-- |
String |
Country Iso code details |
|
name |
-- |
String |
Name of the country |
|
postalCodeSample |
-- |
String |
Postal/Zip code number example |
| Parameter | Length | Data type | Description |
|
isocode |
-- |
String |
Country Iso code details |
|
isocodeShort |
-- |
String |
|
|
name |
-- |
String |
Name of the region/state |
| Parameter | Length | Data type | Description |
|
currencyIso |
-- |
String |
Iso code of the currency |
|
formattedValue |
-- |
String |
Combination of ISO code and Value |
|
value |
-- |
Bigdecimal |
Price Amount |
|
valueWithoutCurrency |
-- |
String |
Value formatted to 2 or 3 decimals based on the country |
| Parameter | Length | Data type | Description |
|
code |
-- |
String |
Value of the delivery name |
|
deliveryCost |
-- |
Freight charges of the quote |
|
|
name |
-- |
String |
Name of the Delivery mode eg: Express, Economy |
|
Description |
-- |
String |
Description of the delivery method |
| Parameter | Length | Data type | Description |
|
currencySymbol |
-- |
String |
Currency Symbol |
|
customerLineNumber |
-- |
String |
Line Number |
|
customerPartNumber |
-- |
String |
Customer entered partnumber |
|
displayEntryNumber |
-- |
integer |
Line number of the SKU |
|
duration |
-- |
String |
Value of duration |
|
chemicalTax |
-- |
Chemical Tax |
|
|
contractStartDate |
-- |
String |
Contract Start Date |
|
contractEndDate |
-- |
String |
Contract EndD ate |
|
estimatedFreight |
-- |
double |
Estimated freight |
|
extendedListPrice |
-- |
Total list price of the item |
|
|
extendedPrice |
-- |
Total reseller price of the item |
|
|
groupDescription |
-- |
String |
Group description of the item provided by the user |
|
groupId |
-- |
String |
Groupid of the item provided by the user |
|
groupIdAndDescription |
-- |
String |
Combination of GroupID and Group description |
|
importDutyAbsolute |
-- |
Absolute value of import duty |
|
|
importDutyPercentage |
-- |
double |
Percentage of import duty |
|
inboundDuty |
-- |
Value of inbound duty |
|
|
inboundDutyPercentage |
-- |
double |
Percentage of inbound duty |
|
listPrice |
-- |
List Price |
|
|
listingFees |
-- |
Listing Fees |
|
|
listPriceInQuoteCurrency |
-- |
List price In Quote Currency |
|
|
periodicBilling |
-- |
List price In Quote Currency |
|
|
pricingConditionLabel |
-- |
String |
|
|
product |
-- |
Product details |
|
|
quantity |
-- |
long |
Number of item quantity |
|
resellerPrice |
-- |
Selling price |
|
|
totalInclVAT |
-- |
double |
|
|
totalChemicalTax |
-- |
Total Chemical Tax |
|
|
totalPrice |
-- |
|
|
|
totalListingFees |
-- |
Total Listing Fees |
|
|
type |
-- |
product type |
ProductType Enum possible values – STD, TCB, TPB, RCB, RPB, VIP, VIC, VPSP, VPSC |
|
vatAbsolute |
-- |
Absolute value of tax |
|
|
vatPercentage |
-- |
double |
Percentage of tax |
|
vendorCurrency |
-- |
String |
SKU's vendor currency |
|
vendorName |
-- |
String |
Name of Vendor |
|
volume |
-- |
String |
Volume of the item belongs |
|
weight |
-- |
String |
Weight of the item belongs |
|
externalNotes |
-- |
String |
Notes on a given line |
| Parameter | Length | Data type | Description |
|
currencyIso |
-- |
currency |
Iso code of the currency (ex: GBP) |
|
formattedValue |
-- |
String |
Combination of ISO code and Value (ex:GBP 2,800.00) |
|
value |
-- |
BigDecimal |
Price Amount (ex: 2800) |
|
valueWithoutCurrency |
-- |
String |
Formatted value minus currency (ex: 2,800.00) |
| Parameter | Length | Data type | Description |
|
code |
-- |
String |
Vendor partnumber |
|
description |
-- |
String |
Part number shot description |
|
itemType |
-- |
String |
Type of Item |
|
name |
-- |
String |
Name of the partnumber |
| Parameter | Length | Data type | Description |
|
name |
-- |
String |
Name of the User |
|
uid |
-- |
String |
Logged in user ID value |
| Parameter | Length | Data type | Description |
|
country |
-- |
String |
Country of which reseller belongs |
|
resellerId |
-- |
String |
Reseller Number |
|
resellerName |
-- |
String |
Reseller name |
| Parameter | Length | Data type | Description |
|
paymentTermsData |
-- |
Payment term data |
|
|
Sales org |
-- |
String |
Country sales org number |
| Parameter | Length | Data type | Description |
|
description |
-- |
paymentTermsData |
description of the payment term |
|
code |
-- |
String |
Configured value of the payment term |
| Parameter | Length | Data type | Description |
|
accountName |
-- |
String |
Acount name |
|
addressLine1 |
-- |
String |
addressLine1 |
|
addressLine2 |
-- |
String |
addressLine2 |
|
addressLine3 |
-- |
String |
addressLine3 |
|
addressLine4 |
-- |
String |
addressLine4 |
|
country |
-- |
String |
country |
|
district |
-- |
String |
district |
|
locality |
-- |
String |
locality |
|
state |
-- |
String |
state |
|
town |
-- |
String |
town |
|
zipCode |
-- |
String |
Post/Zip code |
|
phone |
-- |
String |
phone number |
| Parameter | Length | Data type | Description |
|
customerNumber |
-- |
String |
Reseller account number |
|
resellerName |
-- |
String |
Reseller name |
| Parameter | Length | Data type | Description |
|
startDate |
-- |
String |
startDate eg: 09/30/2020 |
|
startDateInYYYY |
-- |
String |
startDateInYYYY eg: 30-September-2020 |
|
expireDate |
-- |
String |
expireDate eg: 09/30/2020 |
|
expireDateInYYYY |
-- |
String |
expireDateInYYYY eg: 30-September-2020 |
|
currency |
-- |
List < string > |
currency |
|
createdByEmail |
-- |
String |
Quote creator email address |
|
createdByPhone |
-- |
String |
Quote creator phone number |
| Parameter | Length | Data type | Description |
|
comment |
-- |
String |
Comment |
|
Date |
-- |
String |
Date |
|
user |
-- |
String |
User |
| Parameter | Length | Data type | Description |
|
billingDate |
-- |
String |
The date on which the billing is actually generated or processed. eg: 09/30/2020 |
|
billingValue |
-- |
Number |
The amount to be billed during this period |
|
startDate |
-- |
String |
The start date of the billing period. eg: 09/30/2020 |
|
endDate |
-- |
String |
The end date of the billing period. eg: 09/30/2020 |