CanadaPostShip Class

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate domestic labels using Canada Post.

Syntax

CanadaPostShip

Remarks

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

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 (CanadaPostShip 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_canadapostship_getcanadapostaccountnumber(void* lpObj);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_getcanadapostcontractid(void* lpObj);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_getcanadapostpassword(void* lpObj);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_getcanadapostserver(void* lpObj);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_getcanadapostuserid(void* lpObj);
int dshippingsdk_canadapostship_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

FirewallAutoDetect Property (CanadaPostShip 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_canadapostship_getfirewallautodetect(void* lpObj);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_getfirewalltype(void* lpObj);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_getfirewallhost(void* lpObj);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_getfirewallpassword(void* lpObj);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_getfirewallport(void* lpObj);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_getfirewalluser(void* lpObj);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_getgroupid(void* lpObj);
int dshippingsdk_canadapostship_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

Manifest Property (CanadaPostShip Class)

Image of the manifest.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetManifest();

Unicode (Windows)
LPWSTR GetManifest();

char* dshippingsdk_canadapostship_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 (CanadaPostShip Class)

The number of records in the Manifest arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetManifestCount();

Unicode (Windows)
INT GetManifestCount();

int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_getmanifestfile(void* lpObj);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_getnotifycount(void* lpObj);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_getnotifyemail(void* lpObj, int notifyidx);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_getnotifyflags(void* lpObj, int notifyidx);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_getoriginpostalcode(void* lpObj);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_getpackagecount(void* lpObj);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_getpackagecodamount(void* lpObj, int packageidx);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_getpackagecodfile(void* lpObj, int packageidx);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_getpackagecodtype(void* lpObj, int packageidx);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_getpackageheight(void* lpObj, int packageidx);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_getpackageinsuredvalue(void* lpObj, int packageidx);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_getpackagelength(void* lpObj, int packageidx);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_getpackagenetcharge(void* lpObj, int packageidx);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_getpackagetype(void* lpObj, int packageidx);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_getpackagereference(void* lpObj, int packageidx);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_getpackagereturnreceiptfile(void* lpObj, int packageidx);
int dshippingsdk_canadapostship_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 (CanadaPostShip 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_canadapostship_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 (CanadaPostShip 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_canadapostship_getpackageshippinglabelfile(void* lpObj, int packageidx);
int dshippingsdk_canadapostship_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

String

PackageSignatureType Property (CanadaPostShip Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageSignatureType(int iPackageIdx);
int SetPackageSignatureType(int iPackageIdx, int iPackageSignatureType);

Unicode (Windows)
INT GetPackageSignatureType(INT iPackageIdx);
INT SetPackageSignatureType(INT iPackageIdx, INT iPackageSignatureType);

ST_SERVICE_DEFAULT(0), 
ST_ADULT(1), 
ST_DIRECT(2), 
ST_INDIRECT(3), 
ST_NO_SIGNATURE_REQUIRED(4), 
ST_USPSDELIVERY_CONFIRMATION(5), 
ST_ADULT_19(6)

int dshippingsdk_canadapostship_getpackagesignaturetype(void* lpObj, int packageidx);
int dshippingsdk_canadapostship_setpackagesignaturetype(void* lpObj, int packageidx, int iPackageSignatureType);

int GetPackageSignatureType(int iPackageIdx);
int SetPackageSignatureType(int iPackageIdx, int iPackageSignatureType);

Default Value

0

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

Size of the package being mailed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageSize(int iPackageIdx);
int SetPackageSize(int iPackageIdx, int iPackageSize);

Unicode (Windows)
INT GetPackageSize(INT iPackageIdx);
INT SetPackageSize(INT iPackageIdx, INT iPackageSize);

PS_REGULAR(0), 
PS_LARGE(1), 
PS_OVERSIZE(2), 
PS_IRREGULAR(3)

int dshippingsdk_canadapostship_getpackagesize(void* lpObj, int packageidx);
int dshippingsdk_canadapostship_setpackagesize(void* lpObj, int packageidx, int iPackageSize);

int GetPackageSize(int iPackageIdx);
int SetPackageSize(int iPackageIdx, int iPackageSize);

Default Value

0

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

Total Actual Discount applicable to this package.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetPackageTotalDiscount(INT iPackageIdx);

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

QString GetPackageTotalDiscount(int iPackageIdx);

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

Total Actual Surcharges applicable to this package.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetPackageTotalSurcharges(INT iPackageIdx);

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

QString GetPackageTotalSurcharges(int iPackageIdx);

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

Tracking number assigned to this package.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetPackageTrackingNumber(INT iPackageIdx);

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

QString GetPackageTrackingNumber(int iPackageIdx);

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

Weight of this package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageWeight(int iPackageIdx);
int SetPackageWeight(int iPackageIdx, const char* lpszPackageWeight);

Unicode (Windows)
LPWSTR GetPackageWeight(INT iPackageIdx);
INT SetPackageWeight(INT iPackageIdx, LPCWSTR lpszPackageWeight);

char* dshippingsdk_canadapostship_getpackageweight(void* lpObj, int packageidx);
int dshippingsdk_canadapostship_setpackageweight(void* lpObj, int packageidx, const char* lpszPackageWeight);

QString GetPackageWeight(int iPackageIdx);
int SetPackageWeight(int iPackageIdx, QString qsPackageWeight);

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

The width of the package to be shipped.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageWidth(int iPackageIdx);
int SetPackageWidth(int iPackageIdx, int iPackageWidth);

Unicode (Windows)
INT GetPackageWidth(INT iPackageIdx);
INT SetPackageWidth(INT iPackageIdx, INT iPackageWidth);

int dshippingsdk_canadapostship_getpackagewidth(void* lpObj, int packageidx);
int dshippingsdk_canadapostship_setpackagewidth(void* lpObj, int packageidx, int iPackageWidth);

int GetPackageWidth(int iPackageIdx);
int SetPackageWidth(int iPackageIdx, int iPackageWidth);

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

The intended payment method when using Canada Post.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPaymentMethod();
int SetPaymentMethod(int iPaymentMethod);

Unicode (Windows)
INT GetPaymentMethod();
INT SetPaymentMethod(INT iPaymentMethod);

PM_ACCOUNT(0), 
PM_CREDIT_CARD(1)

int dshippingsdk_canadapostship_getpaymentmethod(void* lpObj);
int dshippingsdk_canadapostship_setpaymentmethod(void* lpObj, int iPaymentMethod);

int GetPaymentMethod();
int SetPaymentMethod(int iPaymentMethod);

Default Value

0

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5)

int dshippingsdk_canadapostship_getproxyauthscheme(void* lpObj);
int dshippingsdk_canadapostship_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Default Value

0

Remarks

This property is used to tell the class 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 class. Look at the configuration file for the class 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 (CanadaPostShip Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

int dshippingsdk_canadapostship_getproxyautodetect(void* lpObj);
int dshippingsdk_canadapostship_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

Default Value

FALSE

Remarks

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

Data Type

Boolean

ProxyPassword Property (CanadaPostShip Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* dshippingsdk_canadapostship_getproxypassword(void* lpObj);
int dshippingsdk_canadapostship_setproxypassword(void* lpObj, const char* lpszProxyPassword);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int dshippingsdk_canadapostship_getproxyport(void* lpObj);
int dshippingsdk_canadapostship_setproxyport(void* lpObj, int iProxyPort);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

char* dshippingsdk_canadapostship_getproxyserver(void* lpObj);
int dshippingsdk_canadapostship_setproxyserver(void* lpObj, const char* lpszProxyServer);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

int dshippingsdk_canadapostship_getproxyssl(void* lpObj);
int dshippingsdk_canadapostship_setproxyssl(void* lpObj, int iProxySSL);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

Default Value

0

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

This property contains a user name, if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

char* dshippingsdk_canadapostship_getproxyuser(void* lpObj);
int dshippingsdk_canadapostship_setproxyuser(void* lpObj, const char* lpszProxyUser);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Default Value

""

Remarks

This property contains a user name, 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

RecipientAddress1 Property (CanadaPostShip Class)

Street name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientAddress1();
int SetRecipientAddress1(const char* lpszRecipientAddress1);

Unicode (Windows)
LPWSTR GetRecipientAddress1();
INT SetRecipientAddress1(LPCWSTR lpszRecipientAddress1);

char* dshippingsdk_canadapostship_getrecipientaddress1(void* lpObj);
int dshippingsdk_canadapostship_setrecipientaddress1(void* lpObj, const char* lpszRecipientAddress1);

QString GetRecipientAddress1();
int SetRecipientAddress1(QString qsRecipientAddress1);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientAddress2();
int SetRecipientAddress2(const char* lpszRecipientAddress2);

Unicode (Windows)
LPWSTR GetRecipientAddress2();
INT SetRecipientAddress2(LPCWSTR lpszRecipientAddress2);

char* dshippingsdk_canadapostship_getrecipientaddress2(void* lpObj);
int dshippingsdk_canadapostship_setrecipientaddress2(void* lpObj, const char* lpszRecipientAddress2);

QString GetRecipientAddress2();
int SetRecipientAddress2(QString qsRecipientAddress2);

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

Name of city, town, etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientCity();
int SetRecipientCity(const char* lpszRecipientCity);

Unicode (Windows)
LPWSTR GetRecipientCity();
INT SetRecipientCity(LPCWSTR lpszRecipientCity);

char* dshippingsdk_canadapostship_getrecipientcity(void* lpObj);
int dshippingsdk_canadapostship_setrecipientcity(void* lpObj, const char* lpszRecipientCity);

QString GetRecipientCity();
int SetRecipientCity(QString qsRecipientCity);

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

Country code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientCountryCode();
int SetRecipientCountryCode(const char* lpszRecipientCountryCode);

Unicode (Windows)
LPWSTR GetRecipientCountryCode();
INT SetRecipientCountryCode(LPCWSTR lpszRecipientCountryCode);

char* dshippingsdk_canadapostship_getrecipientcountrycode(void* lpObj);
int dshippingsdk_canadapostship_setrecipientcountrycode(void* lpObj, const char* lpszRecipientCountryCode);

QString GetRecipientCountryCode();
int SetRecipientCountryCode(QString qsRecipientCountryCode);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientPostalCode();
int SetRecipientPostalCode(const char* lpszRecipientPostalCode);

Unicode (Windows)
LPWSTR GetRecipientPostalCode();
INT SetRecipientPostalCode(LPCWSTR lpszRecipientPostalCode);

char* dshippingsdk_canadapostship_getrecipientpostalcode(void* lpObj);
int dshippingsdk_canadapostship_setrecipientpostalcode(void* lpObj, const char* lpszRecipientPostalCode);

QString GetRecipientPostalCode();
int SetRecipientPostalCode(QString qsRecipientPostalCode);

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

Province or state code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientProvince();
int SetRecipientProvince(const char* lpszRecipientProvince);

Unicode (Windows)
LPWSTR GetRecipientProvince();
INT SetRecipientProvince(LPCWSTR lpszRecipientProvince);

char* dshippingsdk_canadapostship_getrecipientprovince(void* lpObj);
int dshippingsdk_canadapostship_setrecipientprovince(void* lpObj, const char* lpszRecipientProvince);

QString GetRecipientProvince();
int SetRecipientProvince(QString qsRecipientProvince);

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

Identifies the contact person's company name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientCompany();
int SetRecipientCompany(const char* lpszRecipientCompany);

Unicode (Windows)
LPWSTR GetRecipientCompany();
INT SetRecipientCompany(LPCWSTR lpszRecipientCompany);

char* dshippingsdk_canadapostship_getrecipientcompany(void* lpObj);
int dshippingsdk_canadapostship_setrecipientcompany(void* lpObj, const char* lpszRecipientCompany);

QString GetRecipientCompany();
int SetRecipientCompany(QString qsRecipientCompany);

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

Sender's first name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientFirstName();
int SetRecipientFirstName(const char* lpszRecipientFirstName);

Unicode (Windows)
LPWSTR GetRecipientFirstName();
INT SetRecipientFirstName(LPCWSTR lpszRecipientFirstName);

char* dshippingsdk_canadapostship_getrecipientfirstname(void* lpObj);
int dshippingsdk_canadapostship_setrecipientfirstname(void* lpObj, const char* lpszRecipientFirstName);

QString GetRecipientFirstName();
int SetRecipientFirstName(QString qsRecipientFirstName);

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

Person's last name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientLastName();
int SetRecipientLastName(const char* lpszRecipientLastName);

Unicode (Windows)
LPWSTR GetRecipientLastName();
INT SetRecipientLastName(LPCWSTR lpszRecipientLastName);

char* dshippingsdk_canadapostship_getrecipientlastname(void* lpObj);
int dshippingsdk_canadapostship_setrecipientlastname(void* lpObj, const char* lpszRecipientLastName);

QString GetRecipientLastName();
int SetRecipientLastName(QString qsRecipientLastName);

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

Middle initial.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientMiddleInitial();
int SetRecipientMiddleInitial(const char* lpszRecipientMiddleInitial);

Unicode (Windows)
LPWSTR GetRecipientMiddleInitial();
INT SetRecipientMiddleInitial(LPCWSTR lpszRecipientMiddleInitial);

char* dshippingsdk_canadapostship_getrecipientmiddleinitial(void* lpObj);
int dshippingsdk_canadapostship_setrecipientmiddleinitial(void* lpObj, const char* lpszRecipientMiddleInitial);

QString GetRecipientMiddleInitial();
int SetRecipientMiddleInitial(QString qsRecipientMiddleInitial);

Default Value

""

Remarks

Middle initial. The value of this property is optional.

Data Type

String

RecipientPhone Property (CanadaPostShip Class)

Identifies the contact person's phone number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientPhone();
int SetRecipientPhone(const char* lpszRecipientPhone);

Unicode (Windows)
LPWSTR GetRecipientPhone();
INT SetRecipientPhone(LPCWSTR lpszRecipientPhone);

char* dshippingsdk_canadapostship_getrecipientphone(void* lpObj);
int dshippingsdk_canadapostship_setrecipientphone(void* lpObj, const char* lpszRecipientPhone);

QString GetRecipientPhone();
int SetRecipientPhone(QString qsRecipientPhone);

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

ReturnAddress1 Property (CanadaPostShip Class)

Street name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReturnAddress1();
int SetReturnAddress1(const char* lpszReturnAddress1);

Unicode (Windows)
LPWSTR GetReturnAddress1();
INT SetReturnAddress1(LPCWSTR lpszReturnAddress1);

char* dshippingsdk_canadapostship_getreturnaddress1(void* lpObj);
int dshippingsdk_canadapostship_setreturnaddress1(void* lpObj, const char* lpszReturnAddress1);

QString GetReturnAddress1();
int SetReturnAddress1(QString qsReturnAddress1);

Default Value

""

Remarks