FedExShipIntl Component

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate a FedEx shipping label for any of FedEx international services complete with addresses and barcode, cancel a shipment, or close out the FedEx Ground shipments.

Syntax

TibxFedExShipIntl

Remarks

Generating a shipping label can be done by calling either the GetPackageLabel or the GetShipmentLabels method. You will have to specify the package information, FedEx service to be used for shipping this package, origin and destination information, and any other special services associated with the shipment (such as Saturday Pickup, Saturday Delivery, Hold At Locations, etc.).

This component also allows you to delete packages included in the daily shipping log that have not already been tendered to FedEx by calling the CancelShipment method. The TrackingNumber parameter that identifies the shipment must be specified in the request along with the DeveloperKey, Password, AccountNumber, and MeterNumber.

When shipping with FedEx Ground, you can close out your shipments and generate a FedEx Ground Close Manifest by calling the CloseGroundShipments method.

To use this component, you must have a FedEx AccountNumber. You should also have already obtained a ClientId and ClientSecret; uniquely assigned to your account by FedEx.

NOTE: FedEx requires that all applications that print shipping labels pass a series of certification tests prior to being placed in production. The full version of FedEx Integrator gives you access to a certification package that makes this process very easy. The certification package is available by request. It includes all test scenarios required by FedEx for FedEx Express and Ground (international and domestic), and Home Delivery. Through the application included in the certification package, you can generate all shipping labels for selected scenarios applicable to your shipping needs with a click of a button.

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.

BrokerAddress Property (FedExShipIntl Component)

Identifies the broker's address.

Syntax

property BrokerAddress: TibxAddressDetail read get_BrokerAddress write set_BrokerAddress;

Remarks

The BrokerAddress represents address data identifying the Broker responsible for the shipment. This is required to be provided in an international ship request only if the BrokerSelect is present (requested) in the ShipmentSpecialServices.

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.

BrokerContact Property (FedExShipIntl Component)

Identifies the broker's contact info.

Syntax

property BrokerContact: TibxContactDetail read get_BrokerContact write set_BrokerContact;

Remarks

The BrokerContact represents descriptive contact data identifying the Broker responsible for the shipment. It is required to be provided in an international ship request only if the BrokerSelect is present (requested) in the ShipmentSpecialServices.

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

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

BrokerType Property (FedExShipIntl Component)

Identifies the broker type.

Syntax

property BrokerType: TibxTBrokerTypes read get_BrokerType write set_BrokerType;

TibxTBrokerTypes = (
  btUnassigned,
  btExport,
  btImport
);

Default Value

btUnassigned

Remarks

When shipping internationally, the customer might want to have their own broker to deal with the delivery (for customs purposes). To request such service, the BrokerSelect option should be set in the ShipmentSpecialServices value. This allows you to designate a specific customs broker other than FedEx (or a FedEx designated broker). This is applicable to the following international FedEx services:

• stFedExInternationalPriority (20)
• stFedExInternationalEconomy (21)
• stFedExInternationalPriorityFreight (23)
• stFedExInternationalEconomyFreight (24)
• stFedExInternationalPriorityExpress (32)
• stFedExInternationalConnectPlus (33)

FedEx International Broker Select is a contract service. Before you begin using FedEx International Broker Select (BSO), you must contact your FedEx account executive to be enrolled for this service. An additional routing surcharge applies to your BSO shipments if you choose to have FedEx complete delivery after customs clearance and if your recipient and customs broker are served by different FedEx clearance points. This service is not valid with SaturdayPickup/SaturdayDelivery services. When this service is requested, then the ClearanceBrokerageType, BrokerType, BrokerContact, and BrokerAddress are required to be provided in the ship request as well.

Note: Certain customs limitations may apply for BSO shipments. Contact FedEx Express International customer service at 1.800.247.4747 for requirements.

Possible values are:

ClearanceBrokerageType Property (FedExShipIntl Component)

Specifies the type of brokerage to be applied to a shipment.

Syntax

property ClearanceBrokerageType: TibxTClearanceBrokerageTypes read get_ClearanceBrokerageType write set_ClearanceBrokerageType;

TibxTClearanceBrokerageTypes = (
  cbUnassigned,
  cbInclusive,
  cbInclusiveNonResidentImporter,
  cbSelect,
  cbSelectNonResidentImporter
);

Default Value

cbUnassigned

Remarks

When shipping internationally, the customer might want to have their own broker to deal with the delivery (for customs purposes). To request such service, the BrokerSelect option should be set in the ShipmentSpecialServices value. This allows you to designate a specific customs broker other than FedEx (or a FedEx designated broker). This is applicable to the following international FedEx services:

• stFedExInternationalPriority (20)
• stFedExInternationalEconomy (21)
• stFedExInternationalPriorityFreight (23)
• stFedExInternationalEconomyFreight (24)
• stFedExInternationalPriorityExpress (32)
• stFedExInternationalConnectPlus (33)

FedEx International Broker Select is a contract service. Before you begin using FedEx International Broker Select (BSO), you must contact your FedEx account executive to be enrolled for this service. An additional routing surcharge applies to your BSO shipments if you choose to have FedEx complete delivery after customs clearance and if your recipient and customs broker are served by different FedEx clearance points. This service is not valid with SaturdayPickup/SaturdayDelivery services. When this service is requested, then the ClearanceBrokerageType, BrokerType, BrokerContact, and BrokerAddress are required to be provided in the ship request as well.

