CanadaPostShipIntl Class

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate international labels using Canada Post.

Syntax

CanadaPostShipIntl

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 class 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 class with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

CanadaPostAccountNumber Property (CanadaPostShipIntl Class)

The shipper's account number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCanadaPostAccountNumber();
int SetCanadaPostAccountNumber(const char* lpszCanadaPostAccountNumber);

Unicode (Windows)
LPWSTR GetCanadaPostAccountNumber();
INT SetCanadaPostAccountNumber(LPCWSTR lpszCanadaPostAccountNumber);

char* dshippingsdk_canadapostshipintl_getcanadapostaccountnumber(void* lpObj);
int dshippingsdk_canadapostshipintl_setcanadapostaccountnumber(void* lpObj, const char* lpszCanadaPostAccountNumber);

QString GetCanadaPostAccountNumber();
int SetCanadaPostAccountNumber(QString qsCanadaPostAccountNumber);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCanadaPostContractId();
int SetCanadaPostContractId(const char* lpszCanadaPostContractId);

Unicode (Windows)
LPWSTR GetCanadaPostContractId();
INT SetCanadaPostContractId(LPCWSTR lpszCanadaPostContractId);

char* dshippingsdk_canadapostshipintl_getcanadapostcontractid(void* lpObj);
int dshippingsdk_canadapostshipintl_setcanadapostcontractid(void* lpObj, const char* lpszCanadaPostContractId);

QString GetCanadaPostContractId();
int SetCanadaPostContractId(QString qsCanadaPostContractId);

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

Password for logging in to the Server .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCanadaPostPassword();
int SetCanadaPostPassword(const char* lpszCanadaPostPassword);

Unicode (Windows)
LPWSTR GetCanadaPostPassword();
INT SetCanadaPostPassword(LPCWSTR lpszCanadaPostPassword);

char* dshippingsdk_canadapostshipintl_getcanadapostpassword(void* lpObj);
int dshippingsdk_canadapostshipintl_setcanadapostpassword(void* lpObj, const char* lpszCanadaPostPassword);

QString GetCanadaPostPassword();
int SetCanadaPostPassword(QString qsCanadaPostPassword);

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

URL for the server where the requests are sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCanadaPostServer();
int SetCanadaPostServer(const char* lpszCanadaPostServer);

Unicode (Windows)
LPWSTR GetCanadaPostServer();
INT SetCanadaPostServer(LPCWSTR lpszCanadaPostServer);

char* dshippingsdk_canadapostshipintl_getcanadapostserver(void* lpObj);
int dshippingsdk_canadapostshipintl_setcanadapostserver(void* lpObj, const char* lpszCanadaPostServer);

QString GetCanadaPostServer();
int SetCanadaPostServer(QString qsCanadaPostServer);

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

User Id for logging in to the Server .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCanadaPostUserId();
int SetCanadaPostUserId(const char* lpszCanadaPostUserId);

Unicode (Windows)
LPWSTR GetCanadaPostUserId();
INT SetCanadaPostUserId(LPCWSTR lpszCanadaPostUserId);

char* dshippingsdk_canadapostshipintl_getcanadapostuserid(void* lpObj);
int dshippingsdk_canadapostshipintl_setcanadapostuserid(void* lpObj, const char* lpszCanadaPostUserId);

QString GetCanadaPostUserId();
int SetCanadaPostUserId(QString qsCanadaPostUserId);

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

The number of records in the Commodity arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommodityCount();
int SetCommodityCount(int iCommodityCount);

Unicode (Windows)
INT GetCommodityCount();
INT SetCommodityCount(INT iCommodityCount);

int dshippingsdk_canadapostshipintl_getcommoditycount(void* lpObj);
int dshippingsdk_canadapostshipintl_setcommoditycount(void* lpObj, int iCommodityCount);

int GetCommodityCount();
int SetCommodityCount(int iCommodityCount);

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

Complete and accurate description of this commodity line item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityDescription(int iCommodityIdx);
int SetCommodityDescription(int iCommodityIdx, const char* lpszCommodityDescription);

Unicode (Windows)
LPWSTR GetCommodityDescription(INT iCommodityIdx);
INT SetCommodityDescription(INT iCommodityIdx, LPCWSTR lpszCommodityDescription);

