UPSShip Component

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate a UPS shipping label for any of UPS domestic services complete with addresses and barcode, or cancel shipments.

Syntax

TibxUPSShip

Remarks

Generating a shipping label can be done by calling the GetShipmentLabels method. You will have to specify the package information, UPS service to be used for shipping this package, origin and destination information, and any other special services you want to associate the shipment (such as Saturday Pickup, Saturday Delivery, etc.). It also supports many valued added services for shipments, including collect on delivery (COD), declared value, delivery confirmation, and automatic notification of delivery status.

This component also allows you to delete packages included in the daily shipping log that have not already been tendered to UPS. This can be done by calling CancelShipment or CancelPackage.

To use this component, you must have a UPS UPSAccountNumber. You should also have already obtained a "Client ID" and "Client Secret" uniquely assigned to your account by UPS after registration for UPS OnLine Tools.

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.

AccountAddress1 Property (UPSShip Component)

Street name.

Syntax

__property String AccountAddress1 = { read=FAccountAddress1, write=FSetAccountAddress1 };

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 AccountAddress1 should not exceed 35 characters.

Data Type

String

AccountAddress2 Property (UPSShip Component)

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

Syntax

__property String AccountAddress2 = { read=FAccountAddress2, write=FSetAccountAddress2 };

Default Value

""

Remarks

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

Data Type

String

AccountCity Property (UPSShip Component)

Name of city, town, etc.

Syntax

__property String AccountCity = { read=FAccountCity, write=FSetAccountCity };

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

AccountCountryCode Property (UPSShip Component)

Country code.

Syntax

__property String AccountCountryCode = { read=FAccountCountryCode, write=FSetAccountCountryCode };

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

AccountState Property (UPSShip Component)

State or province code.

Syntax

__property String AccountState = { read=FAccountState, write=FSetAccountState };

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

AccountZipCode Property (UPSShip Component)

Postal code.

Syntax

__property String AccountZipCode = { read=FAccountZipCode, write=FSetAccountZipCode };

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 AccountCity and AccountState are not present.

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

Data Type

String

AccountCompany Property (UPSShip Component)

Identifies the contact person's company name.

Syntax

__property String AccountCompany = { read=FAccountCompany, write=FSetAccountCompany };

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either AccountFirstName and AccountLastName or AccountCompany are required to be provided.

Data Type

String

AccountEmail Property (UPSShip Component)

Identifies the contact person's email address.

Syntax

__property String AccountEmail = { read=FAccountEmail, write=FSetAccountEmail };

Default Value

""

Remarks

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

Data Type

String

AccountFax Property (UPSShip Component)

Recipient's fax number.

Syntax

__property String AccountFax = { read=FAccountFax, write=FSetAccountFax };

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

AccountFirstName Property (UPSShip Component)

Sender's first name.

Syntax

__property String AccountFirstName = { read=FAccountFirstName, write=FSetAccountFirstName };

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either AccountFirstName and AccountLastName or AccountCompany must be sent.

Data Type

String

AccountLastName Property (UPSShip Component)

Person's last name.

Syntax

__property String AccountLastName = { read=FAccountLastName, write=FSetAccountLastName };

Default Value

""

Remarks

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

Data Type

String

AccountMiddleInitial Property (UPSShip Component)

Middle initial.

Syntax

__property String AccountMiddleInitial = { read=FAccountMiddleInitial, write=FSetAccountMiddleInitial };

Default Value

""

Remarks

Middle initial. The value of this property is optional.

Data Type

String

AccountPhone Property (UPSShip Component)

Identifies the contact person's phone number.

Syntax

__property String AccountPhone = { read=FAccountPhone, write=FSetAccountPhone };

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

FirewallAutoDetect Property (UPSShip Component)

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

Syntax

__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (UPSShip Component)

This property determines the type of firewall to connect through.

Syntax

__property TibxUPSShipFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };

enum TibxUPSShipFirewallTypes {
  fwNone=0,
  fwTunnel=1,
  fwSOCKS4=2,
  fwSOCKS5=3,
  fwSOCKS4A=10
};

Default Value

fwNone

Remarks

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

Data Type

Integer

FirewallHost Property (UPSShip Component)

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

Syntax

__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };

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

Data Type

String

FirewallPassword Property (UPSShip Component)

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

Syntax

__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };

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

Data Type

String

FirewallPort Property (UPSShip Component)

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

Syntax

__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };

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

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

Syntax

__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };

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

Data Type

String

LabelImageType Property (UPSShip Component)

Type of image or printer commands the shipping label is to be formatted in.

Syntax

__property TibxUPSShipLabelImageTypes LabelImageType = { read=FLabelImageType, write=FSetLabelImageType };

enum TibxUPSShipLabelImageTypes {
  uitGIF=0,
  uitEPL=1,
  uitSPL=2,
  uitZPL=3,
  uitStar=4
};

Default Value

uitGIF

Remarks

This element defines the print method code that the labels are to be generated to. It is applicable and required to be provided in a ship request for forward shipments or return shipments. The value selection depends on the printer type used to print the shipping label.

Valid image types and their meanings with the corresponding usage are listed below:

There are two types of shipping labels supported: plain paper (when printing to an HP compatible laser or inkjet type printer only. In this case, the only possible value for the LabelImageType is 0 (uitGIF)), and thermal (when printing to thermal printers only. In this case, possible values for the LabelImageType are 1, 2, 3, and 4).

While the content of each of these labels is the same, their usages are different. Each provides a bar-coded image for the purpose of scanning the package during handling. The uses of each label depend on the type of working environment to be used.

Data Type

Integer

MasterTrackingNumber Property (UPSShip Component)

Tracking number assigned to the whole MPS shipment.

Syntax

__property String MasterTrackingNumber = { read=FMasterTrackingNumber };

Default Value

""

Remarks

This is applicable to MPS shipment requests only and identifies the whole shipment. In a MPS ship request, this property is returned in the server reply when the GetShipmentLabels method is called.

This value is used as parameter when a cancel shipment request is sent (i.e., when the CancelShipment method is called). It can also be used when tracking a MPS.

This property is read-only.

Data Type

String

NotifyCount Property (UPSShip Component)

The number of records in the Notify arrays.

Syntax

__property int NotifyCount = { read=FNotifyCount, write=FSetNotifyCount };

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

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

Syntax

__property String NotifyAggregate[int NotifyIdx] = { read=FNotifyAggregate, write=FSetNotifyAggregate };

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

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

Email address of the recipient to be notified.

Syntax

__property String NotifyEmail[int NotifyIdx] = { read=FNotifyEmail, write=FSetNotifyEmail };

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

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

Syntax

__property String NotifyMessage[int NotifyIdx] = { read=FNotifyMessage, write=FSetNotifyMessage };

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

Identifies the type of notification requested.

Syntax

__property int NotifyFlags[int NotifyIdx] = { read=FNotifyFlags, write=FSetNotifyFlags };

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

PackageCount Property (UPSShip Component)

The number of records in the Package arrays.

Syntax