Note: Certain customs limitations may apply for BSO shipments. Contact FedEx Express International customer service at 1.800.247.4747 for requirements.

Possible values are:

CloseRequest Property (FedExShipIntl Component)

Identifies the close request.

Syntax

property CloseRequest: TibxCloseDetail read get_CloseRequest write set_CloseRequest;

Remarks

The CloseRequest represents information specific for a close request. This is applicable for FedEx Ground shipments only. Is is required to be provided when the CloseGroundShipments method is called.

This must be set to an instance of the CloseDetail type, which will contain close request details. See the CloseDetail type for more information.

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

CommercialInvoice Property (FedExShipIntl Component)

Contains the collection of commercial Invoice (CI) details.

Syntax

property CommercialInvoice: TibxCommercialInvoiceDetail read get_CommercialInvoice write set_CommercialInvoice;

Remarks

This is applicable only to international shipments that contain non-documents.

Commercial Invoice is required for electronic upload of CI data. It will serve to create/transmit an Electronic Commercial Invoice through FedEx System. Customers are responsible for printing their own Commercial Invoice. Commercial Invoice support consists of a maximum of 99 commodity line items.

This must be set to an instance of the CommercialInvoiceDetail type, which will contain specific information about the commercial invoice that should 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 (FedExShipIntl 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 regardless of the fact that it contains documents or non-documents.

For Express International MPS shipments, if one package is a commodity shipment, then all packages in the shipment must contain commodities. Commodity and document shipments cannot be combined in a MPS shipment. Also, in a 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 in the first 4 occurrences for this request.. A maximum of 99 occurrences of commodity line item information is supported by this component.

Each commodity item has a: NumberOfPieces (required), Description (required), Manufacturer (required), HarmonizedCode (optional), Weight (required), Quantity (optional), QuantityUnit (optional), UnitPrice (optional) 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

Before you process shipments containing alcohol, review the following information:

• You must sign a FedEx Alcohol Shipping Agreement prior to shipping. Contact your FedEx account executive to start the enrollment process.
• Alcohol content information is not required except for international shipments. For international shipments, you must identify alcohol shipments in the commodity description for that commodity item.
• Common carriers such as FedEx Express and FedEx Ground must report alcohol shipping activity to state authorities on a regular basis. For this reason, shippers must notify FedEx of each shipment containing alcohol via their electronic FedEx shipping solution and by applying FedEx alcohol shipping labels. For all FedEx electronic shipping solutions or third-party systems, the shipper must identify the shipment as containing alcohol by entering "$AW" in the Customer Reference field for all shipments.
• State law, as well as FedEx policy, requires an adult signature at the time of delivery for every package containing alcohol. It is the shipper's responsibility to ensure an adult is available to sign for the shipment at delivery. When alcohol is present in the ship request, the signature type should be set to ADULT, so that FedEx is alerted to the adult signature requirement as a condition of delivery of the shipment. If a shipper fails to follow the procedures outlined herein, the shipment will be deemed undeliverable. Violations may result in suspension or termination of your FedEx account.

For more information about alcohol shipping, see https://www.fedex.com/en-us/shipping/alcohol.html. FedEx accepts shipments of alcohol (beer, wine, and spirits) within the U.S. and for both U.S. import and export when the shipper and the recipient are licensed to import/export alcohol.

This property is not available at design time.

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

DeliveryDate Property (FedExShipIntl Component)

Date on which shipment is expected to be delivered.

Syntax

property DeliveryDate: String read get_DeliveryDate;

Default Value

''

Remarks

When either the GetPackageLabel or the GetShipmentLabels method is called, the DeliveryDate will be returned in the server reply. For international shipments, this information is limited to a number of international countries.

This property is read-only.

DutiesPayor Property (FedExShipIntl Component)

Identifies how payment of duties for the shipment will be made.

Syntax

property DutiesPayor: TibxPayorDetail read get_DutiesPayor write set_DutiesPayor;

Remarks

The DutiesPayor is required to be provided in an international ship request. 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.

FedExAccount Property (FedExShipIntl Component)

Login information for FedEx.

Syntax

property FedExAccount: TibxFedExAccount read get_FedExAccount write set_FedExAccount;

Remarks

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

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

Firewall Property (FedExShipIntl 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.

FreightGuarantee Property (FedExShipIntl Component)

Identifies the freight guarantee details.

Syntax

property FreightGuarantee: TibxFreightGuaranteeDetail read get_FreightGuarantee write set_FreightGuarantee;

Remarks

This specifies the type and date of guarantee provided for the freight shipment.

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

HoldAtLocation Property (FedExShipIntl Component)

Identifies the FedEx location where you want to have your shipment held for pickup.

Syntax

property HoldAtLocation: TibxAddressDetail read get_HoldAtLocation write set_HoldAtLocation;

Remarks

This is the address required for a FedEx shipment that is to be held at the destination FedEx location for pickup by the recipient. The HoldAtLocation and HoldAtLocationPhone properties are required to be provided in a ship request only when the HoldAtLocation is present in the ShipmentSpecialServices.

This must be set to an instance of the AddressDetail type, which will contain HoldAtLocation details.

Hold at FedEx Location (HAL) is available to customers who want to pick up a package rather than have it delivered. The sender must select the FedEx pick-up location from designated FedEx Kinko's Office and Print Centers, FedEx Kinko's ShipCenters, or FedEx World Service Centers. For a list of available FedEx locations, use the FindLocations method of the FedExAddress component to search for FedEx stations where Hold at Location service is available.

The following FedEx services allow the HAL option:

• stFedExPriorityOvernight (10) - FedEx Priority Overnight (Saturday Service available)
• stFedExStandardOvernight (11) - FedEx Standard Overnight
• stFedEx2Day (13) - FedEx 2Day (Saturday Service available)
• stFedEx2DayAM (27) - FedEx 2Day A.M.
• stFedExExpressSaver (14) - FedEx Express Saver
• stFedExGround (15) - FedEx Ground
• stFedExInternationalConnectPlus (33) - FedEx International Connect Plus

To determine if Hold at FedEx Location is available for your origin/destination pair, you can use the FedExRates component. For US, to find the possible FedEx locations close to the recipient address, you can use the FindLocations method of the FedExAddress component.

This is applicable for FedEx Express services only.

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

HoldAtLocationContact Property (FedExShipIntl Component)

The contact information for shipment when the Hold At Location service is used.

Syntax

property HoldAtLocationContact: TibxContactDetail read get_HoldAtLocationContact write set_HoldAtLocationContact;

Remarks

If the shipment uses the Hold At Location service as specified in ShipmentSpecialServices, this specifies the information for the person to contact.

When the shipment arrives at the FedEx location where the shipment will be held, FedEx will notify the person specified here.

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

HoldAtLocationPhone Property (FedExShipIntl Component)

Phone number of the FedEx location where the shipment will be hold at.

Syntax

property HoldAtLocationPhone: String read get_HoldAtLocationPhone write set_HoldAtLocationPhone;

Default Value

''

Remarks

When your Hold at Location shipment is received at the designated FedEx station, you will be notified that your shipment is ready to be picked up. It is required to be provided in a HoldAtLocation request.

InsuredValue Property (FedExShipIntl Component)

Total insured amount.

Syntax

property InsuredValue: String read get_InsuredValue write set_InsuredValue;

Default Value

'0.00'

Remarks

This element is optional. This is just insurance on the whole shipment if it is lost or stolen. If not provided in the request, FedEx will assume the 0 USD value. This value cannot exceed TotalCustomsValue. The value has 2 explicit decimal position and has a maximum of 11 characters including the decimal.

IntlExportControlledExportType Property (FedExShipIntl Component)

The controlled export type.

Syntax

property IntlExportControlledExportType: TibxTControlledExportTypes read get_IntlExportControlledExportType write set_IntlExportControlledExportType;

TibxTControlledExportTypes = (
  cetDEA036,
  cetDEA236,
  cetDEA486,
  cetDSP05,
  cetDSP61,
  cetDSP73,
  cetDSP85,
  cetDSP94,
  cetDSPLicenceAgreement,
  cetFromForeignTradeZone,
  cetWarehouseWithdrawal
);

Default Value

cetDEA036

Remarks

This specifies the type of permit to be used for shipments that are controlled by the US State Department or the US Drug Enforcement Agency.

This only applies when the ServiceType is stFedExInternationalPriority or stFedExInternationalPriorityFreight.

IntlExportEntryNumber Property (FedExShipIntl Component)

The entry number for the controlled export.

Syntax

property IntlExportEntryNumber: String read get_IntlExportEntryNumber write set_IntlExportEntryNumber;

Default Value

''

Remarks

This specifies the entry number for any shipments that are controlled by the US State Department or the US Drug Enforcement Agency.

This only applies when the ServiceType is stFedExInternationalPriority or stFedExInternationalPriorityFreight.

IntlExportForeignTradeZoneCode Property (FedExShipIntl Component)

The foreign trade zone code.

Syntax

property IntlExportForeignTradeZoneCode: String read get_IntlExportForeignTradeZoneCode write set_IntlExportForeignTradeZoneCode;

Default Value

''

Remarks

This specifies the trade zone for shipments that are controlled by the US State Department or the US Drug Enforcement Agency.

This only applies when the ServiceType is stFedExInternationalPriority or stFedExInternationalPriorityFreight.

IntlExportLicenseNumber Property (FedExShipIntl Component)

The license or permit number.

Syntax

property IntlExportLicenseNumber: String read get_IntlExportLicenseNumber write set_IntlExportLicenseNumber;

Default Value

''

Remarks

This should be set to the license or permit number to be used when the International Controlled Export option (0x00010000L) or International Traffic in arms Regulations option (0x10000000000L) is selected in the ShipmentSpecialServices

IntlExportLicenseNumberExpiration Property (FedExShipIntl Component)

The license or permit number expiration date.

Syntax

property IntlExportLicenseNumberExpiration: String read get_IntlExportLicenseNumberExpiration write set_IntlExportLicenseNumberExpiration;

Default Value

''

Remarks

This should be set to the expiration date for the license or permit to be used when the International Controlled Export option (0x00010000L) is selected in the ShipmentSpecialServices

LabelImageType Property (FedExShipIntl Component)

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

Syntax

property LabelImageType: TibxFedExImageTypes read get_LabelImageType write set_LabelImageType;

TibxFedExImageTypes = (
  fitPDF,
  fitPNG,
  fitEltron,
  fitZebra,
  fitUniMark
);

Default Value

fitPDF

Remarks

This element is required to indicate the format that the shipping label should be printed in. This must be set when either GetPackageLabel or GetShipmentLabels are called. The values for the thermal printers indicate the type of printer that is being used.

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

Note: To generate PDF labels, you will need Adobe Reader 6.0 or higher, and the printer driver configuration set to 'none' for print scaling.

There are two types of shipping labels supported:

• plain paper (to be used in laser printers only. In this case, possible values for the LabelImageType are PNG or PDF),
• thermal (to be used in thermal printers only. In this case, possible values for the LabelImageType are ELTRON, ZEBRA, or UNIMARK).

While the content of each of these labels is the same, using the correct image type for the work environment the application will be used in is essential.

You may use the LabelStockType config to specify the size of the label. By default, the component will request a 4x6 label.

MasterTrackingNumber Property (FedExShipIntl 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 either the GetPackageLabel or 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.

OriginAddress Property (FedExShipIntl Component)

Identifies the originating address.

Syntax

property OriginAddress: TibxAddressDetail read get_OriginAddress write set_OriginAddress;

Remarks

The OriginAddress is optional and should be used when the OriginAddress is different from the SenderAddress.

The Residential flag in the AddressFlags property is applicable for FedEx Ground services only.

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

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

OriginContact Property (FedExShipIntl Component)

Identifies the sender's contact info.

Syntax

property OriginContact: TibxContactDetail read get_OriginContact write set_OriginContact;

Remarks

The OriginContact is optional and should be used to when the OriginAddress is different from the SenderAddress

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.

Packages Property (FedExShipIntl 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 FedEx, the PackagingType and either the Weight or TotalWeight must be specified. The Length, Width, Height, InsuredValue, and SpecialServices are optional.

This property is not available at design time.

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

Payor Property (FedExShipIntl 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.

PickupType Property (FedExShipIntl Component)

Pickup type used for the shipment that rate is requested for.

Syntax

property PickupType: TibxFedExPickupTypes read get_PickupType write set_PickupType;

TibxFedExPickupTypes = (
  fptDropoffAtFedexLocation,
  fptContactFedexToSchedule,
  fptUseScheduledPickup,
  fptOnCall,
  fptPackageReturnProgram,
  fptRegularStop,
  fptTag,
  fptNoneType
);

Default Value

fptDropoffAtFedexLocation

Remarks

Indicate the pickup type method by which the shipment to be tendered to FedEx.

Valid values are:

Proxy Property (FedExShipIntl Component)

This property includes 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 (FedExShipIntl Component)

Identifies the recipient's address.

Syntax

property RecipientAddress: TibxAddressDetail read get_RecipientAddress write set_RecipientAddress;

Remarks

The Residential flag is required to be set in the AddressFlags property 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 (FedExShipIntl 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.

When shipping via FedEx Ground, the FirstName, LastName, and Company are all required to be provided in the request. Otherwise, either one of those is sufficient.

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.

RequestedETDDocuments Property (FedExShipIntl Component)

Specifies which document type to request copies of when using Electronic Trade Document Special Service.

Syntax

property RequestedETDDocuments: Integer read get_RequestedETDDocuments write set_RequestedETDDocuments;

Default Value

0

Remarks

This specifies which documents you would like to get copies of when using FedEx Special Services to generate and send the documents electronically (Electronic Trade Documents option is set in the ShipmentSpecialServices). Note that not all customs offices support Electronic Trade Documents (ETD). For a full list of countries that support ETD, you can go to http://images.fedex.com/international/pdf/FedExElectronicTradeDocuments_Coverage.pdf.

Make sure to specify in the ShippingDocumentFile config the location where you want to save the documents.

To request one or more ETD documents be generated by FedEx you will need to set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:

ReturnAddress Property (FedExShipIntl Component)

Identifies the return address to be printed on the label.

Syntax

property ReturnAddress: TibxAddressDetail read get_ReturnAddress write set_ReturnAddress;

Remarks

The ReturnAddress is required to be provided in a ship request. may be provided in a ship request, however it is optional. This should be set if the return address to be printed on the label is different than what is provided in SenderAddress

The Residential flag in the AddressFlags property is applicable for FedEx Ground services only.

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.

ReturnContact Property (FedExShipIntl Component)

Identifies the return contact info to be printed on the label.

Syntax

property ReturnContact: TibxContactDetail read get_ReturnContact write set_ReturnContact;

Remarks

The ReturnContact may be provided in a ship request, however it is optional. This should be set if the return address to be printed on the label is different than what is provided in SenderContact.

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.

SenderAddress Property (FedExShipIntl 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.

The Residential flag in the AddressFlags property is applicable for FedEx Ground services only.

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 (FedExShipIntl 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.

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

Identifies the FedEx international service 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,
  stFedExDistanceDeferred,
  stFedExNextDayAfternoon,
  stFedExNextDayEarlyMorning,
  stFedExNextDayEndOfDay,
  stFedExNextDayFreight,
  stFedExNextDayMidMorning,
  stFedExSameDay,
  stFedExSameDayCity,
  stFedExSameDayMetroAfternoon,
  stFedExSameDayMetroMorning,
  stFedExSameDayMetroRush,
  stUPSWorldwideEconomyDDU,
  stUPSWorldwideEconomyDDP,
  stUSPSParcelSelectGround,
  stUSPSPriorityMailCubic,
  stUSPSGroundAdvantage,
  stUSPSGroundAdvantageCubic,
  stFedExFirst,
  stFedExPriority,
  stFedExPriorityExpress,
  stFedExPriorityExpressFreight,
  stFedExPriorityFreight
);

Default Value

stUnspecified

Remarks

This property is required to be provided in a ship request when either the GetPackageLabel or the GetShipmentLabels method is called. FedEx Ground is applicable to FedEx Ground carrier only. All other service types are only applicable to FedEx Express carrier.

Possible values are:

This property is not available at design time.

ShipDate Property (FedExShipIntl Component)

The date on which the package will be tendered to FedEx.

Syntax

property ShipDate: String read get_ShipDate write set_ShipDate;

Default Value

''

Remarks

This is required to be provided in a ship request. The date should be the current date, or a date no more than 10 days in the future.

If future day shipping is requested (i.e., the corresponding flag of Future Day is present in the ShipmentSpecialServices): for Express shipping this value must be less than or equal to 10 days in the future; for Express freight, this must be less than or equal to 5 days in the future.

Defaults to current system date if not present.

This property is also required to be used for the PickupAvailability and SchedulePickup methods. It is used by these methods to tell FedEx when to pickup the packages.

Format: YYYY-MM-DD (e.g. 2008-09-30).

ShipmentSpecialServices Property (FedExShipIntl Component)

Contains the collection of special services offered by FedEx.

Syntax

property ShipmentSpecialServices: Int64 read get_ShipmentSpecialServices write set_ShipmentSpecialServices;

Default Value

0

Remarks

To request any of the special services offered by FedEx in a ship request, you must set the ShipmentSpecialServices to a set of flags as listed below:

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

• COD: Indicates that this is a COD shipment. 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 COD details must be provided on the Package level.
• Dry Ice: Indicates that the shipment contains dry ice. This might affect the shipping rates and service availability. When this service is requested (i.e., when the corresponding Dry Ice flag is contained in the ShipmentSpecialServices), then the DryIceCount and PackageDryIceWeight are required to be specified in the request (shipment level). This is allowed for FedEx Express shipments only.
• Event Notification: Indicates that event notification is requested. This might affect the service availability. If this is requested in a ship request, then the Notify collection is required to be set.
• Future Day: Indicates that future day shipping is requested. This might affect the service availability. When this is requested, for Express shipping the ShipDate must be less than or equal to 10 days in the future. For Express freight, the ShipDate must be less than or equal to 5 days in the future.
• Hold At Location: This is applicable for FedEx Express services only. Indicates that the FedEx shipment is to be held at the destination FedEx location for pickup by the recipient. The request of this special service might affect the shipping rates and/or service availability. This service is not valid with the Hold Saturday service, and when the AddressFlags is set to Residential (i.e., for residential delivery). When this service is requested (i.e., when the corresponding Hold At Location flag is contained in the ShipmentSpecialServices), then the HoldAtLocation is required to be provided in the request as well.
• Home Delivery: Indicates that the Home Delivery Premium special service is requested. This is applicable for residential delivery only (i.e., when this is present in the request, the AddressFlags is automatically set to Residential in the request). If ServiceType is set to GROUND HOME DELIVERY, the corresponding flag of Home Delivery is automatically added to the ShipmentSpecialServices. In this case, the HomeDeliveryDate, HomeDeliveryPhone, and HomeDeliveryType properties are required to be provided in the request as well. This property is applicable for FedEx Ground services only.
• Inside Delivery: Indicates that inside delivery service is requested. In this case, FedEx may move shipments to positions beyond the adjacent loading area. In doing so, FedEx will assess an inside delivery charge in addition to all other applicable charges. The adjacent loading area is defined as a delivery site that is directly accessible from the curb and is no more than 50 feet inside the outermost door. FedEx will assess an inside delivery charge when shipment breakdown is necessary to fit a shipment through a doorway. FedEx does not provide piece count or piece verification when a breakdown of a freight shipment occurs at the delivery site. Current FedEx surcharge for this option: US$0.0412 per lb./$0.0908 per kg (US$60 minimum).
• Inside Pickup: Indicates that inside pickup service is requested. In this case, FedEx may move shipments from positions beyond the adjacent loading area. In doing so, FedEx will assess an inside pickup charge in addition to all other applicable charges. The adjacent loading area is defined as a pickup site that is directly accessible from the curb and is no more than 50 feet inside the outermost door. Current FedEx surcharge for this option: US$0.0412 per lb./$0.0908 per kg (US$60 minimum).
• Pending Shipment Indicates that an email label has been requested. When this option is selected, you will need to also set the Notify property to specify the email address to send to and the message to be sent. You will also need to set the MerchantPhoneNumber and EmailLabelExpirationDate configuration settings. When this option is selected a label will not be saved to the location in ShippingLabelFile, as the label will now be emailed to the recipient(s) specified in Email
• Return Shipment: Indicates that the return label is requested. This might affect the shipping rates and/or service availability. In this case, the RMANumber and RMAReason can be provided in the request. When this option is selected, the return label will be returned in the server response. The recipient can then apply this return label to the return package as needed and drop the package off at a FedEx drop off location. No charges are assessed until the label is used. Express and Ground return labels are interchangeable, regardless of the original shipping service. For example, you can send the original shipment using an express service, but include a Ground return label as part of your packing documents. Express/Ground Return Labels are available for FedEx First Overnight, FedEx Priority Overnight, FedEx Standard Overnight, FedEx 2Day, FedEx Ground, FedEx Home Delivery, FedEx 2Day Freight, and FedEx 3Day Freight throughout the 50 United States. FedEx Express Saver and FedEx 1Day Freight services are not available. Also, Dangerous Goods and Hazardous Materials cannot be shipped. Additional service options include Saturday Service, Dry Ice Shipments, and Hold at FedEx Location. The maximum declared value is $1,000 for FedEx First Overnight, FedEx Priority Overnight, FedEx Standard Overnight, and FedEx 2Day. The maximum declared value is $50,000 for FedEx 2Day Freight and FedEx 3Day Freight. The maximum declared value is $100 for FedEx Ground and FedEx Home Delivery.
• 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 available for: FedEx Priority Overnight, FedEx 2day, FedEx International Priority, FedEx 1Day Freight, and FedEx 2Day Freight. The rates and service availability depend on the ship date specified in the request. If the ship date falls on Thursday or Friday and you want Saturday delivery, the ground option and some express option will not be valid.
• Saturday Pickup: Indicates that you request to have the shipment picked up on a Saturday. Saturday pickup service is available for an additional charge depending on the package service type and origin/destination pair. This service is available for: FedEx Priority Overnight, FedEx 2day, FedEx International Priority, FedEx 1Day Freight, and FedEx 2Day Freight. The rates and service availability depend on the ship date specified in the request. If the ship date falls on week day other than Saturday and you want Saturday pickup, the ground option and some express option will not be valid.
• ThirdParty Consignee: Indicates that the third party special service is requested. This might affect the shipping rates and/or service availability.
• Electronic Trade Documents: This only applies when shipping internationally. FedEx will generate and submit your trade documents specified in the ShippingDocumentTypes electronically and you no longer need to print and attach them. Note that some countries do not accept Electronic Trade Documents (ETD). For a full list of countries that support ETD you can go to http://images.fedex.com/international/pdf/FedExElectronicTradeDocuments_Coverage.pdf.

  If you also want to receive copies of the FedEx generated documents use the RequestedETDDocuments property together with the ShippingDocumentFile config to specify the files you are requesting and the location where to save them.

• Broker Select: Indicates that the broker select special service is requested. When shipping internationally, the customer might want to have their own broker to deal with the delivery (for customs purposes). To request such service, the BrokerSelect option should be set in the ShipmentSpecialServices value. This allows you to designate a specific customs broker other than FedEx (or a FedEx designated broker). This is applicable to the following international FedEx services:
  • stFedExInternationalPriority (20)
  • stFedExInternationalEconomy (21)
  • stFedExInternationalPriorityFreight (23)
  • stFedExInternationalEconomyFreight (24)
  • stFedExInternationalPriorityExpress (32)
  • stFedExInternationalConnectPlus (33)
  FedEx International Broker Select is a contract service. Before you begin using FedEx International Broker Select (BSO), you must contact your FedEx account executive to be enrolled for this service. An additional routing surcharge applies to your BSO shipments if you choose to have FedEx complete delivery after customs clearance and if your recipient and customs broker are served by different FedEx clearance points. This service is not valid with SaturdayPickup/SaturdayDelivery services. When this service is requested, then the ClearanceBrokerageType, BrokerType, BrokerContact, and BrokerAddress are required to be provided in the ship request as well.

  Note: Certain customs limitations may apply for BSO shipments. Contact FedEx Express International customer service at 1.800.247.4747 for requirements.

• East Coast Special: Indicates that East Coast special service is requested. This is applicable to domestic shipments only. This might affect the shipping rates and/or service availability.
• International Controlled Export Service Indicates that the Controlled Export service is requested. This is only applicable for international shipments. This might affect the shipping rates and/or service availability.
• International Traffic in Arms Regulations Indicates that the Traffic in Arms Regulations service is requested. This is only applicable for international shipments. This might affect the shipping rates and/or service availability.
• FedEx One Rate Shipping Indicates that FedEx One Rate packaging is being used. This is only applicable for when using a U.S. origin and destination, excluding Hawaii. Valid service types are listed below as both the :

  ServiceType	FedEx Service
  stFedExPriorityOvernight (10)	PRIORITY_OVERNIGHT
  stFedExStandardOvernight (11)	STANDARD_OVERNIGHT
  stFedExFirstOvernight (12)	FIRST_OVERNIGHT
  stFedExExpressSaver (14)	FEDEX_EXPRESS_SAVER
  stFedEx2Day (13)	FEDEX_2_DAY
  stFedEx2DayAM (27)	FEDEX_2_DAY_AM

SSLAcceptServerCertEncoded Property (FedExShipIntl 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 (FedExShipIntl 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 (FedExShipIntl 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 are designations of 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. PKCS12 certificate store).

SSLCertStorePassword Property (FedExShipIntl 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 (FedExShipIntl 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 (FedExShipIntl 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 displayed below.

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

SSLProvider Property (FedExShipIntl 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 (FedExShipIntl 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 (FedExShipIntl 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.

TotalCustomsValue Property (FedExShipIntl Component)

Total customs value for the shipment.

Syntax

property TotalCustomsValue: String read get_TotalCustomsValue write set_TotalCustomsValue;

Default Value

'0.00'

Remarks

The TotalCustomsValue is required to be provided in an international shipment request. It represents the sum of the values of all commodities, and may include freight, miscellaneous, and insurance charges.

Format: Two explicit decimal positions (e.g. 100.00) with a maximum length of 17 including the decimal.

The following countries require a minimum customs value of $1 USD for all shipment, including document shipments:

TotalNetCharge Property (FedExShipIntl Component)

The total net charge 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.

TotalWeight Property (FedExShipIntl Component)

Total shipment weight.

Syntax

property TotalWeight: String read get_TotalWeight write set_TotalWeight;

Default Value

''

Remarks

Identifies the total weight of the shipment being conveyed to FedEx. This element is optional when submitting a ship request. It requires one explicit decimal position (i.e. N.N formatting).

TransitTime Property (FedExShipIntl Component)

Expected number of days in transit from pickup to delivery.

Syntax

property TransitTime: String read get_TransitTime;

Default Value

''

Remarks

This is an estimate only. When either the GetPackageLabel or GetShipmentLabels method is called, the DeliveryDate will be returned in the server reply. For international shipments, this information is a limited to a number of international countries and it depends on the customs clearance times.

Possible values are: ONE_DAY, TWO_DAYS, THREE_DAYS, FOUR_DAYS, FIVE_DAYS, SIX_DAYS, SEVEN_DAYS, EIGHT_DAYS, NINE_DAYS, and UNKNOWN.

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

UploadDocumentDetails Property (FedExShipIntl Component)

Collection of documents to be uploaded to FedEx.

Syntax

property UploadDocumentDetails: TibxUploadDocumentDetailList read get_UploadDocumentDetails write set_UploadDocumentDetails;

Remarks

This contains a collection of the details of the documents to be uploaded to FedEx when UploadDocuments is called. If the ETD option (0x00000200L) is specified in the ShipmentSpecialServices property, the documents specified will be sent electronically with the shipment.

This property is not available at design time.

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

CancelShipment Method (FedExShipIntl Component)

Cancels all packages within the shipment.

Syntax

procedure CancelShipment(TrackingNumber: String);

Remarks

Cancels FedEx Express and Ground shipments that have not already been tendered to FedEx.

The TrackingNumber parameter, that identifies the shipment to be canceled and deleted from the shipping log, is assigned by FedEx server when either the GetPackageLabel or GetShipmentLabels method was called.

The following properties can be set prior to calling this method:

• AccountNumber (required)
• CountryCode

CloseGroundShipments Method (FedExShipIntl Component)

Closes out all FedEx Ground shipments made for the day or generates reports for the last 3 days' close requests.

Syntax

procedure CloseGroundShipments();

Remarks

Closing is a function to be used for FedEx Ground shipments only. Express shipments are automatically closed and do not require you to perform a specific close operation. The Close service allows you to reconcile shipping information for your Ground shipments and print a Ground Manifest for your Ground driver.

At the end of the shipping day, you should perform the FedEx Ground End of Day Close procedure. To do so, call the CloseGroundShipments method. The Ground manifest (Manifest stored in ReportFile) is generated after a successful close and must be printed before your Ground shipments are tendered to FedEx. This is required to be tendered to FedEx along with your packages if they are being picked up by FedEx Ground. If you are dropping the packages off at a FedEx drop-off location, the manifest is not required.

You may continue to ship Ground packages after a Close has been performed. The Close service may be performed multiple times during your shipping day. Use the Close service to initiate the final stage of processing all shipment data submitted for the day (close of business).

A customer cannot cancel any shipments once they are closed out. However, shipments can be added to a day's shipment after a close operation has been performed and multiple closes can be performed in a day.

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

• Server (required)
• DeveloperKey (required)
• Password (required)
• AccountNumber (required)
• MeterNumber (required)
• CloseRequest (required)

ReportType specifies the type of report. Only one type of report can be returned per Close request. If you need multiple report types you will have to issue multiple CloseGroundShipments requests.

The report will automatically be written to the file specified by ReportFile. These reports can be printed anytime during the shipping day for shipments that have already been closed (up to three days in the past).

Config Method (FedExShipIntl 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.

CSPVersionCapture Method (FedExShipIntl Component)

Uploads your CSP software version information to FedEx when you close your ship day.

Syntax

procedure CSPVersionCapture();

Remarks

This is applicable to CSP users and/or developers only.

The Version Capture request is required when you close your ship day (regardless of whether you have shipped FedEx Ground or FedEx Express packages). This transaction uploads your CSP software version information to FedEx.

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

• Server (required)
• DeveloperKey (required)
• Password (required)
• AccountNumber (required)
• MeterNumber (required)
• CSPUserKey (required)
• CSPUserPassword (required)
• CSPProductId (required)
• CSPProductVersion (required)
• CSPOriginLocationId; (required)
• CSPProductPlatform; (required)

GetPackageLabel Method (FedExShipIntl Component)

Generates a shipping label for the specified package.

Syntax

procedure GetPackageLabel(Index: Integer);

Remarks

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

• Server (required)
• DeveloperKey (required)
• Password (required)
• AccountNumber (required)
• MeterNumber (required)
• ShipDate (required)
• ShipTime (optional)
• ServiceType (required)
• PackagingType (required)
• TotalWeight (optional; applicable to international shipments only)
• WeightUnit (required; defaults to LB)
• SizeUnit (required; defaults to IN)
• InsuredValue (optional)
• SenderContact (required)
• SenderAddress (required)
• RecipientContact (required)
• RecipientAddress (required)
• Payor (required)
• ShipmentSpecialServices (optional)
• DutiesPayor (required for international shipments only)
• Packages (required)
• LabelImageType (required)
• CommercialInvoice (required if Documents is set to False; applicable to international shipments only)
• Commodities (required, regardless of the Documents value; applicable to international shipments only)
• ClearanceBrokerageType (optional)
• BrokerType (optional)
• BrokerContact (optional)
• BrokerAddress (optional)
• Documents (optional)
• BlockVisibility (optional)

In express international shipments, at least one commodity line item has to be included in the request. However, the customer has to print out its own Commercial Invoice (a required document for international shipments). 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).

This method fills in the following properties:

• TrackingNumber for each package included in the shipment;
• ShippingLabel for each package included in the shipment;
• NetCharge for each package included in the shipment;
• BaseCharge for each package included in the shipment;
• TotalDiscount for each package included in the shipment;
• TotalSurcharges for each package included in the shipment;
• DeliveryDate (applicable to the whole shipment);
• TotalNetCharge (applicable to the whole shipment);

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

GetShipmentLabels Method (FedExShipIntl Component)

Generates a shipping label for all packages in the shipment.

Syntax

procedure GetShipmentLabels();

Remarks

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

• Server (required)
• DeveloperKey (required)
• Password (required)
• AccountNumber (required)
• MeterNumber (required)
• ShipDate (required)
• ShipTime (optional)
• ServiceType (required)
• PackagingType (required)
• TotalWeight (optional; applicable to international shipments only)
• WeightUnit (required; defaults to LB)
• SizeUnit (required; defaults to IN)
• InsuredValue (optional)
• SenderContact (required)
• SenderAddress (required)
• RecipientContact (required)
• RecipientAddress (required)
• Payor (required)
• ShipmentSpecialServices (optional)
• DutiesPayor (required for international shipments only)
• Packages (required)
• LabelImageType (required)
• CommercialInvoice (required if Documents is set to False; applicable to international shipments only)
• Commodities (required, regardless of the Documents value; applicable to international shipments only)
• ClearanceBrokerageType (optional)
• BrokerType (optional)
• BrokerContact (optional)
• BrokerAddress (optional)
• Documents (optional)
• BlockVisibility (optional)

In express international shipments, at least one commodity line item has to be included in the request. However, the customer has to print out its own Commercial Invoice (a required document for international shipments). 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).

This method fills in the following properties:

• TrackingNumber for each package included in the shipment;
• ShippingLabel for each package included in the shipment;
• NetCharge for each package included in the shipment;
• BaseCharge for each package included in the shipment;
• TotalDiscount for each package included in the shipment;
• TotalSurcharges for each package included in the shipment;
• DeliveryDate (applicable to the whole shipment);
• TotalNetCharge (applicable to the whole shipment);

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

ReprintDocuments Method (FedExShipIntl Component)

Reprints the requested document.

Syntax

procedure ReprintDocuments();

Remarks

When called this will request the document type specified in ReportType for the specified.

Reset Method (FedExShipIntl 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.

UploadDocuments Method (FedExShipIntl Component)

Uploads documents to FedEx.

Syntax

procedure UploadDocuments();

Remarks

When called this will upload any documents specified in UploadDocumentDetails to FedEx.

Error Event (FedExShipIntl 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 (FedExShipIntl 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 (FedExShipIntl 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

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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

Shows the progress of the secure connection.

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. Used to track 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();

CloseDetail Type

Represents the details of a Close request (applicable to Ground shipments only).

Remarks

This type contains specific information of a Close request. It is used in the FedExShip and FedExShipIntl components when the CloseGroundShipments method is called.

Example: Setting the fields of a Close request (when requesting to reprint the Close manifest) CloseDetail close = new CloseDetail close.Date = "2008-10-15" close.TrackingNumber = "123456789012345" close.ReportFile = "manifest.txt"

The fields contained by this type are listed below.

Fields

Constructors

constructor Create();

constructor Create(valDate: String; valTime: String);

constructor Create(valDate: String; valTime: String; valTrackingNumber: String; valReportFile: String);

constructor Create(valDate: String; valTime: String; valReportType: Integer; valReportFile: String);

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

FedExAccount Type

Represents the details of a FedEx account.

Remarks

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

Example: Setting the fields of an account FedExAccount account = new FedExAccount account.AccountNumber = "1234567" account.DeveloperKey = "my_developer_key" account.MeterNumber = "1234567" account.Password = "my_password" account.Server = "https://test.fedex.com"

The properties contained by this type are listed below.

Fields

Constructors

constructor Create();

Firewall Type

This is 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();

FreightGuaranteeDetail Type

Indicates the freight guarantee details.

Remarks

This type provide the details for when the freight shipment is guaranteed for.

Example: Setting the fields for the freight guarantee details

FreightGuaranteeDetail detail = new FreightGuaranteeDetail detail.Type = TFreightGuaranteeType.fgtGuaranteedMorning detail.Date = "2013-08-15"

Fields

Constructors

constructor Create();

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

This is 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);

UploadDocumentDetail Type

Indicates the details for a document to be uploaded.

Remarks

This type contains data describing a document to be uploaded.

Example: Setting the fields of the upload document UploadDocumentDetail uploadDocDetail = new UploadDocumentDetail uploadDocDetail.DocType = FedExDocumentTypes.fdtCertificateOfOrigin uploadDocDetail.LocalFileName = "..\\..\\files\\CertificateOfOrigin.pdf" uploadDocDetail.UploadFileName = "CertificateOfOrigin.pdf"

Fields

Constructors

constructor Create();

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

FedExShipIntl Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (FedExShipIntl Component)

FedExShipIntl Errors

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

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