UPSFreightShip Component

Properties   Methods   Events   Config Settings   Errors  

Provides UPS Freight Shipment service.

Syntax

TibxUPSFreightShip

Remarks

The UPSFreightShip component allows labels and documents to be generated for a freight shipment. To use the component, 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 component with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

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

Config Settings

---

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

BillableWeight Property (UPSFreightShip Component)

Represents the billable weight associated with the shipment.

Syntax

property BillableWeight: String read get_BillableWeight;

Default Value

''

Remarks

This property is read-only.

BOLID Property (UPSFreightShip Component)

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

Syntax

property BOLID: String read get_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.

Charges Property (UPSFreightShip Component)

Collection of shipment charges.

Syntax

property Charges: TibxChargeDetailList read get_Charges write set_Charges;

Remarks

Freight shipments may include various charges. This collection holds information about each of the charges applied to this shipment.

Please refer to the ChargeDetail type for a complete list of fields.

CODPayorType Property (UPSFreightShip Component)

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

Syntax

property CODPayorType: TibxTFreightCODPayorTypes read get_CODPayorType write set_CODPayorType;

TibxTFreightCODPayorTypes = (
  fcodptCollect,
  fcodptPrepaid
);

Default Value

fcodptCollect

Remarks

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

CODRemitToAddress Property (UPSFreightShip Component)

Specifies the contact address detail of the contact to whom to send COD funds. If not specified, sender address will be used.

Syntax

property CODRemitToAddress: TibxAddressDetail read get_CODRemitToAddress write set_CODRemitToAddress;

Remarks

Please refer to the AddressDetail type for a complete list of fields.

CODRemitToContact Property (UPSFreightShip Component)

Specifies the contact detail of the contact to whom to send COD funds. If not specified, funds will be sent to the sender.

Syntax

property CODRemitToContact: TibxContactDetail read get_CODRemitToContact write set_CODRemitToContact;

Remarks

Please refer to the ContactDetail type for a complete list of fields.

CODTotalAmount Property (UPSFreightShip Component)

The total amount of additional fees.

Syntax

property CODTotalAmount: String read get_CODTotalAmount write set_CODTotalAmount;

Default Value

''

Remarks

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

CODType Property (UPSFreightShip Component)

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

Syntax

property CODType: TibxTFreightCODTypes read get_CODType write set_CODType;

TibxTFreightCODTypes = (
  fcodtsCertifiedCheck,
  fcodtsCash,
  fcodtsCompanyCheck
);

Default Value

fcodtsCertifiedCheck

Remarks

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

Commodities Property (UPSFreightShip Component)

Collection of commodity items of the shipment.

Syntax

property Commodities: TibxCommodityDetailList read get_Commodities write set_Commodities;

Remarks

This collection contains details of the commodities associated with the shipment. At least one commodity must be added for international shipments.

For each idx = 0 to CommodityCount - 1, this must be set to an instance of the CommodityDetail type, which will contain specific information about a commodity item contained in the shipment. See the CommodityDetail type for more information.

The following properties are applicable for each commodity item:

Note: The WeightUnit configuration setting may be set to specify KGS instead of LBS for the weight unit.

For instance, to add a commodity: Weight = 1500 FreightClass = "92.5" FreightNMFC = "116030" FreightNMFCSub = "1" NumberOfPieces = 1 Description = "Test Items"

Please refer to the CommodityDetail type for a complete list of fields.

DimensionalWeight Property (UPSFreightShip Component)

Represents the dimensional weight associated with the shipment.

Syntax

property DimensionalWeight: String read get_DimensionalWeight;

Default Value

''

Remarks

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

This property is read-only.

Documents Property (UPSFreightShip Component)

Collection of information about each of the requested documents.

Syntax

property Documents: TibxDocumentInfoList read get_Documents write set_Documents;

Remarks

This collection contains information about the requested documents. Populate this collection to request specific documents such as labels, packing lists, etc. This must be set before calling GetShipmentDocuments. For 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)

Please refer to the DocumentInfo type for a complete list of fields.

Firewall Property (UPSFreightShip Component)

A set of properties related to firewall access.

Syntax

property Firewall: TibxFirewall read get_Firewall write set_Firewall;

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.

Please refer to the Firewall type for a complete list of fields.

HandlingUnit Property (UPSFreightShip Component)

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

Syntax

property HandlingUnit: String read get_HandlingUnit write set_HandlingUnit;

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'.

