UPSShipIntl Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TibxUPSShipIntl

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 special services you want to associate the shipment (such as Saturday Pickup, Saturday Delivery), and any other specific information on international shipments (such as Commercial Invoice, international forms required by Customs, 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, where the MasterTrackingNumber parameter identifies the shipment.

To use this component, you must have a UPS AccountNumber. 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.

AccountAddress Property (UPSShipIntl Component)

Identifies the UPS AccountNumber holder's address, if different from the sender's address.

Syntax

property AccountAddress: TibxAddressDetail read get_AccountAddress write set_AccountAddress;

Remarks

The AccountAddress is required to be provided in a ship request only if the SenderAddress is different from the billing address of the AccountNumber. Otherwise, it defaults to SenderAddress. For international shipments, even when account address is different from sender's address, the CountryCode should be the same as CountryCode.

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

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

AccountContact Property (UPSShipIntl Component)

Identifies the UPS AccountNumber holder's contact info if different from SenderContact .

Syntax

property AccountContact: TibxContactDetail read get_AccountContact write set_AccountContact;

Remarks

If different from SenderContact, the AccountContact is required to be provided in a ship request. Otherwise, it defaults to SenderContact.

If the CountryCode is international, or if Commercial Invoice and other International forms are requested, the FirstName and LastName are required to be provided in the request.

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

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

CODReport Property (UPSShipIntl Component)

Image of a COD Turn In Page.

Syntax

property CODReport: String read get_CODReport;
property CODReportB: TBytes read get_CODReportB;

Default Value

''

Remarks

This applies only to shipments within the European Union (EU) countries. It is the decoded binary image file of the COD report, stored in memory upon successful ship response. The report is generated in HTML format and it will automatically be saved to disk in the file designated by CODReportFile (if this is set to a valid path and filename).

This property is read-only.

CODReportFile Property (UPSShipIntl Component)

Filename and location to save the CODReport to.

Syntax

property CODReportFile: String read get_CODReportFile write set_CODReportFile;

Default Value

''

Remarks

This applies only to shipments within the European Union (EU) countries. When applicable and the CODReportFile is set to a valid path and filename, the contents of the CODReport are written to disk upon successful response.

This has to have .html extension.

CODTotalAmount Property (UPSShipIntl Component)

The total amount to be collected on shipment level.

Syntax

property CODTotalAmount: String read get_CODTotalAmount write set_CODTotalAmount;

Default Value

''

Remarks

This indicates customer's input COD amount (prior to any accumulations: total collection amount minus transportation charges).

For MPS COD shipments (when Packages is greater than 1), the COD amount must be included on each package that uses COD service by setting the CODAmount.

Format: Two explicit decimals (e.g.5.00).

CODType Property (UPSShipIntl Component)

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

Syntax

property CODType: TibxTSCODTypes read get_CODType write set_CODType;

TibxTSCODTypes = (
  codtsCash,
  codtsCheck
);

Default Value

codtsCash

Remarks

This property identifies the type of funds UPS should collect upon shipment delivery. It is required to be provided in the request only if COD is requested (i.e., CODTotalAmount is set to a value other than "0.00").

Valid values are:

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

CommercialInvoice Property (UPSShipIntl Component)

Contains specific details on Commercial Invoice (when this form is requested).

Syntax

property CommercialInvoice: TibxCommercialInvoiceDetail read get_CommercialInvoice write set_CommercialInvoice;

Remarks

This is applicable only to international shipments that contain non-documents. It is required to be provided in the request only if Commercial Invoice international form is requested (i.e., one of the FormTypes is set to Invoice).

This must be set to an instance of the CommercialInvoiceDetail type, which will contain specific information about the Commercial Invoice (CI) that is requested to associate an international shipment. See the CommercialInvoiceDetail type for more information.

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

Commodities Property (UPSShipIntl Component)

Collection of commodity line items.

Syntax

property Commodities: TibxCommodityDetailList read get_Commodities write set_Commodities;

Remarks

The Commodities is required to be provided in any international shipment request only if any of the international forms (Invoice, CO, NAFTA CO, SED or Partial Invoice) are requested.

For international multiple piece shipments (MPS), commodity information will be passed in the Master and on each subsequent package. If this shipment contains more than four commodities line items, the four highest valued should be included in the request.

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

Each commodity item has a: NumberOfPieces (required), Description (required), Manufacturer (required), HarmonizedCode (optional), Weight (conditional), Quantity (optional), QuantityUnit (optional), UnitPrice (optional), and ExportType (conditional) tied to it.

For instance, to send a package containing 2 computer softwares and 5 iPods: NumberOfPieces(0) = 2 Description(0) = "computer software" Manufacturer(0) = "US" // country of manufacturer Weight(0) = "0.5" // each software box weighs .5 lbs QuantityUnit(0) = "EA" // for 'each' UnitPrice(0) = "100.00" // each software priced at $100 NumberOfPieces(1) = 5 Description(1) = "portable digital audio player" Manufacturer(1) = "US" // country of manufacturer Weight(1) = "0.5" // each iPod box weighs .5 lbs QuantityUnit(1) = "EA" // for 'each' UnitPrice(1) = "150.00" // each iPod priced at $150

This property is not available at design time.

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

DutiesPayor Property (UPSShipIntl Component)

Identifies the payor of duty and tax charges for the requested shipment.

Syntax

property DutiesPayor: TibxPayorDetail read get_DutiesPayor write set_DutiesPayor;

Remarks

This is applicable to and required for international shipments only, and only if origin and destination countries are different (i.e., the CountryCode is different than CountryCode), and the shipment is not US/PR or PR/US.

The ZipCode is required for United States and Canadian UPS accounts and/or if the UPS account pickup address has a postal code. If the UPS account's pickup country is US or Puerto Rico, the postal code is 5 or 9 digits. The character '-' may be used to separate the first five digits and the last four digits. If the UPS account's pickup country is CA, the postal code is 6 alphanumeric characters.

This must be set to an instance of the PayorDetail type, which will contain the duties payor details. See the PayorDetail type for more information.

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

Firewall Property (UPSShipIntl Component)

A set of properties related to firewall access.

Syntax

property Firewall: TibxFirewall read get_Firewall write set_Firewall;

Remarks

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

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

FormTypes Property (UPSShipIntl Component)

Contains the collection of types for international forms that can associate an international shipment.

Syntax

property FormTypes: Integer read get_FormTypes write set_FormTypes;

Default Value

0

Remarks

The FormTypes property is optional. Up to 6 international forms (such as Invoice, Shipper's Export Declaration, Certificate of Origin, NAFTA Certificate of Origin, etc.) can be requested within a ship request. To request any of the forms offered by UPS, you must set the FormTypes to a set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:

For instance, to request both a Commercial Invoice and a CN22 you could set the property like below:

upsshipintl1.FormTypes = 0x00000011

Note: Invoice and Partial Invoice are mutually exclusive.

InternationalForms Property (UPSShipIntl Component)

Image of the international forms.

Syntax

property InternationalForms: String read get_InternationalForms;
property InternationalFormsB: TBytes read get_InternationalFormsB;

Default Value

''

Remarks

This is the decoded binary image file of the international forms accompanying the shipment already requested via the FormTypes property (such as Invoice, SED, Certificate of Origin, etc.), stored in memory upon successful international ship response. If the InternationalFormsFile is set to a valid path and filename, the international forms are also saved to disk in PDF format.

This property is read-only.

InternationalFormsFile Property (UPSShipIntl Component)

Filename and location to save the InternationalForms to.

Syntax

property InternationalFormsFile: String read get_InternationalFormsFile write set_InternationalFormsFile;

Default Value

''

Remarks

When the InternationalFormsFile is set to a valid path and filename, the contents of the InternationalForms are written to disk upon successful response.

The InternationalFormsFile has to have .pdf extension.

LabelImageType Property (UPSShipIntl Component)

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

Syntax

property LabelImageType: TibxUPSImageTypes read get_LabelImageType write set_LabelImageType;

TibxUPSImageTypes = (
  uitGIF,
  uitEPL,
  uitSPL,
  uitZPL,
  uitStar
);

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.

MasterTrackingNumber Property (UPSShipIntl Component)

Tracking number assigned to the whole MPS shipment.

Syntax

property MasterTrackingNumber: String read get_MasterTrackingNumber;

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.

NAFTABlanketPeriod Property (UPSShipIntl Component)

Contains specific details on NAFTA CO (when this form is requested).

Syntax

property NAFTABlanketPeriod: String read get_NAFTABlanketPeriod write set_NAFTABlanketPeriod;

Default Value

''

Remarks

This is applicable only to international shipments that contain non-documents. It is required to be provided in the request only if NAFTA CO international form is requested (i.e., one of the FormTypes is set to NAFTA).

This contains the begin date and the end date of the blanket period. The begin date is the date upon which the Certificate becomes applicable to the good covered by the blanket Certificate (it may be prior to the date of signing this Certificate). The end date is the date upon which the blanket period expires.

This is applicable and required to be provided in the request only if the NAFTA Certificate covers multiple shipments of identical goods as described in the ShipmentDescription that are imported into a NAFTA country for a specified period of up to one year (the blanket period). The importation of a good for which preferential treatment is claimed based on this certificate must occur between beginning and ending dates.

Format is: YYYYMMDD-YYYYMMDD

NAFTAPreferenceCriteria Property (UPSShipIntl Component)

Preference Criteria for NAFTA Certificate of Origin documents.

Syntax

property NAFTAPreferenceCriteria: String read get_NAFTAPreferenceCriteria write set_NAFTAPreferenceCriteria;

Default Value

''

Remarks

This property is required when the FormTypes property includes the NAFTA flag. Valid values and their descriptions are listed from the UPS documentation:

NAFTAProducerInfo Property (UPSShipIntl Component)

Producer information for NAFTA Certificate of Origin documents.

Syntax

property NAFTAProducerInfo: TibxNAFTAProducerInfos read get_NAFTAProducerInfo write set_NAFTAProducerInfo;

TibxNAFTAProducerInfos = (
  piYes,
  piNo1,
  piNo2,
  piNo3
);

Default Value

piYes

Remarks

This property is required when the FormTypes property includes the NAFTA flag.

From UPS documentation, specify: piYes - If shipper is the producer of the good. If not, state No depending on whether this certificate was based upon: piNo1 - Knowledge of whether the good qualifies as an originating good. piNo2 - Reliance on the producer's written representation (other than a Certificate of Origin) that the good qualifies as an originating good. piNo3 - A completed and signed Certificate for the good voluntarily provided to the exporter by the producer.

Notify Property (UPSShipIntl Component)

Collection of e-mail notifications to be sent.

Syntax

property Notify: TibxNotifyDetailList read get_Notify write set_Notify;

Remarks

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

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

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

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

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

This property is not available at design time.

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

Packages Property (UPSShipIntl Component)

A collection of packages contained in the shipment.

Syntax

property Packages: TibxPackageDetailList read get_Packages write set_Packages;

Remarks

At least one package must be specified.

This property must be set to a collection of PackageDetail instances, which will contain specific information about a package contained in the shipment. See the PackageDetail type for more information.

For UPS, the PackagingType is required. The Description is optional. The Weight, Length, Width, and Height are all conditionally required. More information can be found in the individual property definitions.

This property is not available at design time.

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

Payor Property (UPSShipIntl Component)

Identifies the payor of transportation charges for the requested shipment.

Syntax

property Payor: TibxPayorDetail read get_Payor write set_Payor;

Remarks

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

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

PickupEarliestTime Property (UPSShipIntl Component)

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

Syntax

property PickupEarliestTime: String read get_PickupEarliestTime write set_PickupEarliestTime;

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.

PickupLatestTime Property (UPSShipIntl Component)

The latest time a shipment can be picked up.

Syntax

property PickupLatestTime: String read get_PickupLatestTime write set_PickupLatestTime;

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.

Proxy Property (UPSShipIntl Component)

A set of properties related to proxy access.

Syntax

property Proxy: TibxProxy read get_Proxy write set_Proxy;

Remarks

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

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

RecipientAddress Property (UPSShipIntl Component)

Identifies the recipient's address.

Syntax

property RecipientAddress: TibxAddressDetail read get_RecipientAddress write set_RecipientAddress;

Remarks

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

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

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

RecipientContact Property (UPSShipIntl Component)

Identifies the recipient's contact info.

Syntax

property RecipientContact: TibxContactDetail read get_RecipientContact write set_RecipientContact;

Remarks

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

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

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

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

SED Property (UPSShipIntl Component)

Contains specific details on SED (when this form is requested).

Syntax

property SED: TibxSEDDetail read get_SED write set_SED;

Remarks

This is applicable only to international shipments that contain non-documents. It is required to be provided in the request only if SED international form is requested (i.e., one of the FormTypes is set to SED).

This must be set to an instance of the SEDDetail type, which will contain specific information about the SED that is requested to associate an international shipment. See the SEDDetail type for more information.

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

SenderAddress Property (UPSShipIntl Component)

Identifies the sender's address.

Syntax

property SenderAddress: TibxAddressDetail read get_SenderAddress write set_SenderAddress;

Remarks

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

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

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

SenderContact Property (UPSShipIntl Component)

Identifies the sender's contact info.

Syntax

property SenderContact: TibxContactDetail read get_SenderContact write set_SenderContact;

Remarks

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

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

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

ServiceType Property (UPSShipIntl Component)

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

Syntax

property ServiceType: TibxServiceTypes read get_ServiceType write set_ServiceType;

TibxServiceTypes = (
  stUnspecified,
  stFedExPriorityOvernight,
  stFedExStandardOvernight,
  stFedExFirstOvernight,
  stFedEx2Day,
  stFedExExpressSaver,
  stFedExGround,
  stFedExGroundHomeDelivery,
  stFedEx1DayFreight,
  stFedEx2DayFreight,
  stFedEx3DayFreight,
  stFedExInternationalPriority,
  stFedExInternationalEconomy,
  stFedExInternationalFirst,
  stFedExInternationalPriorityFreight,
  stFedExInternationalEconomyFreight,
  stFedExEuropeFirstInternationalPriority,
  stFedExSmartPost,
  stFedEx2DayAM,
  stFedExFirstFreight,
  stFedExInternationalGround,
  stFedExFreightEconomy,
  stFedExFreightPriority,
  stFedExInternationalPriorityExpress,
  stFedExInternationalConnectPlus,
  stUPSFirstClass,
  stUPSPriorityMail,
  stUPSExpeditedMailInnovations,
  stUPSPriorityMailInnovations,
  stUPSEconomyMailInnovations,
  stUPSNextDayAir,
  stUPSExpress,
  stUPS2ndDayAir,
  stUPSGround,
  stUPSWorldwideExpress,
  stUPSWorldwideExpedited,
  stUPSExpedited,
  stUPSStandard,
  stUPS3DaySelect,
  stUPSNextDayAirSaver,
  stUPSSaver,
  stUPSNextDayAirEarlyAM,
  stUPSExpressEarlyAM,
  stUPSWorldwideExpressPlus,
  stUPSExpressPlus,
  stUPS2ndDayAirAM,
  stUPSTodayStandard,
  stUPSTodayCourrier,
  stUPSTodayInterCity,
  stUPSTodayExpress,
  stUPSTodayExpressSaver,
  stUPSWorldwideExpressFreight,
  stUPSSurePostLessThan1LB,
  stUPSSurePost1LBOrGreater,
  stUPSSurePostBPM,
  stUPSSurePostMedia,
  stUSPSExpress,
  stUSPSFirstClass,
  stUSPSPriority,
  stUSPSParcelPost,
  stUSPSBPM,
  stUSPSMedia,
  stUSPSLibrary,
  stUSPSOnline,
  stUSPSGlobalExpress,
  stUSPSParcelSelect,
  stUSPSCriticalMail,
  stUSPSStandardMail,
  stUSPSExpressMailInternational,
  stUSPSFirstClassMailInternational,
  stUSPSPriorityMailInternational,
  stUSPSPriorityExpress,
  stUSPSRetailGround,
  stUSPSFirstClassPackageInternationalService,
  stUSPSPriorityMailExpressInternational,
  stCanadaRegularParcel,
  stCanadaExpeditedParcel,
  stCanadaXpresspost,
  stCanadaLibrary,
  stCanadaPriority,
  stCanadaPriorityEnvelopeUSA,
  stCanadaPriorityPakUSA,
  stCanadaPriorityParcelUSA,
  stCanadaXpresspostUSA,
  stCanadaExpeditedParcelUSA,
  stCanadaSmallPacketAirUSA,
  stCanadaTrackedPacketUSA,
  stCanadaTrackedPacketLVMUSA,
  stCanadaPriorityEnvelopeInternational,
  stCanadaPriorityPakInternational,
  stCanadaPriorityParcelInternational,
  stCanadaXpresspostInternational,
  stCanadaSmallPacketAirInternational,
  stCanadaSmallPacketLandInternational,
  stCanadaParcelAirInternational,
  stCanadaParcelLandInternational,
  stCanadaTrackedPacketInternational,
  stFedExSameDay,
  stFedExSameDayCity,
  stFedExSameDayMetroAfternoon,
  stFedExSameDayMetroMorning,
  stFedExSameDayMetroRush,
  stUPSWorldwideEconomyDDU,
  stUPSWorldwideEconomyDDP,
  stUSPSParcelSelectGround,
  stUSPSPriorityMailCubic,
  stUSPSGroundAdvantage,
  stUSPSGroundAdvantageCubic,
  stFedExFirst,
  stFedExPriority,
  stFedExPriorityExpress,
  stFedExPriorityExpressFreight,
  stFedExPriorityFreight,
  stFedExEconomySelect
);

Default Value

stUnspecified

Remarks

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

Note that the availability and the description of UPS services depend on the country of origin. Possible values of ServiceType and their corresponding availability to each group country origin are listed below:

This property is not available at design time.

ShipDate Property (UPSShipIntl Component)

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

Syntax

property ShipDate: String read get_ShipDate write set_ShipDate;

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.

ShipmentDescription Property (UPSShipIntl Component)

A textual description of goods for the whole shipment.

Syntax

property ShipmentDescription: String read get_ShipmentDescription write set_ShipmentDescription;

Default Value

''

Remarks

This is applicable to international shipments only. Provide a detailed description of items being shipped for documents and non-documents, such as 'annual reports', '9 mm steel screws', etc..

This is required to be provided in a ship request if all of the listed conditions are true:

• the CountryCode and CountryCode are not the same;
• the CountryCode and/or CountryCode are not in the European Union; or the CountryCode and CountryCode are both in the European Union; and ServiceType is not 'UPS Standard'.
• the packaging type of any packages contained in the shipment is not 'UPS Letter';

Maximum length: 35 characters.

ShipmentReference Property (UPSShipIntl Component)

Customer-defined number (that may or may not be unique) used to identify the whole shipment.

Syntax

property ShipmentReference: String read get_ShipmentReference write set_ShipmentReference;

Default Value

''

Remarks

This is applicable to international shipments only. Valid if the origin/destination pair is not US/US or PR/PR.

This is optional to be provided in a ship request (when the GetShipmentLabels method is called). You can enter up to two customer references on shipment 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 shipment, the ShipmentReference 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 shipment by reference.

ShipmentSpecialServices Property (UPSShipIntl Component)

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

Syntax

property ShipmentSpecialServices: Int64 read get_ShipmentSpecialServices write set_ShipmentSpecialServices;

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 CountryCode, CountryCode and CountryCode: 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 Description is required to be provided in the request for each package contained in the shipment. The PackagingType 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.

ShipmentVoidStatus Property (UPSShipIntl Component)

Status description of shipment void request.

Syntax

property ShipmentVoidStatus: String read get_ShipmentVoidStatus;

Default Value

''

Remarks

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

This property is read-only.

SoldToAddress Property (UPSShipIntl Component)

Identifies the address of the party who imports and pays any duties due on the current shipment, or the end-user of the goods..

Syntax

property SoldToAddress: TibxAddressDetail read get_SoldToAddress write set_SoldToAddress;

Remarks

The SoldToAddress represents address details of the party who imports and pays any duties due on the shipment, or the end-user. It is required to be provided in an international ship request only if this party is different from recipient, and if Commercial Invoice, NAFTA CO, and/or SED international forms are requested.

• in Commercial Invoice or NAFTA CO forms: SoldToAddress represents the party's address who imports and pays any duties due on the current shipment.
• in SED form: SoldToAddress represents the person or company's address who receives the goods for end-use or the person or company listed on the export license. This is the end-user of the goods.

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

If not set, it will default to RecipientAddress.

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

SoldToContact Property (UPSShipIntl Component)

Identifies the contact info of the party who imports and pays any duties due on the current shipment.

Syntax

property SoldToContact: TibxContactDetail read get_SoldToContact write set_SoldToContact;

Remarks

The SoldToContact represents descriptive contact data identifying the party who imports and pays any duties due on the shipment, or the end-user. It is required to be provided in an international ship request only if this party is different from recipient, and if Commercial Invoice, NAFTA CO, and/or SED international forms are requested.

• in Commercial Invoice or NAFTA CO forms: SoldToAddress represents the party's contact who imports and pays any duties due on the current shipment.
• in SED form: SoldToAddress represents the person or company's contact who receives the goods for end-use or the person or company listed on the export license. This is the end-user of the goods.

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

If not set, it will default to RecipientContact.

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

SSLAcceptServerCertEncoded Property (UPSShipIntl Component)

This is the certificate (PEM/Base64 encoded).

Syntax

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

Default Value

''

Remarks

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

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

This property is not available at design time.

SSLCertEncoded Property (UPSShipIntl Component)

This is the certificate (PEM/Base64 encoded).

Syntax

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

Default Value

''

Remarks

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

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

This property is not available at design time.

SSLCertStore Property (UPSShipIntl Component)

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

Syntax

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

Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

SSLCertStorePassword Property (UPSShipIntl Component)

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

Syntax

property SSLCertStorePassword: String read get_SSLCertStorePassword write set_SSLCertStorePassword;

Default Value

''

Remarks

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

SSLCertStoreType Property (UPSShipIntl Component)

This is the type of certificate store for this certificate.

Syntax

property SSLCertStoreType: TibxCertStoreTypes read get_SSLCertStoreType write set_SSLCertStoreType;

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

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

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

SSLCertSubject Property (UPSShipIntl Component)

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

Syntax

property SSLCertSubject: String read get_SSLCertSubject write set_SSLCertSubject;

Default Value

''

Remarks

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

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

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

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

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

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

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

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

SSLProvider Property (UPSShipIntl Component)

This specifies the SSL/TLS implementation to use.

Syntax

property SSLProvider: TibxTSSLProviders read get_SSLProvider write set_SSLProvider;

TibxTSSLProviders = (
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
);

Default Value

sslpAutomatic

Remarks

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

Possible values are:

Additional Notes

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

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

SSLServerCertEncoded Property (UPSShipIntl Component)

This is the certificate (PEM/Base64 encoded).

Syntax

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

Default Value

''

Remarks

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

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

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

Timeout Property (UPSShipIntl Component)

A timeout for the component.

Syntax

property Timeout: Integer read get_Timeout write set_Timeout;

Default Value

60

Remarks

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

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

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

If Timeout expires, and the operation is not yet complete, the component raises an exception.

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

The default value for the Timeout property is 60 seconds.

TotalBaseCharge Property (UPSShipIntl Component)

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

Syntax

property TotalBaseCharge: String read get_TotalBaseCharge;

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 BaseCharge at index=0.

This property is read-only.

TotalCustomsValue Property (UPSShipIntl Component)

Total customs value for the shipment.

Syntax

property TotalCustomsValue: String read get_TotalCustomsValue write set_TotalCustomsValue;

Default Value

'1'

Remarks

The TotalCustomsValue is required to be provided in an international shipment request only if the following requirements are met:

• the CountryCode is US;
• the CountryCode is either CA (Canada) or PR (PuertoRico);
• the shipment does not contain any package of UPS Letter type;

If Commercial Invoice is requested (i.e., one of the FormTypes is set to Invoice), this value should match the invoice line total on the invoice form. If not it will be replaced by the actual calculated invoice line total. It represents the sum of the values of all commodities included in the shipment.

Format: Whole number, no decimal position (e.g. 100) with maximum length of 8 digits. Possible values: 1 to 99999999.

TotalNetCharge Property (UPSShipIntl Component)

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

Syntax

property TotalNetCharge: String read get_TotalNetCharge;

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 NetCharge at index=0.

This property is read-only.

TotalSurcharges Property (UPSShipIntl Component)

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

Syntax

property TotalSurcharges: String read get_TotalSurcharges;

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 TotalSurcharges at index=0.

This property is read-only.

UPSAccount Property (UPSShipIntl Component)

Login information for UPS.

Syntax

property UPSAccount: TibxUPSAccount read get_UPSAccount write set_UPSAccount;

Remarks

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

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

CancelPackage Method (UPSShipIntl Component)

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

Syntax

procedure CancelPackage(MasterTrackingNumber: String; PackageTrackingNumber: String);

Remarks

To cancel shipment of a single package, a void shipment request should be sent to UPS Server by calling the CancelPackage 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 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 (UPSShipIntl Component)

Cancel a pickup.

Syntax

procedure CancelPickup(ConfirmationNumber: String);

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

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

Syntax

procedure CancelShipment(MasterTrackingNumber: String);

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

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

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

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

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

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

GetShipmentLabels Method (UPSShipIntl Component)

Generates a shipping label.

Syntax

procedure GetShipmentLabels();

Remarks

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

• Server (required)
• AuthorizationToken (required)
• AccountNumber (required)
• ServiceType (required)
• AccountContact (conditional)
• AccountAddress (conditional)
• SenderContact (required)
• SenderAddress (required)
• RecipientContact (required)
• RecipientAddress (required)
• SoldToContact (conditional)
• SoldToAddress (conditional)
• Payor (required)
• ShipmentSpecialServices (optional)
• ShipmentDescription (conditional)
• ShipmentReference (conditional)
• Packages (required)
• LabelImageType (required)
• Notify (optional)
• FormTypes (optional)
• CommercialInvoice (optional)
• Commodities (conditional)
• CODReportFile (optional)
• CODTotalAmount (optional)
• CODType (optional)
• WeightUnit (required; defaults to LB)
• Documents (optional)

The commodity information you provide in your transaction is forwarded to customs electronically at the time the shipping label is generated. Commodity information can be provided via the Commodities (required, regardless of the Documents value).

Upon successful response, the following properties might be populated:

• MasterTrackingNumber (if MPS)
• TrackingNumber for each package included in the shipment;
• ShippingLabel for each package included in the shipment;
• TotalSurcharges for each package included in the shipment (only guaranteed to be returned for shipments whose origin country is US or Puerto Rico);
• TotalNetCharge (applicable to the whole shipment);
• TotalBaseCharge (applicable to the whole shipment);
• TotalSurcharges (applicable to the whole shipment);

To print out the ShippingLabel, you can save it to the ShippingLabelFile file in LabelImageType format.

Reset Method (UPSShipIntl Component)

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

Syntax

procedure Reset();

Remarks

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

SchedulePickup Method (UPSShipIntl Component)

Schedules a pickup.

Syntax

function SchedulePickup(): String;

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)
• FirstName (Optional, required if Company is not provided)
• LastName (Optional, required if Company is not provided)
• Company (Optional, required if FirstName and/or LastName are not provided)
• Phone (Required)
• Address1 (Required)
• PickupFloorNumber (Optional)
• PickupRoomNumber (Optional)
• City (Required)
• State (Required, optional if outside US and Canada)
• ZipCode (Required)
• CountryCode (Required)
• ShipDate (Required)

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

Error Event (UPSShipIntl Component)

Information about errors during data delivery.

Syntax

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

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

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

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

Notification Event (UPSShipIntl Component)

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

Syntax

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

property OnNotification: TNotificationEvent read FOnNotification write FOnNotification;

Remarks

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

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

SSLServerAuthentication Event (UPSShipIntl Component)

Fired after the server presents its certificate to the client.

Syntax

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

property OnSSLServerAuthentication: TSSLServerAuthenticationEvent read FOnSSLServerAuthentication write FOnSSLServerAuthentication;

Remarks

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

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

SSLStatus Event (UPSShipIntl Component)

Fired when secure connection progress messages are available.

Syntax

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

property OnSSLStatus: TSSLStatusEvent read FOnSSLStatus write FOnSSLStatus;

Remarks

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

AddressDetail Type

Represents the address details of a sender or recipient.

Remarks

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

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

The properties contained by this type are listed below.

Fields

Constructors

constructor Create();

CommercialInvoiceDetail Type

Represents the commercial invoice (CI) information.

Remarks

This type contains descriptive data identifying the commercial invoice (CI) associating an international shipment that contains non-documents items.

Example: Setting the fields CommercialInvoiceDetail ci = new CommercialInvoiceDetail ci.Comments = "Anything" ci.FreightCharge = "100.00" ci.Insurance = "1000.00" ci.Purpose = CIP_SAMPLE ci.Terms = CIT_FOB_OR_FCA

The fields contained by this type are listed below.

Fields

Constructors

constructor Create();

constructor Create(valComments: String; valFreightCharge: String; valInsurance: String; valPurpose: Integer; valNumber: String; valTerms: Integer);

CommodityDetail Type

Represents a single commodity line item.

Remarks

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

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

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

The fields contained by this type are listed below.

Fields

Constructors

constructor Create();

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

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

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

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

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

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

ContactDetail Type

Represents the contact information.

Remarks

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

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

The fields contained by this type are listed below.

Fields

Constructors

constructor Create();

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

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

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

Firewall Type

The firewall the component will connect through.

Remarks

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

Fields

Constructors

constructor Create();

NotifyDetail Type

Represents a single recipient to be notified via email.

Remarks

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

The fields contained by this type are listed below.

Fields

Constructors

constructor Create();

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

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

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

constructor Create(valName: String);

PackageDetail Type

Represents a single package contained in shipment.

Remarks

This type contains specific information on the package that is part of the whole shipment.

Example: Setting the package elements PackageDetail pckg = new PackageDetail pckg.Weight = "2.0" pckg.Description = "Your order for the 4D Shipping SDK" pckg.ShippingLabelFile = "shipping label for package# 1.pdf"

The fields contained by this type are listed below.

Fields

Constructors

constructor Create();

constructor Create(valPackagingType: Integer; valWeight: String);

constructor Create(valLength: Integer; valWidth: Integer; valHeight: Integer);

constructor Create(valPackagingType: Integer; valLength: Integer; valWidth: Integer; valHeight: Integer);

constructor Create(valPackagingType: Integer; valWeight: String; valLength: Integer; valWidth: Integer; valHeight: Integer);

constructor Create(valPackagingType: Integer; valWeight: String; valLength: Integer; valWidth: Integer; valHeight: Integer; valSpecialServices: Integer; valInsuredValue: String; valCODAmount: String; valCODType: Integer; valSignatureType: Integer);

constructor Create(valWeight: String; valLength: Integer; valWidth: Integer; valHeight: Integer; valSpecialServices: Integer; valInsuredValue: String; valCODAmount: String; valDangerousGoodsAccessible: Boolean; valSignatureType: Integer);

constructor Create(valWeight: String; valLength: Integer; valWidth: Integer; valHeight: Integer; valDescription: String; valReference: String; valSpecialServices: Integer; valInsuredValue: String; valCODAmount: String; valDangerousGoodsAccessible: Boolean; valSignatureType: Integer; valShippingLabelFile: String; valCODFile: String);

constructor Create(valPackagingType: Integer; valWeight: String; valLength: Integer; valWidth: Integer; valHeight: Integer; valDescription: String; valReference: String; valSpecialServices: Integer; valInsuredValue: String; valCODAmount: String; valCODType: Integer; valSignatureType: Integer; valShippingLabelFile: String; valReturnReceiptFile: String);

PayorDetail Type

Represents the payor details responsible for payment.

Remarks

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

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

The fields contained by this type are listed below.

Fields

Constructors

constructor Create();

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

Proxy Type

The proxy the component will connect to.

Remarks

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

Fields

Constructors

constructor Create();

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

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

SEDDetail Type

Represents specific information of Shipper's Export Declaration (SED).

Remarks

This type contains descriptive data identifying the Shipper's Export Declaration (SED) associating an international shipment that contains non-documents items. This is used in the UPSShipIntl component only. It is applicable only if the Shipper's Export Declaration flag of the FormTypes is set.

Example: Setting the fields SEDDetail sed = new SEDDetail sed.FiledByUPS = false sed.PointOfOrigin = "NJ" sed.InBondCode = "36" sed.TransportType = "Air"

The fields contained by this type are listed below.

Fields

Constructors

constructor Create();

constructor Create(valFiledByUPS: Boolean; valPointOfOrigin: String; valTransportType: String; valInBondCode: Integer; valEntryNumber: String; valLicenseNumber: String; valLicenseDate: String; valShipperTaxId: String);

constructor Create(valFiledByUPS: Boolean; valPointOfOrigin: String; valTransportType: String; valInBondCode: Integer; valLicenseNumber: String; valLicenseDate: String; valShipperTaxId: String);

constructor Create(valFiledByUPS: Boolean; valPointOfOrigin: String; valTransportType: String; valInBondCode: Integer; valEntryNumber: String; valExceptionCode: Integer; valECCNNumber: String; valShipperTaxId: String);

constructor Create(valFiledByUPS: Boolean; valPointOfOrigin: String; valTransportType: String; valInBondCode: Integer; valExceptionCode: Integer; valECCNNumber: String; valShipperTaxId: String);

constructor Create(valFiledByUPS: Boolean; valPointOfOrigin: String; valTransportType: String; valInBondCode: Integer; valExceptionCode: Integer; valShipperTaxId: String);

UPSAccount Type

Represents the details of a UPS account.

Remarks

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

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

The properties contained by this type are listed below.

Fields

Constructors

constructor Create();

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

UPSShipIntl Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (UPSShipIntl Component)

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