UPSFreightShip Control

Properties   Methods   Events   Config Settings   Errors  

Provides UPS Freight Shipment service.

Syntax

UPSFreightShip

Remarks

The UPSFreightShip control allows labels and documents to be generated for a freight shipment. To use the control, populate Documents to specify the type of documents requested. Specify the sender, recipient, commodity and UPS account information before calling GetShipmentDocuments. For instance:

component.UPSAccount.Server = "https://wwwcie.ups.com/api/freight/" component.UPSAuthorizationToken = "Bearer token..." component.UPSAccountNumber = "000000" component.SenderCompany = "Developer Test 1" component.SenderPhone = "884530171" component.SenderAddress1 = "101 Developer Way" component.SenderCity = "Richmond" component.SenderState = "VA" component.SenderZipCode = "23224" component.SenderCountryCode = "US" component.RecipientCompany = "Consignee Test 1" component.RecipientAddress1 = "1000 Consignee Street" component.RecipientCity = "Allanton" component.RecipientState = "MO" component.RecipientZipCode = "63001" component.RecipientCountryCode = "US" component.PayorType = ptSender component.HandlingUnit = "SKD:1" component.CommodityCount = 1 component.CommodityDescription(0) = "LCD TVS" component.CommodityFreightClass(0) = "77.5" component.CommodityWeight(0) = "150" component.CommodityFreightNMFC(0) = "132680" component.CommodityFreightNMFCSub(0) = "02" component.CommodityNumberOfPieces(0) = 20 component.CommodityValue(0) = "100" component.DocumentCount = 1 component.DocumentPrintFormat = fpfLaser component.DocumentPrintSize = fpsSize8X11 component.DocumentType = ftcLabel component.DocumentFileName = "TestLabel.pdf" component.GetShipmentDocuments Debug.Print ("Total Charge: " & component.TotalCharge) Dim i As Integer For i = 0 To component.ChargeCount - 1 Debug.Print component.ChargeType(0) & ": " & component.ChargeValue(0) Next i Debug.Print ("Billable Weight: " & component.BillableWeight) Debug.Print ("BOLID: " & component.BOLID) Debug.Print ("Shipment Number: " & component.ShipmentNumber)

Property List

---

The following is the full list of the properties of the control with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the control with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the control with short descriptions. Click on the links for further details.

BillableWeight Property (UPSFreightShip Control)

Represents the billable weight associated with the shipment.

Syntax

upsfreightshipcontrol.BillableWeight

Default Value

""

Remarks

This property is read-only.

Data Type

String

BOLID Property (UPSFreightShip Control)

The retrieval key for the stored BOL (Bill of Lading).

Syntax

upsfreightshipcontrol.BOLID

Default Value

""

Remarks

This property holds the retrieval key for the stored BOL (Bill of Lading) as returned by the server.

This property is read-only.

Data Type

String

ChargeCount Property (UPSFreightShip Control)

The number of records in the Charge arrays.

Syntax

upsfreightshipcontrol.ChargeCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• ChargeDescription
• ChargeType
• ChargeValue

The array indices start at 0 and end at ChargeCount - 1.

This property is not available at design time.

Data Type

Integer

ChargeType Property (UPSFreightShip Control)

Indicates the type of the charge.

Syntax

upsfreightshipcontrol.ChargeType(ChargeIndex)[=string]

Default Value

""

Remarks

Indicates the type of the charge. A partial list of possible values are:

The ChargeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChargeCount property.

This property is not available at design time.

Data Type

String

ChargeDescription Property (UPSFreightShip Control)

The description of the rate.

Syntax

upsfreightshipcontrol.ChargeDescription(ChargeIndex)[=string]

Default Value

""

Remarks

The description of the rate. The text description is provided by the control based on the value in ChargeType. If a description is not know for the ChargeType this property will hold an empty string. Possible values are:

The ChargeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChargeCount property.

This property is not available at design time.

Data Type

String

ChargeValue Property (UPSFreightShip Control)

The value of the charge type specified by ChargeType .

Syntax

upsfreightshipcontrol.ChargeValue(ChargeIndex)[=string]

Default Value

""

Remarks

The value of the charge type specified by ChargeType.

The ChargeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChargeCount property.

This property is not available at design time.

Data Type

String

CODPayorType Property (UPSFreightShip Control)

The type of payment that will be used for the COD payment.

Syntax

upsfreightshipcontrol.CODPayorType[=integer]

Possible Values

fcodptCollect(0), 
fcodptPrepaid(1)

Default Value

0

Remarks

This property specifies the type of COD payment. Possible values are:

Data Type

Integer

CODRemitToAddress1 Property (UPSFreightShip Control)

Street name.

Syntax

upsfreightshipcontrol.CODRemitToAddress1[=string]

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS CODRemitToAddress1 should not exceed 35 characters.

Data Type

String

CODRemitToAddress2 Property (UPSFreightShip Control)