HazMatContactName Property (UPSFreightShip Component)

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

Syntax

property HazMatContactName: String read get_HazMatContactName write set_HazMatContactName;

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 FreightIsHazardous is true.

HazMatContactPhone Property (UPSFreightShip Component)

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

Syntax

property HazMatContactPhone: String read get_HazMatContactPhone write set_HazMatContactPhone;

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 FreightIsHazardous is true.

Notify Property (UPSFreightShip Component)

Collection of e-mail notifications to be sent.

Syntax

property Notify: TibxNotifyDetailList read get_Notify write set_Notify;

Remarks

The Notify is optional to be provided in a ship request. This should be set only if the shipper wants to send e-mail notifications on shipment status, exceptions, and/or delivery status. Up to 3 notification requests can be made within a ship request.

For each idx = 0 to NotifyCount - 1 (where NotifyCount<=2), this must be set to an instance of the NotifyDetail type, which will contain specific information about the notification to be e-mailed. See the NotifyDetail type for more information.

Each notification has a: NotificationFlags (required), Email (required), Message (optional) tied to it.

For instance, if only one notification is requested to be sent:

component.Email(0) = "test@test.com" component.NotificationFlags(0) = 0x00000001 // On Shipment component.Message(0) = "test"

This property is not available at design time.

Please refer to the NotifyDetail type for a complete list of fields.

OverSeasLeg Property (UPSFreightShip Component)

Identifies the OverSeasLeg detail. Required when origin or destination is Hawaii, Alaska, and Puerto Rico.

Syntax

property OverSeasLeg: TibxOverSeasLegDetail read get_OverSeasLeg write set_OverSeasLeg;

Remarks

This must be set to an instance of the OverSeasLegDetail type, which will contain the ShipmentWidth, ShipmentLength and ShipmentHeight etc. See the OverSeasLegDetail type for more information.

Please refer to the OverSeasLegDetail type for a complete list of fields.

Payor Property (UPSFreightShip Component)

Identifies the payor of transportation charges for the shipment.

Syntax

property Payor: TibxPayorDetail read get_Payor write set_Payor;

Remarks

The Payor is required to be provided in a ship request. This must be set to an instance of the PayorDetail type, which will contain the payor details. See the PayorDetail type for more information.

Please refer to the PayorDetail type for a complete list of fields.

PickupRequester Property (UPSFreightShip Component)

Identifies the pickup requester's contact info. Used with the EarliestPickupTime and LatestPickupTime configuration settings.

Syntax

property PickupRequester: TibxContactDetail read get_PickupRequester write set_PickupRequester;

Remarks

The PickupRequester is required only if a pickup is requested.

This must be set to an instance of the ContactDetail type, which will contain specific contact information about the pickup requester. See the ContactDetail type for more information.

Please refer to the ContactDetail type for a complete list of fields.

Proxy Property (UPSFreightShip Component)

A set of properties related to proxy access.

Syntax

property Proxy: TibxProxy read get_Proxy write set_Proxy;

Remarks

This property contains fields describing the proxy through which the component will attempt to connect.

Please refer to the Proxy type for a complete list of fields.

RecipientAddress Property (UPSFreightShip Component)

Identifies the recipient's address.

Syntax

property RecipientAddress: TibxAddressDetail read get_RecipientAddress write set_RecipientAddress;

Remarks

The RecipientAddress is required to be provided in a ship request.

This must be set to an instance of the AddressDetail type, which will contain recipient's address info. See the AddressDetail type for more information.

Please refer to the AddressDetail type for a complete list of fields.

RecipientContact Property (UPSFreightShip Component)

Identifies the recipient's contact info.

Syntax

property RecipientContact: TibxContactDetail read get_RecipientContact write set_RecipientContact;

Remarks

The RecipientContact is required to be provided in a ship request.

The Company is required to be provided in the request. In domestic shipments: the FirstName and LastName are required when using UPS Next Day Air Early A.M. service. In international shipments: the FirstName and LastName are required when the CountryCode is different than CountryCode, and if Commercial Invoice international form is requested.

The RecipientContact must be set to an instance of the ContactDetail type, which will contain specific contact information about the point-of-contact recipient. See the ContactDetail type for more information.

Please refer to the ContactDetail type for a complete list of fields.

References Property (UPSFreightShip Component)

Collection of reference numbers for the shipment.

Syntax

property References: TibxReferenceDetailList read get_References;

Remarks