__property int PackageCount = { read=FPackageCount, write=FSetPackageCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• PackageBaseCharge
• PackageCODAmount
• PackageCODType
• PackageDescription
• PackageHeight
• PackageId
• PackageInsuredValue
• PackageLength
• PackageReference
• PackageReturnReceipt
• PackageReturnReceiptFile
• PackageShippingLabel
• PackageShippingLabelFile
• PackageSignatureType
• PackageSpecialServices
• PackageTotalSurcharges
• PackageTrackingNumber
• PackageType
• PackageWeight
• PackageWidth

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

This property is not available at design time.

Data Type

Integer

PackageBaseCharge Property (UPSShip Component)

Actual Base Charge applicable to this package.

Syntax

__property String PackageBaseCharge[int PackageIdx] = { read=FPackageBaseCharge };

Default Value

""

Remarks

Actual Base Charge applicable to this package.

For FedEx, this is normally specific to the PayorAccountNumber. It is used in the FedExShip and FedExShipIntl only. When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on the package level. In this case, the properties that store the rating information: PackageBaseCharge, PackageNetCharge, PackageTotalSurcharges, and PackageTotalDiscount, indicate the rate for that particular package.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the properties that store the rating information will be set to 'N/A', and in the last package (at index=PackageCount - 1, these properties will contain the rate for the whole shipment.

For UPS, this is the "transportation charge - fuel surcharge" applicable to this package. Upon a successful response, this is returned in the server reply for each package included in the shipment if SubVersion is 1701 or greater.

This is not applicable to USPS.

For Canada Post, upon a successful response, this is returned in the server reply for the package requested.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

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

Data Type

String

PackageCODAmount Property (UPSShip Component)

The COD monetary value for the package.

Syntax

__property String PackageCODAmount[int PackageIdx] = { read=FPackageCODAmount, write=FSetPackageCODAmount };

Default Value

""

Remarks

The COD monetary value for the package.

For FedEx, this is applicable and required for Ground shipments only. If the shipment is using COD special service (i.e., the ShipmentSpecialServices is set to the corresponding value of COD), then the COD amount should be specified on package level for all packages that are going to use COD. If this is set, then the package will be considered as using the COD service.

Since Ground packages do not travel together and may be delivered at different times, you should add the value for the individual packages to be collected. On MPS Ground shipments, a COD return label will be generated for each package that uses COD service (stored in PackageCODLabel).

On COD Express shipments, the COD amount should be specified on shipment level and the CODTotalAmount is required instead.

For UPS, if the PackageCODAmount is set to a value other than "0.00", it indicates that COD special service is requested for that package. The collection type should be specified in the request via the PackageCODType. COD special service is not valid for return service movements. Package level COD is available for shipment from US/PR to US/PR, CA to CA, and CA to US. COD service for shipment from CA to US is not allowed for PackageType Letter/Envelope. COD special service is available for shipper's with PickupType 'Daily Pickup' or 'Drop Shipping'. Delivery Confirmation (represented by PackageSignatureType) and COD cannot coexist on a single package.

This property is not applicable to USPS packages.

Format: Two explicit decimal positions (e.g. 100.00).

This is not applicable for Canada Post.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageCODType Property (UPSShip Component)

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

Syntax

__property TibxUPSShipPackageCODTypes PackageCODType[int PackageIdx] = { read=FPackageCODType, write=FSetPackageCODType };

enum TibxUPSShipPackageCODTypes {
  codtpAny=0,
  codtpCash=1,
  codtpGuaranteedFunds=2,
  codtpCompanyCheck=3,
  codtpPersonalCheck=4
};

Default Value

codtpAny

Remarks

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

This property is only applicable to FedEx and UPS and identifies the type of funds that should be collected upon package delivery. It is required to be provided in the request only if COD is requested for this package (i.e., PackageCODAmount is set to a value other than "0.00").

Valid values are:

Note: COD special service is not valid for return service movements.

Also note that only codtpAny (0) and codtGuaranteedFunds (2) are valid for UPS. For CanadaPost codtpAny is not valid and any type of check is accepted.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageDescription Property (UPSShip Component)

For FedEx, this is the description that appears in the email to identify this package.

Syntax

__property String PackageDescription[int PackageIdx] = { read=FPackageDescription, write=FSetPackageDescription };

Default Value

""

Remarks

For FedEx, this is the description that appears in the email to identify this package. This is optional.

For UPS, this is applicable and required for shipments with return service only.

This does not apply for USPS and Canada Post.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageHeight Property (UPSShip Component)

The height of the package to be shipped.

Syntax

__property int PackageHeight[int PackageIdx] = { read=FPackageHeight, write=FSetPackageHeight };

Default Value

0

Remarks

The height of the package to be shipped.

For FedEx, the PackageHeight is optional, but recommended, if "Your Packaging" is used as PackagePackagingType. This is required if PackageLength and PackageWidth are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When PackageWidth is provided in the request, then all other dimensions (PackageLength and PackageHeight) are to be set as well.

For USPS, this only applies to GetRates and is only required if the package is irregular and the PackagePackagingType property is set to ptNonRectangular. (In this case PackageWidth and PackageHeight must still be set). For parcels, PackageLength is the measurement of the longest dimension and PackageWidth and PackageHeight make up the other two dimensions. PackageGirth is the measurement around the thickest part of the package, perpendicular to the length.

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the PackageLength, PackageWidth, and PackageHeight are required for Priority Mail packages when the PackageSize is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the Shortest dimension (3.1 digits e.g. 999.9 pattern).

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageId Property (UPSShip Component)

An 8-digit Unique Parcel Identification Number.

Syntax

__property String PackageId[int PackageIdx] = { read=FPackageId, write=FSetPackageId };

Default Value

""

Remarks

An 8-digit Unique Parcel Identification Number.

Unique number used to identify the package. This property is optional, and only applies to USPS return labels.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageInsuredValue Property (UPSShip Component)

Amount of insurance requested for this package.

Syntax

__property String PackageInsuredValue[int PackageIdx] = { read=FPackageInsuredValue, write=FSetPackageInsuredValue };

Default Value

""

Remarks

Amount of insurance requested for this package. The value has 2 explicit decimal position and has a maximum of 11 characters including the decimal.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageLength Property (UPSShip Component)

The length of the package to be shipped.

Syntax

__property int PackageLength[int PackageIdx] = { read=FPackageLength, write=FSetPackageLength };

Default Value

0

Remarks

The length of the package to be shipped.

For FedEx, the PackageLength is optional, but recommended, if "Your Packaging" is used as PackagePackagingType. This is required if PackageWidth and PackageHeight are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments. Length must be the longest dimension of the container.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When PackageWidth is provided in the request, then all other dimensions (PackageLength and PackageHeight) are to be set as well.

Valid values are 0 to 108 IN and 0 to 270 CM.

For USPS, this is only required if the package is irregular and the PackagePackagingType property is set to ptNonRectangular. (In this case PackageWidth and PackageHeight must still be set).

Note: For parcels, the PackageLength is the measurement of the longest dimension and PackageWidth and PackageHeight make up the other two dimensions. PackageGirth is the measurement around the thickest part of the package, perpendicular to the length.

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the PackageLength, PackageWidth, and PackageHeight are required for Priority Mail packages when the PackageSize is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the longest dimension (3.1 digits e.g. 999.9 pattern).

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageType Property (UPSShip Component)

The packaging type of the package being rated and/or shipped.

Syntax

__property TibxUPSShipPackageTypes PackageType[int PackageIdx] = { read=FPackageType, write=FSetPackageType };

enum TibxUPSShipPackageTypes {
  ptNone=0,
  ptPostcards=1,
  ptLetter=2,
  ptLargeEnvelope=3,
  ptFlatRateEnvelope=4,
  ptFlatRateLegalEnvelope=5,
  ptFlatRatePaddedEnvelope=6,
  ptFlatRateGiftCardEnvelope=7,
  ptFlatRateWindowEnvelope=8,
  ptFlatRateCardboardEnvelope=9,
  ptSmallFlatRateEnvelope=10,
  ptPak=11,
  ptBox=12,
  pt10kgBox=13,
  pt25kgBox=14,
  ptSmallExpressBox=15,
  ptMediumExpressBox=16,
  ptLargeExpressBox=17,
  ptFlatRateBox=18,
  ptSmallFlatRateBox=19,
  ptMediumFlatRateBox=20,
  ptLargeFlatRateBox=21,
  ptDVDFlatRateBox=22,
  ptLargeVideoFlatRateBox=23,
  ptRegionalRateBoxA=24,
  ptRegionalRateBoxB=25,
  ptRectangular=26,
  ptNonRectangular=27,
  ptTube=28,
  ptMatterForTheBlind=29,
  ptPallet=30,
  ptYourPackaging=31,
  ptDocument=32,
  ptFlats=33,
  ptParcels=34,
  ptBPM=35,
  ptFirstClass=36,
  ptPriority=37,
  ptMachinables=38,
  ptIrregulars=39,
  ptParcelPost=40,
  ptBPMParcel=41,
  ptMediaMail=42,
  ptBPMFlat=43,
  ptStandardFlat=44,
  ptRegionalRateBoxC=45,
  ptThickEnvelope=46,
  ptSmallBox=47,
  ptMediumBox=48,
  ptLargeBox=49,
  ptExtraLargeBox=50,
  ptPackageService=51,
  ptCubicParcels=52,
  ptCubicSoftPack=53
};

Default Value

ptNone

Remarks

The packaging type of the package being rated and/or shipped.

Possible values are:

If this is set to a value that is not applicable to a certain provider, it will automatically be set to ptNone (0).

For FedEx, this is required in a ship request when either the GetPackageLabel or GetShipmentLabels method is called. FedEx only supports one packaging type for the whole shipment, so only the PackagePackagingType for the first package is used in label requests.

If the PackagePackagingType is set to 31 (Your Packaging), then the dimensions of the package should be provided in the request by setting the following: PackageLength, PackageWidth, and PackageHeight.

If the ServiceType is set to any of the FedEx Ground services (Ground or Ground Home Delivery), then the PackagePackagingType will be automatically set to 31 (Your Packaging).

Please note that the types pt10kgBox (13) and pt25kgBox (14) are only meant for international shipments and domestic shipments outside of the United States.

For UPS, please note that when selecting PackagePackagingType make sure this is valid for all the following: SenderCountryCode, RecipientCountryCode, ServiceType, and all special services requested at both shipment and package level.

Also the following restrictions apply when using UPS Mail Innovations:

For USPS, this is used for getting rates and Endicia labels. For international shipments, the only valid values are: ptRectangular and ptNonRectangular.

For Canada Post, ptLetter (2) is only applicable if theContractId is set.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageReference Property (UPSShip Component)

Indicates the package reference type and value, that associates this package (assigned by the customer).

Syntax

__property String PackageReference[int PackageIdx] = { read=FPackageReference, write=FSetPackageReference };

Default Value

""

Remarks

Indicates the package reference type and value, that associates this package (assigned by the customer).

For FedEx, this is optional to be provided in a ship request. You can enter up to 3 customer references by providing: the type(s) and value(s) in the request.

Valid values for types are:

The type and value pair(s) should be entered as a string in this format: type1:value1; type2:value2; type3:value3;. For example, if the user wants to assign 3 references to this package, the PackageReference should be set to: CN:123456; IN:123; SN:12;.

Reference information may also be used to track packages by reference.

For UPS, this is also optional to be provided in a ship request and valid if the origin/destination pair is US/US or PR/PR.

You can enter up to two customer references on package level by providing: the type(s) and value(s) in the request.

Valid values for types are:

The type and value pair(s) should be entered as a string in this format: 'type1:value1; type2:value2'. For example, if the user wants to assign 2 references to this package, the PackageReference should be set to: 'AJ:123456; TN:123'.

You can also chose to bar code the first reference number's value on the shipping label by setting the BarCodeReference to True.

Reference information may also be used to track packages by reference.

For USPS, this is only used by Endicia labels, and is used as a reference value for logs.

This is used in Canada Post to provide user-defined values, such as an internal "orderID".

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageReturnReceipt Property (UPSShip Component)

Image of the receipt for a return shipment.

Syntax

__property String PackageReturnReceipt[int PackageIdx] = { read=FPackageReturnReceipt };
__property DynamicArray<Byte> PackageReturnReceiptB[int PackageIdx] = { read=FPackageReturnReceiptB };

Default Value

""

Remarks

Image of the receipt for a return shipment.

This is only valid for UPS, and is the decoded binary image file of the receipt, stored in memory upon successful ship response. The receipt is generated in HTML format, and if the PackageReturnReceiptFile is set to a valid path and filename (with .html extension), the receipt is also saved to disk.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

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

Data Type

Byte Array

PackageReturnReceiptFile Property (UPSShip Component)

Filename and location to save the ReturnReceipt of this package to.

Syntax

__property String PackageReturnReceiptFile[int PackageIdx] = { read=FPackageReturnReceiptFile, write=FSetPackageReturnReceiptFile };

Default Value

""

Remarks

Filename and location to save the PackageReturnReceipt of this package to. This is applicable only if using UPS.

When the PackageReturnReceiptFile is set to a valid path and filename, the contents of the PackageReturnReceipt are written to disk upon successful response (if a return shipment).

The PackageReturnReceiptFile has to have .html extension.

Note: When using UPS, the HTML file references a 'page 2', this is the HTML page containing the return label. You can print this page by using the ShippingLabelHTMLDirectory and PackageShippingLabelFileHTML[i]; configuration settings.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageShippingLabel Property (UPSShip Component)

Image of the shipping label for this package returned by the Server upon a successful ship response.

Syntax

__property String PackageShippingLabel[int PackageIdx] = { read=FPackageShippingLabel };
__property DynamicArray<Byte> PackageShippingLabelB[int PackageIdx] = { read=FPackageShippingLabelB };

Default Value

""

Remarks

Image of the shipping label for this package returned by the Server upon a successful ship response.

This is the decoded binary image file of the shipping label, stored in memory upon successful ship response. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the PackageShippingLabelFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

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

Data Type

Byte Array

PackageShippingLabelFile Property (UPSShip Component)

Filename and location to save the ShippingLabel of this package to.

Syntax

__property String PackageShippingLabelFile[int PackageIdx] = { read=FPackageShippingLabelFile, write=FSetPackageShippingLabelFile };

Default Value

""

Remarks

Filename and location to save the PackageShippingLabel of this package to. When the PackageShippingLabelFile is set to a valid path and filename, the contents of the PackageShippingLabel are written to disk upon successful response.

This filename should have the same extension defined by LabelImageType (for example, if LabelImageType is set to GIF, then PackageShippingLabelFile has to have .gif extension).

If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True).

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageSignatureType Property (UPSShip Component)

Specifies one of the Delivery Signature Options requested for this package.

Syntax

__property TibxUPSShipPackageSignatureTypes PackageSignatureType[int PackageIdx] = { read=FPackageSignatureType, write=FSetPackageSignatureType };

enum TibxUPSShipPackageSignatureTypes {
  stServiceDefault=0,
  stAdult=1,
  stDirect=2,
  stIndirect=3,
  stNoSignatureRequired=4,
  stUSPSDeliveryConfirmation=5,
  stAdult19=6
};

Default Value

stServiceDefault

Remarks

Specifies one of the Delivery Signature Options requested for this package. Possible values are:

For FedEx Express shipments, the NoSignatureRequired option will not be allowed when the following special services are requested: Alcohol, Hold At Location or Dangerous Goods.

For residential FedEx Ground International shipments from Canada to the U.S., two valid signature options are allowed: NoSignatureRequired and Direct.

The impact of signature options fees may vary depending on your agreement with FedEx. Following are the definitions for FedEx:

• Service Default: In this case, the appropriate signature option will be selected for your shipping service. For example, if the package contains Dangerous Goods, the Direct signature option is chosen for you. The actual signature option applied to this package could be different than the signature option requested if a conflict occurred with other service features in the package. In this case, the value set in the request will be ignored.
• Indirect Signature Required: Indicates that an indirect signature is required upon delivery. This is allowed to residential addresses only. In this case, FedEx obtains a signature in one of three ways: from any person at the delivery address, from a neighbor, building manager, or other person at a neighboring address. The recipient can sign a FedEx door tag authorizing release of the package without anyone present. This might affect the shipping rates and/or service availability.
• Direct Signature Required: Indicates that a direct signature is required upon delivery. In this case, FedEx obtains a signature from any person at the delivery address. If no one is at the address, FedEx will reattempt delivery; Direct Signature Required overrides any recipient release that may be on file for deliveries to nonresidential addresses. This option is not available for Hold at FedEx Location shipments. This might affect the shipping rates and/or service availability.
• Adult Signature Required: Indicates that the adult signature is required upon delivery. In this case, FedEx obtains a signature from any person at least 21 years old (government-issued photo identification required) at the delivery address. If no one is at the address, FedEx will reattempt delivery. Adult Signature Required overrides any recipient release that may be on file for deliveries to nonresidential addresses. This might affect the shipping rates and/or service availability.

Note: In the server reply, this option may differ from that requested value due to other characteristics of the shipment.

For UPS, when delivery confirmation is requested for a package, the PackageSignatureType should be set to a value other than 0 (stServiceDefault). The availability of this special service depends on the ServiceType. The type stIndirect is not valid for UPS packages.

Also, when using UPS Mail Innovations, delivery confirmation can be requested by setting this to stUSPSDeliveryConfirmation.

Delivery Confirmation and COD cannot coexist on a single package. Also, Delivery Confirmation option cannot be combined with the Return Services option.

For USPS, if this is not set to stServiceDefault or stNoSignatureRequired, the Signature Confirmation service will be used. Also, for Express label shipments, set this to stNoSignatureRequired to waive the signature requirements.

This does not apply for Canada Post.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageSpecialServices Property (UPSShip Component)

Contains the collection of special services offered on the package level.

Syntax

__property __int64 PackageSpecialServices[int PackageIdx] = { read=FPackageSpecialServices, write=FSetPackageSpecialServices };

Default Value

0

Remarks

Contains the collection of special services offered on the package level. Valid values are:

For FedEx, to request any of the special services offered for a particular package in a ship request, you must set the PackageSpecialServices of that package to a set of valid flags.

The meaning and limitations for each special service option are listed below for FedEx:

• Appointment Delivery: Indicates that the appointment delivery special service is requested for this package. This might affect the shipping rates and/or service availability.
• Dangerous Goods: Indicates that this package contains dangerous goods. When the PackageSpecialServices contains this flag, then the PackageDangerousGoodsAccessible is required to be provided in the request as well. For FedEx Express services, these types of shipments are referred to as dangerous goods shipments. For FedEx Ground services, these types of shipments are referred to as hazardous materials (Hazmat) shipments. Hazmat shipments must be single package. FedEx Ground provides reliable delivery of hazardous materials in all U.S. states except Alaska and Hawaii. If you have not shipped hazardous materials with FedEx Ground before, contact your FedEx account executive first. FedEx needs to confirm that you have met government training requirements and can generate the documentation your shipments need. Additional information regarding hazardous materials shipping is provided at fedex.com/ us/services/options under the Hazardous Materials link. The Shipper's Hazardous Materials Certification report (OP-950), prints after a successful Ground close request. Please note that Hazmat shipments must be single package. If you create a multiple package (MPS) hazmat shipment, only one commodity prints on the OP-950. FedEx assesses a surcharge on each package containing dangerous goods/Hazmat materials. This might affect service availability as well.
• Dry Ice: Indicates that this package contains dry ice. FedEx assesses a surcharge on each package containing dry ice. This might affect service availability as well.
• Priority Alert: Indicates whether the priority alert special service is requested for this package. This is applicable to domestic shipments only. A per package surcharge is associated with Priority Alert. This is applicable for FedEx First Overnight and FedEx Priority Overnight. It can be associated with: Saturday Delivery, Hold Saturday, Hold at Location, Dangerous Goods, Dry Ice or Signature Service Option. Please note that Priority Alert requires a service contract. If you are interested in signing up for Priority Alert, contact your FedEx account executive.
• Non Standard Container: Indicates whether this package type is a non standard container. This might affect the shipping rates and/or service availability.
• COD: Indicates that this is a COD package. This service will affect shipping rates and service availability. This is applicable for domestic FedEx Express and Ground services, except FedEx Home Delivery premium. When shipping COD via FedEx Ground, the PackageCODAmount and PackageCODType must also be provided in the request.

For UPS, to request any of the special services offered for a particular package in a rate or ship request, you must set the PackageSpecialServices of that package to a set of valid flags.

The meaning and limitations for each special service option are listed below:

• Additional Handling: Indicates that additional handling special service is requested for this package. This might affect the shipping rates and/or service availability.
• Non Standard Container: Indicates whether this package type is to be considered a large package (a non standard container). Dimensions must be 130 to 165 inches: Length + (2 x Width) + (2 x Height). This might affect the shipping rates and/or service availability.

Some other special services on package level, such as COD, Delivery Confirmation, Insured Value, are already implemented respectively through the PackageCODAmount and PackageCODType, PackageSignatureType, and PackageInsuredValue.

This property is not applicable to USPS or Canada Post.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Long64

PackageTotalSurcharges Property (UPSShip Component)

Total Actual Surcharges applicable to this package.

Syntax

__property String PackageTotalSurcharges[int PackageIdx] = { read=FPackageTotalSurcharges };

Default Value

""

Remarks

Total Actual Surcharges applicable to this package.

For FedEx, this is normally specific to the PayorAccountNumber. It is used in the FedExShip and FedExShipIntl components only.

Please note that for MPS, the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on package level. In this case, the properties that store the rating information: PackageBaseCharge, PackageNetCharge, PackageTotalSurcharges, and PackageTotalDiscount, indicate the rate for that particular package.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the properties that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these properties will contain the rate for the whole shipment.

For UPS, upon a successful response, this is returned in the server reply for each package included in the shipment.

This does not apply to USPS packages.

For Canada Post, upon a successful response, this is returned in the server reply for the package requested.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

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

Data Type

String

PackageTrackingNumber Property (UPSShip Component)

Tracking number assigned to this package.

Syntax

__property String PackageTrackingNumber[int PackageIdx] = { read=FPackageTrackingNumber };

Default Value

""

Remarks

Tracking number assigned to this package. Upon successful request, this is returned in the server reply for each package included in the shipment.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

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

Data Type

String

PackageWeight Property (UPSShip Component)

Weight of this package.

Syntax

__property String PackageWeight[int PackageIdx] = { read=FPackageWeight, write=FSetPackageWeight };

Default Value

"0.0"

Remarks

Weight of this package.

For FedEx, this is required to be provided in the request. It requires one explicit decimal position in pounds or kilograms, depending on the value of the WeightUnit config, (i.e. N.N formatting).

For UPS, this is required to be provided in the request for each package contained in the shipment if PackagePackagingType is set to a value other than 0 (UPS Letter). For Ground shipments, if the actual weight is less than 150 pounds, then the billable weight is 150 pounds. Air and 3 Day Select shipments will not be subject to a minimum billable weight. Format: it requires one explicit decimal position in pounds or kilograms, depending on the value of the WeightUnit config, (i.e. N.N formatting).

Note that if the ServiceType stUPSSurePostLessThan1LB or stUPSFirstClassMail is used, or the ServiceType stUPSExpeditedMailInovations is used with the PackagePackagingType ptMachineables, ptIrregulars, or ptStandardFlat then the weight must be specified in ounces. The WeightUnit config will be set automatically to "OZS" if not set.

For USPS, this must be the weight in pounds and ounces of the package. Package weight cannot exceed 70 pounds. (First-Class Mail cannot exceed 13 ounces. Bound Printed Matter cannot exceed 15 pounds). On international shipments, weight limits vary by country.

The format must be in "N lbs N oz", or as an integer showing the number of ounces. For example, a package with weight 6 lbs, 8 oz can be specified as "6 lbs 8 oz" or as "104".

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

For Canada Post, the weight of the parcel should be specified in kilograms (e.g. 99.999).

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageWidth Property (UPSShip Component)

The width of the package to be shipped.

Syntax

__property int PackageWidth[int PackageIdx] = { read=FPackageWidth, write=FSetPackageWidth };

Default Value

0

Remarks

The width of the package to be shipped.

For FedEx, the PackageWidth is optional, but recommended, if "Your Packaging" is used as PackagePackagingType. This is required if PackageLength and PackageHeight are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When PackageWidth is provided in the request, then all other dimensions (PackageLength and PackageHeight) are to be set as well.

For USPS, this is only required if the package is irregular and the PackagePackagingType property is set to ptNonRectangular. (In this case PackageWidth and PackageHeight must still be set).

Note: For parcels, PackageLength is the measurement of the longest dimension and PackageWidth and PackageHeight make up the other two dimensions. PackageGirth is the measurement around the thickest part of the package, perpendicular to the length.

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the PackageLength, PackageWidth, and PackageHeight are required for Priority Mail packages when the PackageSize is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the second longest dimension (3.1 digits e.g. 999.9 pattern).

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PayorAccountNumber Property (UPSShip Component)

The account number of the party responsible for payment (shipping charges, or duties and taxes).

Syntax

__property String PayorAccountNumber = { read=FPayorAccountNumber, write=FSetPayorAccountNumber };

Default Value

""

Remarks

The account number of the party responsible for payment (shipping charges, or duties and taxes).

This is required to be provided in the ship request, only if PayorType is set to 'RECIPIENT' or 'THIRDPARTY'. Otherwise, it defaults to PayorAccountNumber.

Data Type

String

PayorType Property (UPSShip Component)

Method of payment for shipment, or duties and taxes.

Syntax

__property TibxUPSShipPayorTypes PayorType = { read=FPayorType, write=FSetPayorType };

enum TibxUPSShipPayorTypes {
  ptSender=0,
  ptRecipient=1,
  ptThirdParty=2,
  ptCollect=3,
  ptConsignee=4
};

Default Value

ptSender

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

PayorZipCode Property (UPSShip Component)

Payor's postal code (if applicable).

Syntax

__property String PayorZipCode = { read=FPayorZipCode, write=FSetPayorZipCode };

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

PickupContainerType Property (UPSShip Component)

The type of container to be picked up.

Syntax

__property TibxUPSShipPickupContainerTypes PickupContainerType = { read=FPickupContainerType, write=FSetPickupContainerType };

enum TibxUPSShipPickupContainerTypes {
  pccPackage=0,
  pccLetter=1,
  pccPallet=2
};

Default Value

pccPackage

Remarks

This indicates what type of container is being picked up.

Note the pccPallet is only valid if ServiceType is set to stUPSWorldwideExpressFreight.

Data Type

Integer

PickupEarliestTime Property (UPSShip Component)

The earliest time a shipment is ready to be picked up.

Syntax

__property String PickupEarliestTime = { read=FPickupEarliestTime, write=FSetPickupEarliestTime };

Default Value

""

Remarks

This is required when calling SchedulePickup. This contains the earliest time UPS can come to pickup the package.

This should be entered in this format: HHmm.

Data Type

String

PickupLatestTime Property (UPSShip Component)

The latest time a shipment can be picked up.

Syntax

__property String PickupLatestTime = { read=FPickupLatestTime, write=FSetPickupLatestTime };

Default Value

""

Remarks

This is required when calling SchedulePickup. This contains the latest time UPS can come to pickup the package.

This should be entered in this format: HHmm.

Data Type

String

PickupPaymentMethod Property (UPSShip Component)

The method of payment for a pickup.

Syntax

__property TibxUPSShipPickupPaymentMethods PickupPaymentMethod = { read=FPickupPaymentMethod, write=FSetPickupPaymentMethod };

enum TibxUPSShipPickupPaymentMethods {
  ppmNone=0,
  ppmAccount=1,
  ppmTrackingNumber=2,
  ppmCheckOrMoneyOrder=3
};

Default Value

ppmAccount

Remarks

This indicates how the pickup will be paid for.

The valid values are as follows:

Data Type

Integer

ProxyAuthScheme Property (UPSShip Component)

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

Syntax

__property TibxUPSShipProxyAuthSchemes ProxyAuthScheme = { read=FProxyAuthScheme, write=FSetProxyAuthScheme };

enum TibxUPSShipProxyAuthSchemes {
  authBasic=0,
  authDigest=1,
  authProprietary=2,
  authNone=3,
  authNtlm=4,
  authNegotiate=5
};

Default Value

authBasic

Remarks

This property is used to tell the component 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 component. Look at the configuration file for the component 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 (UPSShip Component)

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

Syntax

__property bool ProxyAutoDetect = { read=FProxyAutoDetect, write=FSetProxyAutoDetect };

Default Value

False

Remarks

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

Data Type

Boolean

ProxyPassword Property (UPSShip Component)

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

Syntax

__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };

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

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

