CanadaPostShipIntl Component

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate international labels using Canada Post.

Syntax

TibxCanadaPostShipIntl

Remarks

Generating a shipping label can be done by calling the GetPackageLabel method. You will need to specify the Packages details, the Canada Post ServiceType to be used for shipping the package, the origin and destination information, and any other ShipmentSpecialServices that should be associated with the shipment (such as COD, Return Shipment, Deliver to Post Office, etc.).

You should also specify the Commodities for all packages. Note that Canada Post will use this information to generate a commercial invoice, which will be returned to you in PDF format in the InternationalForm property, unless InternationalFormFile is set, in which case the file will be saved to the path specified.

In order to print a label and manifest to be tendered to a Canada Post driver, you must:

1. Assign each shipment a GroupId and then call GetPackageLabel for each package in the shipment.
2. Call TransmitShipments with the GroupId for the shipment.
3. Call GetManifest for each manifest in ManifestDetails.

Note that this only applies when submitting a contract shipment (ie. CanadaPostContractId is set).

If you wish to cancel a package before you call TransmitShipments for that shipment, you can call CancelShipment and the package will be voided.

In order to use this component you will need to have a CanadaPost CanadaPostAccountNumber, which is your customer number. You will also need to have signed up for the Developer Program and obtained a CanadaPostUserId and CanadaPostPassword.

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.

CanadaPostAccountNumber Property (CanadaPostShipIntl Component)

The shipper's account number.

Syntax

__property String CanadaPostAccountNumber = { read=FCanadaPostAccountNumber, write=FSetCanadaPostAccountNumber };

Default Value

""

Remarks

The shipper's account number.

This field should be set to the customer number of the owner of the mail (mailed on behalf of customer).

Data Type

String

CanadaPostContractId Property (CanadaPostShipIntl Component)

This property is used to specify the Contract Id of a Canada Post account and is used to identify a commercial contract.

Syntax

__property String CanadaPostContractId = { read=FCanadaPostContractId, write=FSetCanadaPostContractId };

Default Value

""

Remarks

This property is used to specify the Contract Id of a Canada Post account and is used to identify a commercial contract.

When specified the negotiated rates for the contract will be used. If not specified the standard list rates will be used.

Data Type

String

CanadaPostPassword Property (CanadaPostShipIntl Component)

Password for logging in to the Server .

Syntax

__property String CanadaPostPassword = { read=FCanadaPostPassword, write=FSetCanadaPostPassword };

Default Value

""

Remarks

Password for logging in to the Server.

This property must be set to the login password for your Canada Post account.

Data Type

String

CanadaPostServer Property (CanadaPostShipIntl Component)

URL for the server where the requests are sent.

Syntax

__property String CanadaPostServer = { read=FCanadaPostServer, write=FSetCanadaPostServer };

Default Value

"https://soa-gw.canadapost.ca/"

Remarks

URL for the server where the requests are sent.

By default this is set to Canada Post's production server: "https://soa-gw.canadapost.ca/"

Data Type

String

CanadaPostUserId Property (CanadaPostShipIntl Component)

User Id for logging in to the Server .

Syntax

__property String CanadaPostUserId = { read=FCanadaPostUserId, write=FSetCanadaPostUserId };

Default Value

""

Remarks

User Id for logging in to the CanadaPostServer.

This property must be set to the login username for your Canada Post account

Data Type

String

CommodityCount Property (CanadaPostShipIntl Component)

The number of records in the Commodity arrays.

Syntax