This collection holds the reference numbers that identify the shipment. See ReferenceType for a complete list of possible types of reference numbers returned.

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

Please refer to the ReferenceDetail type for a complete list of fields.

SenderAddress Property (UPSFreightShip Component)

Identifies the sender's address.

Syntax

property SenderAddress: TibxAddressDetail read get_SenderAddress write set_SenderAddress;

Remarks

The SenderAddress is required to be provided in a ship request when the GetShipmentLabels method is called.

This must be set to an instance of the AddressDetail type, which will contain shipper's address details. See the AddressDetail type for more information.

Please refer to the AddressDetail type for a complete list of fields.

SenderContact Property (UPSFreightShip Component)

Identifies the sender's contact info.

Syntax

property SenderContact: TibxContactDetail read get_SenderContact write set_SenderContact;

Remarks

The SenderContact is required to be provided in a ship request, when the GetShipmentLabels method is called.

This must be set to an instance of the ContactDetail type, which will contain specific contact information about the point-of-contact sender. See the ContactDetail type for more information.

Please refer to the ContactDetail type for a complete list of fields.

ServiceType Property (UPSFreightShip Component)

The service selected for the shipment.

Syntax

property ServiceType: TibxUServiceTypes read get_ServiceType write set_ServiceType;

TibxUServiceTypes = (
  stUPSFreight,
  stUPSFreightGuaranteed
);

Default Value

stUPSFreight

Remarks

Specifies the service to be used for the shipment.

Valid values for UPS Freight are:

ShipmentNumber Property (UPSFreightShip Component)

The shipment number assigned to the shipment.

Syntax

property ShipmentNumber: String read get_ShipmentNumber;

Default Value

''

Remarks

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

This property is read-only.

SSLAcceptServerCertEncoded Property (UPSFreightShip Component)

This is the certificate (PEM/Base64 encoded).

Syntax

property SSLAcceptServerCertEncoded: String read get_SSLAcceptServerCertEncoded write set_SSLAcceptServerCertEncoded;
property SSLAcceptServerCertEncodedB: TBytes read get_SSLAcceptServerCertEncodedB write set_SSLAcceptServerCertEncodedB;

Default Value

''

Remarks

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

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

This property is not available at design time.

SSLCertEncoded Property (UPSFreightShip Component)

This is the certificate (PEM/Base64 encoded).

Syntax

property SSLCertEncoded: String read get_SSLCertEncoded write set_SSLCertEncoded;
property SSLCertEncodedB: TBytes read get_SSLCertEncodedB write set_SSLCertEncodedB;

Default Value

''

Remarks

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

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

This property is not available at design time.

SSLCertStore Property (UPSFreightShip Component)

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

Syntax

property SSLCertStore: String read get_SSLCertStore write set_SSLCertStore;
property SSLCertStoreB: TBytes read get_SSLCertStoreB write set_SSLCertStoreB;

Default Value

'MY'

Remarks

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

The StoreType property denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject property to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject 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).

SSLCertStorePassword Property (UPSFreightShip Component)

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

Syntax

property SSLCertStorePassword: String read get_SSLCertStorePassword write set_SSLCertStorePassword;

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.

SSLCertStoreType Property (UPSFreightShip Component)

This is the type of certificate store for this certificate.

Syntax

property SSLCertStoreType: TibxCertStoreTypes read get_SSLCertStoreType write set_SSLCertStoreType;

TibxCertStoreTypes = (
  cstUser,
  cstMachine,
  cstPFXFile,
  cstPFXBlob,
  cstJKSFile,
  cstJKSBlob,
  cstPEMKeyFile,
  cstPEMKeyBlob,
  cstPublicKeyFile,
  cstPublicKeyBlob,
  cstSSHPublicKeyBlob,
  cstP7BFile,
  cstP7BBlob,
  cstSSHPublicKeyFile,
  cstPPKFile,
  cstPPKBlob,
  cstXMLFile,
  cstXMLBlob,
  cstJWKFile,
  cstJWKBlob,
  cstSecurityKey,
  cstBCFKSFile,
  cstBCFKSBlob,
  cstPKCS11,
  cstAuto
);

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

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

SSLCertSubject Property (UPSFreightShip Component)

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

Syntax

property SSLCertSubject: String read get_SSLCertSubject write set_SSLCertSubject;

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.

SSLProvider Property (UPSFreightShip Component)

This specifies the SSL/TLS implementation to use.

Syntax

property SSLProvider: TibxTSSLProviders read get_SSLProvider write set_SSLProvider;