Syntax

__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };

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

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

Syntax

__property String ProxyServer = { read=FProxyServer, write=FSetProxyServer };

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

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

Syntax

__property TibxUPSShipProxySSLs ProxySSL = { read=FProxySSL, write=FSetProxySSL };

enum TibxUPSShipProxySSLs {
  psAutomatic=0,
  psAlways=1,
  psNever=2,
  psTunnel=3
};

Default Value

psAutomatic

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

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

Syntax

__property String ProxyUser = { read=FProxyUser, write=FSetProxyUser };

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

Street name.

Syntax

__property String RecipientAddress1 = { read=FRecipientAddress1, write=FSetRecipientAddress1 };

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

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

Syntax

__property String RecipientAddress2 = { read=FRecipientAddress2, write=FSetRecipientAddress2 };

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

Various flags that denote information about the address.

Syntax

__property int RecipientAddressFlags = { read=FRecipientAddressFlags, write=FSetRecipientAddressFlags };

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

RecipientCity Property (UPSShip Component)

Name of city, town, etc.

Syntax

__property String RecipientCity = { read=FRecipientCity, write=FSetRecipientCity };

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

Country code.

Syntax

__property String RecipientCountryCode = { read=FRecipientCountryCode, write=FSetRecipientCountryCode };

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