A specific detail on the address (such as building, suite, apartment, floor number etc.

Syntax

upsfreightshipcontrol.CODRemitToAddress2[=string]

Default Value

""

Remarks

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS CODRemitToAddress2 should not exceed 35 characters.

Data Type

String

CODRemitToCity Property (UPSFreightShip Control)

Name of city, town, etc.

Syntax

upsfreightshipcontrol.CODRemitToCity[=string]

Default Value

""

Remarks

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

Data Type

String

CODRemitToState Property (UPSFreightShip Control)

State or province code.

Syntax

upsfreightshipcontrol.CODRemitToState[=string]

Default Value

""

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

Data Type

String

CODRemitToZipCode Property (UPSFreightShip Control)

Postal code.

Syntax

upsfreightshipcontrol.CODRemitToZipCode[=string]

Default Value

""

Remarks

Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both CODRemitToCity and CODRemitToState are not present.

Valid characters: A-Z; 0-9; a-z. Maximum length: 16.

Data Type

String

CODRemitToCompany Property (UPSFreightShip Control)

Identifies the contact person's company name.

Syntax

upsfreightshipcontrol.CODRemitToCompany[=string]

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either CODRemitToFirstName and CODRemitToLastName or CODRemitToCompany are required to be provided.

Data Type

String

CODRemitToEmail Property (UPSFreightShip Control)

Identifies the contact person's email address.

Syntax

upsfreightshipcontrol.CODRemitToEmail[=string]

Default Value

""

Remarks

Identifies the contact person's email address. Maximum length: 120.

Data Type

String

CODRemitToFax Property (UPSFreightShip Control)

Recipient's fax number.

Syntax

upsfreightshipcontrol.CODRemitToFax[=string]

Default Value

""

Remarks

Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.

Data Type

String

CODRemitToFirstName Property (UPSFreightShip Control)

Sender's first name.

Syntax

upsfreightshipcontrol.CODRemitToFirstName[=string]

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either CODRemitToFirstName and CODRemitToLastName or CODRemitToCompany must be sent.

Data Type

String

CODRemitToLastName Property (UPSFreightShip Control)

Person's last name.

Syntax

upsfreightshipcontrol.CODRemitToLastName[=string]

Default Value

""

Remarks

Person's last name. The value of this property is required. Values for either CODRemitToFirstName and CODRemitToLastName or CODRemitToCompany must be sent. Maximum length: 45 characters for both names or company name.

Data Type

String

CODRemitToMiddleInitial Property (UPSFreightShip Control)

Middle initial.

Syntax

upsfreightshipcontrol.CODRemitToMiddleInitial[=string]

Default Value

""

Remarks

Middle initial. The value of this property is optional.

Data Type

String

CODRemitToPhone Property (UPSFreightShip Control)

Identifies the contact person's phone number.

Syntax

upsfreightshipcontrol.CODRemitToPhone[=string]

Default Value

""

Remarks

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

Data Type

String

CODTotalAmount Property (UPSFreightShip Control)

The total amount of additional fees.

Syntax

upsfreightshipcontrol.CODTotalAmount[=string]

Default Value

""

Remarks

UPS Freight handles your payment collections upon delivery and sends the payment to you (if applicable) for an additional charge.

Data Type

String

CODType Property (UPSFreightShip Control)

The code that indicates the type of funds that will be used for the COD payment.

Syntax

upsfreightshipcontrol.CODType[=integer]

Possible Values

fcodtsCertifiedCheck(0), 
fcodtsCash(1), 
fcodtsCompanyCheck(2)

Default Value

0

Remarks

This property specifies the type of COD requested. Possible values are:

Data Type

Integer

CommodityCount Property (UPSFreightShip Control)

The number of records in the Commodity arrays.

Syntax

upsfreightshipcontrol.CommodityCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• CommodityDescription
• CommodityFreightClass
• CommodityFreightIsHazardous
• CommodityFreightNMFC
• CommodityFreightNMFCSub
• CommodityFreightPackagingType
• CommodityNumberOfPieces
• CommodityValue
• CommodityWeight

The array indices start at 0 and end at CommodityCount - 1.

This property is not available at design time.

Data Type

Integer

CommodityDescription Property (UPSFreightShip Control)

Complete and accurate description of this commodity line item.

Syntax

upsfreightshipcontrol.CommodityDescription(CommodityIndex)[=string]

Default Value

""

Remarks

Complete and accurate description of this commodity line item.

It is applicable to all international forms. Optional for Partial Invoice and required for the rest of form types.

Specific description of the type of equipment and its intended use is required. Clearance delays may result if the contents are not completely and accurately described. Vague description will not be accepted by Customs. Only a portion of this field will print on the label.

For FedEx, if the shipment contains documents only (i.e., Documents is set to True), then the CommodityDescription has to be set to an approved value. The following table lists document descriptions approved by U.S. Customs.

The CommodityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityFreightClass Property (UPSFreightShip Control)

Indicates the freight class of the commodity.

Syntax

upsfreightshipcontrol.CommodityFreightClass(CommodityIndex)[=string]

Default Value

""

Remarks

Indicates the freight class of the commodity.

The following table lists freight classes available from UPS freight services.

NOTE: This field is only applicable to UPS freight.

The CommodityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityFreightIsHazardous Property (UPSFreightShip Control)

Identifies if the Commodity item is hazardous.

Syntax

upsfreightshipcontrol.CommodityFreightIsHazardous(CommodityIndex)[=boolean]

Default Value

False

Remarks

Identifies if the Commodity item is hazardous.

NOTE: This field is only applicable to UPS freight.

The CommodityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

Boolean

CommodityFreightNMFC Property (UPSFreightShip Control)

Identifies the National Motor Freight Classification numbers.

Syntax

upsfreightshipcontrol.CommodityFreightNMFC(CommodityIndex)[=string]

Default Value

""

Remarks

Identifies the National Motor Freight Classification numbers.

NOTE: This field is only applicable to UPS freight.

The CommodityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityFreightNMFCSub Property (UPSFreightShip Control)

Identifies the sub code of National Motor Freight Classification numbers.

Syntax

upsfreightshipcontrol.CommodityFreightNMFCSub(CommodityIndex)[=string]

Default Value

""

Remarks

Identifies the sub code of National Motor Freight Classification numbers.

NOTE: This field is only applicable to UPS freight.

The CommodityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityFreightPackagingType Property (UPSFreightShip Control)

Identifies the Commodity item's packaging type.

Syntax

upsfreightshipcontrol.CommodityFreightPackagingType(CommodityIndex)[=integer]

Possible Values

cptBag(0), 
cptBale(1), 
cptBarrel(2), 
cptBundle(3), 
cptBin(4), 
cptBox(5), 
cptBasket(6), 
cptBunch(7), 
cptCabinet(8), 
cptCan(9), 
cptCarrier(10), 
cptCase(11), 
cptCarboy(12), 
cptContainer(13), 
cptCrate(14), 
cptCask(15), 
cptCarton(16), 
cptCylinder(17), 
cptDrum(18), 
cptLoose(19), 
cptOther(20), 
cptPail(21), 
cptPieces(22), 
cptPackage(23), 
cptPipe(24), 
Line(25), 
cptPallet(26), 
cptRack(27), 
cptReel(28), 
cptRoll(29), 
cptSkid(30), 
cptSpool(31), 
cptTube(32), 
cptTank(33), 
cptUnit(34), 
cptVanPack(35), 
cptWrapped(36)

Default Value

0

Remarks

Identifies the Commodity item's packaging type. Possible values are:

NOTE: This field is only applicable to UPS freight.

The CommodityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

Integer

CommodityNumberOfPieces Property (UPSFreightShip Control)

The total number of packages, cartons, or containers for the commodity line item.

Syntax

upsfreightshipcontrol.CommodityNumberOfPieces(CommodityIndex)[=integer]

Default Value

1

Remarks

The total number of packages, cartons, or containers for the commodity line item.

In UPS, it is required and applicable to CO only.

In FedEx, if the Documents is set to False in ship request, the CommodityNumberOfPieces is required to be entered for each commodity item included in an international shipment. At least one occurrence is required for international dutiable (non-documents) shipments.

This property is not applicable to USPS.

The CommodityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

Integer

CommodityValue Property (UPSFreightShip Control)

The value of an individual item being shipped.

Syntax

upsfreightshipcontrol.CommodityValue(CommodityIndex)[=string]

Default Value

""

Remarks

The value of an individual item being shipped. This should be provided for each item contained in the package being shipped. This property provides the value of the set of items. If the item is 2 boxes of 50 pens and the value of each box is $10.00, "20.00" (2 boxes x $10.00) should be entered. If the value of each pen is .25, then "25.00" (100 pens x .25) should be entered.

This property is only applicable to USPS and UPS freight.

Note: For USPS, the maximum value for this property is "99999.99".

Note: For UPS freight, the maximum value for this property is "99999999999999.99".

The CommodityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityWeight Property (UPSFreightShip Control)

The shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code.

Syntax

upsfreightshipcontrol.CommodityWeight(CommodityIndex)[=string]

Default Value

"0.00"

Remarks

The shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code. This weight does not include carrier equipment.

For FedEx, if the shipment contains non-documents item(s) (i.e., the Documents is set to False), the CommodityWeight is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments.

For UPS, this is required and applicable to CO and SED forms only .

When using USPS and PostageProvider is set to ppNone, the format of this property must be "XX lbs YY oz", where XX is the number of pounds and YY is the number of ounces.

However, in USPS, if PostageProvider is set to ppEndicia, then the format must be one explicit decimal position in ounces (i.e. N.N formatting).

The CommodityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

DimensionalWeight Property (UPSFreightShip Control)

Represents the dimensional weight associated with the shipment.

Syntax

upsfreightshipcontrol.DimensionalWeight

Default Value

""

Remarks

The dimensional weight as calculated by the server and returned in the response.

This property is read-only.

Data Type

String

DocumentCount Property (UPSFreightShip Control)

The number of records in the Document arrays.

Syntax

upsfreightshipcontrol.DocumentCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• DocumentFile
• DocumentFileName
• DocumentLabelsPerPage
• DocumentPrintFormat
• DocumentPrintSize
• DocumentType

The array indices start at 0 and end at DocumentCount - 1.

This property is not available at design time.

Data Type

Integer

DocumentType Property (UPSFreightShip Control)

Specifies the type of document that is requested.

Syntax

upsfreightshipcontrol.DocumentType(DocumentIndex)[=integer]

Possible Values

ftcLabel(0), 
ftcAWB(1), 
ftcUPSBOL(2), 
ftcVICSBOL(3), 
ftcPackingList(4)

Default Value

0

Remarks

Specifies the type of document that is requested. Possible values are:

The default value is ftcLabel (0).

The DocumentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCount property.

This property is not available at design time.

Data Type

Integer

DocumentFile Property (UPSFreightShip Control)

The decoded binary label file.

Syntax

upsfreightshipcontrol.DocumentFile(DocumentIndex)

Default Value

""

Remarks

The decoded binary label file.

The DocumentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCount property.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .DocumentFileB.

This property is read-only and not available at design time.

Data Type

Binary String

DocumentFileName Property (UPSFreightShip Control)

Specifies where the file will be written.

Syntax

upsfreightshipcontrol.DocumentFileName(DocumentIndex)[=string]

Default Value

""

Remarks

Specifies where the file will be written. This property must be set before calling GetShipmentDocuments. It should contain the full path and filename to which the returned document will be written when GetShipmentDocuments is called.

The DocumentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCount property.

This property is not available at design time.

Data Type

String

DocumentLabelsPerPage Property (UPSFreightShip Control)

This specifies the number of labels per page in the returned label file.

Syntax

upsfreightshipcontrol.DocumentLabelsPerPage(DocumentIndex)[=integer]

Possible Values

flppOne(0), 
flppTwo(1), 
flppFour(2)

Default Value

0

Remarks

This specifies the number of labels per page in the returned label file. Possible values are:

Required when DocumentType is fitLabel. Otherwise it is ignored.

The DocumentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCount property.

This property is not available at design time.

Data Type

Integer

DocumentPrintFormat Property (UPSFreightShip Control)

Specifies the print format of the label.

Syntax

upsfreightshipcontrol.DocumentPrintFormat(DocumentIndex)[=integer]

Possible Values

fpfLaser(0), 
fpfThermal(1)

Default Value

0

Remarks

Specifies the print format of the label. Possible values are:

Required when DocumentType is fitLabel. Otherwise it is ignored.

The DocumentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCount property.

This property is not available at design time.

Data Type

Integer

DocumentPrintSize Property (UPSFreightShip Control)

Specifies the requested print size of the label.

Syntax

upsfreightshipcontrol.DocumentPrintSize(DocumentIndex)[=integer]

Possible Values

fpsSize4X6(0), 
fpsSize4X8(1), 
fpsSize8X11(2)

Default Value

0

Remarks

Specifies the requested print size of the label. Possible values are:

Required when DocumentType is fitLabel. Otherwise it is ignored.

The DocumentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCount property.

This property is not available at design time.

Data Type

Integer

FirewallAutoDetect Property (UPSFreightShip Control)

This property tells the control whether or not to automatically detect and use firewall system settings, if available.

Syntax

upsfreightshipcontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

This property tells the control whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (UPSFreightShip Control)

This property determines the type of firewall to connect through.

Syntax

upsfreightshipcontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (UPSFreightShip Control)

This property contains the name or IP address of firewall (optional).

Syntax

upsfreightshipcontrol.FirewallHost[=string]

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the control fails with an error.

Data Type

String

FirewallPassword Property (UPSFreightShip Control)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

upsfreightshipcontrol.FirewallPassword[=string]

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Data Type

String

FirewallPort Property (UPSFreightShip Control)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

upsfreightshipcontrol.FirewallPort[=integer]

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (UPSFreightShip Control)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

upsfreightshipcontrol.FirewallUser[=string]

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.

Data Type

String

HandlingUnit Property (UPSFreightShip Control)

Describe the Handling Units (Movable Pieces) in this Shipment.

Syntax

upsfreightshipcontrol.HandlingUnit[=string]

Default Value

""

Remarks

The first 4 codes are valid for handling unit one and the last two are valid for handling unit two. The type and value pair(s) should be entered as a string in this format: 'type1:value1; type2:value2'. For example: SKD:1; OTH:1'.

Data Type

String

HazMatContactName Property (UPSFreightShip Control)

Identifies the contact name for questions of the hazardous materials. Required when any commodity is marked as a hazardous material.

Syntax

upsfreightshipcontrol.HazMatContactName[=string]

Default Value

""

Remarks

This property hold the name of the person who can be contacted with questions regarding the dangerous goods in the shipment. This must be set if the shipment contains hazardous materials and CommodityFreightIsHazardous is true.

Data Type

String

HazMatContactPhone Property (UPSFreightShip Control)

Identifies the contact phone for questions of the hazardous materials. Required when any commodity is marked as a hazardous material.

Syntax

upsfreightshipcontrol.HazMatContactPhone[=string]

Default Value

""

Remarks

This property hold the phone number of the person who can be contacted with questions regarding the dangerous goods in the shipment. This must be set if the shipment contains hazardous materials and CommodityFreightIsHazardous is true.

Data Type

String

NotifyCount Property (UPSFreightShip Control)

The number of records in the Notify arrays.

Syntax

upsfreightshipcontrol.NotifyCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• NotifyAggregate
• NotifyEmail
• NotifyFlags
• NotifyMessage

The array indices start at 0 and end at NotifyCount - 1.

This property is not available at design time.

Data Type

Integer

NotifyAggregate Property (UPSFreightShip Control)

This can be used to set the entire aggregate xml for the recipient to be notified.

Syntax

upsfreightshipcontrol.NotifyAggregate(NotifyIdx)[=string]

Default Value

""

Remarks

This can be used to set the entire aggregate xml for the recipient to be notified. This is only valid for ship requests only when the EmailNotification=0x00000004 is present in the ShipmentSpecialServices.

FedEx

For FedEx, this aggregate should contain descriptive data required for FedEx to provide e-mail notification to the customer regarding the shipment.

The format of this aggregate should be as follows: <EMailNotificationDetail> <PersonalMessage>personal_message</PersonalMessage> <Recipients> (this aggregate can be entered up to six times) <EMailNotificationRecipientType>recipient_type</EMailNotificationRecipientType> <EMailAddress>recipient_email</EMailAddress> <NotifyOnShipment>true_or_false</NotifyOnShipment> <NotifyOnException>true_or_false</NotifyOnException> <NotifyOnDelivery>true_or_false</NotifyOnDelivery> <Format>format_type</Format> <Localization> <LanguageCode>language_code</LanguageCode> </Localization> </Recipients> </EMailNotificationDetail>

In this aggregate, you can specify:

• a message text to be sent in the email notification (via the PersonalMessage element). This is optional.
• the type of the recipient: SHIPPER, RECIPIENT, BROKER, OTHER (via the EMailNotificationRecipientType element). This is optional.
• the recipient's email address (via the EMailAddress element). This is required.
• whether the recipient is to be notified on shipment, exception or delivery (via the NotifyOnShipment, NotifyOnException, NotifyOnDelivery elements). These are required.
• the format of the message: HTML, TEXT, WIRELESS (via the Format element). This is required.
• the language code you want the message to be sent to (via the LanguageCode element). This is optional. If not present, it will default to English (EN).

The specified shipment notification can be sent up to six (6) email addresses to receive (i.e., the Recipients field can have up to 6 recipient emails).

This setting is optional. If NotifyAggregate is not set it will be automatically created by the control.

UPS

For UPS, the following JSON format is valid: { "NotificationCode": "6", "EMail": { "EMailAddress": [ "recipient1_email", (up to five recipient emails) "recipient2_email" ], "UndeliverableEMailAddress": "undeliverable_email", "FromEMailAddress": "sender_email", "FromName": "sender_name", "Memo": "message" } }

In this aggregate, you can specify:

• a notification code which describes the notification requested: "6" (Ship Notification), "7" (Exception Notification), "8" (Delivery Notification), or "2" (Return Notification). This is required.
• the recipient's email address (via the EMailAddress element). This is required.
• the undeliverable email address if to specify where an undeliverable email should be sent. This is optional.
• the email address for the reply-to address. The From field of the email will contain pkginfo@ups.com. This should be specified by the FromEMailAddress element.
• an optional from name.
• a message text to be sent in the email notification (via the Memo element). This is optional.

Note that this property does not apply for USPS and CanadaPost.

The NotifyIdx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.

This property is not available at design time.

Data Type

String

NotifyEmail Property (UPSFreightShip Control)

Email address of the recipient to be notified.

Syntax

upsfreightshipcontrol.NotifyEmail(NotifyIdx)[=string]

Default Value

""

Remarks

Email address of the recipient to be notified. This is required to be provided for each recipient.

The NotifyIdx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.

This property is not available at design time.

Data Type

String

NotifyMessage Property (UPSFreightShip Control)

User defined text that will be included in the email to be sent to Email .

Syntax

upsfreightshipcontrol.NotifyMessage(NotifyIdx)[=string]

Default Value

""

Remarks

User defined text that will be included in the email to be sent to NotifyEmail. This is optional.

For FedEx, when multiple recipients exist, the message for the first recipient is the only message that will be included in the request. FedEx only allows one message for all of the recipients of the notification email.

This property is not used by USPS or Canada Post.

The NotifyIdx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.

This property is not available at design time.

Data Type

String

NotifyFlags Property (UPSFreightShip Control)

Identifies the type of notification requested.

Syntax

upsfreightshipcontrol.NotifyFlags(NotifyIdx)[=integer]

Default Value

0

Remarks

Identifies the type of notification requested. Valid values are:

For FedEx notifications, the following flags apply:

• On Shipment
• On Exception
• On Delivery
• On Tender
• On Estimated Delivery
• HTML
• Text

To use Estimated Delivery with FedEx, the APIVersion configuration setting must be set to 19 or higher.

For UPS notifications, the following flags apply:

• On Shipment
• On Exception
• On Delivery
• On Return
• In Transit
• ADL
• UAP

For CanadaPost notifications, only the On Shipment, On Exception, and On Delivery apply.

This field is not used by USPS.

The NotifyIdx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.

This property is not available at design time.

Data Type

Integer

OverSeasLegHeight Property (UPSFreightShip Control)

The height of the shipment.

Syntax

upsfreightshipcontrol.OverSeasLegHeight[=integer]

Default Value

0

Remarks

The height of the shipment. For shipments with destinations of Hawaii, Alaska or Puerto Rico, you must specify this property or the TotalShipmentCubicFeet before shipping.

Data Type

Integer

OverSeasLegLength Property (UPSFreightShip Control)

The length of the shipment.

Syntax

upsfreightshipcontrol.OverSeasLegLength[=integer]

Default Value

0

Remarks

The length of the shipment. For shipments with destinations of Hawaii, Alaska or Puerto Rico, you must specify this property or the TotalShipmentCubicFeet before shipping.

Data Type

Integer

OverSeasLegPricePerCubicFoot Property (UPSFreightShip Control)

The price per CubicFoot.

Syntax

upsfreightshipcontrol.OverSeasLegPricePerCubicFoot[=string]

Default Value

""

Remarks

The price per CubicFoot.

Data Type

String

OverSeasLegPricePerCWT Property (UPSFreightShip Control)

Price per Hundredweight.

Syntax

upsfreightshipcontrol.OverSeasLegPricePerCWT[=string]

Default Value

""

Remarks

Price per Hundredweight. For shipments with Puerto Rico as a destination, you may specify this amount before shipping.

Data Type

String

OverSeasLegTotalCubicFeet Property (UPSFreightShip Control)

Total cubic weight of the shipment, obtained by multiplying width by height by depth.

Syntax

upsfreightshipcontrol.OverSeasLegTotalCubicFeet[=string]

Default Value

""

Remarks

Total cubic weight of the shipment, obtained by multiplying width by height by depth. For shipments with destinations of Hawaii, Alaska or Puerto Rico, you must specify this amount before shipping.

Data Type

String

OverSeasLegWidth Property (UPSFreightShip Control)

The width of the shipment.

Syntax

upsfreightshipcontrol.OverSeasLegWidth[=integer]

Default Value

0

Remarks

The width of the shipment. For shipments with destinations of Hawaii, Alaska or Puerto Rico, you must specify this property or the TotalShipmentCubicFeet before shipping.

Data Type

Integer

PayorAddress1 Property (UPSFreightShip Control)

Street name.

Syntax

upsfreightshipcontrol.PayorAddress1[=string]

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. Combination of PayorAddress1 and PayorAddress2 should not exceed 35 characters.

Data Type

String

PayorAddress2 Property (UPSFreightShip Control)

A specific detail on the address (such as building, suite, apartment, floor number etc.

Syntax

upsfreightshipcontrol.PayorAddress2[=string]

Default Value

""

Remarks

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. Combination of PayorAddress1 and PayorAddress2 should not exceed 35 characters.

Data Type

String

PayorCity Property (UPSFreightShip Control)

Name of city, town, etc.

Syntax

upsfreightshipcontrol.PayorCity[=string]

Default Value

""

Remarks

Name of city, town, etc.

Data Type

String

PayorCountryCode Property (UPSFreightShip Control)

The country code for the payor of the shipment, or duties and taxes.

Syntax

upsfreightshipcontrol.PayorCountryCode[=string]

Default Value

"US"

Remarks

The country code for the payor of the shipment, or duties and taxes.

When shipping via FedEx Express, the PayorCountryCode is required to be provided in the ship request only if PayorType is set to 'RECIPIENT' or 'THIRDPARTY'. For FedEx Ground shipments, the PayorCountryCode is required only if PayorType is set to 'THIRDPARTY'.

For UPS, this should be the same as it was entered in the UPS system when this account was set up. In domestic shipments, it will always default to US.

Data Type

String

PayorName Property (UPSFreightShip Control)

Identifies the payor's name.

Syntax

upsfreightshipcontrol.PayorName[=string]

Default Value

""

Remarks

Identifies the payor's name.

PayorName is required only if PayorType is set to 'THIRDPARTY'.

Note: This property is only applicable to UPSFreightRates and UPSFreightShip.

Data Type

String

PayorType Property (UPSFreightShip Control)

Method of payment for shipment, or duties and taxes.

Syntax

upsfreightshipcontrol.PayorType[=integer]

Possible Values

ptSender(0), 
ptRecipient(1), 
ptThirdParty(2), 
ptCollect(3), 
ptConsignee(4)

Default Value

0

Remarks

Method of payment for shipment, or duties and taxes. This is required to be provided in a ship request. Valid payment types are:

The COLLECT payment type is only supported in FedEx Ground services. The CONSIGNEE type is only supported in UPS service.

For FedEx, when this property is set to a value other than 0 (ptSender), the PayorAccountNumber and PayorCountryCode are required to be provided in the request as well. Otherwise, those will default to FedExAccountNumber and SenderCountryCode.

For UPS, when set to ptSender, the PayorAccountNumber is automatically set to UPSAccountNumber. When ptRecipient is specified, PayorAccountNumber and PayorZipCode are required to be provided in the request. For return international shipments, this option is invalid for transportation charges. And, when ptThirdParty has been specified, the PayorAccountNumber, PayorZipCode and PayorCountryCode are required to be provided in the request. When ptConsignee is specified, it indicates that UPS Consignee Billing option is selected, no other fields need to be set. ptConsignee only applies to US/PR and PR/US shipment origins and destination.

Data Type

Integer

PayorState Property (UPSFreightShip Control)

State or province code.

Syntax

upsfreightshipcontrol.PayorState[=string]

Default Value

""

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

Data Type

String

PayorZipCode Property (UPSFreightShip Control)

Payor's postal code (if applicable).

Syntax

upsfreightshipcontrol.PayorZipCode[=string]

Default Value

""

Remarks

Payor's postal code (if applicable).

This is only applicable to UPS and is the corresponding postal code of the UPS PayorAccountNumber's pickup address. This should be the same as it was entered in the UPS system when this account was set up.

It can be provided in a ship request only if the PayorType is set to 1 (RECIPIENT) or 2 (THIRDPARTY).

Maximum length: 10.

Data Type

String

PickupRequesterCompany Property (UPSFreightShip Control)

Identifies the contact person's company name.

Syntax

upsfreightshipcontrol.PickupRequesterCompany[=string]

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either PickupRequesterFirstName and PickupRequesterLastName or PickupRequesterCompany are required to be provided.

Data Type

String

PickupRequesterEmail Property (UPSFreightShip Control)

Identifies the contact person's email address.

Syntax

upsfreightshipcontrol.PickupRequesterEmail[=string]

Default Value

""

Remarks

Identifies the contact person's email address. Maximum length: 120.

Data Type

String

PickupRequesterFax Property (UPSFreightShip Control)

Recipient's fax number.

Syntax

upsfreightshipcontrol.PickupRequesterFax[=string]

Default Value

""

Remarks

Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.

Data Type

String

PickupRequesterFirstName Property (UPSFreightShip Control)

Sender's first name.

Syntax

upsfreightshipcontrol.PickupRequesterFirstName[=string]

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either PickupRequesterFirstName and PickupRequesterLastName or PickupRequesterCompany must be sent.

Data Type

String

PickupRequesterLastName Property (UPSFreightShip Control)

Person's last name.

Syntax

upsfreightshipcontrol.PickupRequesterLastName[=string]

Default Value

""

Remarks

Person's last name. The value of this property is required. Values for either PickupRequesterFirstName and PickupRequesterLastName or PickupRequesterCompany must be sent. Maximum length: 45 characters for both names or company name.

Data Type

String

PickupRequesterMiddleInitial Property (UPSFreightShip Control)

Middle initial.

Syntax

upsfreightshipcontrol.PickupRequesterMiddleInitial[=string]

Default Value

""

Remarks

Middle initial. The value of this property is optional.

Data Type

String

PickupRequesterPhone Property (UPSFreightShip Control)

Identifies the contact person's phone number.

Syntax

upsfreightshipcontrol.PickupRequesterPhone[=string]

Default Value

""

Remarks

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

Data Type

String

ProxyAuthScheme Property (UPSFreightShip Control)

This property is used to tell the control which type of authorization to perform when connecting to the proxy.

Syntax

upsfreightshipcontrol.ProxyAuthScheme[=integer]

Possible Values

authBasic(0), 
authDigest(1), 
authProprietary(2), 
authNone(3), 
authNtlm(4), 
authNegotiate(5)

Default Value

0

Remarks

This property is used to tell the control which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the control. Look at the configuration file for the control being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (UPSFreightShip Control)

This property tells the control whether or not to automatically detect and use proxy system settings, if available.

Syntax

upsfreightshipcontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

This property tells the control whether or not to automatically detect and use proxy system settings, if available. The default value is .

Data Type

Boolean

ProxyPassword Property (UPSFreightShip Control)

This property contains a password if authentication is to be used for the proxy.

Syntax

upsfreightshipcontrol.ProxyPassword[=string]

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (UPSFreightShip Control)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

upsfreightshipcontrol.ProxyPort[=integer]

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (UPSFreightShip Control)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

upsfreightshipcontrol.ProxyServer[=string]

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (UPSFreightShip Control)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

upsfreightshipcontrol.ProxySSL[=integer]

Possible Values

psAutomatic(0), 
psAlways(1), 
psNever(2), 
psTunnel(3)

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (UPSFreightShip Control)

This property contains a username if authentication is to be used for the proxy.

Syntax

upsfreightshipcontrol.ProxyUser[=string]

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

RecipientAddress1 Property (UPSFreightShip Control)

Street name.

Syntax

upsfreightshipcontrol.RecipientAddress1[=string]

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS RecipientAddress1 should not exceed 35 characters.

Data Type

String

RecipientAddress2 Property (UPSFreightShip Control)

A specific detail on the address (such as building, suite, apartment, floor number etc.

Syntax

upsfreightshipcontrol.RecipientAddress2[=string]

Default Value

""

Remarks

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS RecipientAddress2 should not exceed 35 characters.

Data Type

String

RecipientAddressFlags Property (UPSFreightShip Control)

Various flags that denote information about the address.

Syntax

upsfreightshipcontrol.RecipientAddressFlags[=integer]

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

RecipientCity Property (UPSFreightShip Control)

Name of city, town, etc.

Syntax

upsfreightshipcontrol.RecipientCity[=string]

Default Value

""

Remarks

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

Data Type

String

RecipientCountryCode Property (UPSFreightShip Control)

Country code.

Syntax

upsfreightshipcontrol.RecipientCountryCode[=string]

Default Value

"US"

Remarks

Country code. This identifies a country. In a ship request, this is required to be provided for both sender and recipient. Maximum length: 2.

Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered. Note that with USPS you can also specify the full country name here.

* Not supported by USPS

** Has multiple values, the values used for USPS are below

Data Type

String

RecipientState Property (UPSFreightShip Control)

State or province code.

Syntax

upsfreightshipcontrol.RecipientState[=string]

Default Value

""

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

Data Type

String

RecipientZipCode Property (UPSFreightShip Control)

Postal code.

Syntax

upsfreightshipcontrol.RecipientZipCode[=string]

Default Value

""

Remarks

Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both RecipientCity and RecipientState are not present.

Valid characters: A-Z; 0-9; a-z. Maximum length: 16.

Data Type

String

RecipientCompany Property (UPSFreightShip Control)

Identifies the contact person's company name.

Syntax

upsfreightshipcontrol.RecipientCompany[=string]

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either RecipientFirstName and RecipientLastName or RecipientCompany are required to be provided.

Data Type

String

RecipientEmail Property (UPSFreightShip Control)

Identifies the contact person's email address.

Syntax

upsfreightshipcontrol.RecipientEmail[=string]

Default Value

""

Remarks

Identifies the contact person's email address. Maximum length: 120.

Data Type

String

RecipientFax Property (UPSFreightShip Control)

Recipient's fax number.

Syntax

upsfreightshipcontrol.RecipientFax[=string]

Default Value

""

Remarks

Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.

Data Type

String

RecipientFirstName Property (UPSFreightShip Control)

Sender's first name.

Syntax

upsfreightshipcontrol.RecipientFirstName[=string]

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either RecipientFirstName and RecipientLastName or RecipientCompany must be sent.

Data Type

String

RecipientLastName Property (UPSFreightShip Control)

Person's last name.

Syntax

upsfreightshipcontrol.RecipientLastName[=string]

Default Value

""

Remarks

Person's last name. The value of this property is required. Values for either RecipientFirstName and RecipientLastName or RecipientCompany must be sent. Maximum length: 45 characters for both names or company name.

Data Type

String

RecipientMiddleInitial Property (UPSFreightShip Control)

Middle initial.

Syntax

upsfreightshipcontrol.RecipientMiddleInitial[=string]

Default Value

""

Remarks

Middle initial. The value of this property is optional.

Data Type

String

RecipientPhone Property (UPSFreightShip Control)

Identifies the contact person's phone number.

Syntax

upsfreightshipcontrol.RecipientPhone[=string]

Default Value

""

Remarks

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

Data Type

String

ReferenceCount Property (UPSFreightShip Control)

The number of records in the Reference arrays.

Syntax

upsfreightshipcontrol.ReferenceCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• ReferenceNumber
• ReferenceNumberOfCartons
• ReferenceType
• ReferenceWeight

The array indices start at 0 and end at ReferenceCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ReferenceNumber Property (UPSFreightShip Control)

The reference number.

Syntax

upsfreightshipcontrol.ReferenceNumber(ReferenceIndex)

Default Value

""

Remarks

The reference number.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

String

ReferenceNumberOfCartons Property (UPSFreightShip Control)

The number of cartons.

Syntax

upsfreightshipcontrol.ReferenceNumberOfCartons(ReferenceIndex)

Default Value

0

Remarks

The number of cartons.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

Integer

ReferenceType Property (UPSFreightShip Control)

The type of the reference number.

Syntax

upsfreightshipcontrol.ReferenceType(ReferenceIndex)

Possible Values

frtBillOfLadingNumber(0), 
frtPurchaseOrderNumber(1), 
frtOTHER(2), 
frtPM(3), 
frtPROJ(4), 
frtQUOTE(5), 
frtSID(6), 
frtTASK(7), 
frtVPRC(8)

Default Value

0

Remarks

The type of the reference number. Possible values are:

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

Integer

ReferenceWeight Property (UPSFreightShip Control)

The weight.

Syntax

upsfreightshipcontrol.ReferenceWeight(ReferenceIndex)

Default Value

"0"

Remarks

The weight.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

String

SenderAddress1 Property (UPSFreightShip Control)

Street name.

Syntax

upsfreightshipcontrol.SenderAddress1[=string]

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS SenderAddress1 should not exceed 35 characters.

Data Type

String

SenderAddress2 Property (UPSFreightShip Control)

A specific detail on the address (such as building, suite, apartment, floor number etc.

Syntax

upsfreightshipcontrol.SenderAddress2[=string]

Default Value

""

Remarks

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS SenderAddress2 should not exceed 35 characters.

Data Type

String

SenderCity Property (UPSFreightShip Control)

Name of city, town, etc.

Syntax

upsfreightshipcontrol.SenderCity[=string]

Default Value

""

Remarks

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

Data Type

String

SenderCountryCode Property (UPSFreightShip Control)

Country code.

Syntax

upsfreightshipcontrol.SenderCountryCode[=string]

Default Value

"US"

Remarks

Country code. This identifies a country. In a ship request, this is required to be provided for both sender and recipient. Maximum length: 2.

Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered. Note that with USPS you can also specify the full country name here.

* Not supported by USPS

** Has multiple values, the values used for USPS are below

Data Type

String

SenderState Property (UPSFreightShip Control)

State or province code.

Syntax

upsfreightshipcontrol.SenderState[=string]

Default Value

""

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

Data Type

String

SenderZipCode Property (UPSFreightShip Control)

Postal code.

Syntax

upsfreightshipcontrol.SenderZipCode[=string]

Default Value

""

Remarks

Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both SenderCity and SenderState are not present.

Valid characters: A-Z; 0-9; a-z. Maximum length: 16.

Data Type

String

SenderCompany Property (UPSFreightShip Control)

Identifies the contact person's company name.

Syntax

upsfreightshipcontrol.SenderCompany[=string]

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either SenderFirstName and SenderLastName or SenderCompany are required to be provided.

Data Type

String

SenderEmail Property (UPSFreightShip Control)

Identifies the contact person's email address.

Syntax

upsfreightshipcontrol.SenderEmail[=string]

Default Value

""

Remarks

Identifies the contact person's email address. Maximum length: 120.

Data Type

String

SenderFax Property (UPSFreightShip Control)

Recipient's fax number.

Syntax

upsfreightshipcontrol.SenderFax[=string]

Default Value

""

Remarks

Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.

Data Type

String

SenderFirstName Property (UPSFreightShip Control)

Sender's first name.

Syntax

upsfreightshipcontrol.SenderFirstName[=string]

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either SenderFirstName and SenderLastName or SenderCompany must be sent.

Data Type

String

SenderLastName Property (UPSFreightShip Control)

Person's last name.

Syntax

upsfreightshipcontrol.SenderLastName[=string]

Default Value

""

Remarks

Person's last name. The value of this property is required. Values for either SenderFirstName and SenderLastName or SenderCompany must be sent. Maximum length: 45 characters for both names or company name.

Data Type

String

SenderMiddleInitial Property (UPSFreightShip Control)

Middle initial.

Syntax

upsfreightshipcontrol.SenderMiddleInitial[=string]

Default Value

""

Remarks

Middle initial. The value of this property is optional.

Data Type

String

SenderPhone Property (UPSFreightShip Control)

Identifies the contact person's phone number.

Syntax

upsfreightshipcontrol.SenderPhone[=string]

Default Value

""

Remarks

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

Data Type

String

ServiceType Property (UPSFreightShip Control)

The service selected for the shipment.

Syntax

upsfreightshipcontrol.ServiceType[=integer]

Possible Values

stUPSFreight(0), 
stUPSFreightGuaranteed(1)

Default Value

0

Remarks

Specifies the service to be used for the shipment.

Valid values for UPS Freight are:

Data Type

Integer

ShipmentNumber Property (UPSFreightShip Control)

The shipment number assigned to the shipment.

Syntax

upsfreightshipcontrol.ShipmentNumber

Default Value

""

Remarks

This property contains a 9 character shipment number returned in the response.

This property is read-only.

Data Type

String

SSLAcceptServerCertEncoded Property (UPSFreightShip Control)

This is the certificate (PEM/Base64 encoded).

Syntax

upsfreightshipcontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (UPSFreightShip Control)

This is the certificate (PEM/Base64 encoded).

Syntax

upsfreightshipcontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (UPSFreightShip Control)

This is the name of the certificate store for the client certificate.

Syntax

upsfreightshipcontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (UPSFreightShip Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

upsfreightshipcontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (UPSFreightShip Control)

This is the type of certificate store for this certificate.

Syntax

upsfreightshipcontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (UPSFreightShip Control)

This is the subject of the certificate used for client authentication.

Syntax

upsfreightshipcontrol.SSLCertSubject[=string]

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (UPSFreightShip Control)

This specifies the SSL/TLS implementation to use.

Syntax

upsfreightshipcontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the control will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

Additional Notes

In most cases using the default value (Automatic) is recommended. The control will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (UPSFreightShip Control)

This is the certificate (PEM/Base64 encoded).

Syntax

upsfreightshipcontrol.SSLServerCertEncoded

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

This property is read-only and not available at design time.

Data Type

Binary String

Timeout Property (UPSFreightShip Control)

A timeout for the control.

Syntax

upsfreightshipcontrol.Timeout[=integer]

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the control will wait for the operation to complete before returning control.

The control will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the control fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TotalCharge Property (UPSFreightShip Control)

Represents the total shipment charge.

Syntax

upsfreightshipcontrol.TotalCharge

Default Value

""

Remarks

This property holds the total charge associated with the shipment. The value is represented in dollars and cents with two decimal places. For instance "1500.25".

This property is read-only.

Data Type

String

UPSAccountNumber Property (UPSFreightShip Control)

The shipper's UPS account number.

Syntax

upsfreightshipcontrol.UPSAccountNumber[=string]

Default Value

""

Remarks

The shipper's UPS account number.

This property describes the shipper's 6- or 10- digit UPS account number.

Data Type

String

UPSAuthorizationToken Property (UPSFreightShip Control)

Authorization Token used to authenticate the request.

Syntax

upsfreightshipcontrol.UPSAuthorizationToken[=string]

Default Value

""

Remarks

Authorization Token used to authenticate the request.

This field should be set to the value of a bearer token obtained through OAuth 2.0. For more information on getting a bearer token, see the documentation for the OAuth component.

Data Type

String

UPSServer Property (UPSFreightShip Control)

URL for the UPS server where the requests are sent.

Syntax

upsfreightshipcontrol.UPSServer[=string]

Default Value

""

Remarks

URL for the UPS server where the requests are sent. This will overwrite the internal values that the component uses.

Normally, you do not need to set this property. By default, the component will send the request to the preset production end-point. In order to send request to the test environment, you must set the TESTMODE config to true like: component.Config("TESTMODE=true").

The following URLs may be used for testing:

Data Type

String

Config Method (UPSFreightShip Control)

Sets or retrieves a configuration setting.

Syntax

upsfreightshipcontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

GetShipmentDocuments Method (UPSFreightShip Control)

Generates a shipping label using one of domestic UPS services.

Syntax

upsfreightshipcontrol.GetShipmentDocuments 

Remarks

The following properties must be set before calling this method:

• UPSServer (required)
• UPSAuthorizationToken (required)
• UPSAccountNumber (required)
• SenderContact (required)
• SenderAddress (required)
• RecipientContact (required)
• RecipientAddress (required)
• DocumentFileName
• DocumentLabelsPerPage
• DocumentPrintFormat
• DocumentPrintSize
• DocumentType (required)
• CommodityDescription (required)
• CommodityFreightClass (required for ground shipments)
• CommodityFreightIsHazardous
• CommodityFreightNMFC
• CommodityFreightNMFCSub
• CommodityNumberOfPieces (required)
• CommodityFreightPackagingType (required)
• CommodityValue (required)
• CommodityWeight (required)
• WeightUnit (required; defaults to LBS)

Documents specifies information about the requested documents, including the type of document being requested, formatting information, and the filename to which the document will be saved.

Upon successful response, the following properties will be populated:

• BOLID
• ShipmentNumber
• BillableWeight
• ChargeType
• ChargeDescription
• ChargeValue
• TotalCharge

The documents will be written to the filenames set in DocumentFileName.

Code example:

component.UPSAccount.Server = "https://wwwcie.ups.com/api/freight/" component.UPSAuthorizationToken = "Bearer token..." component.UPSAccountNumber = "000000" component.SenderCompany = "Developer Test 1" component.SenderPhone = "884530171" component.SenderAddress1 = "101 Developer Way" component.SenderCity = "Richmond" component.SenderState = "VA" component.SenderZipCode = "23224" component.SenderCountryCode = "US" component.RecipientCompany = "Consignee Test 1" component.RecipientAddress1 = "1000 Consignee Street" component.RecipientCity = "Allanton" component.RecipientState = "MO" component.RecipientZipCode = "63001" component.RecipientCountryCode = "US" component.PayorType = ptSender component.HandlingUnit = "SKD:1" component.CommodityCount = 1 component.CommodityDescription(0) = "LCD TVS" component.CommodityFreightClass(0) = "77.5" component.CommodityWeight(0) = "150" component.CommodityFreightNMFC(0) = "132680" component.CommodityFreightNMFCSub(0) = "02" component.CommodityNumberOfPieces(0) = 20 component.CommodityValue(0) = "100" component.DocumentCount = 1 component.DocumentPrintFormat = fpfLaser component.DocumentPrintSize = fpsSize8X11 component.DocumentType = ftcLabel component.DocumentFileName = "TestLabel.pdf" component.GetShipmentDocuments Debug.Print ("Total Charge: " & component.TotalCharge) Dim i As Integer For i = 0 To component.ChargeCount - 1 Debug.Print component.ChargeType(0) & ": " & component.ChargeValue(0) Next i Debug.Print ("Billable Weight: " & component.BillableWeight) Debug.Print ("BOLID: " & component.BOLID) Debug.Print ("Shipment Number: " & component.ShipmentNumber)

Reset Method (UPSFreightShip Control)

Resets the internal state of the control and all properties to their default values.

Syntax

upsfreightshipcontrol.Reset 

Remarks

The Reset method does not have any parameters and does not return any value.

Error Event (UPSFreightShip Control)

Information about errors during data delivery.

Syntax

Sub upsfreightshipcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Notification Event (UPSFreightShip Control)

Notification returned by the server upon successful request (if applicable).

Syntax

Sub upsfreightshipcontrol_Notification(Message As String)

Remarks

When sending a request, the server may return with a successful reply or an error. However, even when a transaction is successful, a warning or a note might still be returned by the server. In such cases, the Notification event is fired.

Notifications returned through this event are non-fatal and shipments will still be processes, labels will still be printable, rates are still returned, etc. These notifications should be treated as informational only.

SSLServerAuthentication Event (UPSFreightShip Control)

Fired after the server presents its certificate to the client.

Syntax

Sub upsfreightshipcontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (UPSFreightShip Control)

Fired when secure connection progress messages are available.

Syntax

Sub upsfreightshipcontrol_SSLStatus(Message As String)

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Config Settings (UPSFreightShip Control)

The control accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

UPSFreightShip Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (UPSFreightShip Control)

UPSFreightShip Errors

	20302    Operation interrupted (or timeout).
	20433    Invalid index.
	20528    Server Error Response.
	20529    Property set with invalid data.
	20561    Missing data.

The control may also return one of the following error codes, which are inherited from other controls.