Request

Parameter Length Possible Values Description

Order

Parent object

None

Include the details of the order number under this parameter.

partnerKey *


32 Char

String. Given by Westcon Account manager

Reseller identifier

customerPurchaseOrderNumber

35 Char

String


customerLongPONumber


70 Char

String

Customer Long PO number

endUserPurchaseOrderNumber


35 Char

String

End user PO number

orderQuote


20 Char

Number between 1-20 char

Westcon Quote number

orderCurrency


3 Char

Currency Code related BillTo Country (ie USD, EUR, ect)

Currency code

requestedShipDate


10 Char

yyyy-mm-dd

Requested ship date

requesterName


35 Char

String

Name of Requester

requesterEmail


35 Char

String

Email of Requester

projectNumber


70 Char

String

Project number

vRFHeaders

--

vRFHeaders

vRF Headers

orderAttachments

--

orderAttachments

Order Attachments

internalOrderAttachments


--

internalOrderAttachments

internal Order Attachments

externalOrderAttachments


--

externalOrderAttachments

External Order Attachments

shippingMethod


--

shippingMethod

shippingMethod

deliveryInstructions


--

deliveryInstructions

Delivery Instructions

billToAddress


--

billToAddress

Bill to address

billToContact


--

billtoContact

billToContact

shipToAddress


--

shipToAddress

Ship to address

shipToContact


--

shipToContact

shipToContact

endUserAddress


--

endUserAddress

End User Address

endUserContact


--

endUserContact

End User Contact

orderLines


--

orderLines

Order Lines

vRFHeaders

Parameter Length Possible Values Description

vRFFieldName


30 Char

Westcon to provide

vRF field name

vRFValue


40 Char

String

vRF value

orderAttachments

Parameter Length Possible Values Description

orderAttachment


70 Char

String

Order Attachment

internalOrderAttachments

Parameter Length Possible Values Description

internalOrderAttachment


70 Char

String

Internal Order attachment

externalOrderAttachments

Parameter Length Possible Values Description

externalOrderAttachment


70 Char

String

External Order attachment

shippingMethod

Parameter Length Possible Values Description

shipComplete


Boolean

true/false

Ship complete

blindShipment


Boolean

true/false

Blind shipment

deliveryInstructions

Parameter Length Possible Values Description

instruction


70 Char

String

Instruction

billToAddress

Parameter Length Possible Values Description

company


35 Char

String

Name of the company

companyName2


35 Char

String

Name of the company

line1


35 Char

String

Address Line 1

line2


35 Char

String

Address Line 2

line3


35 Char

String

Address Line 3

line4


35 Char

String

Address Line 4

city


35 Char

String

City name

state


3 Char

String

Name of the State

postalCode


9 Char

String

Postal code

country


2 Char

String

Country code (ISO Alpha-2)

billToContact

Parameter Length Possible Values Description

contactName


35 Char

String

Contact name

contactName2


35 Char

String

Contact name

phone


25 Char

String

Phone number

countryPrefix


8 Char

+1, 011, 00, etc

Country prefix code

extension


25 Char

Number between 1-25 char

Extension number

fax


25 Char

String

Fax number

mobile


25 Char

String

Mobile number

emailAddress


64 Char

String

Email address

shipToAddress

Parameter Length Possible Values Description

shipToAddress


Parent Object

None

Ship to address

company


35 Char

String

Name of the Company

companyName2


35 Char

String

Name of the Company

line1


35 Char

String

Address Line 1

line2


35 Char

String

Address Line 2

line3


35 Char

String

Address Line 3

line4


35 Char

String

Address Line 4

city


35 Char

String

Name of the City

state


3 Char

String

Name of the State

postalCode


9 Char

String

Postal code

country *


2 Char

String

Country code (ISO Alpha-2)

trackItEmailAddress


64 Char

String

TrackIt email address

shipItEmailAddress


64 Char

String

ShipIt email address

shipToContact

Parameter Length Possible Values Description

contactName


S35 Char

SString

SContact name

contactName2


35 Char

String

Contact name

phone


25 Char

String

Phone number

countryPrefix


8 Char

+1, 011, 00, etc

Country prefix code

extension


25 Char

Number between 1-25 char

Extension number

fax


25 Char

String

Fax number

mobile


25 Char

String

Mobile number

emailAddress


64 Char

String

Email address

endUserAddress

Parameter Length Possible Values Description

vertical


16 Char

String

Vertical

company


35 Char

String

Name of the Company

companyName2


35 Char

String

Name of the Company

line1


35 Char

String

Address Line 1

line2


35 Char

String

Address Line 2

line3


35 Char

String

Address Line 3

line4


35 Char

String

Address Line 4

city


35 Char

String

Name of the City

state


3 Char

String

Name of the State

postalCode


9 Char

String

Postal code

country


2 Char

String

Country code (ISO Alpha-2)

endUserContact

Parameter Length Possible Values Description

contactName


35 Char

String

Contact name

contactName2


35 Char

String

Contact name

phone


25 Char

String

Phone number

countryPrefix


8 Char

+1, 011, 00, etc

Country Prefix code

extension


25 Char

Number between 1-25 char

Extension number

fax


25 Char

String

Fax number

mobile


25 Char

String

Mobile number

emailAddress


64 Char

String

Email address

orderLines

Parameter Length Possible Values Description

customerLineNumber


6 Char

Any number 1-999999

Customer Line number

requestedDeliveryDate


10 Char

yyyy-mm-dd

Request Delivery date

requestedShipDate


10 Char

yyyy-mm-dd

Requested Ship date

quantityOrdered *


15 Char

Any number 1-999999999999999

Quantity Ordered

unitPrice


15 Char

Any decimal value

Unit Price

contractNum


--

String

contractNum

internalOrderLineAttachments


--

internalOrderLineAttachments

internal Order Line Attachments

externalOrderLineAttachments


--

externalOrderLineAttachments

External Order attachments

vRFLines


--

vRFLines

vRFLines

vRFQuantities


--

vRFQuantities

vRFQuantities

product *


--

product

product

internalOrderLineAttachments

Parameter Length Possible Values Description

internalOrderLineAttachment


70 Char

String

Internal Order Line attachments

externalOrderLineAttachments

Parameter Length Possible Values Description

externalOrderLineAttachment


70 Char

String

external Order Line Attachment

vRFLines

Parameter Length Possible Values Description

fieldName


30 Char

Westcon to provide

vRF Lines Field name

value


40 Char

String

vRF Lines Value

vRFQuantities

Parameter Length Possible Values Description

fieldName


30 Char

String

Field name

value


40 Char

String

Value

product

Parameter Length Possible Values Description<

productNumber *


40 Char

Valid Skus

Product Number

customerProductNumber


70 Char

String

Customer Product number

Response

Parameter Length Possible Values Description

code


--

String

Code

descripton

--

String

Description


success


Boolean

True/False

Success

confirmationNumber


12

String

Confirmation number