State or province code.

Syntax

__property String RecipientState = { read=FRecipientState, write=FSetRecipientState };

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

Postal code.

Syntax

__property String RecipientZipCode = { read=FRecipientZipCode, write=FSetRecipientZipCode };

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

Identifies the contact person's company name.

Syntax

__property String RecipientCompany = { read=FRecipientCompany, write=FSetRecipientCompany };

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

Identifies the contact person's email address.

Syntax

__property String RecipientEmail = { read=FRecipientEmail, write=FSetRecipientEmail };

Default Value

""

Remarks

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

Data Type

String

RecipientFax Property (UPSShip Component)

Recipient's fax number.

Syntax

__property String RecipientFax = { read=FRecipientFax, write=FSetRecipientFax };

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

Sender's first name.

Syntax

__property String RecipientFirstName = { read=FRecipientFirstName, write=FSetRecipientFirstName };

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

Person's last name.

Syntax

__property String RecipientLastName = { read=FRecipientLastName, write=FSetRecipientLastName };

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

Middle initial.

Syntax

__property String RecipientMiddleInitial = { read=FRecipientMiddleInitial, write=FSetRecipientMiddleInitial };

Default Value

""

Remarks

Middle initial. The value of this property is optional.

Data Type

String

RecipientPhone Property (UPSShip Component)