char* dshippingsdk_canadapostshipintl_getcommoditydescription(void* lpObj, int commodityidx);
int dshippingsdk_canadapostshipintl_setcommoditydescription(void* lpObj, int commodityidx, const char* lpszCommodityDescription);

QString GetCommodityDescription(int iCommodityIdx);
int SetCommodityDescription(int iCommodityIdx, QString qsCommodityDescription);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityHarmonizedCode(int iCommodityIdx);
int SetCommodityHarmonizedCode(int iCommodityIdx, const char* lpszCommodityHarmonizedCode);

Unicode (Windows)
LPWSTR GetCommodityHarmonizedCode(INT iCommodityIdx);
INT SetCommodityHarmonizedCode(INT iCommodityIdx, LPCWSTR lpszCommodityHarmonizedCode);

char* dshippingsdk_canadapostshipintl_getcommodityharmonizedcode(void* lpObj, int commodityidx);
int dshippingsdk_canadapostshipintl_setcommodityharmonizedcode(void* lpObj, int commodityidx, const char* lpszCommodityHarmonizedCode);

QString GetCommodityHarmonizedCode(int iCommodityIdx);
int SetCommodityHarmonizedCode(int iCommodityIdx, QString qsCommodityHarmonizedCode);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityManufacturer(int iCommodityIdx);
int SetCommodityManufacturer(int iCommodityIdx, const char* lpszCommodityManufacturer);

Unicode (Windows)
LPWSTR GetCommodityManufacturer(INT iCommodityIdx);
INT SetCommodityManufacturer(INT iCommodityIdx, LPCWSTR lpszCommodityManufacturer);

char* dshippingsdk_canadapostshipintl_getcommoditymanufacturer(void* lpObj, int commodityidx);
int dshippingsdk_canadapostshipintl_setcommoditymanufacturer(void* lpObj, int commodityidx, const char* lpszCommodityManufacturer);

QString GetCommodityManufacturer(int iCommodityIdx);
int SetCommodityManufacturer(int iCommodityIdx, QString qsCommodityManufacturer);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommodityNumberOfPieces(int iCommodityIdx);
int SetCommodityNumberOfPieces(int iCommodityIdx, int iCommodityNumberOfPieces);

Unicode (Windows)
INT GetCommodityNumberOfPieces(INT iCommodityIdx);
INT SetCommodityNumberOfPieces(INT iCommodityIdx, INT iCommodityNumberOfPieces);

int dshippingsdk_canadapostshipintl_getcommoditynumberofpieces(void* lpObj, int commodityidx);
int dshippingsdk_canadapostshipintl_setcommoditynumberofpieces(void* lpObj, int commodityidx, int iCommodityNumberOfPieces);

int GetCommodityNumberOfPieces(int iCommodityIdx);
int SetCommodityNumberOfPieces(int iCommodityIdx, int iCommodityNumberOfPieces);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityUnitPrice(int iCommodityIdx);
int SetCommodityUnitPrice(int iCommodityIdx, const char* lpszCommodityUnitPrice);

Unicode (Windows)
LPWSTR GetCommodityUnitPrice(INT iCommodityIdx);
INT SetCommodityUnitPrice(INT iCommodityIdx, LPCWSTR lpszCommodityUnitPrice);

char* dshippingsdk_canadapostshipintl_getcommodityunitprice(void* lpObj, int commodityidx);
int dshippingsdk_canadapostshipintl_setcommodityunitprice(void* lpObj, int commodityidx, const char* lpszCommodityUnitPrice);

QString GetCommodityUnitPrice(int iCommodityIdx);
int SetCommodityUnitPrice(int iCommodityIdx, QString qsCommodityUnitPrice);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityWeight(int iCommodityIdx);
int SetCommodityWeight(int iCommodityIdx, const char* lpszCommodityWeight);

Unicode (Windows)
LPWSTR GetCommodityWeight(INT iCommodityIdx);
INT SetCommodityWeight(INT iCommodityIdx, LPCWSTR lpszCommodityWeight);