__property int CommodityCount = { read=FCommodityCount, write=FSetCommodityCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• CommodityDescription
• CommodityHarmonizedCode
• CommodityManufacturer
• CommodityNumberOfPieces
• CommodityUnitPrice
• CommodityWeight

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

This property is not available at design time.

Data Type

Integer

CommodityDescription Property (CanadaPostShipIntl Component)

Complete and accurate description of this commodity line item.

Syntax

__property String CommodityDescription[int CommodityIdx] = { read=FCommodityDescription, write=FSetCommodityDescription };

Default Value

""

Remarks

Complete and accurate description of this commodity line item.

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

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

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

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

This property is not available at design time.

Data Type

String

CommodityHarmonizedCode Property (CanadaPostShipIntl Component)

Unique code representing this commodity line item (for imports only).

Syntax

__property String CommodityHarmonizedCode[int CommodityIdx] = { read=FCommodityHarmonizedCode, write=FSetCommodityHarmonizedCode };

Default Value

""

Remarks

Unique code representing this commodity line item (for imports only).

The World Trade Organization has classified all commodities with a number. This number is called a Harmonized Schedule code and ranges from six to 12 digits depending on the country. However, the first six digits of this number are more or less uniform throughout the world. Customs uses the HS number to determine the import duties, taxes and import license requirements for goods entering a country. This number is required for filling in the Customs documentation.

It is applicable to Invoice, Partial Invoice and NAFTA CO. Required for NAFTA CO and optional for Partial Invoice. For NAFTA CO: For each good described in CommodityDescription, identify the Harmonized Schedule (HS) tariff classification using the one of the country into whose territory the good is imported. This number must appear on import documentation that accompanies a shipment.

If the shipment contains non-documents item(s) (i.e., the Documents is set to False), the CommodityHarmonizedCode is required for each commodity line item for shipments to EU countries.

At least one occurrence is required for U.S. Export shipments if the TotalCustomsValue is greater than 2,500 USD or if a valid U.S. Export license is required.

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

This property is not available at design time.

Data Type

String

CommodityManufacturer Property (CanadaPostShipIntl Component)

Country code where the contents of this commodity line were produced, manufactured or grown in their final form.

Syntax

__property String CommodityManufacturer[int CommodityIdx] = { read=FCommodityManufacturer, write=FSetCommodityManufacturer };

Default Value

"US"

Remarks

Country code where the contents of this commodity line were produced, manufactured or grown in their final form. In international shipment requests, the CommodityManufacturer is required to be entered.

In FedEx, when the shipment contains documents only (i.e., Documents is set to True), this represent the country where the documents were compiled and/or produced in their final form. In this case, only the CommodityManufacturer and CommodityDescription are required to be provided in the request. If the CommodityManufacturer is not provided, it defaults to US.

When the shipment contains non-documents items (i.e., Documents is set to False and the shipment is considered dutiable), at least one occurrence of a commodity item is required to be entered. The CommodityManufacturer has to be provided for each commodity item included in that international shipment.

In UPS, this applies to Invoice, Partial Invoice, CO and NAFTA CO. It is required for Invoice and CO forms, and optional for Partial Invoice.

In USPS, the value of this property is optional, and is only used by commercial shippers. If PostageProvider is set to ppEndicia or ppStamps, then the format must be 2 charachters long (for example: US for United States, CA for Canada etc.).

Here is a list of country names and their codes where UPS services are available. Code is the value that has to be provided in all requests sent to UPS where country code is to be entered. This is also echoed in server reply.

Along with country names and their codes, we have also listed here the currency code used in that country, the maximum weight applicable to that country, whether address validation is supported and if postal code is required.

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

This property is not available at design time.

Data Type

String

CommodityNumberOfPieces Property (CanadaPostShipIntl Component)

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

Syntax

__property int CommodityNumberOfPieces[int CommodityIdx] = { read=FCommodityNumberOfPieces, write=FSetCommodityNumberOfPieces };

Default Value

1

Remarks

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

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

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

This property is not applicable to USPS.

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

This property is not available at design time.

Data Type

Integer

CommodityUnitPrice Property (CanadaPostShipIntl Component)

Value of each QuantityUnit in Quantity of this commodity line item.

Syntax

__property String CommodityUnitPrice[int CommodityIdx] = { read=FCommodityUnitPrice, write=FSetCommodityUnitPrice };

Default Value

"1.00"

Remarks

Value of each CommodityQuantityUnit in CommodityQuantity of this commodity line item. This is used in conjunction with the CommodityQuantityUnit and CommodityQuantity. This indicates the monetary amount used to specify the worth or price of the commodity and it should be greater than zero.

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

For UPS, it is required and applicable to Invoice and Partial Invoice forms only.

For USPS, use the CommodityValue property instead.

Format: Limit to 6 digits after the decimal (e.g. 900.000000).

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

This property is not available at design time.

Data Type

String

CommodityWeight Property (CanadaPostShipIntl Component)

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

Syntax

__property String CommodityWeight[int CommodityIdx] = { read=FCommodityWeight, write=FSetCommodityWeight };

Default Value

"0.00"

Remarks

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

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

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

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

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

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

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (CanadaPostShipIntl Component)

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

Syntax

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

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (CanadaPostShipIntl Component)

This property determines the type of firewall to connect through.

Syntax

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

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

Default Value

fwNone

Remarks

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

Data Type

Integer

FirewallHost Property (CanadaPostShipIntl Component)

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

Syntax

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

Default Value

""

Remarks

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

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the component raises an exception.

Data Type

String

FirewallPassword Property (CanadaPostShipIntl Component)

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

Syntax

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

Default Value

""

Remarks

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

Data Type

String

FirewallPort Property (CanadaPostShipIntl Component)

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

Syntax

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

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (CanadaPostShipIntl Component)

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

Syntax

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

Default Value

""

Remarks

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

Data Type

String

GroupId Property (CanadaPostShipIntl Component)

The Group Id that will be associated with the shipment.

Syntax

__property String GroupId = { read=FGroupId, write=FSetGroupId };

Default Value

""

Remarks

This property is used to specify the Group Id that will be associated with the shipment.

This is a user specified value and may be a number or string up to 32 characters in length. It is used by Canada Post to group shipments together for reporting purposes. If the specified group does not exist, it will be created automatically by the Canada Post service.

This value is required when CanadaPostContractId is specified.

Data Type

String

InternationalForm Property (CanadaPostShipIntl Component)

Image of the international form.

Syntax

__property String InternationalForm = { read=FInternationalForm };

Default Value

""

Remarks

This is the decoded binary image file of the international form and will be populated on a GetPackageLabel call if ManifestFile is not set.

This property is read-only.

Data Type

String

InternationalFormFile Property (CanadaPostShipIntl Component)

The location where the international form files will be written.

Syntax

__property String InternationalFormFile = { read=FInternationalFormFile, write=FSetInternationalFormFile };

Default Value

""

Remarks

This should contain the full path to where the international form file will be written.

Data Type

String

Manifest Property (CanadaPostShipIntl Component)

Image of the manifest.

Syntax

__property String Manifest = { read=FManifest };

Default Value

""

Remarks

This is the decoded binary image file of the Manifest and will be populated on a GetManifest call if ManifestFile is not set.

This property is read-only.

Data Type

String

ManifestCount Property (CanadaPostShipIntl Component)

The number of records in the Manifest arrays.

Syntax

__property int ManifestCount = { read=FManifestCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ManifestAccountNumber
• ManifestBaseCharge
• ManifestCCAuthCode
• ManifestCCAuthTimestamp
• ManifestCCMerchantName
• ManifestCCMerchantURL
• ManifestCCNameOnCard
• ManifestContractId
• ManifestCustomerReference
• ManifestDate
• ManifestDestinationPostalCode
• ManifestGST
• ManifestHST
• ManifestMediaType
• ManifestNetCharge
• ManifestOriginId
• ManifestOriginName
• ManifestPayorAccountNumber
• ManifestPONumber
• ManifestPST
• ManifestShipperAccountNumber
• ManifestTime
• ManifestTotalDiscount
• ManifestTotalSurcharge
• ManifestURL

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

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

Data Type

Integer

ManifestAccountNumber Property (CanadaPostShipIntl Component)

This is the 10-digit customer number of who mailed the package(s).

Syntax

__property String ManifestAccountNumber[int ManifestIdx] = { read=FManifestAccountNumber };

Default Value

""

Remarks

This is the 10-digit customer number of who mailed the package(s).

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestBaseCharge Property (CanadaPostShipIntl Component)

This is the total base cost for all shipments on the manifest.

Syntax

__property String ManifestBaseCharge[int ManifestIdx] = { read=FManifestBaseCharge };

Default Value

""

Remarks

This is the total base cost for all shipments on the manifest.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestCCAuthCode Property (CanadaPostShipIntl Component)

The authorization code received from the credit card issuer.

Syntax

__property String ManifestCCAuthCode[int ManifestIdx] = { read=FManifestCCAuthCode };

Default Value

""

Remarks

The authorization code received from the credit card issuer.

This will only be populated if a credit card was used to pay for the postage.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestCCAuthTimestamp Property (CanadaPostShipIntl Component)

The date and time that the credit card company authorized the transaction.

Syntax

__property String ManifestCCAuthTimestamp[int ManifestIdx] = { read=FManifestCCAuthTimestamp };

Default Value

""

Remarks

The date and time that the credit card company authorized the transaction.

This will only be populated if a credit card was used to pay for the postage.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestCCMerchantName Property (CanadaPostShipIntl Component)

The merchant name used when charging the credit card.

Syntax

__property String ManifestCCMerchantName[int ManifestIdx] = { read=FManifestCCMerchantName };

Default Value

""

Remarks

The merchant name used when charging the credit card.

This will only be populated if a credit card was used to pay for the postage.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestCCMerchantURL Property (CanadaPostShipIntl Component)

The URL for the merchant who charged the credit card.

Syntax

__property String ManifestCCMerchantURL[int ManifestIdx] = { read=FManifestCCMerchantURL };

Default Value

""

Remarks

The URL for the merchant who charged the credit card.

This will only be populated if a credit card was used to pay for the postage.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestCCNameOnCard Property (CanadaPostShipIntl Component)

The name on the card that was charged.

Syntax

__property String ManifestCCNameOnCard[int ManifestIdx] = { read=FManifestCCNameOnCard };

Default Value

""

Remarks

The name on the card that was charged.

This will only be populated if a credit card was used to pay for the postage.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestContractId Property (CanadaPostShipIntl Component)

This is the contract number that was used for pricing this manifest.

Syntax

__property String ManifestContractId[int ManifestIdx] = { read=FManifestContractId };

Default Value

""

Remarks

This is the contract number that was used for pricing this manifest.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestCustomerReference Property (CanadaPostShipIntl Component)

This is the reference property provided by the client in the transmit shipments request.

Syntax

__property String ManifestCustomerReference[int ManifestIdx] = { read=FManifestCustomerReference };

Default Value

""

Remarks

This is the reference field provided by the client in the transmit shipments request.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestDate Property (CanadaPostShipIntl Component)

This is the date the manifest was generated.

Syntax

__property String ManifestDate[int ManifestIdx] = { read=FManifestDate };

Default Value

""

Remarks

This is the date the manifest was generated.

The date format is as follows YYYY-MM-DD.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestDestinationPostalCode Property (CanadaPostShipIntl Component)

The Postal code of the post office where the shipment is to be dropped off.

Syntax

__property String ManifestDestinationPostalCode[int ManifestIdx] = { read=FManifestDestinationPostalCode };

Default Value

""

Remarks

The Postal code of the post office where the shipment is to be dropped off.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestGST Property (CanadaPostShipIntl Component)

The Good and Services Tax (GST) for all shipments on the manifest.

Syntax

__property String ManifestGST[int ManifestIdx] = { read=FManifestGST };

Default Value

""

Remarks

The Good and Services Tax (GST) for all shipments on the manifest.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestHST Property (CanadaPostShipIntl Component)

The Harmonized Sales Tax (HST) for all shipments on the manifest.

Syntax

__property String ManifestHST[int ManifestIdx] = { read=FManifestHST };

Default Value

""

Remarks

The Harmonized Sales Tax (HST) for all shipments on the manifest.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestMediaType Property (CanadaPostShipIntl Component)

This contains the media-type attribute for the URL .

Syntax

__property String ManifestMediaType[int ManifestIdx] = { read=FManifestMediaType };

Default Value

""

Remarks

This contains the media-type attribute for the ManifestURL.

This will be populated after a call to TransmitShipments or SearchManifests.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestNetCharge Property (CanadaPostShipIntl Component)

This is the total amount due to Canada Post for all shipments on the manifest.

Syntax

__property String ManifestNetCharge[int ManifestIdx] = { read=FManifestNetCharge };

Default Value

""

Remarks

This is the total amount due to Canada Post for all shipments on the manifest.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestOriginId Property (CanadaPostShipIntl Component)

This is the Canada Post identification number of the shipment's origin.

Syntax

__property String ManifestOriginId[int ManifestIdx] = { read=FManifestOriginId };

Default Value

""

Remarks

This is the Canada Post identification number of the shipment's origin.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestOriginName Property (CanadaPostShipIntl Component)

This is the descriptive name of the shipment's origin as printed on the manifest.

Syntax

__property String ManifestOriginName[int ManifestIdx] = { read=FManifestOriginName };

Default Value

""

Remarks

This is the descriptive name of the shipment's origin as printed on the manifest.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestPayorAccountNumber Property (CanadaPostShipIntl Component)

This is the 10-digit customer number of the customer who is paying for the shipment.

Syntax

__property String ManifestPayorAccountNumber[int ManifestIdx] = { read=FManifestPayorAccountNumber };

Default Value

""

Remarks

This is the 10-digit customer number of the customer who is paying for the shipment. This is often the same as the ManifestShipperAccountNumber.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestPONumber Property (CanadaPostShipIntl Component)

This is the PO number used for billing and will be displayed on the manifest.

Syntax

__property String ManifestPONumber[int ManifestIdx] = { read=FManifestPONumber };

Default Value

""

Remarks

This is the PO number used for billing and will be displayed on the manifest.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestPST Property (CanadaPostShipIntl Component)

The Provincial Sales Tax (PST) for all shipments on the manifest.

Syntax

__property String ManifestPST[int ManifestIdx] = { read=FManifestPST };

Default Value

""

Remarks

The Provincial Sales Tax (PST) for all shipments on the manifest.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestShipperAccountNumber Property (CanadaPostShipIntl Component)

This is the 10-digit customer number of the entity for whom the shipment was sent on behalf of.

Syntax

__property String ManifestShipperAccountNumber[int ManifestIdx] = { read=FManifestShipperAccountNumber };

Default Value

""

Remarks

This is the 10-digit customer number of the entity for whom the shipment was sent on behalf of.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestTime Property (CanadaPostShipIntl Component)

This is the time when the manifest was generated.

Syntax

__property String ManifestTime[int ManifestIdx] = { read=FManifestTime };

Default Value

""

Remarks

This is the time when the manifest was generated.

The format for the time is HH:MM TZ.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestTotalDiscount Property (CanadaPostShipIntl Component)

This is the total discount for all shipments on the manifest.

Syntax

__property String ManifestTotalDiscount[int ManifestIdx] = { read=FManifestTotalDiscount };

Default Value

""

Remarks

This is the total discount for all shipments on the manifest.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestTotalSurcharge Property (CanadaPostShipIntl Component)

This is the total surcharge for all shipments on the manifest.

Syntax

__property String ManifestTotalSurcharge[int ManifestIdx] = { read=FManifestTotalSurcharge };

Default Value

""

Remarks

This is the total surcharge for all shipments on the manifest.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestURL Property (CanadaPostShipIntl Component)

This property will contain the URL for the manifest.

Syntax

__property String ManifestURL[int ManifestIdx] = { read=FManifestURL };

Default Value

""

Remarks

This property will contain the URL for the manifest.

This will be populated after a call to TransmitShipments or SearchManifests.

The ManifestIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ManifestCount property.

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

Data Type

String

ManifestFile Property (CanadaPostShipIntl Component)

The location where the manifest files will be written.

Syntax

__property String ManifestFile = { read=FManifestFile, write=FSetManifestFile };

Default Value

""

Remarks

This should contain the full path to where the manifest file will be written.

Data Type

String

NotifyCount Property (CanadaPostShipIntl Component)

The number of records in the Notify arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• NotifyEmail
• NotifyFlags

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

This property is not available at design time.

Data Type

Integer

NotifyEmail Property (CanadaPostShipIntl Component)

Email address of the recipient to be notified.

Syntax

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

NotifyFlags Property (CanadaPostShipIntl Component)

Identifies the type of notification requested.

Syntax

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

Default Value

0

Remarks

Identifies the type of notification requested. Valid values are:

For FedEx notifications, the following flags apply:

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

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

For UPS notifications, the following flags apply:

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

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

This field is not used by USPS.

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

This property is not available at design time.

Data Type

Integer

OriginPostalCode Property (CanadaPostShipIntl Component)

The Postal Code of the client sending location when using the Canada Post provider.

Syntax

__property String OriginPostalCode = { read=FOriginPostalCode, write=FSetOriginPostalCode };

Default Value

""

Remarks

This property is used to specify the postal code of the client sending location to determine the nearest Post Office (this information is used for pricing). To force selection of a particular Post Office, the postal code of the desired Post Office should be used.

If packages are picked up by Canada Post enter the postal code of your location.

This must be set to a valid six character postal code such as A9A9A9

Note: This value is only used when a CanadaPostContractId is specified.

Data Type

String

PackageCount Property (CanadaPostShipIntl Component)

The number of records in the Package arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• PackageBaseCharge
• PackageCODAmount
• PackageCODFile
• PackageCODLabel
• PackageCODType
• PackageHeight
• PackageInsuredValue
• PackageLength
• PackageNetCharge
• PackageRatingAggregate
• PackageReference
• PackageReturnReceipt
• PackageReturnReceiptFile
• PackageShippingLabel
• PackageShippingLabelFile
• PackageSignatureType
• PackageSize
• PackageTotalDiscount
• PackageTotalSurcharges
• PackageTrackingNumber
• PackageType
• PackageWeight
• PackageWidth

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

This property is not available at design time.

Data Type

Integer

PackageBaseCharge Property (CanadaPostShipIntl Component)

Actual Base Charge applicable to this package.

Syntax

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

Default Value

""

Remarks

Actual Base Charge applicable to this package.

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

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

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

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

This is not applicable to USPS.

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

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

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

Data Type

String

PackageCODAmount Property (CanadaPostShipIntl Component)

The COD monetary value for the package.

Syntax

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

Default Value

""

Remarks

The COD monetary value for the package.

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

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

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

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

This property is not applicable to USPS packages.

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

This is not applicable for Canada Post.

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

This property is not available at design time.

Data Type

String

PackageCODFile Property (CanadaPostShipIntl Component)

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

Syntax

__property String PackageCODFile[int PackageIdx] = { read=FPackageCODFile, write=FSetPackageCODFile };

Default Value

""

Remarks

Filename and location to save the PackageCODLabel of this package to. This is applicable for package(s) that use the COD service.

When the PackageCODFile is set to a valid path and filename, the contents of the PackageCODLabel are written to disk when either the GetPackageLabel or GetShipmentLabels method is called.

This filename should have the same extension defined by LabelImageType (for example, if LabelImageType is set to PDF, then PackageCODFile has to have .pdf extension).

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

This property is only applicable to FedEx shipments.

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

This property is not available at design time.

Data Type

String

PackageCODLabel Property (CanadaPostShipIntl Component)

Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request.

Syntax

__property String PackageCODLabel[int PackageIdx] = { read=FPackageCODLabel };
__property DynamicArray<Byte> PackageCODLabelB[int PackageIdx] = { read=FPackageCODLabelB };

Default Value

""

Remarks

Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request.

This is the decoded binary image file of the COD return label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a PNG label, the data returned will be a PNG file. If you requested a thermal label, it will be a thermal label image. If the PackageCODFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format.

Since MPS Ground packages do not travel together and may be delivered at different times, a PackageCODLabel return label will be generated for each package that uses COD service.

On MPS Express packages, only one COD label will be generated and this will be returned on the last package of the MPS.

This property is only applicable to FedEx.

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

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

Data Type

Byte Array

PackageCODType Property (CanadaPostShipIntl Component)

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

Syntax

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

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

Default Value

codtpAny

Remarks

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

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

Valid values are:

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

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

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

This property is not available at design time.

Data Type

Integer

PackageHeight Property (CanadaPostShipIntl Component)

The height of the package to be shipped.

Syntax

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

Default Value

0

Remarks

The height of the package to be shipped.

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

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

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

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

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

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

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

Note also that this applies to Endicia shipping label requests.

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

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

This property is not available at design time.

Data Type

Integer

PackageInsuredValue Property (CanadaPostShipIntl Component)

Amount of insurance requested for this package.

Syntax

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

PackageLength Property (CanadaPostShipIntl Component)

The length of the package to be shipped.

Syntax

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

Default Value

0

Remarks

The length of the package to be shipped.

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

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

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

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

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

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

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

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

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

Note also that this applies to Endicia shipping label requests.

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

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

This property is not available at design time.

Data Type

Integer

PackageNetCharge Property (CanadaPostShipIntl Component)

Actual Net Charge applicable to this package.

Syntax

__property String PackageNetCharge[int PackageIdx] = { read=FPackageNetCharge, write=FSetPackageNetCharge };

Default Value

""

Remarks

Actual Net Charge applicable to this package.

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

When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments.

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

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

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

For USPS, this specifies the postage required for mailing a package of the indicated size and weight. If this property is not supplied, it will be calculated and returned in the response.

This will also be set when an Endicia label is returned describing how much postage was charged from the Endicia account for the package.

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

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

This property is not available at design time.

Data Type

String

PackageType Property (CanadaPostShipIntl Component)

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

Syntax

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

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

Default Value

ptNone

Remarks

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

Possible values are:

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

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

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

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

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

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

Also the following restrictions apply when using UPS Mail Innovations:

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

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

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

This property is not available at design time.

Data Type

Integer

PackageRatingAggregate Property (CanadaPostShipIntl Component)

Rating aggregate applicable to this package.

Syntax

__property String PackageRatingAggregate[int PackageIdx] = { read=FPackageRatingAggregate };

Default Value

""

Remarks

Rating aggregate applicable to this package.

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

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

Data Type

String

PackageReference Property (CanadaPostShipIntl Component)

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

Syntax

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

Default Value

""

Remarks

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

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

Valid values for types are:

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

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

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

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

Valid values for types are:

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

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

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

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

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

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

This property is not available at design time.

Data Type

String

PackageReturnReceipt Property (CanadaPostShipIntl Component)

Image of the receipt for a return shipment.

Syntax

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

Default Value

""

Remarks

Image of the receipt for a return shipment.

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

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

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

Data Type

Byte Array

PackageReturnReceiptFile Property (CanadaPostShipIntl Component)

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

Syntax

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

Default Value

""

Remarks

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

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

The PackageReturnReceiptFile has to have .html extension.

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

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

This property is not available at design time.

Data Type

String

PackageShippingLabel Property (CanadaPostShipIntl Component)

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

Syntax

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

Default Value

""

Remarks

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

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

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

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

Data Type

Byte Array

PackageShippingLabelFile Property (CanadaPostShipIntl Component)

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

Syntax

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

Default Value

""

Remarks

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

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

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

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

This property is not available at design time.

Data Type

String

PackageSignatureType Property (CanadaPostShipIntl Component)

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

Syntax

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

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

Default Value

stServiceDefault

Remarks

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

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

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

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

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

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

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

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

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

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

This does not apply for Canada Post.

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

This property is not available at design time.

Data Type

Integer

PackageSize Property (CanadaPostShipIntl Component)

Size of the package being mailed.

Syntax

__property TibxCanadaPostShipIntlPackageSizes PackageSize[int PackageIdx] = { read=FPackageSize, write=FSetPackageSize };

enum TibxCanadaPostShipIntlPackageSizes {
  psRegular=0,
  psLarge=1,
  psOversize=2,
  psIrregular=3
};

Default Value

psRegular

Remarks

Size of the package being mailed.

This property is only used by USPS and is required for the GetRates method call.

See below for valid entries:

Note: For parcels, length; is the measurement of the longest dimension and girth is the measurement around the thickest part (perpendicular to the length). Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note: Use the PackageLength, PackageHeight, PackageWidth and optionally PackageGirth (irregular shaped packages only) properties to specify the dimensions of the package.

Note: only psRegular and psLarge are available when getting rates for international shipments.

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

This property is not available at design time.

Data Type

Integer

PackageTotalDiscount Property (CanadaPostShipIntl Component)

Total Actual Discount applicable to this package.

Syntax

__property String PackageTotalDiscount[int PackageIdx] = { read=FPackageTotalDiscount };

Default Value

""

Remarks

Total Actual Discount applicable to this package.

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

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

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

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

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

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

Data Type

String

PackageTotalSurcharges Property (CanadaPostShipIntl Component)

Total Actual Surcharges applicable to this package.

Syntax

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

Default Value

""

Remarks

Total Actual Surcharges applicable to this package.

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

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

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

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

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

This does not apply to USPS packages.

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

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

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

Data Type

String

PackageTrackingNumber Property (CanadaPostShipIntl Component)

Tracking number assigned to this package.

Syntax

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

Default Value

""

Remarks

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

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

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

Data Type

String

PackageWeight Property (CanadaPostShipIntl Component)

Weight of this package.

Syntax

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

Default Value

"0.0"

Remarks

Weight of this package.

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

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

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

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

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

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

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

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

This property is not available at design time.

Data Type

String

PackageWidth Property (CanadaPostShipIntl Component)

The width of the package to be shipped.

Syntax

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

Default Value

0

Remarks

The width of the package to be shipped.

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

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

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

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

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

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

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

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

Note also that this applies to Endicia shipping label requests.

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

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

This property is not available at design time.

Data Type

Integer

PaymentMethod Property (CanadaPostShipIntl Component)

The intended payment method when using Canada Post.

Syntax

__property TibxCanadaPostShipIntlPaymentMethods PaymentMethod = { read=FPaymentMethod, write=FSetPaymentMethod };

enum TibxCanadaPostShipIntlPaymentMethods {
  pmAccount=0,
  pmCreditCard=1
};

Default Value

pmAccount

Remarks

This field is used to specify the intended method of payment when shipping via Canada Post.

The available values are:

Note: This value is only used when a CanadaPostContractId is specified.

Data Type

Integer

ProxyAuthScheme Property (CanadaPostShipIntl Component)

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

Syntax

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

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

Default Value

authBasic

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (CanadaPostShipIntl Component)

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

Syntax

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

Default Value

False

Remarks

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

Data Type

Boolean

ProxyPassword Property (CanadaPostShipIntl Component)

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

Syntax

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

Default Value

""

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (CanadaPostShipIntl Component)

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

Syntax

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

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (CanadaPostShipIntl Component)

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

Syntax

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

Default Value

""

Remarks

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

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

Data Type

String

ProxySSL Property (CanadaPostShipIntl Component)

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

Syntax

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

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

Default Value

psAutomatic

Remarks

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

Data Type

Integer

ProxyUser Property (CanadaPostShipIntl Component)

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

Syntax

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

Default Value

""

Remarks

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

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

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

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

Data Type

String

ReasonForExport Property (CanadaPostShipIntl Component)

The reason for the export.

Syntax

__property TibxCanadaPostShipIntlReasonForExports ReasonForExport = { read=FReasonForExport, write=FSetReasonForExport };

enum TibxCanadaPostShipIntlReasonForExports {
  erGift=0,
  erDocument=1,
  erCommercialSample=2,
  erRepair=3,
  erSale=4,
  erOther=5
};

Default Value

erGift

Remarks

This provides the reason for the export, which is necessary to generate the customs forms.

The valid values are as follows:

Data Type

Integer

RecipientAddress1 Property (CanadaPostShipIntl Component)

Street name.

Syntax

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

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address.

Maximum Length: 44 characters

Data Type

String

RecipientAddress2 Property (CanadaPostShipIntl Component)

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

Syntax

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

Default Value

""

Remarks

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

Maximum Length: 44 characters

Data Type

String

RecipientCity Property (CanadaPostShipIntl Component)

Name of city, town, etc.

Syntax

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

Default Value

""

Remarks

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

Data Type

String

RecipientCountryCode Property (CanadaPostShipIntl Component)

Country code.

Syntax

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

Default Value

"CA"

Remarks

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

Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered.

Data Type

String

RecipientPostalCode Property (CanadaPostShipIntl Component)

This is identifies of a region (usually small) for mail/package delivery.

Syntax

__property String RecipientPostalCode = { read=FRecipientPostalCode, write=FSetRecipientPostalCode };

Default Value

""

Remarks

This is identifies of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country. The format for Canadian postal codes is A9A9A9.

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

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

Data Type

String

RecipientProvince Property (CanadaPostShipIntl Component)

Province or state code.

Syntax

__property String RecipientProvince = { read=FRecipientProvince, write=FSetRecipientProvince };

Default Value

""

Remarks

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

This is required when RecipientCountryCode is either CA or US.

Data Type

String

RecipientCompany Property (CanadaPostShipIntl Component)

Identifies the contact person's company name.

Syntax

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

Default Value

""

Remarks

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

Data Type

String

RecipientFirstName Property (CanadaPostShipIntl Component)

Sender's first name.

Syntax

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

Default Value

""

Remarks

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

Data Type

String

RecipientLastName Property (CanadaPostShipIntl Component)

Person's last name.

Syntax

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

Default Value

""

Remarks

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

Data Type

String

RecipientMiddleInitial Property (CanadaPostShipIntl Component)

Middle initial.

Syntax

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

Default Value

""

Remarks

Middle initial. The value of this property is optional.

Data Type

String

RecipientPhone Property (CanadaPostShipIntl Component)

Identifies the contact person's phone number.

Syntax

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

Default Value

""

Remarks

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

Data Type

String

SenderAddress1 Property (CanadaPostShipIntl Component)

Street name.

Syntax

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

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address.

Maximum Length: 44 characters

Data Type

String

SenderAddress2 Property (CanadaPostShipIntl Component)

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

Syntax

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

Default Value

""

Remarks

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

Maximum Length: 44 characters

Data Type

String

SenderCity Property (CanadaPostShipIntl Component)

Name of city, town, etc.

Syntax

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

Default Value

""

Remarks

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

Data Type

String

SenderCountryCode Property (CanadaPostShipIntl Component)

Country code.

Syntax

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

Default Value

"CA"

Remarks

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

Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered.

Data Type

String

SenderPostalCode Property (CanadaPostShipIntl Component)

This is identifies of a region (usually small) for mail/package delivery.

Syntax

__property String SenderPostalCode = { read=FSenderPostalCode, write=FSetSenderPostalCode };

Default Value

""

Remarks

This is identifies of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country. The format for Canadian postal codes is A9A9A9.

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

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

Data Type

String

SenderProvince Property (CanadaPostShipIntl Component)

Province or state code.

Syntax

__property String SenderProvince = { read=FSenderProvince, write=FSetSenderProvince };

Default Value

""

Remarks

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

This is required when SenderCountryCode is either CA or US.

Data Type

String

SenderCompany Property (CanadaPostShipIntl Component)

Identifies the contact person's company name.

Syntax

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

Default Value

""

Remarks

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

Data Type

String

SenderFirstName Property (CanadaPostShipIntl Component)

Sender's first name.

Syntax

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

Default Value

""

Remarks

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

Data Type

String

SenderLastName Property (CanadaPostShipIntl Component)

Person's last name.

Syntax

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

Default Value

""

Remarks

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

Data Type

String

SenderMiddleInitial Property (CanadaPostShipIntl Component)

Middle initial.

Syntax

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

Default Value

""

Remarks

Middle initial. The value of this property is optional.

Data Type

String

SenderPhone Property (CanadaPostShipIntl Component)

Identifies the contact person's phone number.

Syntax

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

Default Value

""

Remarks

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

Data Type

String

ServiceType Property (CanadaPostShipIntl Component)

Identifies the domestic service to use in a ship request.

Syntax

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

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

Default Value

stUnspecified

Remarks

This property is required to be provided in a ship request.

Valid values for Canada Post are:

This property is not available at design time.

Data Type

Integer

ShipDate Property (CanadaPostShipIntl Component)

The date on which the package will be tendered.

Syntax

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

Default Value

""

Remarks

This property contains the expected ship date for the package(s).

Data Type

String

ShipmentId Property (CanadaPostShipIntl Component)

The unique identifier for this shipment.

Syntax

__property String ShipmentId = { read=FShipmentId };

Default Value

""

Remarks

A unique identifier for the shipment. This can be used in any future calls to TransmitShipments, using the ExcludedShipments config to indicate that this shipment is to be excluded from the manifest.

This property is read-only.

Data Type

String

ShipmentSpecialServices Property (CanadaPostShipIntl Component)

Contains the collection of special services offered.

Syntax

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

Default Value

0

Remarks

To request any of the special services offered by Canada Post 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:

Return Shipment

This indicates that a return shipment is requested. If you wish to have the return shipment go to a different address, you can set the ReturnAddress and ReturnContact properties.

Card for Pickup

When this is set, the package will be held at the post office and the recipient will be notified that their package is ready to be picked up. The recipient must show ID before they can pickup the package.

Do Not Safe Drop

Indicates that if no one is available to accept the package when delivery is attempted, a Delivery Notice Card is left and the recipient must pick up the package at the post office.

Return at Sender's Expense

This indicates that if unable to delivery the package, the package should be returned to the sender at the sender's expense.

Return to Sender

This indicates that if unable to delivery the package, the package should be returned to the sender.

Abandon

This indicates that if unable to delivery the package, the package should be abandoned.

Data Type

Long64

SSLAcceptServerCertEncoded Property (CanadaPostShipIntl Component)

This is the certificate (PEM/Base64 encoded).

Syntax

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

SSLCertEncoded Property (CanadaPostShipIntl Component)

This is the certificate (PEM/Base64 encoded).

Syntax

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

SSLCertStore Property (CanadaPostShipIntl Component)

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

Syntax

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

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Byte Array

SSLCertStorePassword Property (CanadaPostShipIntl Component)

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

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (CanadaPostShipIntl Component)

This is the type of certificate store for this certificate.

Syntax

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

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

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (CanadaPostShipIntl Component)

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

Syntax

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

Default Value

""

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (CanadaPostShipIntl Component)

This specifies the SSL/TLS implementation to use.

Syntax

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

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

Default Value

sslpAutomatic

Remarks

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

Possible values are:

Additional Notes

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

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

Data Type

Integer

SSLServerCertEncoded Property (CanadaPostShipIntl Component)

This is the certificate (PEM/Base64 encoded).

Syntax

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

Default Value

""

Remarks

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

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

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

Data Type

Byte Array

Timeout Property (CanadaPostShipIntl Component)

A timeout for the component.

Syntax

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

Default Value

60

Remarks

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

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

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

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

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

CancelShipment Method (CanadaPostShipIntl Component)

Cancels a shipment.

Syntax

void __fastcall CancelShipment(String ShipmentId);

Remarks

This method cancels a shipment. The ShipmentId parameter is the value returned by the ShipmentId property when GetPackageLabel was called.

Note: This is only valid for shipments created using a contract (e.g. when CanadaPostContractId is specified) and must be called before TransmitShipments has been called for the specified shipment;

Config Method (CanadaPostShipIntl Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

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

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

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

GetManifest Method (CanadaPostShipIntl Component)

Gets the manifest info and file for the specified manifest.

Syntax

void __fastcall GetManifest(int ManifestIdx);

Remarks

When called, this will populate the manifest details in ManifestDetails at the specified index, specified by ManifestIdx. It will also write the manifest file to the path specified in ManifestFile.

In order to print a label and manifest to be tendered to a Canada Post driver, you must:

1. Assign each shipment a GroupId and then call GetPackageLabel for each package in the shipment.
2. Call TransmitShipments with the GroupId for the shipment.
3. Call GetManifest for each manifest in ManifestDetails.

Note that this only applies when submitting a contract shipment (ie. CanadaPostContractId is set).

GetPackageLabel Method (CanadaPostShipIntl Component)

Generates a shipping label for the specified package.

Syntax

void __fastcall GetPackageLabel(int PackageIndex);

Remarks

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

• CanadaPostAccount (required)
• Commodities (required)
• GroupId (required if CanadaPostContractId is set)
• Packages (required)
• PaymentMethod (required if CanadaPostContractId is set)
• ReasonForExport (required)
• RecipientContact (required)
• RecipientAddress (required)
• SenderContact (required)
• SenderAddress (required)
• ServiceType (required)
• ShipmentSpecialServices (optional)

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

Reset Method (CanadaPostShipIntl Component)

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

Syntax

void __fastcall Reset();

Remarks

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

SearchManifests Method (CanadaPostShipIntl Component)

Search for manifests within a given date range.

Syntax

void __fastcall SearchManifests(String StartDate, String EndDate);

Remarks

This will retrieve any manifests printed between the StartDate and EndDate and populates the ManifestURL. The date must be specified in the format "YYYYMMDD".

TransmitShipments Method (CanadaPostShipIntl Component)

Submits the shipment information and retrieve the manifest for the specified GroupId.

Syntax

void __fastcall TransmitShipments();

Remarks

This will transmit the shipment information for the specified GroupId and print the manifest for that shipment.

If you wish to get the manifest for more than one group, you can specify more than one group ID in a comma separated list in the GroupId property.

The following properties must be set before making a call to TransmitShipments:

• ExcludedShipments (Optional)
• GroupId (Required)
• ManifestFile (Required)
• SenderAddress (Required)

In order to print a label and manifest to be tendered to a Canada Post driver, you must:

1. Assign each shipment a GroupId and then call GetPackageLabel for each package in the shipment.
2. Call TransmitShipments with the GroupId for the shipment.
3. Call GetManifest for each manifest in ManifestDetails.

Note that this only applies when submitting a contract shipment (ie. CanadaPostContractId is set).

Error Event (CanadaPostShipIntl Component)

Information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TibxCanadaPostShipIntlErrorEventParams;
typedef void __fastcall (__closure *TibxCanadaPostShipIntlErrorEvent)(System::TObject* Sender, TibxCanadaPostShipIntlErrorEventParams *e);
__property TibxCanadaPostShipIntlErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

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

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

Notification Event (CanadaPostShipIntl Component)

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

Syntax

typedef struct {
  String Message;
} TibxCanadaPostShipIntlNotificationEventParams;
typedef void __fastcall (__closure *TibxCanadaPostShipIntlNotificationEvent)(System::TObject* Sender, TibxCanadaPostShipIntlNotificationEventParams *e);
__property TibxCanadaPostShipIntlNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

Remarks

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

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

SSLServerAuthentication Event (CanadaPostShipIntl Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TibxCanadaPostShipIntlSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TibxCanadaPostShipIntlSSLServerAuthenticationEvent)(System::TObject* Sender, TibxCanadaPostShipIntlSSLServerAuthenticationEventParams *e);
__property TibxCanadaPostShipIntlSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

Remarks

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

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

SSLStatus Event (CanadaPostShipIntl Component)

Fired when secure connection progress messages are available.

Syntax

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

Remarks

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

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

CanadaPostShipIntl Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (CanadaPostShipIntl Component)

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