Identifies the contact person's phone number.

Syntax

__property String RecipientPhone = { read=FRecipientPhone, write=FSetRecipientPhone };

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

SenderAddress1 Property (UPSShip Component)

Street name.

Syntax

__property String SenderAddress1 = { read=FSenderAddress1, write=FSetSenderAddress1 };

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

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

Syntax

__property String SenderAddress2 = { read=FSenderAddress2, write=FSetSenderAddress2 };

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

Name of city, town, etc.

Syntax

__property String SenderCity = { read=FSenderCity, write=FSetSenderCity };

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

Country code.

Syntax

__property String SenderCountryCode = { read=FSenderCountryCode, write=FSetSenderCountryCode };

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

State or province code.

Syntax

__property String SenderState = { read=FSenderState, write=FSetSenderState };

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

Postal code.

Syntax

__property String SenderZipCode = { read=FSenderZipCode, write=FSetSenderZipCode };

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

Identifies the contact person's company name.

Syntax

__property String SenderCompany = { read=FSenderCompany, write=FSetSenderCompany };

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

Identifies the contact person's email address.

Syntax

__property String SenderEmail = { read=FSenderEmail, write=FSetSenderEmail };

Default Value

""

Remarks

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

Data Type

String

SenderFax Property (UPSShip Component)