TibxTSSLProviders = (
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
);

Default Value

sslpAutomatic

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 component 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 component will select a provider depending on the current platform.

When Automatic is selected, on Windows the component will use the platform implementation. On Linux/macOS the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

SSLServerCertEncoded Property (UPSFreightShip Component)

This is the certificate (PEM/Base64 encoded).

Syntax

property SSLServerCertEncoded: String read get_SSLServerCertEncoded;
property SSLServerCertEncodedB: TBytes read get_SSLServerCertEncodedB;

Default Value

''

Remarks

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

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

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

Timeout Property (UPSFreightShip Component)

A timeout for the component.

Syntax

property Timeout: Integer read get_Timeout write set_Timeout;

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 component will wait for the operation to complete before returning control.

The component 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 component raises an exception.

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.

TotalCharge Property (UPSFreightShip Component)

Represents the total shipment charge.

Syntax

property TotalCharge: String read get_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.

UPSAccount Property (UPSFreightShip Component)

Login information for UPS.

Syntax

property UPSAccount: TibxUPSAccount read get_UPSAccount write set_UPSAccount;

Remarks

This property must be set when connecting to UPS server. It contains server and login information.

Please refer to the UPSAccount type for a complete list of fields.

Config Method (UPSFreightShip Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 Component)

Generates a shipping label using one of domestic UPS services.

Syntax

procedure GetShipmentDocuments();

Remarks

The following properties must be set before calling this method:

• Server (required)
• AuthorizationToken (required)
• AccountNumber (required)
• SenderContact (required)
• SenderAddress (required)
• RecipientContact (required)
• RecipientAddress (required)
• FileName
• LabelsPerPage
• PrintFormat
• PrintSize
• DocumentType (required)
• Description (required)
• FreightClass (required for ground shipments)
• FreightIsHazardous
• FreightNMFC
• FreightNMFCSub
• NumberOfPieces (required)
• FreightPackagingType (required)
• Value (required)
• Weight (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
• Description
• Value
• TotalCharge

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

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 Component)

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

Syntax

procedure Reset();

Remarks

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

Error Event (UPSFreightShip Component)

Information about errors during data delivery.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

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 Component)

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

Syntax

type TNotificationEvent = procedure (
  Sender: TObject;
  const Message: String
) of Object;

property OnNotification: TNotificationEvent read FOnNotification write FOnNotification;

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 Component)

Fired after the server presents its certificate to the client.

Syntax

type TSSLServerAuthenticationEvent = procedure (
  Sender: TObject;
  CertEncoded: String;
  CertEncodedB: TBytes;
  const CertSubject: String;
  const CertIssuer: String;
  const Status: String;
  var Accept: Boolean
) of Object;

property OnSSLServerAuthentication: TSSLServerAuthenticationEvent read FOnSSLServerAuthentication write FOnSSLServerAuthentication;

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 Component)

Fired when secure connection progress messages are available.

Syntax

type TSSLStatusEvent = procedure (
  Sender: TObject;
  const Message: String
) of Object;

property OnSSLStatus: TSSLStatusEvent read FOnSSLStatus write FOnSSLStatus;

Remarks

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

AddressDetail Type

Represents the address details of a sender or recipient.

Remarks

This type contains descriptive data of physical location of a sender or recipient.

Example: Setting the fields of a sender SenderAddress addr = new SenderAddress addr.Address1 = "100 Somewhere St." addr.Address2 = "Ste 100" addr.City = "Raleigh" addr.State = "NC" addr.ZipCode = "27154" addr.CountryCode = "US"

The properties contained by this type are listed below.

Fields

Constructors

constructor Create();

ChargeDetail Type

Represents a shipment charge returned on a successful response.

Remarks

Fields

Constructors

constructor Create();

CommodityDetail Type

Represents a single commodity line item.

Remarks

This type contains specific information about a commodity line item included in the shipment. It is used in the international shipping components when either the GetPackageLabel or GetShipmentLabels method is called. For UPS, it is applicable if any of the international forms (Invoice, CO, NAFTA CO, SED or Partial Invoice) are requested.

Example: Setting the fields for a commodity line item CommodityDetail commodity = new CommodityDetail(); commodity.Description = "Computer software" commodity.Manufacturer = "US" commodity.Weight = "1.0" commodity.QuantityUnit = "EA" commodity.UnitPrice = "99.99" commodity.HarmonizedCode = "9031.80.90"