char* dshippingsdk_canadapostshipintl_getcommodityweight(void* lpObj, int commodityidx);
int dshippingsdk_canadapostshipintl_setcommodityweight(void* lpObj, int commodityidx, const char* lpszCommodityWeight);

QString GetCommodityWeight(int iCommodityIdx);
int SetCommodityWeight(int iCommodityIdx, QString qsCommodityWeight);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int dshippingsdk_canadapostshipintl_getfirewallautodetect(void* lpObj);
int dshippingsdk_canadapostshipintl_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

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

Data Type

Boolean

FirewallType Property (CanadaPostShipIntl Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int dshippingsdk_canadapostshipintl_getfirewalltype(void* lpObj);
int dshippingsdk_canadapostshipintl_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (CanadaPostShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* dshippingsdk_canadapostshipintl_getfirewallhost(void* lpObj);
int dshippingsdk_canadapostshipintl_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

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 class fails with an error.

Data Type

String

FirewallPassword Property (CanadaPostShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* dshippingsdk_canadapostshipintl_getfirewallpassword(void* lpObj);
int dshippingsdk_canadapostshipintl_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

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 class fails with an error.

Data Type

String

FirewallPort Property (CanadaPostShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int dshippingsdk_canadapostshipintl_getfirewallport(void* lpObj);
int dshippingsdk_canadapostshipintl_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* dshippingsdk_canadapostshipintl_getfirewalluser(void* lpObj);
int dshippingsdk_canadapostshipintl_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

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 class fails with an error.

Data Type

String

GroupId Property (CanadaPostShipIntl Class)

The Group Id that will be associated with the shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetGroupId();
int SetGroupId(const char* lpszGroupId);

Unicode (Windows)
LPWSTR GetGroupId();
INT SetGroupId(LPCWSTR lpszGroupId);

char* dshippingsdk_canadapostshipintl_getgroupid(void* lpObj);
int dshippingsdk_canadapostshipintl_setgroupid(void* lpObj, const char* lpszGroupId);

QString GetGroupId();
int SetGroupId(QString qsGroupId);

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

Image of the international form.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInternationalForm();

Unicode (Windows)
LPWSTR GetInternationalForm();

char* dshippingsdk_canadapostshipintl_getinternationalform(void* lpObj);

QString GetInternationalForm();

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

The location where the international form files will be written.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInternationalFormFile();
int SetInternationalFormFile(const char* lpszInternationalFormFile);

Unicode (Windows)
LPWSTR GetInternationalFormFile();
INT SetInternationalFormFile(LPCWSTR lpszInternationalFormFile);

char* dshippingsdk_canadapostshipintl_getinternationalformfile(void* lpObj);
int dshippingsdk_canadapostshipintl_setinternationalformfile(void* lpObj, const char* lpszInternationalFormFile);

QString GetInternationalFormFile();
int SetInternationalFormFile(QString qsInternationalFormFile);

Default Value

""

Remarks

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

Data Type

String

Manifest Property (CanadaPostShipIntl Class)

Image of the manifest.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifest();

Unicode (Windows)
LPWSTR GetManifest();

char* dshippingsdk_canadapostshipintl_getmanifest(void* lpObj);

QString GetManifest();

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

The number of records in the Manifest arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetManifestCount();

Unicode (Windows)
INT GetManifestCount();

int dshippingsdk_canadapostshipintl_getmanifestcount(void* lpObj);

int GetManifestCount();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestAccountNumber(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestAccountNumber(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifestaccountnumber(void* lpObj, int manifestidx);

QString GetManifestAccountNumber(int iManifestIdx);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestBaseCharge(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestBaseCharge(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifestbasecharge(void* lpObj, int manifestidx);

QString GetManifestBaseCharge(int iManifestIdx);

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

The authorization code received from the credit card issuer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestCCAuthCode(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestCCAuthCode(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifestccauthcode(void* lpObj, int manifestidx);

QString GetManifestCCAuthCode(int iManifestIdx);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestCCAuthTimestamp(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestCCAuthTimestamp(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifestccauthtimestamp(void* lpObj, int manifestidx);

QString GetManifestCCAuthTimestamp(int iManifestIdx);

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

The merchant name used when charging the credit card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestCCMerchantName(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestCCMerchantName(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifestccmerchantname(void* lpObj, int manifestidx);

QString GetManifestCCMerchantName(int iManifestIdx);

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

The URL for the merchant who charged the credit card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestCCMerchantURL(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestCCMerchantURL(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifestccmerchanturl(void* lpObj, int manifestidx);

QString GetManifestCCMerchantURL(int iManifestIdx);

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

The name on the card that was charged.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestCCNameOnCard(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestCCNameOnCard(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifestccnameoncard(void* lpObj, int manifestidx);

QString GetManifestCCNameOnCard(int iManifestIdx);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestContractId(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestContractId(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifestcontractid(void* lpObj, int manifestidx);

QString GetManifestContractId(int iManifestIdx);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestCustomerReference(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestCustomerReference(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifestcustomerreference(void* lpObj, int manifestidx);

QString GetManifestCustomerReference(int iManifestIdx);

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

This is the date the manifest was generated.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestDate(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestDate(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifestdate(void* lpObj, int manifestidx);

QString GetManifestDate(int iManifestIdx);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestDestinationPostalCode(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestDestinationPostalCode(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifestdestinationpostalcode(void* lpObj, int manifestidx);

QString GetManifestDestinationPostalCode(int iManifestIdx);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestGST(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestGST(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifestgst(void* lpObj, int manifestidx);

QString GetManifestGST(int iManifestIdx);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestHST(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestHST(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifesthst(void* lpObj, int manifestidx);

QString GetManifestHST(int iManifestIdx);

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

This contains the media-type attribute for the URL .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestMediaType(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestMediaType(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifestmediatype(void* lpObj, int manifestidx);

QString GetManifestMediaType(int iManifestIdx);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestNetCharge(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestNetCharge(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifestnetcharge(void* lpObj, int manifestidx);

QString GetManifestNetCharge(int iManifestIdx);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestOriginId(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestOriginId(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifestoriginid(void* lpObj, int manifestidx);

QString GetManifestOriginId(int iManifestIdx);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestOriginName(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestOriginName(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifestoriginname(void* lpObj, int manifestidx);

QString GetManifestOriginName(int iManifestIdx);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestPayorAccountNumber(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestPayorAccountNumber(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifestpayoraccountnumber(void* lpObj, int manifestidx);

QString GetManifestPayorAccountNumber(int iManifestIdx);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestPONumber(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestPONumber(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifestponumber(void* lpObj, int manifestidx);

QString GetManifestPONumber(int iManifestIdx);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestPST(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestPST(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifestpst(void* lpObj, int manifestidx);

QString GetManifestPST(int iManifestIdx);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestShipperAccountNumber(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestShipperAccountNumber(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifestshipperaccountnumber(void* lpObj, int manifestidx);

QString GetManifestShipperAccountNumber(int iManifestIdx);

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

This is the time when the manifest was generated.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestTime(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestTime(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifesttime(void* lpObj, int manifestidx);

QString GetManifestTime(int iManifestIdx);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestTotalDiscount(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestTotalDiscount(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifesttotaldiscount(void* lpObj, int manifestidx);

QString GetManifestTotalDiscount(int iManifestIdx);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestTotalSurcharge(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestTotalSurcharge(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifesttotalsurcharge(void* lpObj, int manifestidx);

QString GetManifestTotalSurcharge(int iManifestIdx);

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

This property will contain the URL for the manifest.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestURL(int iManifestIdx);

Unicode (Windows)
LPWSTR GetManifestURL(INT iManifestIdx);

char* dshippingsdk_canadapostshipintl_getmanifesturl(void* lpObj, int manifestidx);

QString GetManifestURL(int iManifestIdx);

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

The location where the manifest files will be written.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifestFile();
int SetManifestFile(const char* lpszManifestFile);

Unicode (Windows)
LPWSTR GetManifestFile();
INT SetManifestFile(LPCWSTR lpszManifestFile);

char* dshippingsdk_canadapostshipintl_getmanifestfile(void* lpObj);
int dshippingsdk_canadapostshipintl_setmanifestfile(void* lpObj, const char* lpszManifestFile);

QString GetManifestFile();
int SetManifestFile(QString qsManifestFile);

Default Value

""

Remarks

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

Data Type

String

NotifyCount Property (CanadaPostShipIntl Class)

The number of records in the Notify arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNotifyCount();
int SetNotifyCount(int iNotifyCount);

Unicode (Windows)
INT GetNotifyCount();
INT SetNotifyCount(INT iNotifyCount);

int dshippingsdk_canadapostshipintl_getnotifycount(void* lpObj);
int dshippingsdk_canadapostshipintl_setnotifycount(void* lpObj, int iNotifyCount);

int GetNotifyCount();
int SetNotifyCount(int iNotifyCount);

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

Email address of the recipient to be notified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNotifyEmail(int iNotifyIdx);
int SetNotifyEmail(int iNotifyIdx, const char* lpszNotifyEmail);

Unicode (Windows)
LPWSTR GetNotifyEmail(INT iNotifyIdx);
INT SetNotifyEmail(INT iNotifyIdx, LPCWSTR lpszNotifyEmail);

char* dshippingsdk_canadapostshipintl_getnotifyemail(void* lpObj, int notifyidx);
int dshippingsdk_canadapostshipintl_setnotifyemail(void* lpObj, int notifyidx, const char* lpszNotifyEmail);

QString GetNotifyEmail(int iNotifyIdx);
int SetNotifyEmail(int iNotifyIdx, QString qsNotifyEmail);

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

Identifies the type of notification requested.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNotifyFlags(int iNotifyIdx);
int SetNotifyFlags(int iNotifyIdx, int iNotifyFlags);

Unicode (Windows)
INT GetNotifyFlags(INT iNotifyIdx);
INT SetNotifyFlags(INT iNotifyIdx, INT iNotifyFlags);

int dshippingsdk_canadapostshipintl_getnotifyflags(void* lpObj, int notifyidx);
int dshippingsdk_canadapostshipintl_setnotifyflags(void* lpObj, int notifyidx, int iNotifyFlags);

int GetNotifyFlags(int iNotifyIdx);
int SetNotifyFlags(int iNotifyIdx, int iNotifyFlags);

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

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOriginPostalCode();
int SetOriginPostalCode(const char* lpszOriginPostalCode);

Unicode (Windows)
LPWSTR GetOriginPostalCode();
INT SetOriginPostalCode(LPCWSTR lpszOriginPostalCode);

char* dshippingsdk_canadapostshipintl_getoriginpostalcode(void* lpObj);
int dshippingsdk_canadapostshipintl_setoriginpostalcode(void* lpObj, const char* lpszOriginPostalCode);

QString GetOriginPostalCode();
int SetOriginPostalCode(QString qsOriginPostalCode);

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

The number of records in the Package arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageCount();
int SetPackageCount(int iPackageCount);

Unicode (Windows)
INT GetPackageCount();
INT SetPackageCount(INT iPackageCount);

int dshippingsdk_canadapostshipintl_getpackagecount(void* lpObj);
int dshippingsdk_canadapostshipintl_setpackagecount(void* lpObj, int iPackageCount);

int GetPackageCount();
int SetPackageCount(int iPackageCount);

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

Actual Base Charge applicable to this package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageBaseCharge(int iPackageIdx);

Unicode (Windows)
LPWSTR GetPackageBaseCharge(INT iPackageIdx);

char* dshippingsdk_canadapostshipintl_getpackagebasecharge(void* lpObj, int packageidx);

QString GetPackageBaseCharge(int iPackageIdx);

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

The COD monetary value for the package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageCODAmount(int iPackageIdx);
int SetPackageCODAmount(int iPackageIdx, const char* lpszPackageCODAmount);

Unicode (Windows)
LPWSTR GetPackageCODAmount(INT iPackageIdx);
INT SetPackageCODAmount(INT iPackageIdx, LPCWSTR lpszPackageCODAmount);

char* dshippingsdk_canadapostshipintl_getpackagecodamount(void* lpObj, int packageidx);
int dshippingsdk_canadapostshipintl_setpackagecodamount(void* lpObj, int packageidx, const char* lpszPackageCODAmount);

QString GetPackageCODAmount(int iPackageIdx);
int SetPackageCODAmount(int iPackageIdx, QString qsPackageCODAmount);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageCODFile(int iPackageIdx);
int SetPackageCODFile(int iPackageIdx, const char* lpszPackageCODFile);

Unicode (Windows)
LPWSTR GetPackageCODFile(INT iPackageIdx);
INT SetPackageCODFile(INT iPackageIdx, LPCWSTR lpszPackageCODFile);

char* dshippingsdk_canadapostshipintl_getpackagecodfile(void* lpObj, int packageidx);
int dshippingsdk_canadapostshipintl_setpackagecodfile(void* lpObj, int packageidx, const char* lpszPackageCODFile);

QString GetPackageCODFile(int iPackageIdx);
int SetPackageCODFile(int iPackageIdx, QString qsPackageCODFile);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageCODLabel(int iPackageIdx, char* &lpPackageCODLabel, int &lenPackageCODLabel);

Unicode (Windows)
INT GetPackageCODLabel(INT iPackageIdx, LPSTR &lpPackageCODLabel, INT &lenPackageCODLabel);

int dshippingsdk_canadapostshipintl_getpackagecodlabel(void* lpObj, int packageidx, char** lpPackageCODLabel, int* lenPackageCODLabel);

QByteArray GetPackageCODLabel(int iPackageIdx);

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

Binary String

PackageCODType Property (CanadaPostShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageCODType(int iPackageIdx);
int SetPackageCODType(int iPackageIdx, int iPackageCODType);

Unicode (Windows)
INT GetPackageCODType(INT iPackageIdx);
INT SetPackageCODType(INT iPackageIdx, INT iPackageCODType);

CODTP_ANY(0), 
CODTP_CASH(1), 
CODTP_GUARANTEED_FUNDS(2), 
CODTP_COMPANY_CHECK(3), 
CODTP_PERSONAL_CHECK(4)

int dshippingsdk_canadapostshipintl_getpackagecodtype(void* lpObj, int packageidx);
int dshippingsdk_canadapostshipintl_setpackagecodtype(void* lpObj, int packageidx, int iPackageCODType);

int GetPackageCODType(int iPackageIdx);
int SetPackageCODType(int iPackageIdx, int iPackageCODType);

Default Value

0

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

The height of the package to be shipped.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageHeight(int iPackageIdx);
int SetPackageHeight(int iPackageIdx, int iPackageHeight);

Unicode (Windows)
INT GetPackageHeight(INT iPackageIdx);
INT SetPackageHeight(INT iPackageIdx, INT iPackageHeight);

int dshippingsdk_canadapostshipintl_getpackageheight(void* lpObj, int packageidx);
int dshippingsdk_canadapostshipintl_setpackageheight(void* lpObj, int packageidx, int iPackageHeight);

int GetPackageHeight(int iPackageIdx);
int SetPackageHeight(int iPackageIdx, int iPackageHeight);

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

Amount of insurance requested for this package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageInsuredValue(int iPackageIdx);
int SetPackageInsuredValue(int iPackageIdx, const char* lpszPackageInsuredValue);

Unicode (Windows)
LPWSTR GetPackageInsuredValue(INT iPackageIdx);
INT SetPackageInsuredValue(INT iPackageIdx, LPCWSTR lpszPackageInsuredValue);

char* dshippingsdk_canadapostshipintl_getpackageinsuredvalue(void* lpObj, int packageidx);
int dshippingsdk_canadapostshipintl_setpackageinsuredvalue(void* lpObj, int packageidx, const char* lpszPackageInsuredValue);

QString GetPackageInsuredValue(int iPackageIdx);
int SetPackageInsuredValue(int iPackageIdx, QString qsPackageInsuredValue);

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

The length of the package to be shipped.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageLength(int iPackageIdx);
int SetPackageLength(int iPackageIdx, int iPackageLength);

Unicode (Windows)
INT GetPackageLength(INT iPackageIdx);
INT SetPackageLength(INT iPackageIdx, INT iPackageLength);

int dshippingsdk_canadapostshipintl_getpackagelength(void* lpObj, int packageidx);
int dshippingsdk_canadapostshipintl_setpackagelength(void* lpObj, int packageidx, int iPackageLength);

int GetPackageLength(int iPackageIdx);
int SetPackageLength(int iPackageIdx, int iPackageLength);

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

Actual Net Charge applicable to this package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageNetCharge(int iPackageIdx);
int SetPackageNetCharge(int iPackageIdx, const char* lpszPackageNetCharge);

Unicode (Windows)
LPWSTR GetPackageNetCharge(INT iPackageIdx);
INT SetPackageNetCharge(INT iPackageIdx, LPCWSTR lpszPackageNetCharge);

char* dshippingsdk_canadapostshipintl_getpackagenetcharge(void* lpObj, int packageidx);
int dshippingsdk_canadapostshipintl_setpackagenetcharge(void* lpObj, int packageidx, const char* lpszPackageNetCharge);

QString GetPackageNetCharge(int iPackageIdx);
int SetPackageNetCharge(int iPackageIdx, QString qsPackageNetCharge);

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 classs 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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageType(int iPackageIdx);
int SetPackageType(int iPackageIdx, int iPackageType);

Unicode (Windows)
INT GetPackageType(INT iPackageIdx);
INT SetPackageType(INT iPackageIdx, INT iPackageType);

PT_NONE(0), 
PT_POSTCARDS(1), 
PT_LETTER(2), 
PT_LARGE_ENVELOPE(3), 
PT_FLAT_RATE_ENVELOPE(4), 
PT_FLAT_RATE_LEGAL_ENVELOPE(5), 
PT_FLAT_RATE_PADDED_ENVELOPE(6), 
PT_FLAT_RATE_GIFT_CARD_ENVELOPE(7), 
PT_FLAT_RATE_WINDOW_ENVELOPE(8), 
PT_FLAT_RATE_CARDBOARD_ENVELOPE(9), 
PT_SMALL_FLAT_RATE_ENVELOPE(10), 
PT_PAK(11), 
PT_BOX(12), 
PT_10KG_BOX(13), 
PT_25KG_BOX(14), 
PT_SMALL_EXPRESS_BOX(15), 
PT_MEDIUM_EXPRESS_BOX(16), 
PT_LARGE_EXPRESS_BOX(17), 
PT_FLAT_RATE_BOX(18), 
PT_SMALL_FLAT_RATE_BOX(19), 
PT_MEDIUM_FLAT_RATE_BOX(20), 
PT_LARGE_FLAT_RATE_BOX(21), 
PT_DVDFLAT_RATE_BOX(22), 
PT_LARGE_VIDEO_FLAT_RATE_BOX(23), 
PT_REGIONAL_RATE_BOX_A(24), 
PT_REGIONAL_RATE_BOX_B(25), 
PT_RECTANGULAR(26), 
PT_NON_RECTANGULAR(27), 
PT_TUBE(28), 
PT_MATTER_FOR_THE_BLIND(29), 
PT_PALLET(30), 
PT_YOUR_PACKAGING(31), 
PT_DOCUMENT(32), 
PT_FLATS(33), 
PT_PARCELS(34), 
PT_BPM(35), 
PT_FIRST_CLASS(36), 
PT_PRIORITY(37), 
PT_MACHINABLES(38), 
PT_IRREGULARS(39), 
PT_PARCEL_POST(40), 
PT_BPMPARCEL(41), 
PT_MEDIA_MAIL(42), 
PT_BPMFLAT(43), 
PT_STANDARD_FLAT(44), 
PT_REGIONAL_RATE_BOX_C(45), 
PT_THICK_ENVELOPE(46), 
PT_SMALL_BOX(47), 
PT_MEDIUM_BOX(48), 
PT_LARGE_BOX(49), 
PT_EXTRA_LARGE_BOX(50), 
PT_PACKAGE_SERVICE(51), 
PT_CUBIC_PARCELS(52), 
PT_CUBIC_SOFT_PACK(53)

int dshippingsdk_canadapostshipintl_getpackagetype(void* lpObj, int packageidx);
int dshippingsdk_canadapostshipintl_setpackagetype(void* lpObj, int packageidx, int iPackageType);

int GetPackageType(int iPackageIdx);
int SetPackageType(int iPackageIdx, int iPackageType);

Default Value

0

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

Rating aggregate applicable to this package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageRatingAggregate(int iPackageIdx);

Unicode (Windows)
LPWSTR GetPackageRatingAggregate(INT iPackageIdx);

char* dshippingsdk_canadapostshipintl_getpackageratingaggregate(void* lpObj, int packageidx);

QString GetPackageRatingAggregate(int iPackageIdx);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageReference(int iPackageIdx);
int SetPackageReference(int iPackageIdx, const char* lpszPackageReference);

Unicode (Windows)
LPWSTR GetPackageReference(INT iPackageIdx);
INT SetPackageReference(INT iPackageIdx, LPCWSTR lpszPackageReference);

char* dshippingsdk_canadapostshipintl_getpackagereference(void* lpObj, int packageidx);
int dshippingsdk_canadapostshipintl_setpackagereference(void* lpObj, int packageidx, const char* lpszPackageReference);

QString GetPackageReference(int iPackageIdx);
int SetPackageReference(int iPackageIdx, QString qsPackageReference);

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

Image of the receipt for a return shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageReturnReceipt(int iPackageIdx, char* &lpPackageReturnReceipt, int &lenPackageReturnReceipt);

Unicode (Windows)
INT GetPackageReturnReceipt(INT iPackageIdx, LPSTR &lpPackageReturnReceipt, INT &lenPackageReturnReceipt);

int dshippingsdk_canadapostshipintl_getpackagereturnreceipt(void* lpObj, int packageidx, char** lpPackageReturnReceipt, int* lenPackageReturnReceipt);

QByteArray GetPackageReturnReceipt(int iPackageIdx);

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

Binary String

PackageReturnReceiptFile Property (CanadaPostShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageReturnReceiptFile(int iPackageIdx);
int SetPackageReturnReceiptFile(int iPackageIdx, const char* lpszPackageReturnReceiptFile);

Unicode (Windows)
LPWSTR GetPackageReturnReceiptFile(INT iPackageIdx);
INT SetPackageReturnReceiptFile(INT iPackageIdx, LPCWSTR lpszPackageReturnReceiptFile);

char* dshippingsdk_canadapostshipintl_getpackagereturnreceiptfile(void* lpObj, int packageidx);
int dshippingsdk_canadapostshipintl_setpackagereturnreceiptfile(void* lpObj, int packageidx, const char* lpszPackageReturnReceiptFile);

QString GetPackageReturnReceiptFile(int iPackageIdx);
int SetPackageReturnReceiptFile(int iPackageIdx, QString qsPackageReturnReceiptFile);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageShippingLabel(int iPackageIdx, char* &lpPackageShippingLabel, int &lenPackageShippingLabel);

Unicode (Windows)
INT GetPackageShippingLabel(INT iPackageIdx, LPSTR &lpPackageShippingLabel, INT &lenPackageShippingLabel);

int dshippingsdk_canadapostshipintl_getpackageshippinglabel(void* lpObj, int packageidx, char** lpPackageShippingLabel, int* lenPackageShippingLabel);

QByteArray GetPackageShippingLabel(int iPackageIdx);

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

Binary String

PackageShippingLabelFile Property (CanadaPostShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageShippingLabelFile(int iPackageIdx);
int SetPackageShippingLabelFile(int iPackageIdx, const char* lpszPackageShippingLabelFile);

Unicode (Windows)
LPWSTR GetPackageShippingLabelFile(INT iPackageIdx);
INT SetPackageShippingLabelFile(INT iPackageIdx, LPCWSTR lpszPackageShippingLabelFile);

char* dshippingsdk_canadapostshipintl_getpackageshippinglabelfile(void* lpObj, int packageidx);
int dshippingsdk_canadapostshipintl_setpackageshippinglabelfile(void* lpObj, int packageidx, const char* lpszPackageShippingLabelFile);

QString GetPackageShippingLabelFile(int iPackageIdx);
int SetPackageShippingLabelFile(int iPackageIdx, QString qsPackageShippingLabelFile);

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