Recipient's fax number.

Syntax

__property String SenderFax = { read=FSenderFax, write=FSetSenderFax };

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

Sender's first name.

Syntax

__property String SenderFirstName = { read=FSenderFirstName, write=FSetSenderFirstName };

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

Person's last name.

Syntax

__property String SenderLastName = { read=FSenderLastName, write=FSetSenderLastName };

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

Middle initial.

Syntax

__property String SenderMiddleInitial = { read=FSenderMiddleInitial, write=FSetSenderMiddleInitial };

Default Value

""

Remarks

Middle initial. The value of this property is optional.

Data Type

String

SenderPhone Property (UPSShip Component)

Identifies the contact person's phone number.

Syntax

__property String SenderPhone = { read=FSenderPhone, write=FSetSenderPhone };

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

Identifies the UPS service type (applicable to US domestic shipments) to use in a ship request.

Syntax

__property TibxUPSShipServiceTypes ServiceType = { read=FServiceType, write=FSetServiceType };

enum TibxUPSShipServiceTypes {
  stUnspecified=0,
  stFedExPriorityOvernight=10,
  stFedExStandardOvernight=11,
  stFedExFirstOvernight=12,
  stFedEx2Day=13,
  stFedExExpressSaver=14,
  stFedExGround=15,
  stFedExGroundHomeDelivery=16,
  stFedEx1DayFreight=17,
  stFedEx2DayFreight=18,
  stFedEx3DayFreight=19,
  stFedExInternationalPriority=20,
  stFedExInternationalEconomy=21,
  stFedExInternationalFirst=22,
  stFedExInternationalPriorityFreight=23,
  stFedExInternationalEconomyFreight=24,
  stFedExEuropeFirstInternationalPriority=25,
  stFedExSmartPost=26,
  stFedEx2DayAM=27,
  stFedExFirstFreight=28,
  stFedExInternationalGround=29,
  stFedExFreightEconomy=30,
  stFedExFreightPriority=31,
  stFedExInternationalPriorityExpress=32,
  stFedExInternationalConnectPlus=33,
  stUPSFirstClass=35,
  stUPSPriorityMail=36,
  stUPSExpeditedMailInnovations=37,
  stUPSPriorityMailInnovations=38,
  stUPSEconomyMailInnovations=39,
  stUPSNextDayAir=40,
  stUPSExpress=41,
  stUPS2ndDayAir=42,
  stUPSGround=43,
  stUPSWorldwideExpress=44,
  stUPSWorldwideExpedited=45,
  stUPSExpedited=46,
  stUPSStandard=47,
  stUPS3DaySelect=48,
  stUPSNextDayAirSaver=49,
  stUPSSaver=50,
  stUPSNextDayAirEarlyAM=51,
  stUPSExpressEarlyAM=52,
  stUPSWorldwideExpressPlus=53,
  stUPSExpressPlus=54,
  stUPS2ndDayAirAM=55,
  stUPSTodayStandard=56,
  stUPSTodayCourrier=57,
  stUPSTodayInterCity=58,
  stUPSTodayExpress=59,
  stUPSTodayExpressSaver=60,
  stUPSWorldwideExpressFreight=61,
  stUPSSurePostLessThan1LB=62,
  stUPSSurePost1LBOrGreater=63,
  stUPSSurePostBPM=64,
  stUPSSurePostMedia=65,
  stUSPSExpress=70,
  stUSPSFirstClass=71,
  stUSPSPriority=72,
  stUSPSParcelPost=73,
  stUSPSBPM=74,
  stUSPSMedia=75,
  stUSPSLibrary=76,
  stUSPSOnline=77,
  stUSPSGlobalExpress=78,
  stUSPSParcelSelect=79,
  stUSPSCriticalMail=80,
  stUSPSStandardMail=81,
  stUSPSExpressMailInternational=82,
  stUSPSFirstClassMailInternational=83,
  stUSPSPriorityMailInternational=84,
  stUSPSPriorityExpress=85,
  stUSPSRetailGround=86,
  stUSPSFirstClassPackageInternationalService=87,
  stUSPSPriorityMailExpressInternational=88,
  stCanadaRegularParcel=90,
  stCanadaExpeditedParcel=91,
  stCanadaXpresspost=92,
  stCanadaLibrary=93,
  stCanadaPriority=94,
  stCanadaPriorityEnvelopeUSA=95,
  stCanadaPriorityPakUSA=96,
  stCanadaPriorityParcelUSA=97,
  stCanadaXpresspostUSA=98,
  stCanadaExpeditedParcelUSA=99,
  stCanadaSmallPacketAirUSA=100,
  stCanadaTrackedPacketUSA=101,
  stCanadaTrackedPacketLVMUSA=102,
  stCanadaPriorityEnvelopeInternational=103,
  stCanadaPriorityPakInternational=104,
  stCanadaPriorityParcelInternational=105,
  stCanadaXpresspostInternational=106,
  stCanadaSmallPacketAirInternational=107,
  stCanadaSmallPacketLandInternational=108,
  stCanadaParcelAirInternational=109,
  stCanadaParcelLandInternational=110,
  stCanadaTrackedPacketInternational=111,
  stFedExSameDay=126,
  stFedExSameDayCity=127,
  stFedExSameDayMetroAfternoon=128,
  stFedExSameDayMetroMorning=129,
  stFedExSameDayMetroRush=130,
  stUPSWorldwideEconomyDDU=131,
  stUPSWorldwideEconomyDDP=132,
  stUSPSParcelSelectGround=133,
  stUSPSPriorityMailCubic=134,
  stUSPSGroundAdvantage=135,
  stUSPSGroundAdvantageCubic=136,
  stFedExFirst=140,
  stFedExPriority=141,
  stFedExPriorityExpress=142,
  stFedExPriorityExpressFreight=143,
  stFedExPriorityFreight=144,
  stFedExEconomySelect=145
};