Note: The following fields are applicable to UPS Freight services.

The fields contained by this type are listed below.

Fields

Constructors

constructor Create();

constructor Create(valDescription: String; valManufacturer: String; valHarmonizedCode: String; valScheduleBCode: String; valWeight: String; valQuantity: Integer; valQuantityUnit: String; valUnitPrice: String; valNumberOfPieces: Integer; valExportType: Integer);

constructor Create(valDescription: String; valManufacturer: String; valHarmonizedCode: String; valScheduleBCode: String; valWeight: String; valQuantity: Integer; valQuantityUnit: String; valUnitPrice: String; valNumberOfPieces: Integer);

constructor Create(valDescription: String; valManufacturer: String; valHarmonizedCode: String; valScheduleBCode: String; valWeight: String; valQuantity: Integer; valQuantityUnit: String; valUnitPrice: String);

constructor Create(valDescription: String; valManufacturer: String; valHarmonizedCode: String; valScheduleBCode: String; valQuantity: Integer; valQuantityUnit: String; valUnitPrice: String);

constructor Create(valDescription: String; valManufacturer: String; valHarmonizedCode: String; valQuantity: Integer; valQuantityUnit: String; valUnitPrice: String);

constructor Create(valDescription: String; valManufacturer: String; valWeight: String);

ContactDetail Type

Represents the contact information.

Remarks

This type contains descriptive data identifying the point-of-contact person (such as sender, recipient, broker, etc.).

Example: Setting the fields of the sender ContactDetail senderContact = new ContactDetail senderContact.Company = "Anything Anywhere" senderContact.FirstName = "John" senderContact.LastName = "Doe" senderContact.Phone = "1234567890" senderContact.Email = "test@test.com"

The fields contained by this type are listed below.

Fields

Constructors

constructor Create();

constructor Create(valFirstName: String; valLastName: String; valPhone: String);

constructor Create(valFirstName: String; valLastName: String; valPhone: String; valEmail: String);

constructor Create(valFirstName: String; valLastName: String; valPhone: String; valEmail: String; valCompany: String);

DocumentInfo Type

Specifies the information of the requested document.

Remarks

This type specifies the information of the document to be requested. This include the type of document, the printing options, and the location on disk where the file will be written. This must be set before calling GetShipmentDocuments. For 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)

Fields

Constructors

constructor Create();

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

constructor Create();

NotifyDetail Type

Represents a single recipient to be notified via email.

Remarks

This type contains specific information about a recipient to be notified via email on shipment, exception and/or delivery status.

The fields contained by this type are listed below.

Fields

Constructors

constructor Create();

constructor Create(valNotificationFlags: Integer; valEmail: String; valMessage: String);

constructor Create(valNotificationFlags: Integer; valEmail: String);

constructor Create(valNotificationFlags: Integer; valRecipientType: Integer; valEmail: String);

constructor Create(valName: String);

OverSeasLegDetail Type

Represents the detail information of the OverSeasLeg.

Remarks

Fields

Constructors

constructor Create();

PayorDetail Type

Represents the payor details responsible for payment.

Remarks

This type contains data of the responsible party for payment of shipping charges, or duties and taxes. This is used in a ship request.

Example: Setting the fields PayorDetail payor = new PayorDetail payor.Type = PT_RECIPIENT payor.AccountNumber = "123456789" payor.CountryCode = "US"

The fields contained by this type are listed below.

Fields

Constructors

constructor Create();

constructor Create(valPayorType: Integer; valAccountNumber: String; valCountryCode: String);

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

constructor Create();

constructor Create(valServer: String; valPort: Integer);

constructor Create(valServer: String; valPort: Integer; valUser: String; valPassword: String);

ReferenceDetail Type

Represents a reference for the shipment.

Remarks

Fields

Constructors

constructor Create();

UPSAccount Type

Represents the details of a UPS account.

Remarks

This type contains data describing the UPS server and login information.

Example: Setting the fields of an account UPSAccount account = new UPSAccount account.AuthorizationToken = "Bearer token..." account.Server = "https://wwwcie.ups.com/api/"; account.AccountNumber = "12345";

The properties contained by this type are listed below.

Fields

Constructors

constructor Create();

Config Settings (UPSFreightShip Component)

The component 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 component, 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 Component)

UPSFreightShip Errors

	301   Operation interrupted (or timeout).
	432   Invalid index.
	527   Server Error Response.
	528   Property set with invalid data.
	560   Missing data.

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