Default Value

stUnspecified

Remarks

This property is required to be provided in a ship request when the GetShipmentLabels method is called.

Valid values for UPS are:

This property is not available at design time.

Data Type

Integer

ShipDate Property (UPSShip Component)

The date the user requests UPS to pickup the package from the origin.

Syntax

__property String ShipDate = { read=FShipDate, write=FSetShipDate };

Default Value

""

Remarks

This is required to be provided in a ship request only if UPS On-Call Pickup service is requested (i.e., when the corresponding flag for On-Call Pickup (0x01000000) is present in ShipmentSpecialServices). This date should not be a past date or a date more than 10 days in the future. If not provided, then it defaults to the current date.

This should be entered in this format: YYYYMMDD.

Note: It is not valid if this pickup date is the same day for shipment(s) going from Germany to Germany using UPS Standard service. Error 129090 will be returned in this case.

Data Type

String

ShipmentSpecialServices Property (UPSShip Component)

Contains the collection of special services offered by UPS on shipment level.

Syntax

__property __int64 ShipmentSpecialServices = { read=FShipmentSpecialServices, write=FSetShipmentSpecialServices };

Default Value

0

Remarks

To request any of the special services offered by UPS in a request, you must set the ShipmentSpecialServices to a set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:

The meaning and limitations for each special service option are listed below:

• Hold for Pickup: This indicates that UPS should deliver your package to the UPS Customer Center you choose and then call the recipient when the package is ready.

  This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.

• Liftgate Dropoff: This requests that UPs provide their liftgate services unload a shipment when unloading docks are not available.

  This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.

• Liftgate Pickup: This requests that UPs provide their liftgate services load a shipment when loading docks are not available.

  This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.

• Return Shipment: This is applicable to return shipments only. Indicates that the ship request is made for Print Return Label (PRL). With this option you can print a return label to include in an outbound shipment, or provide a label to your customer separately.

  If you want to arrange for UPS to mail a return label to your customer, you can use the ReturnPrintAndMail config setting.

  If you want to arrange for UPS to email a return label to your customer, you can use the ElectronicReturnLabel config setting.

  If you want to arrange for UPS to make one attempt to pick up the package to be returned, you can use the ReturnServiceFirstAttempt config setting.

  If you want to arrange for UPS to make three attempts to pick up the package to be returned, you can use the ReturnServiceThirdAttempt config setting.

  Using the last 4 options: in the server response, you will receive only a Tracking number for the shipment to be returned, but not a return label and/or return receipt.

  For return shipments, one of the following conditions must be met on AccountCountryCode, SenderCountryCode and RecipientCountryCode: At least two of these country codes are the same; None of these country codes are the same and are a member of the EU; None of these country codes are the same and at least one of them is not a member of the EU, and the shipper must have third country contract service. Following is a list of restrictions that are applicable when using return label types. This cannot be combined with COD, Saturday Delivery, Saturday Pickup, and/or Delivery Confirmation service options. For international shipments with return service, the Invoice flag is the only valid value for FormTypes. The availability of return service depends on the origin and destination country code, and on the selected ServiceType. The PackageDescription is required to be provided in the request for each package contained in the shipment. The PackageType should be set to a value other than: 4 (ptUPS25kgBox), 5 (ptUPS10kgBox), and 6 (ptPallet). Return shipments cannot be voided at the package level. Return shipments can be voided within 24 hours only.

  Also please note that when you set this option that only the return label is being printed, you must submit a separate request to print the shipping label.

• Saturday Delivery: Indicates that you request to have the shipment delivered on a Saturday. Saturday delivery service is available for an additional charge depending on the package service type and origin/destination pair. This service is not available for return shipments.
• Saturday Pickup: The presence indicates Saturdary pickup is requested. Saturday pickup service is available for an additional charge depending on the package service type and origin/destination pair.
• Return of Document: This may also be referred to as the Return of Invoice service and is unique to Poland. If set UPS will use their Return of Document service to return the signed invoice to the shipper.
• Commercial Invoice Removal: When set this will indicate that the commercial invoice should be removed before delivery, thus not revealing the value of the contents to the recipient.
• Carbon Neutral: This is required to make a shipment that is carbon neutral.
• Exchange Forward: This is required in order to make exchange forward shipments.
• Dropoff at UPS Facility: When set this indicates that the package will be dropped off at a UPS Facility.

  This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.

• Deliver To Addressee Only: When set this requires that the addressee be the one who takes final delivery of the package being held at a UPS Access Point

  This accessorial is only valid when ShipmentIndicationType is set to 1.

• Direct Delivery Only: When set this will ensure that the package is delivered to the ShipTo address on the shipping label.

  This accessorial is not valid when ShipmentIndicationType is set.

Data Type

Long64

ShipmentVoidStatus Property (UPSShip Component)

Status description of shipment void request.

Syntax

__property String ShipmentVoidStatus = { read=FShipmentVoidStatus };

Default Value

""

Remarks

Upon successful response, this is populated when the CancelShipment or CancelPackage method is called.

This property is read-only.

Data Type

String

SSLAcceptServerCertEncoded Property (UPSShip Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

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.

This property is not available at design time.

Data Type

Byte Array

SSLCertEncoded Property (UPSShip Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

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.

This property is not available at design time.

Data Type

Byte Array

SSLCertStore Property (UPSShip Component)

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

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

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

Data Type

Byte Array

SSLCertStorePassword Property (UPSShip 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 String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

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

This is the type of certificate store for this certificate.

Syntax

__property TibxUPSShipSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };

enum TibxUPSShipSSLCertStoreTypes {
  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

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:

Data Type

Integer

SSLCertSubject Property (UPSShip Component)

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

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

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

This specifies the SSL/TLS implementation to use.

Syntax

__property TibxUPSShipSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };

enum TibxUPSShipSSLProviders {
  sslpAutomatic=0,
  sslpPlatform=1,
  sslpInternal=2
};

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

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };

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.

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

Data Type

Byte Array

Timeout Property (UPSShip Component)

A timeout for the component.

Syntax

__property int Timeout = { read=FTimeout, write=FSetTimeout };

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.

Data Type

Integer

TotalBaseCharge Property (UPSShip Component)

The total base charge applied to the whole shipment (specific to the AccountNumber ).

Syntax

__property String TotalBaseCharge = { read=FTotalBaseCharge };

Default Value

""

Remarks

In a MPS ship request, this represents the total base charge applied to all packages contained in the shipment. When the shipment consists of a single package, this is the same as PackageBaseCharge at index=0.

This property is read-only.

Data Type

String

TotalNetCharge Property (UPSShip Component)

The total net charge (transportation charge + options charges) applied to the whole shipment (specific to the AccountNumber ).

Syntax

__property String TotalNetCharge = { read=FTotalNetCharge };

Default Value

""

Remarks

In a MPS ship request, this represents the total net charge applied to all packages contained in the shipment. When the shipment consists of a single package, this is the same as PackageNetCharge at index=0.

This property is read-only.

Data Type

String

TotalSurcharges Property (UPSShip Component)

The total surcharges (on all options) applied to the whole shipment (specific to the AccountNumber ).

Syntax

__property String TotalSurcharges = { read=FTotalSurcharges };

Default Value

""

Remarks

In a MPS ship request, this represents the total surcharges applied to all packages contained in the shipment. When the shipment consists of a single package, this is the same as PackageTotalSurcharges at index=0.

This property is read-only.

Data Type

String

TotalTransportationCharge Property (UPSShip Component)

The total transportation charges applied to the whole shipment (specific to the AccountNumber ).

Syntax

__property String TotalTransportationCharge = { read=FTotalTransportationCharge };

Default Value

""

Remarks

In a MPS ship request, this represents the total base charge applied to all packages contained in the shipment.

This property is read-only.

Data Type

String

UPSAccountNumber Property (UPSShip Component)

The shipper's UPS account number.

Syntax

__property String UPSAccountNumber = { read=FUPSAccountNumber, write=FSetUPSAccountNumber };

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

Authorization Token used to authenticate the request.

Syntax

__property String UPSAuthorizationToken = { read=FUPSAuthorizationToken, write=FSetUPSAuthorizationToken };

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

URL for the UPS server where the requests are sent.

Syntax

__property String UPSServer = { read=FUPSServer, write=FSetUPSServer };

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

CancelPackage Method (UPSShip Component)

Cancels a single package by deleting it from the shipping log.

Syntax

void __fastcall CancelPackage(String MasterTrackingNumber, String PackageTrackingNumber);

Remarks

To cancel shipment of a single package, a void shipment request should be sent to UPS UPSServer by calling the CancelPackage method.

For void shipment requests while your application is undergoing testing and integration, you will have to set the UPSServer to: https://wwwcie.ups.com/api/shipments/.

Once your application is in production, the UPSServer should be sent to the URL provided as part of the certification process.

The TrackingNumber parameter identifies the package to be deleted from the shipping log.

This method will return the void status of the specified package.

To check the status of your shipment void request, the ShipmentVoidStatus should be inspected.

CancelPickup Method (UPSShip Component)

Cancel a pickup.

Syntax

void __fastcall CancelPickup(String ConfirmationNumber);

Remarks

When called the pickup referenced by the ConfirmationNumber will be canceled.

To check the status of your cancel pickup request the CancelPickUpStatus config should be inspected.

CancelShipment Method (UPSShip Component)

Cancels an entire multi-package (MPS) shipment by deleting it from the shipping log.

Syntax

void __fastcall CancelShipment(String MasterTrackingNumber);

Remarks

To cancel an entire MPS shipment, a void shipment request should be sent to UPS Server by calling the CancelShipment method.

For void shipment requests while your application is undergoing testing and integration, you will have to set the Server to: https://wwwcie.ups.com/api/shipments/.

Once your application is in production, the Server should be sent to the URL provided as part of the certification process.

The MasterTrackingNumber parameter identifies the shipment that contains all packages to be deleted from shipping log.

To check the status of your shipment void request, the ShipmentVoidStatus should be inspected.

Config Method (UPSShip Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

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.

GetShipmentLabels Method (UPSShip Component)

Generates a shipping label using one of domestic UPS services.

Syntax

void __fastcall GetShipmentLabels();

Remarks

When this method is called, the following properties must have been set:

• UPSServer (required)
• UPSAuthorizationToken (required)
• UPSAccountNumber (required)
• ServiceType (required)
• AccountContact (conditional)
• AccountAddress (conditional)
• SenderContact (required)
• SenderAddress (required)
• RecipientContact (required)
• RecipientAddress (required)
• Payor (required)
• ShipmentSpecialServices (optional)
• Packages (required)
• LabelImageType (required)
• Notify (optional)
• WeightUnit (required; defaults to LB)

Upon successful response, the following properties might be populated:

• MasterTrackingNumber (if MPS)
• PackageTrackingNumber for each package included in the shipment
• PackageShippingLabel for each package included in the shipment
• PackageTotalSurcharges for each package included in the shipment
• TotalNetCharge (applicable to the whole shipment)
• TotalBaseCharge (applicable to the whole shipment)
• TotalSurcharges (applicable to the whole shipment)

To print out the PackageShippingLabel, you can save it to the PackageShippingLabelFile in LabelImageType format.

Reset Method (UPSShip Component)

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

Syntax

void __fastcall Reset();

Remarks

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

SchedulePickup Method (UPSShip Component)

Schedules a pickup.

Syntax

String __fastcall SchedulePickup();

Remarks

When called, this will request an OnCall Pickup from UPS and return the Pickup Confirmation Number.

The valid properties when calling this method are as follows:

• ServiceType (Required)
• PickupEarliestTime (Required)
• PickupLatestTime (Required)
• SenderFirstName (Optional, required if Company is not provided)
• SenderLastName (Optional, required if Company is not provided)
• SenderCompany (Optional, required if FirstName and/or LastName are not provided)
• SenderPhone (Required)
• SenderAddress1 (Required)
• PickupFloorNumber (Optional)
• PickupRoomNumber (Optional)
• SenderCity (Required)
• SenderState (Required, optional if outside US and Canada)
• SenderZipCode (Required)
• SenderCountryCode (Required)
• ShipDate (Required)

Please note that only SenderAddress1 is valid as the request only allows one address line.

Error Event (UPSShip Component)

Information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TibxUPSShipErrorEventParams;
typedef void __fastcall (__closure *TibxUPSShipErrorEvent)(System::TObject* Sender, TibxUPSShipErrorEventParams *e);
__property TibxUPSShipErrorEvent OnError = { 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 (UPSShip Component)

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

Syntax

typedef struct {
  String Message;
} TibxUPSShipNotificationEventParams;
typedef void __fastcall (__closure *TibxUPSShipNotificationEvent)(System::TObject* Sender, TibxUPSShipNotificationEventParams *e);
__property TibxUPSShipNotificationEvent OnNotification = { 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 (UPSShip Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TibxUPSShipSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TibxUPSShipSSLServerAuthenticationEvent)(System::TObject* Sender, TibxUPSShipSSLServerAuthenticationEventParams *e);
__property TibxUPSShipSSLServerAuthenticationEvent OnSSLServerAuthentication = { 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 (UPSShip Component)

Fired when secure connection progress messages are available.

Syntax

typedef struct {
  String Message;
} TibxUPSShipSSLStatusEventParams;
typedef void __fastcall (__closure *TibxUPSShipSSLStatusEvent)(System::TObject* Sender, TibxUPSShipSSLStatusEventParams *e);
__property TibxUPSShipSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

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

Config Settings (UPSShip 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.

UPSShip Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (UPSShip Component)

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